@theguild/federation-composition/esm/subgraph/validation/rules/elements/override.js

Open Source Composition library for Apollo Federation

import { GraphQLError, Kind } from 'graphql';
import { validateDirectiveAgainstOriginal } from '../../../helpers.js';
export function OverrideRules(context) {
    return {
        DirectiveDefinition(node) {
            validateDirectiveAgainstOriginal(node, 'override', context);
        },
        Directive(node) {
            if (!context.isAvailableFederationDirective('override', node)) {
                return;
            }
            const fieldDef = context.typeNodeInfo.getFieldDef();
            const typeDef = context.typeNodeInfo.getTypeDef();
            if (!fieldDef || !typeDef) {
                return;
            }
            if ((typeDef.kind === Kind.INTERFACE_TYPE_DEFINITION ||
                typeDef.kind === Kind.INTERFACE_TYPE_EXTENSION) &&
                context.satisfiesVersionRange('>= v2.3')) {
                context.reportError(new GraphQLError(`@override cannot be used on field "${typeDef.name.value}.${fieldDef.name.value}" on subgraph "${context.getSubgraphName()}": @override is not supported on interface type fields.`, { nodes: node, extensions: { code: 'OVERRIDE_ON_INTERFACE' } }));
                return;
            }
            const labelArg = node.arguments?.find(arg => arg.name.value === 'label');
            if (labelArg && context.satisfiesVersionRange('>= v2.7')) {
                context.reportError(new GraphQLError([
                    `Progressive @override labels are not yet supported.`,
                    `Attempted to override field "${typeDef.name.value}.${fieldDef.name.value}".`,
                ].join(' '), {
                    extensions: {
                        code: 'UNSUPPORTED_FEATURE',
                    },
                }));
            }
            const fromArg = node.arguments?.find(arg => arg.name.value === 'from');
            if (!fromArg || fromArg.value.kind !== Kind.STRING) {
                return;
            }
            if (!typeDef) {
                throw new Error('Parent type not found but `@override` directive is present on a field.');
            }
            const conflictingDirectives = fieldDef.directives?.filter(directive => context.isAvailableFederationDirective('external', directive));
            if (conflictingDirectives?.length) {
                conflictingDirectives.forEach(directive => {
                    context.reportError(new GraphQLError(`@override cannot be used on field "${typeDef.name.value}.${fieldDef.name.value}" on subgraph "${context.getSubgraphName()}" since "${typeDef.name.value}.${fieldDef.name.value}" on "${context.getSubgraphName()}" is marked with directive "@${directive.name.value}"`, {
                        extensions: {
                            code: 'OVERRIDE_COLLISION_WITH_ANOTHER_DIRECTIVE',
                        },
                    }));
                });
            }
            if (fromArg.value.value === context.getSubgraphName()) {
                context.reportError(new GraphQLError(`Source and destination subgraphs "${fromArg.value.value}" are the same for overridden field "${typeDef.name.value}.${fieldDef.name.value}"`, { nodes: node, extensions: { code: 'OVERRIDE_FROM_SELF_ERROR' } }));
            }
            if (typeDef.kind === Kind.OBJECT_TYPE_DEFINITION ||
                typeDef.kind === Kind.OBJECT_TYPE_EXTENSION) {
                context.stateBuilder.objectType.field.setOverride(typeDef.name.value, fieldDef.name.value, fromArg.value.value);
            }
            else {
                context.stateBuilder.interfaceType.field.setOverride(typeDef.name.value, fieldDef.name.value, fromArg.value.value);
            }
        },
    };
}