@theguild/federation-composition 0.6.2 → 0.7.0-alpha-20240104152841-c814a1f

package/README.md

@@ -196,6 +196,7 @@ Your feedback and bug reports are welcome and appreciated.
 - [ ] `SHAREABLE_HAS_MISMATCHED_RUNTIME_TYPES`
 - [ ] `UNSUPPORTED_FEATURE`
 - [ ] `UNSUPPORTED_LINKED_FEATURE`
+- [ ] `TYPE_WITH_ONLY_UNUSED_EXTERNAL`
 - [ ] `SATISFIABILITY_ERROR` - deeply nested key fields
 - [ ] `SATISFIABILITY_ERROR` - fragments in keys
 - [ ] `SATISFIABILITY_ERROR` - support interfaces... (kill me)

package/cjs/graphql/sort-sdl.js

@@ -33,6 +33,7 @@ function sortSDL(doc) {
                     ...node,
                     directives: sortNodes(node.directives),
                     fields: sortNodes(node.fields),
+                    interfaces: sortNodes(node.interfaces),
                 };
             },
             InterfaceTypeDefinition(node) {

package/cjs/subgraph/helpers.js

@@ -138,7 +138,8 @@ function visitFields({ context, selectionSet, typeDefinition, interceptField, in
             }
             break;
         }
-        if (interceptDirective && selection.directives?.length) {
+        const isTypename = selection.name.value === '__typename';
+        if (!isTypename && interceptDirective && selection.directives?.length) {
             for (const directive of selection.directives) {
                 interceptDirective({
                     directiveName: directive.name.value,
@@ -146,21 +147,23 @@ function visitFields({ context, selectionSet, typeDefinition, interceptField, in
                 });
             }
         }
-        context.markAsUsed('fields', typeDefinition.kind, typeDefinition.name.value, selectionFieldDef.name.value);
-        if (interceptField) {
+        if (!isTypename) {
+            context.markAsUsed('fields', typeDefinition.kind, typeDefinition.name.value, selectionFieldDef.name.value);
+        }
+        if (!isTypename && interceptField) {
             interceptField({
                 typeDefinition,
                 fieldName: selection.name.value,
             });
         }
-        if (selectionFieldDef.arguments?.length && interceptArguments) {
+        if (!isTypename && selectionFieldDef.arguments?.length && interceptArguments) {
             interceptArguments({
                 typeDefinition,
                 fieldName: selection.name.value,
             });
             continue;
         }
-        if (interceptNonExternalField || interceptExternalField) {
+        if (!isTypename && (interceptNonExternalField || interceptExternalField)) {
             const isExternal = selectionFieldDef.directives?.some(d => context.isAvailableFederationDirective('external', d));
             const fieldName = selection.name.value;
             const fieldDef = typeDefinition.fields?.find(field => field.name.value === fieldName);
@@ -189,7 +192,8 @@ function visitFields({ context, selectionSet, typeDefinition, interceptField, in
         if (!innerTypeDef) {
             continue;
         }
-        if (interceptInterfaceType &&
+        if (!isTypename &&
+            interceptInterfaceType &&
             (innerTypeDef.kind === graphql_1.Kind.INTERFACE_TYPE_DEFINITION ||
                 innerTypeDef.kind === graphql_1.Kind.INTERFACE_TYPE_EXTENSION)) {
             interceptInterfaceType({
@@ -212,9 +216,13 @@ function visitFields({ context, selectionSet, typeDefinition, interceptField, in
             context,
             selectionSet: innerSelection,
             typeDefinition: innerTypeDef,
+            interceptField,
             interceptArguments,
             interceptUnknownField,
             interceptInterfaceType,
+            interceptDirective,
+            interceptExternalField,
+            interceptFieldWithMissingSelectionSet,
         });
     }
 }

package/cjs/subgraph/validation/rules/elements/key.js

@@ -39,17 +39,37 @@ function KeyRules(context) {
             }
             const printedFieldsValue = (0, printer_js_1.print)(fieldsArg.value);
             if (fieldsArg.value.kind !== graphql_1.Kind.STRING) {
-                context.reportError(new graphql_1.GraphQLError(`On type "${typeCoordinate}", for @key(fields: ${printedFieldsValue}): Invalid value for argument "fields": must be a string.`, {
-                    nodes: directiveNode,
-                    extensions: {
-                        code: 'KEY_INVALID_FIELDS_TYPE',
-                    },
-                }));
-                return;
+                const isListWithStrings = fieldsArg.value.kind === graphql_1.Kind.LIST &&
+                    fieldsArg.value.values.every(value => value.kind === graphql_1.Kind.STRING);
+                if (context.satisfiesVersionRange('> v1.0') || !isListWithStrings) {
+                    context.reportError(new graphql_1.GraphQLError(`On type "${typeCoordinate}", for @key(fields: ${printedFieldsValue}): Invalid value for argument "fields": must be a string.`, {
+                        nodes: directiveNode,
+                        extensions: {
+                            code: 'KEY_INVALID_FIELDS_TYPE',
+                        },
+                    }));
+                    return;
+                }
             }
             let selectionSet;
+            let normalizedFieldsArgValue = fieldsArg.value.kind === graphql_1.Kind.STRING
+                ? fieldsArg.value
+                : ({
+                    kind: graphql_1.Kind.STRING,
+                    value: fieldsArg.value.values
+                        .map(v => {
+                        if (v.kind !== graphql_1.Kind.STRING) {
+                            throw new Error('Expected fields argument value to be a string');
+                        }
+                        return v.value;
+                    })
+                        .join(' '),
+                });
+            if (normalizedFieldsArgValue.kind !== graphql_1.Kind.STRING) {
+                throw new Error('Expected fields argument value to be a string');
+            }
             try {
-                selectionSet = (0, helpers_js_1.parseFields)(fieldsArg.value.value);
+                selectionSet = (0, helpers_js_1.parseFields)(normalizedFieldsArgValue.value);
             }
             catch (error) {
                 if (error instanceof graphql_1.GraphQLError) {
@@ -112,7 +132,7 @@ function KeyRules(context) {
                 },
             });
             if (usedOnInterface) {
-                const expectedFieldsValue = fieldsArg.value.value;
+                const expectedFieldsValue = normalizedFieldsArgValue.value;
                 knownObjectsAndInterfaces.forEach(def => {
                     if (def.interfaces?.some(i => i.name.value === typeDef.name.value)) {
                         let shouldError = true;
@@ -141,10 +161,10 @@ function KeyRules(context) {
                 const resolvableArgValue = directiveNode.arguments?.find(arg => arg.name.value === 'resolvable' && arg.value.kind === graphql_1.Kind.BOOLEAN)?.value;
                 const resolvable = resolvableArgValue?.value ?? true;
                 if (usedOnInterface) {
-                    context.stateBuilder.interfaceType.setKey(typeDef.name.value, fieldsArg.value.value, fieldsUsedInKey, resolvable);
+                    context.stateBuilder.interfaceType.setKey(typeDef.name.value, normalizedFieldsArgValue.value, fieldsUsedInKey, resolvable);
                     return;
                 }
-                context.stateBuilder.objectType.setKey(typeDef.name.value, fieldsArg.value.value, fieldsUsedInKey, resolvable);
+                context.stateBuilder.objectType.setKey(typeDef.name.value, normalizedFieldsArgValue.value, fieldsUsedInKey, resolvable);
             }
         },
     };

package/cjs/subgraph/validation/rules/elements/provides.js

@@ -114,9 +114,6 @@ function ProvidesRules(context) {
                     }));
                 },
                 interceptExternalField(info) {
-                    if (context.satisfiesVersionRange('< v2.0')) {
-                        return;
-                    }
                     const keyDirectives = info.typeDefinition.directives?.filter(directive => context.isAvailableFederationDirective('key', directive));
                     if (!keyDirectives?.length) {
                         return;
@@ -157,14 +154,17 @@ function ProvidesRules(context) {
                                         }
                                         if (info.typeDefinition.kind === graphql_1.Kind.OBJECT_TYPE_DEFINITION ||
                                             info.typeDefinition.kind === graphql_1.Kind.OBJECT_TYPE_EXTENSION) {
-                                            context.stateBuilder.objectType.field.markAsProvided(info.typeDefinition.name.value, info.fieldName);
+                                            if (info.fieldName !== '__typename') {
+                                                context.stateBuilder.objectType.field.markAsProvided(info.typeDefinition.name.value, info.fieldName);
+                                            }
                                         }
                                     },
                                 });
                             }
                         }
                     }
-                    if (interceptedFieldIsPrimaryKeyFromExtension) {
+                    if (context.satisfiesVersionRange('>= v2.0') &&
+                        interceptedFieldIsPrimaryKeyFromExtension) {
                         isValid = false;
                         context.reportError(new graphql_1.GraphQLError(`On field "${fieldCoordinate}", for @provides(fields: ${printedFieldsValue}): field "${info.typeDefinition.name.value}.${info.fieldName}" should not be part of a @provides since it is already "effectively" provided by this subgraph (while it is marked @external, it is a @key field of an extension type, which are not internally considered external for historical/backward compatibility reasons)`, {
                             extensions: {

package/cjs/subgraph/validation/rules/elements/requires.js

@@ -81,7 +81,9 @@ function RequiresRules(context) {
                 interceptField(info) {
                     if (info.typeDefinition.kind === graphql_1.Kind.OBJECT_TYPE_DEFINITION ||
                         info.typeDefinition.kind === graphql_1.Kind.OBJECT_TYPE_EXTENSION) {
-                        context.stateBuilder.objectType.field.markedAsRequired(info.typeDefinition.name.value, info.fieldName);
+                        if (info.fieldName !== '__typename') {
+                            context.stateBuilder.objectType.field.markedAsRequired(info.typeDefinition.name.value, info.fieldName);
+                        }
                     }
                 },
                 interceptUnknownField(info) {

package/cjs/subgraph/validation/rules/known-directives-rule.js

@@ -11,7 +11,9 @@ function KnownDirectivesRule(context) {
         }
     }
     for (const specifiedDirective of graphql_1.specifiedDirectives) {
-        locationsMap.set(specifiedDirective.name, new Set(specifiedDirective.locations.map(loc => String(loc))));
+        if (!locationsMap.has(specifiedDirective.name)) {
+            locationsMap.set(specifiedDirective.name, new Set(specifiedDirective.locations.map(loc => String(loc))));
+        }
     }
     return {
         Directive(node, _key, _parent, _path, ancestors) {

package/cjs/subgraph/validation/rules/provided-arguments-on-directives-rule.js

@@ -28,6 +28,12 @@ function ProvidedArgumentsOnDirectivesRule(context) {
                                 continue;
                             }
                             if (printedType !== 'Any' && printedType !== printedValue) {
+                                if (printedValue === '[]') {
+                                    if (argDefinition.type.kind === graphql_1.Kind.LIST_TYPE &&
+                                        argDefinition.type.type.kind !== graphql_1.Kind.NON_NULL_TYPE) {
+                                        continue;
+                                    }
+                                }
                                 const namedType = (0, helpers_js_1.namedTypeFromTypeNode)(argDefinition.type);
                                 const typeName = namedType.name.value;
                                 if (printedValue === 'Int' && typeName === 'Float') {

package/cjs/subgraph/validation/validate-state.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isUnionType = exports.isInterfaceType = exports.isObjectType = exports.isEnumType = exports.isScalarType = exports.isInputObjectType = exports.typeExists = exports.isInputType = exports.isTypeSubTypeOf = exports.validateSubgraphState = void 0;
+exports.isDirective = exports.isUnionType = exports.isInterfaceType = exports.isObjectType = exports.isEnumType = exports.isScalarType = exports.isInputObjectType = exports.typeExists = exports.isInputType = exports.isTypeSubTypeOf = exports.validateSubgraphState = void 0;
 const graphql_1 = require("graphql");
 const format_js_1 = require("../../utils/format.js");
 const state_js_1 = require("../../utils/state.js");
@@ -16,6 +16,7 @@ function validateSubgraphState(state) {
         }));
     }
     validateRootTypes(state, reportError);
+    validateDirectives(state, reportError);
     validateTypes(state, reportError);
     return errors;
 }
@@ -57,6 +58,24 @@ function validateRootTypes(state, reportError) {
 function capitalize(str) {
     return str.charAt(0).toUpperCase() + str.slice(1).toLowerCase();
 }
+function validateDirectives(state, reportError) {
+    for (const directive of state.types.values()) {
+        if (isDirective(directive)) {
+            validateName(reportError, directive.name);
+            for (const [argName, arg] of directive.args) {
+                validateName(reportError, argName);
+                const argInputTypeName = (0, state_js_1.stripTypeModifiers)(arg.type);
+                if (!isInputType(state, argInputTypeName)) {
+                    reportError(`The type of @${directive.name}(${arg.name}:) must be Input Type ` +
+                        `but got: ${arg.type}.`);
+                }
+                if (isRequiredArgument(arg) && arg.deprecated?.deprecated === true) {
+                    reportError(`Required argument @${directive.name}(${arg.name}:) cannot be deprecated.`);
+                }
+            }
+        }
+    }
+}
 function validateTypes(state, reportError) {
     const validateInputObjectCircularRefs = createInputObjectCircularRefsValidator(state, reportError);
     const implementationsMap = new Map();
@@ -474,3 +493,7 @@ function isUnionType(type) {
     return type.kind === state_js_2.TypeKind.UNION;
 }
 exports.isUnionType = isUnionType;
+function isDirective(type) {
+    return type.kind === state_js_2.TypeKind.DIRECTIVE;
+}
+exports.isDirective = isDirective;

package/cjs/subgraph/validation/validate-subgraph.js

@@ -62,6 +62,33 @@ function validateSubgraphCore(subgraph) {
 exports.validateSubgraphCore = validateSubgraphCore;
 function validateSubgraph(subgraph, stateBuilder, federation, __internal) {
     subgraph.typeDefs = cleanSubgraphTypeDefsFromSubgraphSpec(subgraph.typeDefs);
+    const linkSpecDefinitions = (0, graphql_1.parse)(`
+    enum Purpose {
+      EXECUTION
+      SECURITY
+    }
+
+    directive @link(
+      url: String
+      as: String
+      for: link__Purpose
+      import: [link__Import]
+    ) repeatable on SCHEMA
+
+    scalar link__Import
+
+    enum link__Purpose {
+      """
+      \`SECURITY\` features provide metadata necessary to securely resolve fields.
+      """
+      SECURITY
+
+      """
+      \`EXECUTION\` features provide metadata necessary for operation execution.
+      """
+      EXECUTION
+    }
+  `).definitions;
     const rulesToSkip = __internal?.disableValidationRules ?? [];
     const typeNodeInfo = new type_node_info_js_1.TypeNodeInfo();
     const validationContext = (0, validation_context_js_1.createSubgraphValidationContext)(subgraph, federation, typeNodeInfo, stateBuilder);
@@ -111,6 +138,12 @@ function validateSubgraph(subgraph, stateBuilder, federation, __internal) {
         return rule(validationContext);
     })))));
     const federationDefinitionReplacements = validationContext.collectFederationDefinitionReplacements();
+    const linkSpecDefinitionsToInclude = linkSpecDefinitions.filter(def => {
+        if ('name' in def && typeof def.name?.value === 'string') {
+            return !stateBuilder.state.types.has(def.name.value);
+        }
+        return true;
+    });
     const fullTypeDefs = (0, graphql_1.concatAST)([
         {
             kind: graphql_1.Kind.DOCUMENT,
@@ -120,33 +153,12 @@ function validateSubgraph(subgraph, stateBuilder, federation, __internal) {
         },
         validationContext.satisfiesVersionRange('> v1.0') && !stateBuilder.state.specs.link
             ?
-                (0, graphql_1.parse)(`
-            enum Purpose {
-              EXECUTION
-              SECURITY
-            }
-
-            directive @link(
-              url: String
-              as: String
-              for: link__Purpose
-              import: [link__Import]
-            ) repeatable on SCHEMA
-
-            scalar link__Import
-
-            enum link__Purpose {
-              """
-              \`SECURITY\` features provide metadata necessary to securely resolve fields.
-              """
-              SECURITY
-
-              """
-              \`EXECUTION\` features provide metadata necessary for operation execution.
-              """
-              EXECUTION
-            }
-          `)
+                linkSpecDefinitionsToInclude.length > 0
+                    ? {
+                        kind: graphql_1.Kind.DOCUMENT,
+                        definitions: linkSpecDefinitionsToInclude,
+                    }
+                    : null
             : null,
         subgraph.typeDefs,
     ].filter(onlyDocumentNode));
@@ -305,6 +317,10 @@ function onlyDocumentNode(item) {
 }
 function cleanSubgraphTypeDefsFromSubgraphSpec(typeDefs) {
     let queryTypes = [];
+    const schemaDef = typeDefs.definitions.find(node => (node.kind === graphql_1.Kind.SCHEMA_DEFINITION || node.kind === graphql_1.Kind.SCHEMA_EXTENSION) &&
+        node.operationTypes?.some(op => op.operation === graphql_1.OperationTypeNode.QUERY));
+    const queryTypeName = schemaDef?.operationTypes?.find(op => op.operation === graphql_1.OperationTypeNode.QUERY)?.type.name
+        .value ?? 'Query';
     typeDefs.definitions = typeDefs.definitions.filter(def => {
         if (def.kind === graphql_1.Kind.SCALAR_TYPE_DEFINITION && def.name.value === '_Any') {
             return false;
@@ -316,7 +332,7 @@ function cleanSubgraphTypeDefsFromSubgraphSpec(typeDefs) {
             return false;
         }
         if ((def.kind === graphql_1.Kind.OBJECT_TYPE_DEFINITION || def.kind === graphql_1.Kind.OBJECT_TYPE_EXTENSION) &&
-            def.name.value === 'Query') {
+            def.name.value === queryTypeName) {
             queryTypes.push(def);
         }
         return true;

package/cjs/supergraph/composition/ast.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.stripFederation = exports.schemaCoordinate = exports.createJoinGraphEnumTypeNode = exports.createScalarTypeNode = exports.createEnumTypeNode = exports.createUnionTypeNode = exports.createInputObjectTypeNode = exports.createInterfaceTypeNode = exports.createObjectTypeNode = exports.createDirectiveNode = exports.createSchemaNode = void 0;
 const graphql_1 = require("graphql");
+const printer_js_1 = require("../../graphql/printer.js");
 function createSchemaNode(schema) {
     return {
         kind: graphql_1.Kind.SCHEMA_DEFINITION,
@@ -353,6 +354,19 @@ function createJoinFieldDirectiveNode(join) {
                     },
                 }
                 : null,
+            join.usedOverridden
+                ? {
+                    kind: graphql_1.Kind.ARGUMENT,
+                    name: {
+                        kind: graphql_1.Kind.NAME,
+                        value: 'usedOverridden',
+                    },
+                    value: {
+                        kind: graphql_1.Kind.BOOLEAN,
+                        value: true,
+                    },
+                }
+                : null,
             join.external
                 ? {
                     kind: graphql_1.Kind.ARGUMENT,
@@ -727,7 +741,16 @@ function createNamedTypeNode(name) {
     };
 }
 function applyDirectives(common) {
-    return [].concat(common.ast?.directives ?? [], common.join?.type?.map(createJoinTypeDirectiveNode) ?? [], common.join?.implements?.map(createJoinImplementsDirectiveNode) ?? [], common.join?.field?.map(createJoinFieldDirectiveNode) ?? [], common.join?.unionMember?.map(createJoinUnionMemberDirectiveNode) ?? [], common.join?.enumValue?.map(createJoinEnumValueDirectiveNode) ?? [], common.tags?.map(createTagDirectiveNode) ?? [], common.inaccessible ? [createInaccessibleDirectiveNode()] : [], common.authenticated ? [createAuthenticatedDirectiveNode()] : [], common.policies?.length ? [createPolicyDirectiveNode(common.policies)] : [], common.scopes?.length ? [createRequiresScopesDirectiveNode(common.scopes)] : [], common.deprecated ? [createDeprecatedDirectiveNode(common.deprecated)] : [], common.specifiedBy ? [createSpecifiedByDirectiveNode(common.specifiedBy)] : []);
+    const deduplicatedDirectives = (common.ast?.directives ?? [])
+        .map(directive => {
+        return {
+            ast: directive,
+            string: (0, printer_js_1.print)(directive),
+        };
+    })
+        .filter((directive, index, all) => all.findIndex(d => d.string === directive.string) === index)
+        .map(d => d.ast);
+    return [].concat(deduplicatedDirectives, common.join?.type?.map(createJoinTypeDirectiveNode) ?? [], common.join?.implements?.map(createJoinImplementsDirectiveNode) ?? [], common.join?.field?.map(createJoinFieldDirectiveNode) ?? [], common.join?.unionMember?.map(createJoinUnionMemberDirectiveNode) ?? [], common.join?.enumValue?.map(createJoinEnumValueDirectiveNode) ?? [], common.tags?.map(createTagDirectiveNode) ?? [], common.inaccessible ? [createInaccessibleDirectiveNode()] : [], common.authenticated ? [createAuthenticatedDirectiveNode()] : [], common.policies?.length ? [createPolicyDirectiveNode(common.policies)] : [], common.scopes?.length ? [createRequiresScopesDirectiveNode(common.scopes)] : [], common.deprecated ? [createDeprecatedDirectiveNode(common.deprecated)] : [], common.specifiedBy ? [createSpecifiedByDirectiveNode(common.specifiedBy)] : []);
 }
 function nonEmpty(value) {
     return value != null;