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
use apollo_compiler::Name;
use apollo_compiler::Node;
use apollo_compiler::ast;
use apollo_compiler::ast::Directive;
use apollo_compiler::ast::Value;
use apollo_compiler::collections::HashMap;
use apollo_compiler::name;
use apollo_compiler::schema::DirectiveList;
use apollo_compiler::schema::EnumType;
use apollo_compiler::schema::ExtendedType;
use apollo_compiler::schema::InputObjectType;
use apollo_compiler::schema::ScalarType;
use itertools::Itertools;
use multimap::MultiMap;

use crate::error::FederationError;
use crate::schema::FederationSchema;
use crate::schema::position::EnumTypeDefinitionPosition;
use crate::schema::position::InputObjectTypeDefinitionPosition;
use crate::schema::position::ScalarTypeDefinitionPosition;

/// merge.rs doesn't have any logic for `@composeDirective` directives, so we
/// need to carry those directives AND their associated input types over into
/// the new supergraph.
///
/// However, we can't just copy the definitions as-is, because their join__*
/// directives may reference subgraphs that no longer exist (were replaced by
/// "expanded" subgraphs/connectors). Each time we encounter a join__* directive
/// with a `graph:` argument referring to a missing subgraph, we'll need to
/// replace it with **one or more** new directives, one for each "expanded"
/// subgraph.
pub(super) fn copy_input_types(
    from: &FederationSchema,
    to: &mut FederationSchema,
    subgraph_enum_replacements: &MultiMap<Name, Name>,
) -> Result<(), FederationError> {
    for (name, ty) in &from.schema().types {
        if to.schema().types.contains_key(name) {
            continue;
        }
        match ty {
            ExtendedType::Scalar(node) => {
                let references = from.referencers().scalar_types.get(name);
                if references.is_none_or(|refs| refs.len() == 0) {
                    continue;
                }

                let pos = ScalarTypeDefinitionPosition {
                    type_name: node.name.clone(),
                };
                let node =
                    strip_invalid_join_directives_from_scalar(node, subgraph_enum_replacements);
                pos.pre_insert(to).ok();
                pos.insert(to, node).ok();
            }
            ExtendedType::Enum(node) => {
                let references = from.referencers().enum_types.get(name);
                if references.is_none_or(|refs| refs.len() == 0) {
                    continue;
                }

                let pos = EnumTypeDefinitionPosition {
                    type_name: node.name.clone(),
                };
                let node =
                    strip_invalid_join_directives_from_enum(node, subgraph_enum_replacements);
                pos.pre_insert(to).ok();
                pos.insert(to, node).ok();
            }
            ExtendedType::InputObject(node) => {
                let references = from.referencers().input_object_types.get(name);
                if references.is_none_or(|refs| refs.len() == 0) {
                    continue;
                }

                let pos = InputObjectTypeDefinitionPosition {
                    type_name: node.name.clone(),
                };
                let node =
                    strip_invalid_join_directives_from_input_type(node, subgraph_enum_replacements);
                pos.pre_insert(to).ok();
                pos.insert(to, node).ok();
            }
            _ => {}
        }
    }

    Ok(())
}

/// Given an original join__Graph enum:
/// ```graphql
/// enum join__Graph {
///  REGULAR_SUBGRAPH @join__graph(name: "regular-subgraph")
///  CONNECTORS_SUBGRAPH @join__graph(name: "connectors-subgraph")
/// }
/// ```
///
/// and a new join__Graph enum:
/// ```graphql
/// enum join__Graph {
///  REGULAR_SUBGRAPH @join__graph(name: "regular-subgraph")
///  CONNECTORS_SUBGRAPH_QUERY_USER_0 @join__graph(name: "connectors-subgraph_Query_user_0")
///  CONNECTORS_SUBGRAPH_QUERY_USERS_0 @join__graph(name: "connectors-subgraph_Query_users_0")
/// }
/// ```
///
/// and a map of original subgraph names to new subgraph names:
/// ```ignore
/// {
///   "connectors-subgraph" => vec!["connectors-subgraph_Query_user_0", "connectors-subgraph_Query_users_0"]
/// }
/// ```
///
/// Return a map of enum value replacements:
/// ```ignore
/// {
///   "CONNECTORS_SUBGRAPH" => vec!["CONNECTORS_SUBGRAPH_QUERY_USER_0", "CONNECTORS_SUBGRAPH_QUERY_USERS_0"],
/// }
/// ```
pub(super) fn subgraph_replacements(
    from_join_graph_enum: &EnumType,
    to_join_graph_enum: &EnumType,
    replaced_subgraph_names: &MultiMap<&str, String>,
) -> Result<MultiMap<Name, Name>, String> {
    let mut replacements = MultiMap::new();

    fn subgraph_names_to_enum_values(enum_type: &EnumType) -> Result<HashMap<&str, &Name>, &str> {
        enum_type
            .values
            .iter()
            .map(|(name, value)| {
                value
                    .directives
                    .iter()
                    .find(|d| d.name == name!(join__graph))
                    .and_then(|d| {
                        d.arguments
                            .iter()
                            .find(|a| a.name == name!(name))
                            .and_then(|a| a.value.as_str())
                    })
                    .ok_or("no name argument on join__graph")
                    .map(|new_subgraph_name| (new_subgraph_name, name))
            })
            .try_collect()
    }

    let new_subgraph_names_to_enum_values = subgraph_names_to_enum_values(to_join_graph_enum)?;

    let original_subgraph_names_to_enum_values =
        subgraph_names_to_enum_values(from_join_graph_enum)?;

    for (original_subgraph_name, new_subgraph_names) in replaced_subgraph_names.iter_all() {
        if let Some(original_enum_value) = original_subgraph_names_to_enum_values
            .get(original_subgraph_name)
            .cloned()
        {
            for new_subgraph_name in new_subgraph_names {
                if let Some(new_enum_value) = new_subgraph_names_to_enum_values
                    .get(new_subgraph_name.as_str())
                    .cloned()
                {
                    replacements.insert(original_enum_value.clone(), new_enum_value.clone());
                }
            }
        }
    }

    Ok(replacements)
}

