Skip to content

Commit cc9b1ba

Browse files
yaacovCRyaacovCR
committed
switch from filtering to actual routing of root fields
for now we will disable support for fragment arguments, pending graphql/graphql-js#4389
1 parent e06aec9 commit cc9b1ba

12 files changed

+541
-133
lines changed

‎src/__testUtils__/__tests__/dedent-test.ts‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
import { expect } from 'chai';
2+
import { describe, it } from 'mocha';
3+
4+
import { dedent, dedentString } from '../dedent.js';
5+
6+
describe('dedentString', () => {
7+
it('removes indentation in typical usage', () => {
8+
const output = dedentString(`
9+
type Query {
10+
me: User
11+
}
12+
13+
type User {
14+
id: ID
15+
name: String
16+
}
17+
`);
18+
expect(output).to.equal(
19+
[
20+
'type Query {',
21+
' me: User',
22+
'}',
23+
'',
24+
'type User {',
25+
' id: ID',
26+
' name: String',
27+
'}',
28+
].join('\n'),
29+
);
30+
});
31+
32+
it('removes only the first level of indentation', () => {
33+
const output = dedentString(`
34+
first
35+
second
36+
third
37+
fourth
38+
`);
39+
expect(output).to.equal(
40+
['first', ' second', ' third', ' fourth'].join('\n'),
41+
);
42+
});
43+
44+
it('does not escape special characters', () => {
45+
const output = dedentString(`
46+
type Root {
47+
field(arg: String = "wi\th de\fault"): String
48+
}
49+
`);
50+
expect(output).to.equal(
51+
[
52+
'type Root {',
53+
' field(arg: String = "wi\th de\fault"): String',
54+
'}',
55+
].join('\n'),
56+
);
57+
});
58+
59+
it('also removes indentation using tabs', () => {
60+
const output = dedentString(`
61+
\t\t type Query {
62+
\t\t me: User
63+
\t\t }
64+
`);
65+
expect(output).to.equal(['type Query {', ' me: User', '}'].join('\n'));
66+
});
67+
68+
it('removes leading and trailing newlines', () => {
69+
const output = dedentString(`
70+
71+
72+
type Query {
73+
me: User
74+
}
75+
76+
77+
`);
78+
expect(output).to.equal(['type Query {', ' me: User', '}'].join('\n'));
79+
});
80+
81+
it('removes all trailing spaces and tabs', () => {
82+
const output = dedentString(`
83+
type Query {
84+
me: User
85+
}
86+
\t\t \t `);
87+
expect(output).to.equal(['type Query {', ' me: User', '}'].join('\n'));
88+
});
89+
90+
it('works on text without leading newline', () => {
91+
const output = dedentString(` type Query {
92+
me: User
93+
}
94+
`);
95+
expect(output).to.equal(['type Query {', ' me: User', '}'].join('\n'));
96+
});
97+
});
98+
99+
describe('dedent', () => {
100+
it('removes indentation in typical usage', () => {
101+
const output = dedent`
102+
type Query {
103+
me: User
104+
}
105+
`;
106+
expect(output).to.equal(['type Query {', ' me: User', '}'].join('\n'));
107+
});
108+
109+
it('supports expression interpolation', () => {
110+
const name = 'John';
111+
const surname = 'Doe';
112+
const output = dedent`
113+
{
114+
"me": {
115+
"name": "${name}",
116+
"surname": "${surname}"
117+
}
118+
}
119+
`;
120+
expect(output).to.equal(
121+
[
122+
'{',
123+
' "me": {',
124+
' "name": "John",',
125+
' "surname": "Doe"',
126+
' }',
127+
'}',
128+
].join('\n'),
129+
);
130+
});
131+
});

‎src/__testUtils__/dedent.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
export function dedentString(string: string): string {
2+
const trimmedStr = string
3+
.replace(/^\n*/m, '') // remove leading newline
4+
.replace(/[ \t\n]*$/, ''); // remove trailing spaces and tabs
5+
6+
// fixes indentation by removing leading spaces and tabs from each line
7+
let indent = '';
8+
for (const char of trimmedStr) {
9+
if (char !== ' ' && char !== '\t') {
10+
break;
11+
}
12+
indent += char;
13+
}
14+
15+
return trimmedStr.replaceAll(RegExp('^' + indent, 'mg'), ''); // remove indent
16+
}
17+
18+
/**
19+
* An ES6 string tag that fixes indentation and also trims string.
20+
*
21+
* Example usage:
22+
* ```ts
23+
* const str = dedent`
24+
* {
25+
* test
26+
* }
27+
* `;
28+
* str === "{\n test\n}";
29+
* ```
30+
*/
31+
export function dedent(
32+
strings: ReadonlyArray<string>,
33+
...values: ReadonlyArray<string>
34+
): string {
35+
let str = strings[0];
36+
37+
for (let i = 1; i < strings.length; ++i) {
38+
str += values[i - 1] + strings[i]; // interpolation
39+
}
40+
return dedentString(str);
41+
}

