apollo-federation 2.13.1

Apollo Federation
Documentation
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
#[allow(dead_code)]
use std::sync::LazyLock;

#[derive(Debug)]
#[allow(dead_code)]
pub(crate) enum HintLevel {
    Warn,
    Info,
    Debug,
}

#[allow(dead_code)]
impl HintLevel {
    pub(crate) fn name(&self) -> &'static str {
        match self {
            HintLevel::Warn => "WARN",
            HintLevel::Info => "INFO",
            HintLevel::Debug => "DEBUG",
        }
    }
}

#[derive(Debug)]
pub(crate) struct HintCodeDefinition {
    code: String,
    level: HintLevel,
    description: String,
}

#[allow(dead_code)]
impl HintCodeDefinition {
    pub(crate) fn new(
        code: impl Into<String>,
        level: HintLevel,
        description: impl Into<String>,
    ) -> Self {
        Self {
            code: code.into(),
            level,
            description: description.into(),
        }
    }

    pub(crate) fn code(&self) -> &str {
        &self.code
    }

    pub(crate) fn level(&self) -> &HintLevel {
        &self.level
    }

    pub(crate) fn description(&self) -> &str {
        &self.description
    }
}

#[derive(Clone, Debug)]
#[allow(dead_code)]
pub(crate) enum HintCode {
    InconsistentButCompatibleFieldType,
    InconsistentButCompatibleArgumentType,
    InconsistentDefaultValuePresence,
    InconsistentEntity,
    InconsistentObjectValueTypeField,
    InconsistentInterfaceValueTypeField,
    InconsistentInputObjectField,
    InconsistentUnionMember,
    InconsistentEnumValueForInputEnum,
    InconsistentEnumValueForOutputEnum,
    InconsistentTypeSystemDirectiveRepeatable,
    InconsistentTypeSystemDirectiveLocations,
    InconsistentExecutableDirectivePresence,
    NoExecutableDirectiveLocationsIntersection,
    InconsistentExecutableDirectiveRepeatable,
    InconsistentExecutableDirectiveLocations,
    InconsistentDescription,
    InconsistentArgumentPresence,
    FromSubgraphDoesNotExist,
    OverriddenFieldCanBeRemoved,
    OverrideDirectiveCanBeRemoved,
    OverrideMigrationInProgress,
    UnusedEnumType,
    InconsistentNonRepeatableDirectiveArguments,
    MergedNonRepeatableDirectiveArguments,
    DirectiveCompositionInfo,
    DirectiveCompositionWarn,
    InconsistentRuntimeTypesForShareableReturn,
    ImplicitlyUpgradedFederationVersion,
    ContextualArgumentNotContextualInAllSubgraphs,
    InterfaceKeyMissingImplementationType,
}

