Skip to content

Commit a160a44

Browse files
n1ru4ldotansimha
n1ru4l
authored and
dotansimha
committed
wip: implement parser extensions for transforming the fragment argument transform syntax into operations without fragment arguments, which are executable by all graphql.js versions
See graphql/graphql-js#3152 for reference
1 parent 9cf5eac commit a160a44

File tree

4 files changed

+346
-0
lines changed

4 files changed

+346
-0
lines changed

‎packages/plugins/fragment-arguments/package.json

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{
2+
"name": "@envelop/fragment-arguments",
3+
"version": "0.0.1",
4+
"author": "Dotan Simha <[email protected]>",
5+
"license": "MIT",
6+
"repository": {
7+
"type": "git",
8+
"url": "https://github.com/dotansimha/envelop.git",
9+
"directory": "packages/plugins/fragment-arguments"
10+
},
11+
"main": "dist/index.js",
12+
"module": "dist/index.mjs",
13+
"exports": {
14+
".": {
15+
"require": "./dist/index.js",
16+
"import": "./dist/index.mjs"
17+
},
18+
"./*": {
19+
"require": "./dist/*.js",
20+
"import": "./dist/*.mjs"
21+
}
22+
},
23+
"typings": "dist/index.d.ts",
24+
"typescript": {
25+
"definition": "dist/index.d.ts"
26+
},
27+
"scripts": {
28+
"test": "jest",
29+
"prepack": "bob prepack"
30+
},
31+
"dependencies": {
32+
"@envelop/types": "0.2.1"
33+
},
34+
"devDependencies": {
35+
"@types/common-tags": "1.8.0",
36+
"@graphql-tools/schema": "7.1.5",
37+
"bob-the-bundler": "1.2.1",
38+
"graphql": "15.5.0",
39+
"typescript": "4.3.2",
40+
"oneline": "1.0.3",
41+
"common-tags": "1.8.0"
42+
},
43+
"peerDependencies": {
44+
"graphql": "^14.0.0 || ^15.0.0"
45+
},
46+
"buildOptions": {
47+
"input": "./src/index.ts"
48+
},
49+
"publishConfig": {
50+
"directory": "dist",
51+
"access": "public"
52+
}
53+
}