‎src/transform/__tests__/abstract-test.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,6 +454,7 @@ describe('Execute: Handles execution of abstract types', () => {
454454
}
455455
`);
456456

457+
// NOTE: This is an *invalid* query, but it should be an *executable* query.
457458
const query = `
458459
{
459460
pets {
@@ -483,14 +484,17 @@ describe('Execute: Handles execution of abstract types', () => {
483484
],
484485
};
485486

486-
// query invalid, unions do not have fields, so name skipped
487+
// invalid fields are dropped during transformation prior to forwarding,
488+
// ultimately resolving to null
487489
expect(await executeQuery({ schema, query, rootValue })).to.deep.equal({
488490
data: {
489491
pets: [
490492
{
493+
name: null,
491494
woofs: true,
492495
},
493496
{
497+
name: null,
494498
meows: false,
495499
},
496500
],

‎src/transform/__tests__/groupedFieldSetToSelectionSet-test.ts‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
import { expect } from 'chai';
2+
import type { OperationDefinitionNode } from 'graphql';
3+
import {
4+
GraphQLObjectType,
5+
GraphQLSchema,
6+
GraphQLString,
7+
Kind,
8+
parse,
9+
print,
10+
} from 'graphql';
11+
// eslint-disable-next-line n/no-missing-import
12+
import { collectFields } from 'graphql/execution/collectFields.js';
13+
import { describe, it } from 'mocha';
14+
15+
import { dedent } from '../../__testUtils__/dedent.js';
16+
17+
import { groupedFieldSetToSelectionSet } from '../groupedFieldSetToSelectionSet.js';
18+
19+
const query = new GraphQLObjectType({
20+
name: 'Query',
21+
fields: {
22+
a: { type: GraphQLString },
23+
b: { type: GraphQLString },
24+
c: { type: GraphQLString },
25+
},
26+
});
27+
const schema = new GraphQLSchema({
28+
query,
29+
});
30+
31+
function expectSourceToMatch(source: string): void {
32+
const document = parse(source);
33+
const operation = document.definitions[0] as OperationDefinitionNode;
34+
const { groupedFieldSet } = collectFields(
35+
schema,
36+
{},
37+
{ sources: {}, coerced: {} },
38+
query,
39+
operation.selectionSet,
40+
false,
41+
);
42+
43+
const selectionSet = groupedFieldSetToSelectionSet(groupedFieldSet);
44+
45+
const printed = print({
46+
kind: Kind.DOCUMENT,
47+
definitions: [
48+
{
49+
kind: Kind.OPERATION_DEFINITION,
50+
operation: 'query',
51+
selectionSet,
52+
},
53+
],
54+
});
55+
56+
expect(printed).to.equal(dedent`${source}`);
57+
}
58+
59+
describe('groupedFieldSetToSelectionSet', () => {
60+
it('should handle field set without @defer', () => {
61+
expectSourceToMatch(`
62+
{
63+
a
64+
b
65+
}
66+
`);
67+
});
68+
69+
it('should handle field set with single @defer', () => {
70+
expectSourceToMatch(`
71+
{
72+
a
73+
b
74+
... @defer(label: "label") {
75+
c
76+
}
77+
}
78+
`);
79+
});
80+
81+
it('should handle field set with nested @defer', () => {
82+
expectSourceToMatch(`
83+
{
84+
a
85+
b
86+
... @defer(label: "outer") {
87+
c
88+
... @defer(label: "inner") {
89+
d
90+
}
91+
}
92+
}
93+
`);
94+
});
95+
96+
it('should handle field set with multiple @defer', () => {
97+
expectSourceToMatch(`
98+
{
99+
a
100+
b
101+
... @defer(label: "label1") {
102+
c
103+
}
104+
... @defer(label: "label2") {
105+
d
106+
}
107+
}
108+
`);
109+
});
110+
});

‎src/transform/__tests__/oneof-test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ describe('Execute: Handles OneOf Input Objects', () => {
262262
});
263263
});
264264

265-
it('errors with nulled fragment variable for field', () => {
265+
it.skip('errors with nulled fragment variable for field', () => {
266266
const query = `
267267
query {
268268
...TestFragment(a: null)

‎src/transform/__tests__/union-interface-test.ts‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,17 +277,22 @@ describe('Execute: Union and intersection types', () => {
277277
}
278278
`);
279279

280-
// name, barks, meows invalid without type conditions
280+
// invalid fields are dropped during transformation prior to forwarding,
281+
// ultimately resolving to null
281282
expect(executeSync({ schema, document, rootValue: john })).to.deep.equal({
282283
data: {
283284
__typename: 'Person',
284285
name: 'John',
285286
pets: [
286287
{
287288
__typename: 'Cat',
289+
name: null,
290+
meows: null,
288291
},
289292
{
290293
__typename: 'Dog',
294+
name: null,
295+
barks: null,
291296
},
292297
],
293298
},
@@ -349,13 +354,15 @@ describe('Execute: Union and intersection types', () => {
349354
}
350355
`);
351356

357+
// invalid fields are dropped during transformation prior to forwarding,
358+
// ultimately resolving to null
352359
expect(executeSync({ schema, document, rootValue: john })).to.deep.equal({
353360
data: {
354361
__typename: 'Person',
355362
name: 'John',
356363
friends: [
357364
{ __typename: 'Person', name: 'Liz' },
358-
{ __typename: 'Dog', name: 'Odie' }, // 'barks' skipped as invalid without type condition
365+
{ __typename: 'Dog', name: 'Odie', barks: null },
359366
],
360367
},
361368
});

‎src/transform/__tests__/variables-test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1190,7 +1190,7 @@ describe('Execute: Handles inputs', () => {
11901190
});
11911191
});
11921192

1193-
describe('using fragment arguments', () => {
1193+
describe.skip('using fragment arguments', () => {
11941194
it('when there are no fragment arguments', () => {
11951195
const result = executeQueryWithFragmentArguments(`
11961196
query {

0 commit comments

Comments
 (0)