-
Notifications
You must be signed in to change notification settings - Fork 242
/
externalUnused.test.ts
380 lines (341 loc) 路 9.56 KB
/
externalUnused.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
import gql from 'graphql-tag';
import { composeServices } from '../../../compose';
import { externalUnused as validateExternalUnused } from '../';
import { graphqlErrorSerializer } from 'apollo-federation-integration-testsuite';
expect.addSnapshotSerializer(graphqlErrorSerializer);
describe('externalUnused', () => {
it('warns when there is an unused @external field', () => {
const serviceA = {
typeDefs: gql`
type Product @key(fields: "id") {
sku: String!
upc: String!
id: ID!
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Product {
sku: String! @external
id: ID! @external
price: Int! @requires(fields: "id")
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toMatchInlineSnapshot(`
Array [
Object {
"code": "EXTERNAL_UNUSED",
"message": "[serviceB] Product.sku -> is marked as @external but is not used by a @requires, @key, or @provides directive.",
},
]
`);
});
it('does not warn when @external is selected by a @key', () => {
const serviceA = {
typeDefs: gql`
type Product @key(fields: "sku") {
sku: String!
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Product @key(fields: "sku") {
sku: String! @external
price: Float!
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it('does not warn when @external is selected by a @requires', () => {
const serviceA = {
typeDefs: gql`
type Product @key(fields: "sku") {
sku: String!
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Product {
sku: String! @external
price: Int! @requires(fields: "sku")
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it('does not warn when @external is selected by a @provides', () => {
const serviceA = {
typeDefs: gql`
type Product @key(fields: "sku") {
sku: String!
id: String!
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Product @key(fields: "sku") {
sku: String! @external
price: Int! @provides(fields: "id")
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it('does not warn when @external is selected by a @provides used from another type', () => {
const serviceA = {
typeDefs: gql`
type User @key(fields: "id") {
id: ID!
username: String
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
type Review {
author: User @provides(fields: "username")
}
extend type User @key(fields: "id") {
username: String @external
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it.todo(
'does not error when @provides selects an external field in a subselection',
);
it.todo('errors when there is an invalid selection in @requires');
it('does not warn when @external is selected by a @requires used from another type', () => {
const serviceA = {
typeDefs: gql`
type User @key(fields: "id") {
id: ID!
username: String
}
type AccountRoles {
canRead: Boolean
canWrite: Boolean
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
type Review {
author: User
}
extend type User @key(fields: "id") {
roles: AccountRoles!
isAdmin: Boolean! @requires(fields: "roles { canWrite }")
}
# Externals -- only referenced by the @requires on User.isAdmin
extend type AccountRoles {
canWrite: Boolean @external
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it('does not warn when @external is selected by a @requires in a deep subselection', () => {
const serviceA = {
typeDefs: gql`
type User @key(fields: "id") {
id: ID!
username: String
}
type AccountRoles {
canRead: Group
canWrite: Group
}
type Group {
id: ID!
name: String
members: [User]
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
type Review {
author: User
}
extend type User @key(fields: "id") {
id: ID! @external
roles: AccountRoles!
username: String @external
isAdmin: Boolean!
@requires(
fields: """
roles {
canWrite {
members {
username
}
}
canRead {
members {
username
}
}
}
"""
)
}
# Externals -- only referenced by the @requires on User.isAdmin
extend type AccountRoles {
canWrite: Group @external
canRead: Group @external
}
extend type Group {
members: [User] @external
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it('does not warn when @external is used on type with multiple @key directives', () => {
const serviceA = {
typeDefs: gql`
type Product @key(fields: "upc") @key(fields: "sku") {
upc: String
sku: String
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Product @key(fields: "upc") {
upc: String @external
}
`,
name: 'serviceB',
};
const serviceC = {
typeDefs: gql`
extend type Product @key(fields: "sku") {
sku: String @external
}
`,
name: 'serviceC',
};
const serviceList = [serviceA, serviceB, serviceC];
const { schema } = composeServices(serviceList);
const warnings = validateExternalUnused({ schema, serviceList });
expect(warnings).toEqual([]);
});
it('does not error when @external is used on a field of a concrete type that implements a shared field of an implemented interface', () => {
const serviceA = {
typeDefs: gql`
type Car implements Vehicle @key(fields: "id") {
id: ID!
speed: Int
}
interface Vehicle {
id: ID!
speed: Int
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Car implements Vehicle @key(fields: "id") {
id: ID! @external
speed: Int @external
}
interface Vehicle {
id: ID!
speed: Int
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const errors = validateExternalUnused({ schema, serviceList });
expect(errors).toHaveLength(0);
});
it('does error when @external is used on a field of a concrete type is not shared by its implemented interface', () => {
const serviceA = {
typeDefs: gql`
type Car implements Vehicle @key(fields: "id") {
id: ID!
speed: Int
wheelSize: Int
}
interface Vehicle {
id: ID!
speed: Int
}
`,
name: 'serviceA',
};
const serviceB = {
typeDefs: gql`
extend type Car implements Vehicle @key(fields: "id") {
id: ID! @external
speed: Int @external
wheelSize: Int @external
}
interface Vehicle {
id: ID!
speed: Int
}
`,
name: 'serviceB',
};
const serviceList = [serviceA, serviceB];
const { schema } = composeServices(serviceList);
const errors = validateExternalUnused({ schema, serviceList });
expect(errors).toMatchInlineSnapshot(`
Array [
Object {
"code": "EXTERNAL_UNUSED",
"message": "[serviceB] Car.wheelSize -> is marked as @external but is not used by a @requires, @key, or @provides directive.",
},
]
`);
});
});