Add fragment arguments to AST and related utility functions

Author: mjmahone

src/language/__tests__/parser-test.ts

@@ -591,11 +591,20 @@ describe('Parser', () => {
     expect('loc' in result).to.equal(false);
   });
 
-  it('Legacy: allows parsing fragment defined variables', () => {
+  it('allows parsing fragment defined variables', () => {
     const document = 'fragment a($v: Boolean = false) on t { f(v: $v) }';
 
     expect(() =>
-      parse(document, { allowLegacyFragmentVariables: true }),
+      parse(document, { allowFragmentArguments: true }),
+    ).to.not.throw();
+    expect(() => parse(document)).to.throw('Syntax Error');
+  });
+
+  it('allows parsing fragment spread arguments', () => {
+    const document = 'fragment a on t { ...b(v: $v) }';
+
+    expect(() =>
+      parse(document, { allowFragmentArguments: true }),
     ).to.not.throw();
     expect(() => parse(document)).to.throw('Syntax Error');
   });

src/language/__tests__/printer-test.ts

@@ -110,10 +110,10 @@ describe('Printer: Query document', () => {
     `);
   });
 
-  it('Legacy: prints fragment with variable directives', () => {
+  it('prints fragment with variable directives', () => {
     const queryASTWithVariableDirective = parse(
       'fragment Foo($foo: TestType @test) on TestType @testDirective { id }',
-      { allowLegacyFragmentVariables: true },
+      { allowFragmentArguments: true },
     );
     expect(print(queryASTWithVariableDirective)).to.equal(dedent`
       fragment Foo($foo: TestType @test) on TestType @testDirective {
@@ -122,14 +122,14 @@ describe('Printer: Query document', () => {
     `);
   });
 
-  it('Legacy: correctly prints fragment defined variables', () => {
+  it('correctly prints fragment defined variables', () => {
     const fragmentWithVariable = parse(
       `
         fragment Foo($a: ComplexType, $b: Boolean = false) on TestType {
           id
         }
       `,
-      { allowLegacyFragmentVariables: true },
+      { allowFragmentArguments: true },
     );
     expect(print(fragmentWithVariable)).to.equal(dedent`
       fragment Foo($a: ComplexType, $b: Boolean = false) on TestType {
@@ -138,6 +138,34 @@ describe('Printer: Query document', () => {
     `);
   });
 
+  it('prints fragment spread with arguments', () => {
+    const queryASTWithVariableDirective = parse(
+      'fragment Foo on TestType { ...Bar(a: {x: $x}, b: true) }',
+      { allowFragmentArguments: true },
+    );
+    expect(print(queryASTWithVariableDirective)).to.equal(dedent`
+      fragment Foo on TestType {
+        ...Bar(a: {x: $x}, b: true)
+      }
+    `);
+  });
+
+  it('prints fragment spread with multi-line arguments', () => {
+    const queryASTWithVariableDirective = parse(
+      'fragment Foo on TestType { ...Bar(a: {x: $x, y: $y, z: $z, xy: $xy}, b: true, c: "a long string extending arguments over max length") }',
+      { allowFragmentArguments: true },
+    );
+    expect(print(queryASTWithVariableDirective)).to.equal(dedent`
+      fragment Foo on TestType {
+        ...Bar(
+          a: {x: $x, y: $y, z: $z, xy: $xy}
+          b: true
+          c: "a long string extending arguments over max length"
+        )
+      }
+    `);
+  });
+
   it('prints kitchen sink without altering ast', () => {
     const ast = parse(kitchenSinkQuery, {
       noLocation: true,

src/language/__tests__/visitor-test.ts

@@ -455,10 +455,10 @@ describe('Visitor', () => {
     ]);
   });
 
-  it('Legacy: visits variables defined in fragments', () => {
+  it('visits variables defined in fragments', () => {
     const ast = parse('fragment a($v: Boolean = false) on t { f }', {
       noLocation: true,
-      allowLegacyFragmentVariables: true,
+      allowFragmentArguments: true,
     });
     const visited: Array<any> = [];
 

src/language/ast.ts

@@ -429,6 +429,7 @@ export interface FragmentSpreadNode {
   readonly loc?: Location | undefined;
   readonly name: NameNode;
   readonly directives?: ReadonlyArray<DirectiveNode> | undefined;
+  readonly arguments?: ReadonlyArray<ArgumentNode> | undefined;
 }
 
 export interface InlineFragmentNode {
@@ -443,7 +444,6 @@ export interface FragmentDefinitionNode {
   readonly kind: Kind.FRAGMENT_DEFINITION;
   readonly loc?: Location | undefined;
   readonly name: NameNode;
-  /** @deprecated variableDefinitions will be removed in v17.0.0 */
   readonly variableDefinitions?:
     | ReadonlyArray<VariableDefinitionNode>
     | undefined;

src/language/parser.ts

@@ -83,12 +83,14 @@ export interface ParseOptions {
   noLocation?: boolean | undefined;
 
   /**
-   * @deprecated will be removed in the v17.0.0
-   *
    * If enabled, the parser will understand and parse variable definitions
    * contained in a fragment definition. They'll be represented in the
    * `variableDefinitions` field of the FragmentDefinitionNode.
    *
+   * Additionally, the parser will understand arguments passed to fragment
+   * spreads. They'll be represented in the `arguments` field of the
+   * FragmentSpreadNode.
+   *
    * The syntax is identical to normal, query-defined variables. For example:
    *
    * ```graphql
@@ -539,7 +541,7 @@ export class Parser {
   /**
    * Corresponds to both FragmentSpread and InlineFragment in the spec.
    *
-   * FragmentSpread : ... FragmentName Directives?
+   * FragmentSpread : ... FragmentName Arguments? Directives?
    *
    * InlineFragment : ... TypeCondition? Directives? SelectionSet
    */
@@ -549,6 +551,14 @@ export class Parser {
 
     const hasTypeCondition = this.expectOptionalKeyword('on');
     if (!hasTypeCondition && this.peek(TokenKind.NAME)) {
+      if (this._options?.allowFragmentArguments === true) {
+        return this.node<FragmentSpreadNode>(start, {
+          kind: Kind.FRAGMENT_SPREAD,
+          name: this.parseFragmentName(),
+          arguments: this.parseArguments(false),
+          directives: this.parseDirectives(false),
+        });
+      }
       return this.node<FragmentSpreadNode>(start, {
         kind: Kind.FRAGMENT_SPREAD,
         name: this.parseFragmentName(),

src/language/printer.ts

@@ -105,8 +105,16 @@ const printDocASTReducer: ASTReducer<string> = {
   // Fragments
 
   FragmentSpread: {
-    leave: ({ name, directives }) =>
-      '...' + name + wrap(' ', join(directives, ' ')),
+    leave: ({ name, arguments: args, directives }) => {
+      const prefix = '...' + name;
+      let argsLine = prefix + wrap('(', join(args, ', '), ')');
+
+      if (argsLine.length > MAX_LINE_LENGTH) {
+        argsLine = prefix + wrap('(\n', indent(join(args, '\n')), '\n)');
+      }
+
+      return argsLine + wrap(' ', join(directives, ' '));
+    },
   },
 
   InlineFragment: {

src/utilities/buildASTSchema.ts

@@ -93,7 +93,7 @@ export function buildSchema(
 ): GraphQLSchema {
   const document = parse(source, {
     noLocation: options?.noLocation,
-    allowLegacyFragmentVariables: options?.allowLegacyFragmentVariables,
+    allowFragmentArguments: options?.allowFragmentArguments,
   });
 
   return buildASTSchema(document, {