#[allow(dead_code)]
impl HintCode {
    pub(crate) fn definition(&self) -> &'static HintCodeDefinition {
        match self {
            HintCode::InconsistentButCompatibleFieldType => &INCONSISTENT_BUT_COMPATIBLE_FIELD_TYPE,
            HintCode::InconsistentButCompatibleArgumentType => {
                &INCONSISTENT_BUT_COMPATIBLE_ARGUMENT_TYPE
            }
            HintCode::InconsistentDefaultValuePresence => &INCONSISTENT_DEFAULT_VALUE_PRESENCE,
            HintCode::InconsistentEntity => &INCONSISTENT_ENTITY,
            HintCode::InconsistentObjectValueTypeField => &INCONSISTENT_OBJECT_VALUE_TYPE_FIELD,
            HintCode::InconsistentInterfaceValueTypeField => {
                &INCONSISTENT_INTERFACE_VALUE_TYPE_FIELD
            }
            HintCode::InconsistentInputObjectField => &INCONSISTENT_INPUT_OBJECT_FIELD,
            HintCode::InconsistentUnionMember => &INCONSISTENT_UNION_MEMBER,
            HintCode::InconsistentEnumValueForInputEnum => &INCONSISTENT_ENUM_VALUE_FOR_INPUT_ENUM,
            HintCode::InconsistentEnumValueForOutputEnum => {
                &INCONSISTENT_ENUM_VALUE_FOR_OUTPUT_ENUM
            }
            HintCode::InconsistentTypeSystemDirectiveRepeatable => {
                &INCONSISTENT_TYPE_SYSTEM_DIRECTIVE_REPEATABLE
            }
            HintCode::InconsistentTypeSystemDirectiveLocations => {
                &INCONSISTENT_TYPE_SYSTEM_DIRECTIVE_LOCATIONS
            }
            HintCode::InconsistentExecutableDirectivePresence => {
                &INCONSISTENT_EXECUTABLE_DIRECTIVE_PRESENCE
            }
            HintCode::NoExecutableDirectiveLocationsIntersection => {
                &NO_EXECUTABLE_DIRECTIVE_LOCATIONS_INTERSECTION
            }
            HintCode::InconsistentExecutableDirectiveRepeatable => {
                &INCONSISTENT_EXECUTABLE_DIRECTIVE_REPEATABLE
            }
            HintCode::InconsistentExecutableDirectiveLocations => {
                &INCONSISTENT_EXECUTABLE_DIRECTIVE_LOCATIONS
            }
            HintCode::InconsistentDescription => &INCONSISTENT_DESCRIPTION,
            HintCode::InconsistentArgumentPresence => &INCONSISTENT_ARGUMENT_PRESENCE,
            HintCode::FromSubgraphDoesNotExist => &FROM_SUBGRAPH_DOES_NOT_EXIST,
            HintCode::OverriddenFieldCanBeRemoved => &OVERRIDDEN_FIELD_CAN_BE_REMOVED,
            HintCode::OverrideDirectiveCanBeRemoved => &OVERRIDE_DIRECTIVE_CAN_BE_REMOVED,
            HintCode::OverrideMigrationInProgress => &OVERRIDE_MIGRATION_IN_PROGRESS,
            HintCode::UnusedEnumType => &UNUSED_ENUM_TYPE,
            HintCode::InconsistentNonRepeatableDirectiveArguments => {
                &INCONSISTENT_NON_REPEATABLE_DIRECTIVE_ARGUMENTS
            }
            HintCode::MergedNonRepeatableDirectiveArguments => {
                &MERGED_NON_REPEATABLE_DIRECTIVE_ARGUMENTS
            }
            HintCode::DirectiveCompositionInfo => &DIRECTIVE_COMPOSITION_INFO,
            HintCode::DirectiveCompositionWarn => &DIRECTIVE_COMPOSITION_WARN,
            HintCode::InconsistentRuntimeTypesForShareableReturn => {
                &INCONSISTENT_RUNTIME_TYPES_FOR_SHAREABLE_RETURN
            }
            HintCode::ImplicitlyUpgradedFederationVersion => {
                &IMPLICITLY_UPGRADED_FEDERATION_VERSION
            }
            HintCode::ContextualArgumentNotContextualInAllSubgraphs => {
                &CONTEXTUAL_ARGUMENT_NOT_CONTEXTUAL_IN_ALL_SUBGRAPHS
            }
            HintCode::InterfaceKeyMissingImplementationType => {
                &INTERFACE_KEY_MISSING_IMPLEMENTATION_TYPE
            }
        }
    }

    pub(crate) fn code(&self) -> &str {
        self.definition().code()
    }
}

