graphql-tag 2.7.1 → 2.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,465 @@
1
+ const gqlRequire = require('../src');
2
+ const gqlDefault = require('../src').default;
3
+ const loader = require('../loader');
4
+ const assert = require('chai').assert;
5
+
6
+ [gqlRequire, gqlDefault].forEach((gql, i) => {
7
+ describe(`gql ${i}`, () => {
8
+ it('parses queries', () => {
9
+ assert.equal(gql`{ testQuery }`.kind, 'Document');
10
+ });
11
+
12
+ it('parses queries when called as a function', () => {
13
+ assert.equal(gql('{ testQuery }').kind, 'Document');
14
+ });
15
+
16
+ it('parses queries with weird substitutions', () => {
17
+ const obj = {};
18
+ assert.equal(gql`{ field(input: "${obj.missing}") }`.kind, 'Document');
19
+ assert.equal(gql`{ field(input: "${null}") }`.kind, 'Document');
20
+ assert.equal(gql`{ field(input: "${0}") }`.kind, 'Document');
21
+ });
22
+
23
+ it('allows interpolation of documents generated by the webpack loader', () => {
24
+ const sameFragment = "fragment SomeFragmentName on SomeType { someField }";
25
+
26
+ const jsSource = loader.call(
27
+ { cacheable() {} },
28
+ "fragment SomeFragmentName on SomeType { someField }"
29
+ );
30
+ const module = { exports: undefined };
31
+ eval(jsSource);
32
+
33
+ const document = gql`query { ...SomeFragmentName } ${module.exports}`;
34
+ assert.equal(document.kind, 'Document');
35
+ assert.equal(document.definitions.length, 2);
36
+ assert.equal(document.definitions[0].kind, 'OperationDefinition');
37
+ assert.equal(document.definitions[1].kind, 'FragmentDefinition');
38
+ });
39
+
40
+ it('parses queries through webpack loader', () => {
41
+ const jsSource = loader.call({ cacheable() {} }, '{ testQuery }');
42
+ const module = { exports: undefined };
43
+ eval(jsSource);
44
+ assert.equal(module.exports.kind, 'Document');
45
+ });
46
+
47
+ it('parses single query through webpack loader', () => {
48
+ const jsSource = loader.call({ cacheable() {} }, `
49
+ query Q1 { testQuery }
50
+ `);
51
+ const module = { exports: undefined };
52
+ eval(jsSource);
53
+
54
+ assert.equal(module.exports.kind, 'Document');
55
+ assert.exists(module.exports.Q1);
56
+ assert.equal(module.exports.Q1.kind, 'Document');
57
+ assert.equal(module.exports.Q1.definitions.length, 1);
58
+ });
59
+
60
+ it('parses single query and exports as default', () => {
61
+ const jsSource = loader.call({ cacheable() {} }, `
62
+ query Q1 { testQuery }
63
+ `);
64
+ const module = { exports: undefined };
65
+ eval(jsSource);
66
+
67
+ assert.deepEqual(module.exports.definitions, module.exports.Q1.definitions);
68
+ });
69
+
70
+ it('parses multiple queries through webpack loader', () => {
71
+ const jsSource = loader.call({ cacheable() {} }, `
72
+ query Q1 { testQuery }
73
+ query Q2 { testQuery2 }
74
+ `);
75
+ const module = { exports: undefined };
76
+ eval(jsSource);
77
+
78
+ assert.exists(module.exports.Q1);
79
+ assert.exists(module.exports.Q2);
80
+ assert.equal(module.exports.Q1.kind, 'Document');
81
+ assert.equal(module.exports.Q2.kind, 'Document');
82
+ assert.equal(module.exports.Q1.definitions.length, 1);
83
+ assert.equal(module.exports.Q2.definitions.length, 1);
84
+ });
85
+
86
+ it('parses fragments with variable definitions', () => {
87
+ gql.enableExperimentalFragmentVariables();
88
+
89
+ const parsed = gql`fragment A ($arg: String!) on Type { testQuery }`;
90
+ assert.equal(parsed.kind, 'Document');
91
+ assert.exists(parsed.definitions[0].variableDefinitions);
92
+
93
+ gql.disableExperimentalFragmentVariables()
94
+ });
95
+
96
+ // see https://github.com/apollographql/graphql-tag/issues/168
97
+ it('does not nest queries needlessly in named exports', () => {
98
+ const jsSource = loader.call({ cacheable() {} }, `
99
+ query Q1 { testQuery }
100
+ query Q2 { testQuery2 }
101
+ query Q3 { test Query3 }
102
+ `);
103
+ const module = { exports: undefined };
104
+ eval(jsSource);
105
+
106
+ assert.notExists(module.exports.Q2.Q1);
107
+ assert.notExists(module.exports.Q3.Q1);
108
+ assert.notExists(module.exports.Q3.Q2);
109
+ });
110
+
111
+ it('tracks fragment dependencies from multiple queries through webpack loader', () => {
112
+ const jsSource = loader.call({ cacheable() {} }, `
113
+ fragment F1 on F { testQuery }
114
+ fragment F2 on F { testQuery2 }
115
+ fragment F3 on F { testQuery3 }
116
+ query Q1 { ...F1 }
117
+ query Q2 { ...F2 }
118
+ query Q3 {
119
+ ...F1
120
+ ...F2
121
+ }
122
+ `);
123
+ const module = { exports: undefined };
124
+ eval(jsSource);
125
+
126
+ assert.exists(module.exports.Q1);
127
+ assert.exists(module.exports.Q2);
128
+ assert.exists(module.exports.Q3);
129
+ const Q1 = module.exports.Q1.definitions;
130
+ const Q2 = module.exports.Q2.definitions;
131
+ const Q3 = module.exports.Q3.definitions;
132
+
133
+ assert.equal(Q1.length, 2);
134
+ assert.equal(Q1[0].name.value, 'Q1');
135
+ assert.equal(Q1[1].name.value, 'F1');
136
+
137
+ assert.equal(Q2.length, 2);
138
+ assert.equal(Q2[0].name.value, 'Q2');
139
+ assert.equal(Q2[1].name.value, 'F2');
140
+
141
+ assert.equal(Q3.length, 3);
142
+ assert.equal(Q3[0].name.value, 'Q3');
143
+ assert.equal(Q3[1].name.value, 'F1');
144
+ assert.equal(Q3[2].name.value, 'F2');
145
+
146
+ });
147
+
148
+ it('tracks fragment dependencies across nested fragments', () => {
149
+ const jsSource = loader.call({ cacheable() {} }, `
150
+ fragment F11 on F { testQuery }
151
+ fragment F22 on F {
152
+ ...F11
153
+ testQuery2
154
+ }
155
+ fragment F33 on F {
156
+ ...F22
157
+ testQuery3
158
+ }
159
+
160
+ query Q1 {
161
+ ...F33
162
+ }
163
+
164
+ query Q2 {
165
+ id
166
+ }
167
+ `);
168
+
169
+ const module = { exports: undefined };
170
+ eval(jsSource);
171
+
172
+ assert.exists(module.exports.Q1);
173
+ assert.exists(module.exports.Q2);
174
+
175
+ const Q1 = module.exports.Q1.definitions;
176
+ const Q2 = module.exports.Q2.definitions;
177
+
178
+ assert.equal(Q1.length, 4);
179
+ assert.equal(Q1[0].name.value, 'Q1');
180
+ assert.equal(Q1[1].name.value, 'F33');
181
+ assert.equal(Q1[2].name.value, 'F22');
182
+ assert.equal(Q1[3].name.value, 'F11');
183
+
184
+ assert.equal(Q2.length, 1);
185
+ });
186
+
187
+ it('correctly imports other files through the webpack loader', () => {
188
+ const query = `#import "./fragment_definition.graphql"
189
+ query {
190
+ author {
191
+ ...authorDetails
192
+ }
193
+ }`;
194
+ const jsSource = loader.call({ cacheable() {} }, query);
195
+ const oldRequire = require;
196
+ const module = { exports: undefined };
197
+ const require = (path) => {
198
+ assert.equal(path, './fragment_definition.graphql');
199
+ return gql`
200
+ fragment authorDetails on Author {
201
+ firstName
202
+ lastName
203
+ }`;
204
+ };
205
+ eval(jsSource);
206
+ assert.equal(module.exports.kind, 'Document');
207
+ const definitions = module.exports.definitions;
208
+ assert.equal(definitions.length, 2);
209
+ assert.equal(definitions[0].kind, 'OperationDefinition');
210
+ assert.equal(definitions[1].kind, 'FragmentDefinition');
211
+ });
212
+
213
+ it('tracks fragment dependencies across fragments loaded via the webpack loader', () => {
214
+ const query = `#import "./fragment_definition.graphql"
215
+ fragment F111 on F {
216
+ ...F222
217
+ }
218
+
219
+ query Q1 {
220
+ ...F111
221
+ }
222
+
223
+ query Q2 {
224
+ a
225
+ }
226
+ `;
227
+ const jsSource = loader.call({ cacheable() {} }, query);
228
+ const oldRequire = require;
229
+ const module = { exports: undefined };
230
+ const require = (path) => {
231
+ assert.equal(path, './fragment_definition.graphql');
232
+ return gql`
233
+ fragment F222 on F {
234
+ f1
235
+ f2
236
+ }`;
237
+ };
238
+ eval(jsSource);
239
+
240
+ assert.exists(module.exports.Q1);
241
+ assert.exists(module.exports.Q2);
242
+
243
+ const Q1 = module.exports.Q1.definitions;
244
+ const Q2 = module.exports.Q2.definitions;
245
+
246
+ assert.equal(Q1.length, 3);
247
+ assert.equal(Q1[0].name.value, 'Q1');
248
+ assert.equal(Q1[1].name.value, 'F111');
249
+ assert.equal(Q1[2].name.value, 'F222');
250
+
251
+ assert.equal(Q2.length, 1);
252
+ });
253
+
254
+ it('does not complain when presented with normal comments', (done) => {
255
+ assert.doesNotThrow(() => {
256
+ const query = `#normal comment
257
+ query {
258
+ author {
259
+ ...authorDetails
260
+ }
261
+ }`;
262
+ const jsSource = loader.call({ cacheable() {} }, query);
263
+ const module = { exports: undefined };
264
+ eval(jsSource);
265
+ assert.equal(module.exports.kind, 'Document');
266
+ done();
267
+ });
268
+ });
269
+
270
+ it('returns the same object for the same query', () => {
271
+ assert.isTrue(gql`{ sameQuery }` === gql`{ sameQuery }`);
272
+ });
273
+
274
+ it('returns the same object for the same query, even with whitespace differences', () => {
275
+ assert.isTrue(gql`{ sameQuery }` === gql` { sameQuery, }`);
276
+ });
277
+
278
+ const fragmentAst = gql`
279
+ fragment UserFragment on User {
280
+ firstName
281
+ lastName
282
+ }
283
+ `;
284
+
285
+ it('returns the same object for the same fragment', () => {
286
+ assert.isTrue(gql`fragment same on Same { sameQuery }` ===
287
+ gql`fragment same on Same { sameQuery }`);
288
+ });
289
+
290
+ it('returns the same object for the same document with substitution', () => {
291
+ // We know that calling `gql` on a fragment string will always return
292
+ // the same document, so we can reuse `fragmentAst`
293
+ assert.isTrue(gql`{ ...UserFragment } ${fragmentAst}` ===
294
+ gql`{ ...UserFragment } ${fragmentAst}`);
295
+ });
296
+
297
+ it('can reference a fragment that references as fragment', () => {
298
+ const secondFragmentAst = gql`
299
+ fragment SecondUserFragment on User {
300
+ ...UserFragment
301
+ }
302
+ ${fragmentAst}
303
+ `;
304
+
305
+ const ast = gql`
306
+ {
307
+ user(id: 5) {
308
+ ...SecondUserFragment
309
+ }
310
+ }
311
+ ${secondFragmentAst}
312
+ `;
313
+
314
+ assert.deepEqual(ast, gql`
315
+ {
316
+ user(id: 5) {
317
+ ...SecondUserFragment
318
+ }
319
+ }
320
+ fragment SecondUserFragment on User {
321
+ ...UserFragment
322
+ }
323
+ fragment UserFragment on User {
324
+ firstName
325
+ lastName
326
+ }
327
+ `);
328
+ });
329
+
330
+ describe('fragment warnings', () => {
331
+ let warnings = [];
332
+ const oldConsoleWarn = console.warn;
333
+ beforeEach(() => {
334
+ gqlRequire.resetCaches();
335
+ warnings = [];
336
+ console.warn = (w) => warnings.push(w);
337
+ });
338
+ afterEach(() => {
339
+ console.warn = oldConsoleWarn;
340
+ });
341
+
342
+ it('warns if you use the same fragment name for different fragments', () => {
343
+ const frag1 = gql`fragment TestSame on Bar { fieldOne }`;
344
+ const frag2 = gql`fragment TestSame on Bar { fieldTwo }`;
345
+
346
+ assert.isFalse(frag1 === frag2);
347
+ assert.equal(warnings.length, 1);
348
+ });
349
+
350
+ it('does not warn if you use the same fragment name for the same fragment', () => {
351
+ const frag1 = gql`fragment TestDifferent on Bar { fieldOne }`;
352
+ const frag2 = gql`fragment TestDifferent on Bar { fieldOne }`;
353
+
354
+ assert.isTrue(frag1 === frag2);
355
+ assert.equal(warnings.length, 0);
356
+ });
357
+
358
+ it('does not warn if you use the same embedded fragment in two different queries', () => {
359
+ const frag1 = gql`fragment TestEmbedded on Bar { field }`;
360
+ const query1 = gql`{ bar { fieldOne ...TestEmbedded } } ${frag1}`;
361
+ const query2 = gql`{ bar { fieldTwo ...TestEmbedded } } ${frag1}`;
362
+
363
+ assert.isFalse(query1 === query2);
364
+ assert.equal(warnings.length, 0);
365
+ });
366
+
367
+ it('does not warn if you use the same fragment name for embedded and non-embedded fragments', () => {
368
+ const frag1 = gql`fragment TestEmbeddedTwo on Bar { field }`;
369
+ const query1 = gql`{ bar { ...TestEmbedded } } ${frag1}`;
370
+ const query2 = gql`{ bar { ...TestEmbedded } } fragment TestEmbeddedTwo on Bar { field }`;
371
+
372
+ assert.equal(warnings.length, 0);
373
+ });
374
+ });
375
+
376
+ describe('unique fragments', () => {
377
+ beforeEach(() => {
378
+ gqlRequire.resetCaches();
379
+ });
380
+
381
+ it('strips duplicate fragments from the document', () => {
382
+ const frag1 = gql`fragment TestDuplicate on Bar { field }`;
383
+ const query1 = gql`{ bar { fieldOne ...TestDuplicate } } ${frag1} ${frag1}`;
384
+ const query2 = gql`{ bar { fieldOne ...TestDuplicate } } ${frag1}`;
385
+
386
+ assert.equal(query1.definitions.length, 2);
387
+ assert.equal(query1.definitions[1].kind, 'FragmentDefinition');
388
+ // We don't test strict equality between the two queries because the source.body parsed from the
389
+ // document is not the same, but the set of definitions should be.
390
+ assert.deepEqual(query1.definitions, query2.definitions);
391
+ });
392
+
393
+ it('ignores duplicate fragments from second-level imports when using the webpack loader', () => {
394
+ // take a require function and a query string, use the webpack loader to process it
395
+ const load = (require, query) => {
396
+ const jsSource = loader.call({ cacheable() {} }, query);
397
+ const module = { exports: undefined };
398
+ eval(jsSource);
399
+ return module.exports;
400
+ }
401
+
402
+ const test_require = (path) => {
403
+ switch (path) {
404
+ case './friends.graphql':
405
+ return load(test_require, [
406
+ '#import "./person.graphql"',
407
+ 'fragment friends on Hero { friends { ...person } }',
408
+ ].join('\n'));
409
+ case './enemies.graphql':
410
+ return load(test_require, [
411
+ '#import "./person.graphql"',
412
+ 'fragment enemies on Hero { enemies { ...person } }',
413
+ ].join('\n'));
414
+ case './person.graphql':
415
+ return load(test_require, 'fragment person on Person { name }\n');
416
+ default:
417
+ return null;
418
+ };
419
+ };
420
+
421
+ const result = load(test_require, [
422
+ '#import "./friends.graphql"',
423
+ '#import "./enemies.graphql"',
424
+ 'query { hero { ...friends ...enemies } }',
425
+ ].join('\n'));
426
+
427
+ assert.equal(result.kind, 'Document');
428
+ assert.equal(result.definitions.length, 4, 'after deduplication, only 4 fragments should remain');
429
+ assert.equal(result.definitions[0].kind, 'OperationDefinition');
430
+
431
+ // the rest of the definitions should be fragments and contain one of
432
+ // each: "friends", "enemies", "person". Order does not matter
433
+ const fragments = result.definitions.slice(1)
434
+ assert(fragments.every(fragment => fragment.kind === 'FragmentDefinition'))
435
+ assert(fragments.some(fragment => fragment.name.value === 'friends'))
436
+ assert(fragments.some(fragment => fragment.name.value === 'enemies'))
437
+ assert(fragments.some(fragment => fragment.name.value === 'person'))
438
+ });
439
+ });
440
+
441
+ // How to make this work?
442
+ // it.only('can reference a fragment passed as a document via shorthand', () => {
443
+ // const ast = gql`
444
+ // {
445
+ // user(id: 5) {
446
+ // ...${userFragmentDocument}
447
+ // }
448
+ // }
449
+ // `;
450
+ //
451
+ // assert.deepEqual(ast, gql`
452
+ // {
453
+ // user(id: 5) {
454
+ // ...UserFragment
455
+ // }
456
+ // }
457
+ // fragment UserFragment on User {
458
+ // firstName
459
+ // lastName
460
+ // }
461
+ // `);
462
+ // });
463
+
464
+ });
465
+ });
@@ -0,0 +1 @@
1
+ --require babel-register