‎packages/plugins/fragment-arguments/src/index.ts

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
import { Plugin } from '@envelop/types';
2+
import { Parser, ParseOptions } from 'graphql/language/parser';
3+
import { Lexer } from 'graphql/language/lexer';
4+
5+
import {
6+
TokenKind,
7+
Kind,
8+
Source,
9+
DocumentNode,
10+
visit,
11+
FragmentDefinitionNode,
12+
InlineFragmentNode,
13+
ArgumentNode,
14+
TokenKindEnum,
15+
Token,
16+
} from 'graphql';
17+
18+
declare module 'graphql/language/parser' {
19+
export class Parser {
20+
constructor(source: string | Source, options?: ParseOptions);
21+
_lexer: Lexer;
22+
expectOptionalKeyword(word: string): boolean;
23+
expectToken(token: TokenKindEnum): void;
24+
peek(token: TokenKindEnum): boolean;
25+
parseFragmentName(): string;
26+
parseArguments(flag: boolean): any;
27+
parseDirectives(flag: boolean): any;
28+
loc(start: Token): any;
29+
parseNamedType(): any;
30+
parseSelectionSet(): any;
31+
expectKeyword(keyword: string): void;
32+
parseVariableDefinitions(): void;
33+
parseDocument(): DocumentNode;
34+
}
35+
}
36+
37+
class FragmentArgumentCompatible extends Parser {
38+
parseFragment() {
39+
const start = this._lexer.token;
40+
this.expectToken(TokenKind.SPREAD);
41+
const hasTypeCondition = this.expectOptionalKeyword('on');
42+
if (!hasTypeCondition && this.peek(TokenKind.NAME)) {
43+
const name = this.parseFragmentName();
44+
if (this.peek(TokenKind.PAREN_L)) {
45+
return {
46+
kind: Kind.FRAGMENT_SPREAD,
47+
name,
48+
arguments: this.parseArguments(false),
49+
directives: this.parseDirectives(false),
50+
loc: this.loc(start),
51+
};
52+
}
53+
return {
54+
kind: Kind.FRAGMENT_SPREAD,
55+
name: this.parseFragmentName(),
56+
directives: this.parseDirectives(false),
57+
loc: this.loc(start),
58+
};
59+
}
60+
return {
61+
kind: Kind.INLINE_FRAGMENT,
62+
typeCondition: hasTypeCondition ? this.parseNamedType() : undefined,
63+
directives: this.parseDirectives(false),
64+
selectionSet: this.parseSelectionSet(),
65+
loc: this.loc(start),
66+
};
67+
}
68+
69+
parseFragmentDefinition() {
70+
const start = this._lexer.token;
71+
this.expectKeyword('fragment');
72+
const name = this.parseFragmentName();
73+
if (this.peek(TokenKind.PAREN_L)) {
74+
return {
75+
kind: Kind.FRAGMENT_DEFINITION,
76+
name,
77+
variableDefinitions: this.parseVariableDefinitions(),
78+
typeCondition: (this.expectKeyword('on'), this.parseNamedType()),
79+
directives: this.parseDirectives(false),
80+
selectionSet: this.parseSelectionSet(),
81+
loc: this.loc(start),
82+
};
83+
}
84+
85+
return {
86+
kind: Kind.FRAGMENT_DEFINITION,
87+
name,
88+
typeCondition: (this.expectKeyword('on'), this.parseNamedType()),
89+
directives: this.parseDirectives(false),
90+
selectionSet: this.parseSelectionSet(),
91+
loc: this.loc(start),
92+
};
93+
}
94+
}
95+
96+
function pimpedParse(source: string | Source, options?: ParseOptions): DocumentNode {
97+
const parser = new FragmentArgumentCompatible(source, options);
98+
return parser.parseDocument();
99+
}
100+
101+
export const useFragmentArguments = (): Plugin => {
102+
return {
103+
onParse({ setParseFn }) {
104+
setParseFn(pimpedParse);
105+
106+
return ({ result, replaceParseResult }) => {
107+
if (result && 'kind' in result) {
108+
replaceParseResult(applySelectionSetFragmentArguments(result));
109+
}
110+
};
111+
},
112+
};
113+
};
114+
115+
function applySelectionSetFragmentArguments(document: DocumentNode): DocumentNode | Error {
116+
const fragmentList = new Map<string, FragmentDefinitionNode>();
117+
for (const def of document.definitions) {
118+
if (def.kind !== 'FragmentDefinition') {
119+
continue;
120+
}
121+
fragmentList.set(def.name.value, def);
122+
}
123+
124+
return visit(document, {
125+
FragmentSpread(fragmentNode) {
126+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
127+
// @ts-ignore
128+
if (fragmentNode.arguments != null && fragmentNode.arguments.length) {
129+
const fragmentDef = fragmentList.get(fragmentNode.name.value);
130+
if (!fragmentDef) {
131+
return;
132+
}
133+
134+
const fragmentArguments = new Map<string, ArgumentNode>();
135+
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
136+
// @ts-ignore
137+
for (const arg of fragmentNode.arguments) {
138+
fragmentArguments.set(arg.name.value, arg);
139+
}
140+
141+
const selectionSet = visit(fragmentDef.selectionSet, {
142+
Variable(variableNode) {
143+
const fragArg = fragmentArguments.get(variableNode.name.value);
144+
if (fragArg) {
145+
return fragArg.value;
146+
}
147+
148+
return variableNode;
149+
},
150+
});
151+
152+
const inlineFragment: InlineFragmentNode = {
153+
kind: 'InlineFragment',
154+
typeCondition: fragmentDef.typeCondition,
155+
selectionSet,
156+
};
157+
158+
return inlineFragment;
159+
}
160+
return fragmentNode;
161+
},
162+
});
163+
}

