refactor(api): remove abstraction of schema service caller (#6781)

Author: n1ru4l

packages/services/api/src/create.ts

@@ -42,7 +42,7 @@ import { provideSchemaModuleConfig, SchemaModuleConfig } from './modules/schema/
 import {
   SCHEMA_SERVICE_CONFIG,
   SchemaServiceConfig,
-} from './modules/schema/providers/orchestrators/tokens';
+} from './modules/schema/providers/orchestrator/tokens';
 import { sharedModule } from './modules/shared';
 import { CryptoProvider, encryptionSecretProvider } from './modules/shared/providers/crypto';
 import { DistributedCache } from './modules/shared/providers/distributed-cache';

packages/services/api/src/modules/schema/index.ts

@@ -4,7 +4,7 @@ import { Contracts } from './providers/contracts';
 import { ContractsManager } from './providers/contracts-manager';
 import { Inspector } from './providers/inspector';
 import { models } from './providers/models';
-import { orchestrators } from './providers/orchestrators';
+import { CompositionOrchestrator } from './providers/orchestrator/composition-orchestrator';
 import { RegistryChecks } from './providers/registry-checks';
 import { SchemaCheckManager } from './providers/schema-check-manager';
 import { SchemaHelper } from './providers/schema-helper';
@@ -30,7 +30,7 @@ export const schemaModule = createModule({
     ContractsManager,
     SchemaCheckManager,
     BreakingSchemaChangeUsageHelper,
-    ...orchestrators,
+    CompositionOrchestrator,
     ...models,
   ],
 });

packages/services/api/src/modules/schema/providers/models/composite.ts

@@ -1,8 +1,6 @@
 import { Injectable, Scope } from 'graphql-modules';
 import { traceFn } from '@hive/service-common';
 import { SchemaChangeType } from '@hive/storage';
-import { FederationOrchestrator } from '../orchestrators/federation';
-import { StitchingOrchestrator } from '../orchestrators/stitching';
 import { RegistryChecks, type ConditionalBreakingChangeDiffConfig } from '../registry-checks';
 import { swapServices } from '../schema-helper';
 import { shouldUseLatestComposableVersion } from '../schema-manager';
@@ -39,8 +37,6 @@ import {
 })
 export class CompositeModel {
   constructor(
-    private federationOrchestrator: FederationOrchestrator,
-    private stitchingOrchestrator: StitchingOrchestrator,
     private checks: RegistryChecks,
     private logger: Logger,
   ) {}
@@ -189,14 +185,7 @@ export class CompositeModel {
       };
     }
 
