Make schema generation consistent (#6951)

* Make schema generation consistent * Add tests for schema generation consistency * Add changeset * Update packages/legacy/runtime/test/getMesh.test.ts Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com> * Update snapshot --------- Co-authored-by: Arda TANRIKULU <ardatanrikulu@gmail.com>
ardatan · May 8, 2024 · d9b5137 · d9b5137
1 parent 234d2f9
commit d9b5137
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 4 deletions.
diff --git a/.changeset/few-teachers-do.md b/.changeset/few-teachers-do.md
@@ -0,0 +1,5 @@
+---
+"@graphql-mesh/runtime": patch
+---
+
+Make schema generation consistent
diff --git a/examples/json-schema-covid/tests/__snapshots__/json-schema-covid.test.ts.snap b/examples/json-schema-covid/tests/__snapshots__/json-schema-covid.test.ts.snap
@@ -137,7 +137,6 @@ scalar JSON
 
 scalar ObjMap
 
-""""""
 type Query {
   """"""
   case(countryRegion: String): Case

diff --git a/packages/legacy/runtime/src/get-mesh.ts b/packages/legacy/runtime/src/get-mesh.ts
@@ -168,7 +168,7 @@ export async function getMesh(options: GetMeshOptions): Promise<MeshInstance> {
   ];
   const wrappedFetchFn: MeshFetch = wrapFetchWithPlugins(initialPluginList);
   await Promise.allSettled(
-    sources.map(async apiSource => {
+    sources.map(async (apiSource, index) => {
       const apiName = apiSource.name;
       const sourceLogger = logger.child(apiName);
       sourceLogger.debug(`Generating the schema`);
@@ -199,7 +199,7 @@ export async function getMesh(options: GetMeshOptions): Promise<MeshInstance> {
         }
 
         const rootTypeMap = getRootTypeMap(apiSchema);
-        rawSources.push({
+        rawSources[index] = {
           name: apiName,
           schema: apiSchema,
           executor: source.executor,
@@ -209,7 +209,7 @@ export async function getMesh(options: GetMeshOptions): Promise<MeshInstance> {
           batch: 'batch' in source ? source.batch : true,
           merge: source.merge,
           createProxyingResolver: createProxyingResolverFactory(apiName, rootTypeMap),
-        });
+        };
       } catch (e: any) {
         sourceLogger.error(
           `Failed to generate the schema for the source "${apiName}"\n ${e.message}`,

diff --git a/packages/legacy/runtime/test/getMesh.test.ts b/packages/legacy/runtime/test/getMesh.test.ts
@@ -39,6 +39,7 @@ describe('getMesh', () => {
     suffixRootTypeNames: boolean;
     suffixFieldNames: boolean;
     suffixResponses: boolean;
+    delayImport?: boolean;
   }
 
   function createGraphQLSchema(config: CreateSchemaConfiguration) {
@@ -96,6 +97,9 @@ describe('getMesh', () => {
         store,
         logger,
         async importFn(moduleId) {
+          if (config.delayImport) {
+            await new Promise(r => setTimeout(r, 1));
+          }
           if (moduleId.endsWith(`schema${config.suffix}.ts`)) {
             return createGraphQLSchema(config);
           }
@@ -323,4 +327,69 @@ describe('getMesh', () => {
     expect(serializedOriginalError?.message).toContain('This is an error');
     expect(serializedOriginalError?.stack).toContain('at Object.throwMe (');
   });
+
+  it('generated consistent schema', async () => {
+    const sources = [
+      createGraphQLSource({
+        suffix: 'Large',
+        suffixRootTypeNames: true,
+        suffixFieldNames: true,
+        suffixResponses: true,
+        delayImport: true,
+      }),
+      ...new Array(2).fill(0).map((_, i) =>
+        createGraphQLSource({
+          suffix: i.toString(),
+          suffixRootTypeNames: true,
+          suffixFieldNames: true,
+          suffixResponses: true,
+        }),
+      ),
+    ];
+    const mesh1 = await getMesh({
+      cache,
+      pubsub,
+      logger,
+      sources,
+      merger,
+    });
+
+    const mesh2 = await getMesh({
+      cache,
+      pubsub,
+      logger,
+      sources,
+      merger,
+    });
+
+    expect(printSchemaWithDirectives(mesh1.schema)).toEqual(
+      printSchemaWithDirectives(mesh2.schema),
+    );
+
+    expect(printSchemaWithDirectives(mesh1.schema)).toMatchInlineSnapshot(`
+      "schema {
+        query: Query
+        mutation: Mutation
+        subscription: Subscription
+      }
+
+      type Query {
+        helloLarge: String
+        hello0: String
+        hello1: String
+      }
+
+      type Mutation {
+        byeLarge: String
+        bye0: String
+        bye1: String
+      }
+
+      type Subscription {
+        waveLarge: String
+        wave0: String
+        wave1: String
+      }"
+    `);
+  });
 });