Improve external composer ux

Author: jdolle

packages/services/api/src/modules/schema/providers/schema-manager.ts

@@ -447,15 +447,10 @@ export class SchemaManager {
       },
     });
 
-    const [project, organization] = await Promise.all([
-      this.storage.getProject({
-        organizationId: selector.organizationId,
-        projectId: selector.projectId,
-      }),
-      this.storage.getOrganization({
-        organizationId: selector.organizationId,
-      }),
-    ]);
+    const project = await this.storage.getProject({
+      organizationId: selector.organizationId,
+      projectId: selector.projectId,
+    });
 
     if (project.type !== ProjectType.FEDERATION) {
       throw new HiveError(
@@ -481,11 +476,8 @@ export class SchemaManager {
         ],
         {
           external: project.externalComposition,
-          native: this.checkProjectNativeFederationSupport({
-            project,
-            organization,
-            targetId: null,
-          }),
+          // when testing external composition, do not use native composition during the check
+          native: false,
           contracts: null,
         },
       );

packages/services/schema/src/api.ts

@@ -105,6 +105,7 @@ export const schemaBuilderApiRouter = t.router({
                 abortSignal,
                 requestId: ctx.req.id,
               });
+
               return result.result;
             },
             result =>

packages/services/schema/src/composition-scheduler.ts

@@ -171,6 +171,7 @@ export class CompositionScheduler {
 
       const time = process.hrtime();
 
+      // starts the composition for this task
       worker.postMessage({
         event: 'composition',
         id: taskId,

packages/services/schema/src/composition-worker.ts

@@ -1,5 +1,7 @@
 import * as crypto from 'node:crypto';
 import type { MessagePort } from 'node:worker_threads';
+// IMPORTANT: Must use "type" to avoid runtime dependency
+import type { FastifyBaseLogger } from 'fastify';
 import type { Logger } from '@hive/api';
 import { CompositionResponse } from './api';
 import { createComposeFederation, type ComposeFederationArgs } from './composition/federation';
@@ -51,11 +53,10 @@ export function createCompositionWorker(args: {
         if (message.data.type === 'federation') {
           const composeFederation = createComposeFederation({
             decrypt,
-            logger: baseLogger.child({ reqId: message.data.args.requestId }) as any,
+            logger: baseLogger.child({ reqId: message.data.args.requestId }) as FastifyBaseLogger,
             requestTimeoutMs: message.data.requestTimeoutMs,
           });
           const composed = await composeFederation(message.data.args);
-
           args.port.postMessage({
             event: 'compositionResult',
             id: message.id,

packages/services/schema/src/composition/federation.ts

@@ -134,7 +134,7 @@ export const createComposeFederation = (deps: ComposeFederationDeps) =>
     if (args.native) {
       deps.logger.debug(
         'Using built-in Federation v2 composition service (schemas=%s)',
-        args.schemas.length,
+        subgraphs.length,
       );
       compose = subgraphs => Promise.resolve(composeFederationV2(subgraphs, deps.logger));
     } else if (args.external) {
@@ -151,7 +151,7 @@ export const createComposeFederation = (deps: ComposeFederationDeps) =>
     } else {
       deps.logger.debug(
         'Using built-in Federation v1 composition service (schemas=%s)',
-        args.schemas.length,
+        subgraphs.length,
       );
       compose = subgraphs => Promise.resolve(composeFederationV1(subgraphs));
     }

packages/services/schema/src/lib/compose.ts

@@ -32,24 +32,21 @@ const EXTERNAL_COMPOSITION_RESULT = z.union([
       supergraph: z.string(),
       sdl: z.string(),
     }),
-    includesNetworkError: z.boolean().optional().default(false),
+    includesNetworkError: z.boolean().default(false),
   }),
   z.object({
     type: z.literal('failure'),
     result: z.object({
-      supergraph: z.string().optional(),
-      sdl: z.string().optional(),
+      supergraph: z.string().nullish(),
+      sdl: z.string().nullish(),
       errors: z.array(
         z.object({
           message: z.string(),
-          source: z
-            .union([z.literal('composition'), z.literal('graphql')])
-            .optional()
-            .transform(value => value ?? 'graphql'),
+          source: z.union([z.literal('composition'), z.literal('graphql')]).default('graphql'),
         }),
       ),
     }),
-    includesNetworkError: z.boolean().optional().default(false),
+    includesNetworkError: z.boolean().default(false),
   }),
 ]);
 
@@ -198,8 +195,20 @@ export async function composeExternalFederation(args: {
 
   if (!parseResult.success) {
     args.logger.error('External composition failure: invalid shape of data: %o', parseResult.error);
-
-    throw new Error(`External composition failure: invalid shape of data`);
+    return {
+      type: 'failure',
+      result: {
+        supergraph: null,
+        sdl: null,
+        errors: [
+          {
+            message: 'External composition failure: invalid shape of data',
+            source: 'composition',
+          },
+        ],
+      },
+      includesNetworkError: false,
+    };
   }
 
   if (parseResult.data.type === 'success') {
@@ -314,6 +323,10 @@ async function callExternalService(
       },
       timeout: {
         request: timeoutMs,
+        // connecting should be quick
+        lookup: 10_000,
+        connect: 10_000,
+        secureConnect: 10_000,
       },
     });
 
@@ -329,7 +342,7 @@ async function callExternalService(
         span.setAttribute('error.type', error.name);
 
         logger.error(
-          'Network error without response. (errorName=%s, errorMessage=%s)',
+          'Network error during external composition without response. (errorName=%s, errorMessage=%s)',
           error.name,
           error.message,
         );
@@ -341,7 +354,7 @@ async function callExternalService(
             supergraph: null,
             errors: [
               {
-                message: `External composition network failure. Is the service reachable?`,
+                message: `A network error occurred during external composition: "${error.message}"`,
                 source: 'graphql',
               },
             ],