‎packages/plugins/fragment-arguments/test/use-fragment-arguments.spec.ts

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
import { buildSchema, print } from 'graphql';
2+
import { oneLine, stripIndent } from 'common-tags';
3+
import { diff } from 'jest-diff';
4+
import { envelop, useSchema } from '@envelop/core';
5+
import { useFragmentArguments } from '../src';
6+
7+
function compareStrings(a: string, b: string): boolean {
8+
return a.includes(b);
9+
}
10+
11+
expect.extend({
12+
toBeSimilarStringTo(received: string, expected: string) {
13+
const strippedReceived = oneLine`${received}`.replace(/\s\s+/g, ' ');
14+
const strippedExpected = oneLine`${expected}`.replace(/\s\s+/g, ' ');
15+
16+
if (compareStrings(strippedReceived, strippedExpected)) {
17+
return {
18+
message: () =>
19+
`expected
20+
${received}
21+
not to be a string containing (ignoring indents)
22+
${expected}`,
23+
pass: true,
24+
};
25+
} else {
26+
const diffString = diff(stripIndent`${expected}`, stripIndent`${received}`, {
27+
expand: this.expand,
28+
});
29+
const hasExpect = diffString && diffString.includes('- Expect');
30+
31+
const message = hasExpect
32+
? `Difference:\n\n${diffString}`
33+
: `expected
34+
${received}
35+
to be a string containing (ignoring indents)
36+
${expected}`;
37+
38+
return {
39+
message: () => message,
40+
pass: false,
41+
};
42+
}
43+
},
44+
});
45+
46+
declare global {
47+
// eslint-disable-next-line no-redeclare
48+
namespace jest {
49+
interface Matchers<R, T> {
50+
/**
51+
* Normalizes whitespace and performs string comparisons
52+
*/
53+
toBeSimilarStringTo(expected: string): R;
54+
}
55+
}
56+
}
57+
58+
describe('useFragmentArguments', () => {
59+
const schema = buildSchema(/* GraphQL */ `
60+
type Query {
61+
a: TestType
62+
}
63+
64+
type TestType {
65+
a(b: String): Boolean
66+
}
67+
`);
68+
test('can inline fragment with argument', () => {
69+
const { parse } = envelop({ plugins: [useFragmentArguments(), useSchema(schema)] })();
70+
const result = parse(/* GraphQL */ `
71+
fragment TestFragment($c: String) on Query {
72+
a(b: $c)
73+
}
74+
75+
query TestQuery($a: String) {
76+
...TestFragment(c: $a)
77+
}
78+
`);
79+
expect(print(result)).toBeSimilarStringTo(/* GraphQL */ `
80+
query TestQuery($a: String) {
81+
... on Query {
82+
a(b: $a)
83+
}
84+
}
85+
`);
86+
});
87+
});

‎yarn.lock

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2358,6 +2358,11 @@
23582358
"@types/connect" "*"
23592359
"@types/node" "*"
23602360

2361+
"@types/[email protected]":
2362+
version "1.8.0"
2363+
resolved "https://registry.yarnpkg.com/@types/common-tags/-/common-tags-1.8.0.tgz#79d55e748d730b997be5b7fce4b74488d8b26a6b"
2364+
integrity sha512-htRqZr5qn8EzMelhX/Xmx142z218lLyGaeZ3YR8jlze4TATRU9huKKvuBmAJEW4LCC4pnY1N6JAm6p85fMHjhg==
2365+
23612366
"@types/component-emitter@^1.2.10":
23622367
version "1.2.10"
23632368
resolved "https://registry.yarnpkg.com/@types/component-emitter/-/component-emitter-1.2.10.tgz#ef5b1589b9f16544642e473db5ea5639107ef3ea"
@@ -3626,6 +3631,29 @@ bn.js@^5.0.0, bn.js@^5.1.1:
36263631
resolved "https://registry.npmjs.org/bn.js/-/bn.js-5.2.0.tgz#358860674396c6997771a9d051fcc1b57d4ae002"
36273632
integrity sha512-D7iWRBvnZE8ecXiLj/9wbxH7Tk79fAh8IHaTNq1RWRixsS02W+5qS+iE9yq6RYl0asXx5tw0bLhmT5pIfbSquw==
36283633