#[allow(dead_code)]
pub(crate) static INCONSISTENT_BUT_COMPATIBLE_FIELD_TYPE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_BUT_COMPATIBLE_FIELD_TYPE",
            HintLevel::Warn,
            "Field has inconsistent but compatible type across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_BUT_COMPATIBLE_ARGUMENT_TYPE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_BUT_COMPATIBLE_ARGUMENT_TYPE",
            HintLevel::Warn,
            "Argument has inconsistent but compatible type across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_DEFAULT_VALUE_PRESENCE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_DEFAULT_VALUE_PRESENCE",
            HintLevel::Warn,
            "Default value presence is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_ENTITY: LazyLock<HintCodeDefinition> = LazyLock::new(|| {
    HintCodeDefinition::new(
        "INCONSISTENT_ENTITY",
        HintLevel::Warn,
        "Entity definition is inconsistent across subgraphs",
    )
});

#[allow(dead_code)]
pub(crate) static INCONSISTENT_OBJECT_VALUE_TYPE_FIELD: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_OBJECT_VALUE_TYPE_FIELD",
            HintLevel::Warn,
            "Object value type field is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_INTERFACE_VALUE_TYPE_FIELD: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_INTERFACE_VALUE_TYPE_FIELD",
            HintLevel::Warn,
            "Interface value type field is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_INPUT_OBJECT_FIELD: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_INPUT_OBJECT_FIELD",
            HintLevel::Warn,
            "Input object field is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_UNION_MEMBER: LazyLock<HintCodeDefinition> = LazyLock::new(|| {
    HintCodeDefinition::new(
        "INCONSISTENT_UNION_MEMBER",
        HintLevel::Warn,
        "Union member is inconsistent across subgraphs",
    )
});

#[allow(dead_code)]
pub(crate) static INCONSISTENT_ENUM_VALUE_FOR_INPUT_ENUM: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_ENUM_VALUE_FOR_INPUT_ENUM",
            HintLevel::Warn,
            "Enum value for input enum is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_ENUM_VALUE_FOR_OUTPUT_ENUM: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_ENUM_VALUE_FOR_OUTPUT_ENUM",
            HintLevel::Warn,
            "Enum value for output enum is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_TYPE_SYSTEM_DIRECTIVE_REPEATABLE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_TYPE_SYSTEM_DIRECTIVE_REPEATABLE",
            HintLevel::Warn,
            "Type system directive repeatable property is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_TYPE_SYSTEM_DIRECTIVE_LOCATIONS: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_TYPE_SYSTEM_DIRECTIVE_LOCATIONS",
            HintLevel::Warn,
            "Type system directive locations are inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_EXECUTABLE_DIRECTIVE_PRESENCE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_EXECUTABLE_DIRECTIVE_PRESENCE",
            HintLevel::Warn,
            "Executable directive presence is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static NO_EXECUTABLE_DIRECTIVE_LOCATIONS_INTERSECTION: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "NO_EXECUTABLE_DIRECTIVE_LOCATIONS_INTERSECTION",
            HintLevel::Warn,
            "No intersection between executable directive locations across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_EXECUTABLE_DIRECTIVE_REPEATABLE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_EXECUTABLE_DIRECTIVE_REPEATABLE",
            HintLevel::Warn,
            "Executable directive repeatable property is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_EXECUTABLE_DIRECTIVE_LOCATIONS: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_EXECUTABLE_DIRECTIVE_LOCATIONS",
            HintLevel::Warn,
            "Executable directive locations are inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static INCONSISTENT_DESCRIPTION: LazyLock<HintCodeDefinition> = LazyLock::new(|| {
    HintCodeDefinition::new(
        "INCONSISTENT_DESCRIPTION",
        HintLevel::Warn,
        "Description is inconsistent across subgraphs",
    )
});

#[allow(dead_code)]
pub(crate) static INCONSISTENT_ARGUMENT_PRESENCE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_ARGUMENT_PRESENCE",
            HintLevel::Warn,
            "Argument presence is inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static FROM_SUBGRAPH_DOES_NOT_EXIST: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "FROM_SUBGRAPH_DOES_NOT_EXIST",
            HintLevel::Warn,
            "From subgraph does not exist",
        )
    });