pub(super) fn subgraph_names_to_enum_values(
    enum_type: &EnumType,
) -> Result<HashMap<&str, &Name>, &str> {
    enum_type
        .values
        .iter()
        .map(|(name, value)| {
            value
                .directives
                .iter()
                .find(|d| d.name == name!(join__graph))
                .and_then(|d| {
                    d.arguments
                        .iter()
                        .find(|a| a.name == name!(name))
                        .and_then(|a| a.value.as_str())
                })
                .ok_or("no name argument on join__graph")
                .map(|new_subgraph_name| (new_subgraph_name, name))
        })
        .try_collect()
}

/// Given a list of directives and a directive name like `@join__type` or `@join__enumValue`,
/// replace the `graph:` argument with a new directive for each subgraph name in the
/// `replaced_subgraph_names` map.
fn replace_join_enum(
    directives: &DirectiveList,
    directive_name: &Name,
    replaced_subgraph_names: &MultiMap<Name, Name>,
) -> DirectiveList {
    let mut new_directives = DirectiveList::new();
    for d in directives.iter() {
        if &d.name == directive_name {
            let Some(graph_arg) = d
                .arguments
                .iter()
                .find(|a| a.name == name!(graph))
                .and_then(|a| a.value.as_enum())
            else {
                continue;
            };

            let Some(replacements) = replaced_subgraph_names.get_vec(graph_arg) else {
                new_directives.push(d.clone());
                continue;
            };

            for replacement in replacements {
                let mut new_directive = d.clone();
                let new_directive = new_directive.make_mut();
                if let Some(a) = new_directive
                    .arguments
                    .iter_mut()
                    .find(|a| a.name == name!(graph))
                {
                    let a = a.make_mut();
                    a.value = Value::Enum(replacement.clone()).into();
                };
                new_directives.push(new_directive.clone());
            }
        } else {
            new_directives.push(d.clone());
        }
    }
    new_directives
}

/// Unfortunately, there are two different DirectiveList types, so this
/// function is duplicated.
fn replace_join_enum_ast(
    directives: &ast::DirectiveList,
    directive_name: &Name,
    replaced_subgraph_names: &MultiMap<Name, Name>,
) -> ast::DirectiveList {
    let mut new_directives = ast::DirectiveList::new();
    for d in directives.iter() {
        if &d.name == directive_name {
            let Some(graph_arg) = d
                .arguments
                .iter()
                .find(|a| a.name == name!(graph))
                .and_then(|a| a.value.as_enum())
            else {
                continue;
            };

            let Some(replacements) = replaced_subgraph_names.get_vec(graph_arg) else {
                new_directives.push(d.clone());
                continue;
            };

            for replacement in replacements {
                let mut new_directive = d.clone();
                let new_directive = new_directive.make_mut();
                if let Some(a) = new_directive
                    .arguments
                    .iter_mut()
                    .find(|a| a.name == name!(graph))
                {
                    let a = a.make_mut();
                    a.value = Value::Enum(replacement.clone()).into();
                };
                new_directives.push(new_directive.clone());
            }
        } else {
            new_directives.push(d.clone());
        }
    }
    new_directives
}

