graphql-composition 0.12.2

An implementation of GraphQL federated schema composition
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

use super::*;

/// Schemas linked with `@link`.
#[derive(Default)]
pub(crate) struct LinkedSchemas {
    pub(super) schemas: Vec<LinkedSchemaRecord>,
    namespaces: HashMap<(SubgraphId, StringId), LinkedSchemaId>,
    /// Directives that have been `@import`ed, and can be used with their unqualified, maybe aliased name.
    pub(super) definitions: Vec<LinkedDefinitionRecord>,
    imported_definitions_by_name: HashMap<(SubgraphId, StringId), LinkedDefinitionId>,
}

/// A schema imported with `@link`.
pub(crate) struct LinkedSchemaRecord {
    /// The subgraph where the schema is @link'ed (imported).
    pub(crate) subgraph_id: SubgraphId,
    /// See [LinkedSchemaType]
    pub(crate) linked_schema_type: LinkedSchemaType,
    /// The url of the schema.
    pub(crate) url: StringId,
    pub(crate) name_from_url: Option<StringId>,
    /// The namespace this schema is linked as.
    pub(crate) r#as: Option<StringId>,
}

#[derive(Debug, Clone, Copy)]
pub(crate) enum LinkedSchemaType {
    FederationSpec(FederationSpec),
    Other,
}

impl LinkedSchemaRecord {
    /// The prefix for the qualified imports from this schema. This can be None, when the url is not a url, or it doesn't have a path segment representing the name, and no `as:` argument is provided. The definitions linked from that `@link()` are then not addressable.
    pub(crate) fn namespace(&self) -> Option<StringId> {
        self.r#as.or(self.name_from_url)
    }
}

/// A definition from a schema imported with `@link`.
pub(crate) struct LinkedDefinitionRecord {
    pub(crate) linked_schema_id: LinkedSchemaId,
    pub(crate) original_name: StringId,
    pub(crate) imported_as: Option<StringId>,
}

impl LinkedDefinitionRecord {
    pub(crate) fn final_name(&self) -> StringId {
        self.imported_as.unwrap_or(self.original_name)
    }
}

pub(crate) type LinkedSchema<'a> = View<'a, LinkedSchemaId, LinkedSchemaRecord>;

impl Subgraphs {
    pub(crate) fn iter_linked_schemas(&self) -> impl ExactSizeIterator<Item = LinkedSchema<'_>> {
        self.linked_schemas
            .schemas
            .iter()
            .enumerate()
            .map(|(idx, record)| View { id: idx.into(), record })
    }

    pub(crate) fn get_linked_schema(&self, subgraph_id: SubgraphId, namespace: StringId) -> Option<LinkedSchemaId> {
        self.linked_schemas.namespaces.get(&(subgraph_id, namespace)).copied()
    }

    pub(crate) fn get_imported_definition(
        &self,
        subgraph_id: SubgraphId,
        name: StringId,
    ) -> Option<LinkedDefinitionId> {
        self.linked_schemas
            .imported_definitions_by_name
            .get(&(subgraph_id, name))
            .copied()
    }

    pub(crate) fn push_linked_definition(
        &mut self,
        subgraph_id: SubgraphId,
        linked_definition: LinkedDefinitionRecord,
    ) -> LinkedDefinitionId {
        let id = LinkedDefinitionId::from(self.linked_schemas.definitions.len());

        self.linked_schemas
            .imported_definitions_by_name
            .insert((subgraph_id, linked_definition.final_name()), id);

        self.linked_schemas.definitions.push(linked_definition);

        id
    }

    pub(crate) fn push_linked_schema(&mut self, linked_schema: LinkedSchemaRecord) -> LinkedSchemaId {
        let id = LinkedSchemaId::from(self.linked_schemas.schemas.len());

        if let Some(namespace) = linked_schema.namespace() {
            let previous = self
                .linked_schemas
                .namespaces
                .insert((linked_schema.subgraph_id, namespace), id);

            if previous.is_some() {
                self.ingestion_diagnostics.push_warning(format!(
                    "Linked schema namespace collision for subgraph {}: the \"{}\" namespace is defined at least twice",
                    self[self[linked_schema.subgraph_id].name], self[namespace],
                ));
            }
        }

        let url = self.strings.resolve(linked_schema.url);
        if let Some(federation_spec) = FederationSpec::from_url(url) {
            let existing = &mut self[linked_schema.subgraph_id].federation_spec;
            *existing = (*existing).max(federation_spec);
        }

        self.linked_schemas.schemas.push(linked_schema);

        id
    }
}