-    const orchestrator =
-      project.type === ProjectType.FEDERATION
-        ? this.federationOrchestrator
-        : this.stitchingOrchestrator;
-    this.logger.debug('Using orchestrator of type %s', orchestrator.type);
-
     const compositionCheck = await this.checks.composition({
-      orchestrator,
       targetId: selector.targetId,
       project,
       organization,
@@ -215,7 +204,6 @@ export class CompositeModel {
     });
 
     const previousVersionSdl = await this.checks.retrievePreviousVersionSdl({
-      orchestrator,
       version: comparedVersion,
       organization,
       project,
@@ -432,13 +420,7 @@ export class CompositeModel {
       };
     }
 
-    const orchestrator =
-      project.type === ProjectType.FEDERATION
-        ? this.federationOrchestrator
-        : this.stitchingOrchestrator;
-
     const compositionCheck = await this.checks.composition({
-      orchestrator,
       targetId: target.id,
       project,
       organization,
@@ -488,7 +470,6 @@ export class CompositeModel {
     }
 
     const previousVersionSdl = await this.checks.retrievePreviousVersionSdl({
-      orchestrator,
       version: schemaVersionToCompareAgainst,
       organization,
       project,
@@ -632,15 +613,10 @@ export class CompositeModel {
       };
     }
 
-    const orchestrator =
-      project.type === ProjectType.FEDERATION
-        ? this.federationOrchestrator
-        : this.stitchingOrchestrator;
     const schemas = latestVersion.schemas.filter(s => s.service_name !== input.serviceName);
     schemas.sort((a, b) => a.service_name.localeCompare(b.service_name));
 
     const compositionCheck = await this.checks.composition({
-      orchestrator,
       targetId: selector.target,
       project,
       organization,
@@ -659,7 +635,6 @@ export class CompositeModel {
     });
 
     const previousVersionSdl = await this.checks.retrievePreviousVersionSdl({
-      orchestrator,
       version: compareToLatestComposable ? latestComposable : latest,
       organization,
       project,

packages/services/api/src/modules/schema/providers/models/single.ts

@@ -1,7 +1,6 @@
 import { Injectable, Scope } from 'graphql-modules';
 import { traceFn } from '@hive/service-common';
 import { SchemaChangeType } from '@hive/storage';
-import { SingleOrchestrator } from '../orchestrators/single';
 import { ConditionalBreakingChangeDiffConfig, RegistryChecks } from '../registry-checks';
 import type { PublishInput } from '../schema-publisher';
 import type { Organization, Project, SingleSchema, Target } from './../../../../shared/entities';
@@ -22,7 +21,6 @@ import {
 })
 export class SingleModel {
   constructor(
-    private orchestrator: SingleOrchestrator,
     private checks: RegistryChecks,
     private logger: Logger,
   ) {}
@@ -108,7 +106,6 @@ export class SingleModel {
     }
 
     const compositionCheck = await this.checks.composition({
-      orchestrator: this.orchestrator,
       targetId: selector.targetId,
       project,
       organization,
@@ -118,7 +115,6 @@ export class SingleModel {
     });
 
     const previousVersionSdl = await this.checks.retrievePreviousVersionSdl({
-      orchestrator: this.orchestrator,
       version: comparedVersion,
       organization,
       project,
@@ -239,7 +235,6 @@ export class SingleModel {
     }
 
     const compositionCheck = await this.checks.composition({
-      orchestrator: this.orchestrator,
       targetId: target.id,
       project,
       organization,
@@ -256,7 +251,6 @@ export class SingleModel {
     });
 
     const previousVersionSdl = await this.checks.retrievePreviousVersionSdl({
-      orchestrator: this.orchestrator,
       version: comparedVersion,
       organization,
       project,

packages/services/api/src/modules/schema/providers/orchestrators/federation.ts renamed to packages/services/api/src/modules/schema/providers/orchestrator/composition-orchestrator.ts

@@ -5,7 +5,6 @@ import { traceFn } from '@hive/service-common';
 import { createTRPCProxyClient, httpLink } from '@trpc/client';
 import {
   ComposeAndValidateResult,
-  Orchestrator,
   Project,
   ProjectType,
   SchemaObject,
@@ -22,12 +21,27 @@ type ExternalCompositionConfig = {
 @Injectable({
   scope: Scope.Operation,
 })
-export class FederationOrchestrator implements Orchestrator {
-  type = ProjectType.FEDERATION;
+/**
+ * Orchestrate composition calls to the schema service.
+ */
+export class CompositionOrchestrator {
   private logger: Logger;
   private schemaService;
   private incomingRequestAbortSignal: AbortSignal;
 
+  static projectTypeToOrchestratorType(
+    projectType: ProjectType,
+  ): 'federation' | 'stitching' | 'single' {
+    switch (projectType) {
+      case ProjectType.FEDERATION:
+        return 'federation';
+      case ProjectType.STITCHING:
+        return 'stitching';
+      case ProjectType.SINGLE:
+        return 'single';
+    }
+  }
+
   constructor(
     logger: Logger,
     @Inject(SCHEMA_SERVICE_CONFIG) serviceConfig: SchemaServiceConfig,
@@ -67,8 +81,9 @@ export class FederationOrchestrator implements Orchestrator {
     return null;
   }
 
-  @traceFn('FederationOrchestrator.composeAndValidate', {
-    initAttributes: (schemas, config) => ({
+  @traceFn('CompositionOrchestrator.composeAndValidate', {
+    initAttributes: (ttype, schemas, config) => ({
+      'hive.composition.type': ttype,
       'hive.composition.schema.count': schemas.length,
       'hive.composition.external': config.external.enabled,
       'hive.composition.native': config.native,
@@ -79,18 +94,35 @@ export class FederationOrchestrator implements Orchestrator {
       'hive.composition.contracts.count': result.contracts?.length ?? 0,
     }),
   })
+  /**
+   * Compose and validate schemas via the schema service.
+   * - Requests time out after 30 seconds and result in a human readable error response
+   * - In case the incoming request is canceled, the call to the schema service is aborted
+   */
   async composeAndValidate(
+    compositionType: 'federation' | 'single' | 'stitching',
     schemas: SchemaObject[],
     config: {
+      /** Whether external composition should be used (only Federation) */
       external: Project['externalComposition'];
+      /** Whether native composition should be used (only Federation) */
       native: boolean;
+      /** Specified contracts (only Federation) */
       contracts: ContractsInputType | null;
     },
   ) {
     this.logger.debug(
-      'Composing and Validating Federated Schemas (method=%s)',
-      config.native ? 'native' : config.external.enabled ? 'external' : 'v1',
+      'Composing and validating schemas (type=%s, method=%s)',
+      compositionType,
+      compositionType === 'federation'
+        ? config.native
+          ? 'native'
+          : config.external.enabled
+            ? 'external'
+            : 'v1'
+        : 'none',
     );
+
     const timeoutAbortSignal = AbortSignal.timeout(30_000);
 
     const onTimeout = () => {
@@ -106,7 +138,7 @@ export class FederationOrchestrator implements Orchestrator {
     try {
       const result = await this.schemaService.composeAndValidate.mutate(
         {
-          type: 'federation',
+          type: compositionType,
           schemas: schemas.map(s => ({
             raw: s.raw,
             source: s.source,