Merge pull request #34 from wayfair-incubator/mfaga-support-unions-wh…

…en-building-private-queries
wayfair-incubator · Dec 21, 2023 · d5e9d23 · d5e9d23
2 parents 9ae05a8 + a09a02d
commit d5e9d23
Show file tree

Hide file tree

Showing 6 changed files with 120 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,12 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [v1.2.1] - 2023-12-15
+
+### Fixed
+
+- feat: support unions when building private queries
+
 ## [v1.2.0] - 2023-11-01
 
 ### Added

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@wayfair/gqmock",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "GQMock - GraphQL Mocking Service",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/src/ApolloServerManager.ts b/src/ApolloServerManager.ts
@@ -319,4 +319,27 @@ export default class ApolloServerManager {
 
     return [];
   }
+
+  getUnionImplementations(schema: GraphQLSchema, typeName: string): string[] {
+    const schemaAst = parse(printSchema(schema));
+    const unionTypeDefinitions = schemaAst.definitions.filter((definition) => {
+      return definition.kind === Kind.UNION_TYPE_DEFINITION;
+    });
+
+    if (unionTypeDefinitions && unionTypeDefinitions.length > 0) {
+      return (
+        unionTypeDefinitions
+          .filter((unionTypeDefinition) =>
+            // @ts-expect-error We know this is a union type definition
+            unionTypeDefinition?.types?.find(
+              (typeDefinition) => typeDefinition.name.value === typeName
+            )
+          )
+          // @ts-expect-error We know this is a union type definition
+          .map((unionTypeDefinition) => unionTypeDefinition.name.value) || []
+      );
+    }
+
+    return [];
+  }
 }
diff --git a/src/__fixtures__/schema.graphql b/src/__fixtures__/schema.graphql
@@ -55,6 +55,8 @@ type SubItemThree implements SubItem {
   field3: String
 }
 
+union RandomThing = ItemOne | ItemTwo | ItemThree
+
 interface Item {
   id: String
   type: String
@@ -101,6 +103,7 @@ type Query {
   productByName(name: String!): Product
   productBySku(sku: String!): Product
   item: Item
+  random: RandomThing
   items(type: String): [Item]
 }
 

diff --git a/src/utilities/__tests__/buildPrivateTypeQuery.ts b/src/utilities/__tests__/buildPrivateTypeQuery.ts
@@ -9,11 +9,13 @@ const schema = fs.readFileSync(
 
 describe('buildPrivateTypeQuery', function () {
   let apolloServerManager;
+
   beforeAll(() => {
     apolloServerManager = new ApolloServerManager();
     apolloServerManager.createApolloServer(schema, {});
   });
-  it('should build a query for the correct inline fragment', () => {
+
+  it('should build a query for the correct interface inline fragment', () => {
     const rollingKey = 'data.item';
     const query = `query itemQuery {
         item {
@@ -93,6 +95,80 @@ describe('buildPrivateTypeQuery', function () {
     ).toBe(expectedQuery);
   });
 
+  it('should build a query for the correct union inline fragment', () => {
+    const rollingKey = 'data.random';
+    const query = `query randomQuery {
+        random {
+            __typename
+            id
+            ... on ItemOne {
+                someField1
+                subItem1 {
+                    __typename
+                    id
+                    ... on SubItemOne {
+                        field1
+                    }
+                    ... on SubItemTwo {
+                        field2
+                    }
+                    ... on SubItemThree {
+                        field3
+                    }
+                }
+                products {
+                  name
+                }
+            }
+            ... on ItemTwo {
+                someField2
+            }
+            ... on ItemThree {
+                someField3
+            }
+        }
+    }`;
+
+    const expectedQuery = `query gqmock_privateQuery {
+  gqmock_ItemOne {
+    __typename
+    id
+    someField1
+    subItem1 {
+      __typename
+      id
+      ... on SubItemOne {
+        field1
+        __typename
+      }
+      ... on SubItemTwo {
+        field2
+        __typename
+      }
+      ... on SubItemThree {
+        field3
+        __typename
+      }
+    }
+    products {
+      name
+      __typename
+    }
+  }
+  __typename
+}`;
+
+    expect(
+      buildPrivateTypeQuery({
+        query,
+        typeName: 'ItemOne',
+        operationName: 'randomQuery',
+        rollingKey,
+        apolloServerManager,
+      })
+    ).toBe(expectedQuery);
+  });
+
   it('should build a query for the correct nested inline fragment', () => {
     const rollingKey = 'data.item.subItem1';
     const query = `query itemQuery {
@@ -224,7 +300,7 @@ describe('buildPrivateTypeQuery', function () {
           someField5
         }
       }
-      
+
     query itemsQuery {
       officeItems: items(type: "office") {
         ...commonItemsFields

diff --git a/src/utilities/buildPrivateTypeQuery.ts b/src/utilities/buildPrivateTypeQuery.ts
@@ -52,6 +52,10 @@ export default function ({
       apolloServerManager.schema as GraphQLSchema,
       typeName
     );
+  const unionImplementations = apolloServerManager.getUnionImplementations(
+    apolloServerManager.schema as GraphQLSchema,
+    typeName
+  );
   const queryAst = parse(query);
   let node: ASTNode = queryAst.definitions.find((definition) => {
     return (
@@ -158,9 +162,12 @@ export default function ({
             );
           } else if (
             selection.typeCondition &&
-            interfaceImplementations.includes(
+            (unionImplementations.includes(
               selection.typeCondition.name.value
-            )
+            ) ||
+              interfaceImplementations.includes(
+                selection.typeCondition.name.value
+              ))
           ) {
             subQueryNodesToVisit.push(selection);
           }