fn strip_invalid_join_directives_from_input_type(
    node: &InputObjectType,
    replaced_subgraph_names: &MultiMap<Name, Name>,
) -> Node<InputObjectType> {
    let mut node = node.clone();

    node.directives = replace_join_enum(
        &node.directives,
        &name!(join__type),
        replaced_subgraph_names,
    );

    for (_, field) in node.fields.iter_mut() {
        let field = field.make_mut();
        field.directives = replace_join_enum_ast(
            &field.directives,
            &name!(join__field),
            replaced_subgraph_names,
        );
    }

    node.into()
}

fn strip_invalid_join_directives_from_enum(
    node: &EnumType,
    replaced_subgraph_names: &MultiMap<Name, Name>,
) -> Node<EnumType> {
    let mut node = node.clone();

    node.directives = replace_join_enum(
        &node.directives,
        &name!(join__type),
        replaced_subgraph_names,
    );

    for (_, value) in node.values.iter_mut() {
        let value = value.make_mut();
        value.directives = replace_join_enum_ast(
            &value.directives,
            &name!(join__enumValue),
            replaced_subgraph_names,
        );
    }
    node.into()
}

fn strip_invalid_join_directives_from_scalar(
    node: &ScalarType,
    replaced_subgraph_names: &MultiMap<Name, Name>,
) -> Node<ScalarType> {
    let mut node = node.clone();

    node.directives = replace_join_enum(
        &node.directives,
        &name!(join__type),
        replaced_subgraph_names,
    );

    node.into()
}

const JOIN_DIRECTIVE_GRAPHS_ARGUMENT_NAME: Name = name!(graphs);

/// Given a @join__directive, this will replace the original subgraph name with
/// the "subgraphs" generated for each connector in the "expansion" process.
///
/// @join__directive(graphs: [CONNECTORS])
/// becomes
/// @join__directive(graphs: [CONNECTORS_QUERY_FOO_0, CONNECTORS_QUERY_FOO_1])
///
/// We don't want to include directives to the connect spec.
pub(super) fn replace_join_directive_graphs_argument(
    directive: &Node<Directive>,
    replaced_subgraph_names: &MultiMap<Name, Name>,
    connect_directive_names: &HashMap<&str, [Name; 2]>,
) -> Option<Node<Directive>> {
    // Get the graphs argument (which should be a list)
    let Some(graphs_list) = directive
        .arguments
        .iter()
        .find(|a| a.name == JOIN_DIRECTIVE_GRAPHS_ARGUMENT_NAME)
        .and_then(|a| a.value.as_list())
    else {
        // No graphs argument or not a list, return as-is
        return Some(directive.clone());
    };

    // Process each enum value in the graphs list
    let mut new_graph_values = Vec::new();
    for graph_value in graphs_list {
        if let Some(graph_enum) = graph_value.as_enum() {
            // if the serialized directive is a connect or source directive in
            // this subgraph (considering renames), then we'll skip this entirely
            if let Some(names_to_ignore) = connect_directive_names.get(graph_enum.as_str()) {
                let names_to_ignore: Vec<&str> =
                    names_to_ignore.iter().map(|n| n.as_str()).collect();
                if directive
                    .specified_argument_by_name("name")
                    .and_then(|v| v.as_str())
                    .map(|v| names_to_ignore.contains(&v))
                    .unwrap_or(false)
                {
                    return None;
                }
            }

            // Check if this graph needs replacement
            if let Some(replacements) = replaced_subgraph_names.get_vec(graph_enum) {
                // Add all replacement values
                for replacement in replacements {
                    new_graph_values.push(Node::new(Value::Enum(replacement.clone())));
                }
            } else {
                // Keep the original value
                new_graph_values.push(graph_value.clone());
            }
        } else {
            // Not an enum value, keep as-is (shouldn't happen in valid schema)
            new_graph_values.push(graph_value.clone());
        }
    }

    // If the graphs list is empty after processing, don't carry over the directive.
    // This filters out the buggy @join__directive(graphs: [], name: "link", ...)
    // that was created by the license enforcement code before our fix.
    // The correct directive with populated graphs will be created separately.
    if new_graph_values.is_empty() {
        return None;
    }

    // Create a new directive with the updated graphs argument
    let mut new_directive = directive.clone();
    if let Some(graphs_arg) = new_directive
        .make_mut()
        .arguments
        .iter_mut()
        .find(|a| a.name == JOIN_DIRECTIVE_GRAPHS_ARGUMENT_NAME)
    {
        let graphs_arg = graphs_arg.make_mut();
        graphs_arg.value = Value::List(new_graph_values).into();
    }

    Some(new_directive)
}