fix: support variables nested in query when making private queries

CHANGELOG.md

@@ -8,6 +8,12 @@ and this project adheres to
 
 ## [Unreleased]
 
+## [v1.3.1] - 2024-02-08
+
+### Fixed
+
+- fix: support variables nested in query when making private queries
+
 ## [v1.3.0] - 2024-02-02
 
 ### Added

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wayfair/gqmock",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "GQMock - GraphQL Mocking Service",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/ApolloServerManager.ts

@@ -71,7 +71,7 @@
     });
   }
 
   private createCustomMocks(fakerConfig: Record<string, any>) {
     const mocks = {};
 
     Object.entries(fakerConfig).forEach(([key, value]) => {
@@ -86,9 +86,9 @@
     key,
     value,
   }: {
     mocks: Record<string, any>;
     key: string;
     value: Record<string, any>;
   }) {
     if (
       // detect a faker method definition:
@@ -129,7 +129,7 @@
 
   private getFakerMethod(
     fakerKeys: string[]
   ): (...args: any[]) => any | null | undefined {
     let fakerMethod = faker;
 
     while (fakerKeys.length) {
@@ -197,11 +197,13 @@
 
   async getNewMock({
     query,
+    variables,
     typeName,
     operationName,
     rollingKey,
   }: {
     query: string;
+    variables: Record<string, unknown>;
     typeName: string;
     operationName: string;
     rollingKey: string;
@@ -213,9 +215,10 @@
       rollingKey,
       apolloServerManager: this,
     });
+
     const queryResult = await this.executeOperation({
       query: newQuery,
-      variables: {},
+      variables,
       operationName: this.getFieldName('privateQuery'),
     });
 

src/seed/SeedManager.ts

@@ -238,6 +238,7 @@ export default class SeedManager {
             {
               apolloServerManager,
               query,
+              variables,
               operationName,
             }
           );

src/utilities/__tests__/buildPrivateTypeQuery.ts

@@ -174,17 +174,20 @@ describe('buildPrivateTypeQuery', function () {
 
   it('should build a query for the correct nested inline fragment', () => {
     const rollingKey = 'data.item.subItem1';
-    const query = `query itemQuery {
-        item {
+    const query = `query itemQuery($first: Int!, $second: String!) {
+        item(first: $first) {
             __typename
             id
             ... on ItemOne {
                 someField1
                 subItem1 {
                     __typename
                     id
+                    fieldWithVariable(first: $first)
                     ... on SubItemOne {
                         field1
+                        anotherWithSameVariable(first: $first)
+                        anotherWithDifferentVariable(second: $second)
                     }
                     ... on SubItemTwo {
                         field2
@@ -209,11 +212,14 @@ describe('buildPrivateTypeQuery', function () {
         }
     }`;
 
-    const expectedQuery = `query gqmock_privateQuery {
+    const expectedQuery = `query gqmock_privateQuery($first: Int!, $second: String!) {
   gqmock_SubItemOne {
     __typename
     id
+    fieldWithVariable(first: $first)
     field1
+    anotherWithSameVariable(first: $first)
+    anotherWithDifferentVariable(second: $second)
   }
   __typename
 }`;

src/utilities/buildPrivateTypeQuery.ts

@@ -6,8 +6,10 @@ import {
   InlineFragmentNode,
   Kind,
   OperationDefinitionNode,
+  VariableDefinitionNode,
   parse,
   print,
+  visit,
 } from 'graphql';
 import ApolloServerManager from '../ApolloServerManager';
 
@@ -57,6 +59,7 @@ export default function ({
     apolloServerManager.schema as GraphQLSchema,
     typeName
   );
+
   const queryAst = parse(query);
   let node: ASTNode = queryAst.definitions.find((definition) => {
     return (
@@ -207,10 +210,38 @@ export default function ({
             },
           ],
         },
+        variableDefinitions: [] as VariableDefinitionNode[],
       },
     ],
   };
 
+  const allVariableDefinitions: VariableDefinitionNode[] = [];
+  visit(queryAst, {
+    VariableDefinition(node) {
+      allVariableDefinitions.push(node);
+    },
+  });
+
+  const variableDefinitions: VariableDefinitionNode[] = [];
+  // @ts-ignore meh
+  visit(newQueryAst, {
+    Variable(node) {
+      const matchingVariable = allVariableDefinitions.find(
+        (definition) => definition.variable.name.value === node.name.value
+      );
+      if (matchingVariable) {
+        const addedToDefinitions = variableDefinitions.find(
+          (definition) => definition.variable.name.value === node.name.value
+        );
+        if (!addedToDefinitions) {
+          variableDefinitions.push(matchingVariable);
+        }
+      }
+    },
+  });
+
+  newQueryAst.definitions[0].variableDefinitions = variableDefinitions;
+
   return apolloServerManager.addTypenameFieldsToQuery(
     print(newQueryAst as ASTNode)
   );

src/utilities/deepMerge.ts

@@ -48,13 +48,15 @@
  * @param {string} graphqlContext.operationName - GraphQL operation name
  * @param {ApolloServerManager} graphqlContext.apolloServerManager - ApolloServerManager instance
  * @param {object} options - Merge options
+ * @param graphqlContext.variables
  * @returns {object} A merged object and a list of warnings
  */
 async function deepMerge(
   source: Record<string, unknown>,
   seed: Record<string, unknown>,
   graphqlContext: {
     query: string;
+    variables: Record<string, unknown>;
     operationName: string;
     apolloServerManager: ApolloServerManager;
   },
@@ -63,7 +65,7 @@
   data: Record<string, unknown>;
   warnings: string[];
 }> {
-  const {query, operationName, apolloServerManager} = graphqlContext;
+  const {query, operationName, apolloServerManager, variables} = graphqlContext;
   const warnings = new Set<string>();
   /**
    * Returns the result of merging target into source
@@ -87,6 +89,7 @@
     ) {
       source = await apolloServerManager.getNewMock({
         query,
+        variables,
         typeName: target.__typename,
         operationName,
         rollingKey,
@@ -107,6 +110,7 @@
             // this should happen regardless of overrides
             const newSourceItemData = await apolloServerManager.getNewMock({
               query,
+              variables,
               typeName: sourceItem.__typename,
               operationName,
               rollingKey: newRollingKey,
@@ -145,6 +149,7 @@
                 // this should happen regardless of overrides
                 const newSourceItemData = await apolloServerManager.getNewMock({
                   query,
+                  variables,
                   typeName: sourceItem.__typename,
                   operationName,
                   rollingKey: newRollingKey,