Add support for fragment arguments

JoviDeCroock · kitten · commit bb7c5233149f · 2024-04-02T12:21:16.000+01:00
diff --git a/src/__tests__/__snapshots__/parser.test.ts.snap b/src/__tests__/__snapshots__/parser.test.ts.snap
@@ -185,6 +185,7 @@ exports[`parse > parses the kitchen sink document like graphql.js does 1`] = `
                                     "selectionSet": undefined,
                                   },
                                   {
+                                    "arguments": undefined,
                                     "directives": [
                                       {
                                         "arguments": undefined,
@@ -669,6 +670,7 @@ exports[`parse > parses the kitchen sink document like graphql.js does 1`] = `
           "value": "Friend",
         },
       },
+      "variableDefinitions": undefined,
     },
     {
       "directives": undefined,
diff --git a/src/__tests__/parser.test.ts b/src/__tests__/parser.test.ts
@@ -134,6 +134,90 @@ describe('parse', () => {
     expect(() => parse('fragment Name on Type { field }')).not.toThrow();
   });
 
+  it('parses fragment variable definitions', () => {
+    expect(parse('fragment x($var: Int = 1) on Type { field }').definitions[0]).toEqual({
+      kind: Kind.FRAGMENT_DEFINITION,
+      directives: undefined,
+      name: {
+        kind: Kind.NAME,
+        value: 'x',
+      },
+      typeCondition: {
+        kind: Kind.NAMED_TYPE,
+        name: {
+          kind: Kind.NAME,
+          value: 'Type',
+        },
+      },
+      variableDefinitions: [
+        {
+          kind: Kind.VARIABLE_DEFINITION,
+          type: {
+            kind: Kind.NAMED_TYPE,
+            name: {
+              kind: Kind.NAME,
+              value: 'Int',
+            },
+          },
+          variable: {
+            kind: Kind.VARIABLE,
+            name: {
+              kind: Kind.NAME,
+              value: 'var',
+            },
+          },
+          defaultValue: {
+            kind: Kind.INT,
+            value: '1',
+          },
+          directives: undefined,
+        },
+      ],
+      selectionSet: {
+        kind: Kind.SELECTION_SET,
+        selections: [
+          {
+            alias: undefined,
+            kind: Kind.FIELD,
+            directives: undefined,
+            selectionSet: undefined,
+            arguments: undefined,
+            name: {
+              kind: Kind.NAME,
+              value: 'field',
+            },
+          },
+        ],
+      },
+    });
+  });
+
+  it('parses fragment spread arguments', () => {
+    expect(
+      parse('query x { ...x(var: 2) } fragment x($var: Int = 1) on Type { field }').definitions[0]
+    ).toHaveProperty('selectionSet.selections.0', {
+      kind: Kind.FRAGMENT_SPREAD,
+      directives: undefined,
+      name: {
+        kind: Kind.NAME,
+        value: 'x',
+      },
+      arguments: [
+        {
+          kind: 'Argument',
+          name: {
+            kind: 'Name',
+            value: 'var',
+          },
+          value: {
+            kind: 'IntValue',
+            value: '2',
+          },
+        },
+      ],
+    });
+  });
+
   it('parses fields', () => {
     expect(() => parse('{ field: }')).toThrow();
     expect(() => parse('{ alias: field() }')).toThrow();
diff --git a/src/__tests__/printer.test.ts b/src/__tests__/printer.test.ts
@@ -4,6 +4,7 @@ import * as graphql16 from 'graphql16';
 import { parse } from '../parser';
 import { print, printString, printBlockString } from '../printer';
 import kitchenSinkAST from './fixtures/kitchen_sink.json';
+import { Kind } from 'src/kind';
 
 function dedentString(string: string) {
   const trimmedStr = string
@@ -115,6 +116,94 @@ describe('print', () => {
     ).toBe('[Type!]');
   });
 
+  it('prints fragment-definition with variables', () => {
+    expect(
+      print({
+        kind: Kind.FRAGMENT_DEFINITION,
+        directives: [],
+        name: {
+          kind: Kind.NAME,
+          value: 'x',
+        },
+        typeCondition: {
+          kind: Kind.NAMED_TYPE,
+          name: {
+            kind: Kind.NAME,
+            value: 'Type',
+          },
+        },
+        variableDefinitions: [
+          {
+            kind: Kind.VARIABLE_DEFINITION,
+            type: {
+              kind: Kind.NAMED_TYPE,
+              name: {
+                kind: Kind.NAME,
+                value: 'Int',
+              },
+            },
+            variable: {
+              kind: Kind.VARIABLE,
+              name: {
+                kind: Kind.NAME,
+                value: 'var',
+              },
+            },
+            defaultValue: {
+              kind: Kind.INT,
+              value: '1',
+            },
+            directives: [],
+          },
+        ],
+        selectionSet: {
+          kind: Kind.SELECTION_SET,
+          selections: [
+            {
+              alias: undefined,
+              kind: Kind.FIELD,
+              directives: [],
+              selectionSet: undefined,
+              arguments: [],
+              name: {
+                kind: Kind.NAME,
+                value: 'field',
+              },
+            },
+          ],
+        },
+      } as any)
+    ).toBe(`fragment x($var: Int = 1) on Type {
+  field
+}`);
+  });
+
+  it('prints fragment-spread with arguments', () => {
+    expect(
+      print({
+        kind: Kind.FRAGMENT_SPREAD,
+        directives: [],
+        name: {
+          kind: Kind.NAME,
+          value: 'x',
+        },
+        arguments: [
+          {
+            kind: 'Argument',
+            name: {
+              kind: 'Name',
+              value: 'var',
+            },
+            value: {
+              kind: 'IntValue',
+              value: '2',
+            },
+          },
+        ],
+      } as any)
+    ).toBe(`...x(var: 2)`);
+  });
+
   // NOTE: The shim won't throw for invalid AST nodes
   it('returns empty strings for invalid AST', () => {
     const badAST = { random: 'Data' };
diff --git a/src/ast.ts b/src/ast.ts
@@ -188,6 +188,7 @@ export type FragmentSpreadNode = Or<
   {
     readonly kind: Kind.FRAGMENT_SPREAD;
     readonly name: NameNode;
+    readonly arguments?: ReadonlyArray<ArgumentNode>;
     readonly directives?: ReadonlyArray<DirectiveNode>;
     readonly loc?: Location;
   }
@@ -209,6 +210,7 @@ export type FragmentDefinitionNode = Or<
   {
     readonly kind: Kind.FRAGMENT_DEFINITION;
     readonly name: NameNode;
+    readonly variableDefinitions?: ReadonlyArray<VariableDefinitionNode>;
     readonly typeCondition: NamedTypeNode;
     readonly directives?: ReadonlyArray<DirectiveNode>;
     readonly selectionSet: SelectionSetNode;
diff --git a/src/parser.ts b/src/parser.ts
@@ -328,6 +328,7 @@ function selectionSet(): ast.SelectionSetNode {
           selections.push({
             kind: 'FragmentSpread' as Kind.FRAGMENT_SPREAD,
             name: { kind: 'Name' as Kind.NAME, value: match },
+            arguments: arguments_(false),
             directives: directives(false),
           });
         } else {
@@ -434,7 +435,7 @@ function fragmentDefinition(): ast.FragmentDefinitionNode {
   let _name: string | undefined;
   let _condition: string | undefined;
   if ((_name = advance(nameRe)) == null) throw error('FragmentDefinition');
-  ignored();
+  const _variableDefinitions = variableDefinitions();
   if (advance(nameRe) !== 'on') throw error('FragmentDefinition');
   ignored();
   if ((_condition = advance(nameRe)) == null) throw error('FragmentDefinition');
@@ -449,6 +450,7 @@ function fragmentDefinition(): ast.FragmentDefinitionNode {
       kind: 'NamedType' as Kind.NAMED_TYPE,
       name: { kind: 'Name' as Kind.NAME, value: _condition },
     },
+    variableDefinitions: _variableDefinitions,
     directives: _directives,
     selectionSet: selectionSet(),
   };
diff --git a/src/printer.ts b/src/printer.ts
@@ -47,6 +47,19 @@ const MAX_LINE_LENGTH = 80;
 
 let LF = '\n';
 
+function Arguments(length: number, node: readonly ArgumentNode[]): string {
+  const args = mapJoin(node, ', ', nodes.Argument);
+  if (length + args.length + 2 > MAX_LINE_LENGTH) {
+    return '(' +
+      (LF += '  ') +
+      mapJoin(node, LF, nodes.Argument) +
+      (LF = LF.slice(0, -2)) +
+      ')';
+  } else {
+    return '(' + args + ')';
+  }
+}
+
 const nodes = {
   OperationDefinition(node: OperationDefinitionNode): string {
     let out: string = node.operation;
@@ -70,19 +83,8 @@ const nodes = {
   },
   Field(node: FieldNode): string {
     let out = node.alias ? node.alias.value + ': ' + node.name.value : node.name.value;
-    if (node.arguments && node.arguments.length) {
-      const args = mapJoin(node.arguments, ', ', nodes.Argument);
-      if (out.length + args.length + 2 > MAX_LINE_LENGTH) {
-        out +=
-          '(' +
-          (LF += '  ') +
-          mapJoin(node.arguments, LF, nodes.Argument) +
-          (LF = LF.slice(0, -2)) +
-          ')';
-      } else {
-        out += '(' + args + ')';
-      }
-    }
+    if (node.arguments && node.arguments.length)
+      out += Arguments(out.length, node.arguments);
     if (node.directives && node.directives.length)
       out += ' ' + mapJoin(node.directives, ' ', nodes.Directive);
     if (node.selectionSet) out += ' ' + nodes.SelectionSet(node.selectionSet);
@@ -137,6 +139,8 @@ const nodes = {
   },
   FragmentSpread(node: FragmentSpreadNode): string {
     let out = '...' + node.name.value;
+    if (node.arguments && node.arguments.length)
+      out += Arguments(out.length, node.arguments);
     if (node.directives && node.directives.length)
       out += ' ' + mapJoin(node.directives, ' ', nodes.Directive);
     return out;
@@ -151,6 +155,8 @@ const nodes = {
   },
   FragmentDefinition(node: FragmentDefinitionNode): string {
     let out = 'fragment ' + node.name.value;
+    if (node.variableDefinitions && node.variableDefinitions.length)
+      out += '(' + mapJoin(node.variableDefinitions, ', ', nodes.VariableDefinition) + ')';
     out += ' on ' + node.typeCondition.name.value;
     if (node.directives && node.directives.length)
       out += ' ' + mapJoin(node.directives, ' ', nodes.Directive);

Original file line number	Diff line number	Diff line change
@@ -185,6 +185,7 @@ exports[`parse > parses the kitchen sink document like graphql.js does 1`] = `
`185`	`185`	`"selectionSet": undefined,`
`186`	`186`	`},`
`187`	`187`	`{`
	`188`	`+ "arguments": undefined,`
`188`	`189`	`"directives": [`
`189`	`190`	`{`
`190`	`191`	`"arguments": undefined,`
@@ -669,6 +670,7 @@ exports[`parse > parses the kitchen sink document like graphql.js does 1`] = `
`669`	`670`	`"value": "Friend",`
`670`	`671`	`},`
`671`	`672`	`},`
	`673`	`+ "variableDefinitions": undefined,`
`672`	`674`	`},`
`673`	`675`	`{`
`674`	`676`	`"directives": undefined,`
Original file line number	Diff line number	Diff line change
`@@ -188,6 +188,7 @@ export type FragmentSpreadNode = Or<`
`188`	`188`	`{`
`189`	`189`	`readonly kind: Kind.FRAGMENT_SPREAD;`
`190`	`190`	`readonly name: NameNode;`
	`191`	`+ readonly arguments?: ReadonlyArray<ArgumentNode>;`
`191`	`192`	`readonly directives?: ReadonlyArray<DirectiveNode>;`
`192`	`193`	`readonly loc?: Location;`
`193`	`194`	`}`
`@@ -209,6 +210,7 @@ export type FragmentDefinitionNode = Or<`
`209`	`210`	`{`
`210`	`211`	`readonly kind: Kind.FRAGMENT_DEFINITION;`
`211`	`212`	`readonly name: NameNode;`
	`213`	`+ readonly variableDefinitions?: ReadonlyArray<VariableDefinitionNode>;`
`212`	`214`	`readonly typeCondition: NamedTypeNode;`
`213`	`215`	`readonly directives?: ReadonlyArray<DirectiveNode>;`
`214`	`216`	`readonly selectionSet: SelectionSetNode;`