3634+
[email protected]:
3635+
version "1.2.1"
3636+
resolved "https://registry.npmjs.org/bob-the-bundler/-/bob-the-bundler-1.2.1.tgz#ed759de2ac59f5bda71cb625d17f1cd787984e4e"
3637+
integrity sha512-mrmiqX10ghyMB6v4T/VXjmhQie8xrqoOCWZ0b3N8JmTqnzYpOZbSw9UaAygxGzg4V2hjwTz0Wl7H1GlXQnawVA==
3638+
dependencies:
3639+
"@rollup/plugin-node-resolve" "7.1.1"
3640+
builtins "4.0.0"
3641+
consola "2.11.3"
3642+
cosmiconfig "6.0.0"
3643+
cross-spawn "7.0.1"
3644+
fs-extra "9.0.0"
3645+
globby "11.0.0"
3646+
lodash.get "4.4.2"
3647+
minimatch "3.0.4"
3648+
mkdirp "1.0.4"
3649+
p-limit "2.2.2"
3650+
param-case "3.0.4"
3651+
rollup "2.3.2"
3652+
rollup-plugin-generate-package-json "3.2.0"
3653+
rollup-plugin-typescript2 "0.27.0"
3654+
tslib "^1.11.1"
3655+
yargs "15.3.1"
3656+
36293657
[email protected]:
36303658
version "1.4.1"
36313659
resolved "https://registry.yarnpkg.com/bob-the-bundler/-/bob-the-bundler-1.4.1.tgz#794382f60f0d2a68c57d85a41d06caf4a45cb1b4"
@@ -4188,6 +4216,11 @@ commander@^7.2.0:
41884216
resolved "https://registry.yarnpkg.com/commander/-/commander-7.2.0.tgz#a36cb57d0b501ce108e4d20559a150a391d97ab7"
41894217
integrity sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==
41904218

4219+
[email protected]:
4220+
version "1.8.0"
4221+
resolved "https://registry.yarnpkg.com/common-tags/-/common-tags-1.8.0.tgz#8e3153e542d4a39e9b10554434afaaf98956a937"
4222+
integrity sha512-6P6g0uetGpW/sdyUy/iQQCbFF0kWVMSIVSyYz7Zgjcgh8mgw8PQzDNZeyZ5DQ2gM7LBoZPHmnjz8rUthkBG5tw==
4223+
41914224
commondir@^1.0.1:
41924225
version "1.0.1"
41934226
resolved "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b"
@@ -6196,6 +6229,11 @@ graphql-ws@^4.4.2:
61966229
resolved "https://registry.yarnpkg.com/graphql-ws/-/graphql-ws-4.4.2.tgz#f2d83f1863ba3069117199311d664fd28f4aaa8e"
61976230
integrity sha512-Cz+t1w+8+tiHIKzcz45tMwrxJpPSQ7KNjQrfN8ADAELECkkBB7aSvAgpShWz0Tne8teH/UxzJsULObLVq5eMvQ==
61986231

6232+
[email protected]:
6233+
version "15.5.0"
6234+
resolved "https://registry.npmjs.org/graphql/-/graphql-15.5.0.tgz#39d19494dbe69d1ea719915b578bf920344a69d5"
6235+
integrity sha512-OmaM7y0kaK31NKG31q4YbD2beNYa6jBBKtMFT6gLYJljHLJr42IqJ8KX08u3Li/0ifzTU5HjmoOOrwa5BRLeDA==
6236+
61996237
[email protected]:
62006238
version "15.5.1"
62016239
resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.5.1.tgz#f2f84415d8985e7b84731e7f3536f8bb9d383aad"
@@ -8684,6 +8722,11 @@ once@^1.3.0, once@^1.3.1, once@^1.4.0:
86848722
dependencies:
86858723
wrappy "1"
86868724

8725+
[email protected]:
8726+
version "1.0.3"
8727+
resolved "https://registry.yarnpkg.com/oneline/-/oneline-1.0.3.tgz#2f2631bd3a5716a4eeb439291697af2fc7fa39a5"
8728+
integrity sha512-KWLrLloG/ShWvvWuvmOL2jw17++ufGdbkKC2buI2Aa6AaM4AkjCtpeJZg60EK34NQVo2qu1mlPrC2uhvQgCrhQ==
8729+
86878730
onetime@^5.1.0, onetime@^5.1.2:
86888731
version "5.1.2"
86898732
resolved "https://registry.npmjs.org/onetime/-/onetime-5.1.2.tgz#d0e96ebb56b07476df1dd9c4806e5237985ca45e"

0 commit comments

Comments
 (0)