#[allow(dead_code)]
pub(crate) static OVERRIDDEN_FIELD_CAN_BE_REMOVED: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "OVERRIDDEN_FIELD_CAN_BE_REMOVED",
            HintLevel::Info,
            "Overridden field can be removed",
        )
    });

#[allow(dead_code)]
pub(crate) static OVERRIDE_DIRECTIVE_CAN_BE_REMOVED: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "OVERRIDE_DIRECTIVE_CAN_BE_REMOVED",
            HintLevel::Info,
            "Override directive can be removed",
        )
    });

#[allow(dead_code)]
pub(crate) static OVERRIDE_MIGRATION_IN_PROGRESS: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "OVERRIDE_MIGRATION_IN_PROGRESS",
            HintLevel::Info,
            "Override migration is in progress",
        )
    });

#[allow(dead_code)]
pub(crate) static UNUSED_ENUM_TYPE: LazyLock<HintCodeDefinition> = LazyLock::new(|| {
    HintCodeDefinition::new("UNUSED_ENUM_TYPE", HintLevel::Warn, "Enum type is unused")
});

#[allow(dead_code)]
pub(crate) static INCONSISTENT_NON_REPEATABLE_DIRECTIVE_ARGUMENTS: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_NON_REPEATABLE_DIRECTIVE_ARGUMENTS",
            HintLevel::Warn,
            "Non-repeatable directive arguments are inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static MERGED_NON_REPEATABLE_DIRECTIVE_ARGUMENTS: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "MERGED_NON_REPEATABLE_DIRECTIVE_ARGUMENTS",
            HintLevel::Info,
            "Non-repeatable directive arguments have been merged",
        )
    });

#[allow(dead_code)]
pub(crate) static DIRECTIVE_COMPOSITION_INFO: LazyLock<HintCodeDefinition> = LazyLock::new(|| {
    HintCodeDefinition::new(
        "DIRECTIVE_COMPOSITION_INFO",
        HintLevel::Info,
        "Directive composition information",
    )
});

#[allow(dead_code)]
pub(crate) static DIRECTIVE_COMPOSITION_WARN: LazyLock<HintCodeDefinition> = LazyLock::new(|| {
    HintCodeDefinition::new(
        "DIRECTIVE_COMPOSITION_WARN",
        HintLevel::Warn,
        "Directive composition warning",
    )
});

#[allow(dead_code)]
pub(crate) static INCONSISTENT_RUNTIME_TYPES_FOR_SHAREABLE_RETURN: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INCONSISTENT_RUNTIME_TYPES_FOR_SHAREABLE_RETURN",
            HintLevel::Warn,
            "Runtime types for shareable return are inconsistent across subgraphs",
        )
    });

#[allow(dead_code)]
pub(crate) static IMPLICITLY_UPGRADED_FEDERATION_VERSION: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "IMPLICITLY_UPGRADED_FEDERATION_VERSION",
            HintLevel::Info,
            "Federation version has been implicitly upgraded",
        )
    });

#[allow(dead_code)]
pub(crate) static CONTEXTUAL_ARGUMENT_NOT_CONTEXTUAL_IN_ALL_SUBGRAPHS: LazyLock<
    HintCodeDefinition,
> = LazyLock::new(|| {
    HintCodeDefinition::new(
        "CONTEXTUAL_ARGUMENT_NOT_CONTEXTUAL_IN_ALL_SUBGRAPHS",
        HintLevel::Warn,
        "Contextual argument is not contextual in all subgraphs",
    )
});

#[allow(dead_code)]
pub(crate) static INTERFACE_KEY_MISSING_IMPLEMENTATION_TYPE: LazyLock<HintCodeDefinition> =
    LazyLock::new(|| {
        HintCodeDefinition::new(
            "INTERFACE_KEY_MISSING_IMPLEMENTATION_TYPE",
            HintLevel::Warn,
            "Interface key missing implementation type",
        )
    });