@apollo/federation-internals 2.8.4 → 2.9.0-beta.0

package/src/federation.ts

@@ -100,6 +100,7 @@ import {
   SourceFieldDirectiveArgs,
   SourceTypeDirectiveArgs,
 } from "./specs/sourceSpec";
+import { CostDirectiveArguments, ListSizeDirectiveArguments } from "./specs/costSpec";
 
 const linkSpec = LINK_VERSIONS.latest();
 const tagSpec = TAG_VERSIONS.latest();
@@ -1275,6 +1276,14 @@ export class FederationMetadata {
     return this.getPost20FederationDirective(FederationDirectiveName.CONTEXT);
   }
 
+  costDirective(): Post20FederationDirectiveDefinition<CostDirectiveArguments> {
+    return this.getPost20FederationDirective(FederationDirectiveName.COST);
+  }
+
+  listSizeDirective(): Post20FederationDirectiveDefinition<ListSizeDirectiveArguments> {
+    return this.getPost20FederationDirective(FederationDirectiveName.LIST_SIZE);
+  }
+
   allFederationDirectives(): DirectiveDefinition[] {
     const baseDirectives: DirectiveDefinition[] = [
       this.keyDirective(),
@@ -1338,6 +1347,16 @@ export class FederationMetadata {
       baseDirectives.push(fromContextDirective);
     }
 
+    const costDirective = this.costDirective();
+    if (isFederationDirectiveDefinedInSchema(costDirective)) {
+      baseDirectives.push(costDirective);
+    }
+
+    const listSizeDirective = this.listSizeDirective();
+    if (isFederationDirectiveDefinedInSchema(listSizeDirective)) {
+      baseDirectives.push(listSizeDirective);
+    }
+
     return baseDirectives;
   }
 
@@ -1831,9 +1850,9 @@ export function setSchemaAsFed2Subgraph(schema: Schema, useLatest: boolean = fal
 
 // This is the full @link declaration as added by `asFed2SubgraphDocument`. It's here primarily for uses by tests that print and match
 // subgraph schema to avoid having to update 20+ tests every time we use a new directive or the order of import changes ...
-export const FEDERATION2_LINK_WITH_FULL_IMPORTS = '@link(url: "https://specs.apollo.dev/federation/v2.8", import: ["@key", "@requires", "@provides", "@external", "@tag", "@extends", "@shareable", "@inaccessible", "@override", "@composeDirective", "@interfaceObject", "@authenticated", "@requiresScopes", "@policy", "@sourceAPI", "@sourceType", "@sourceField", "@context", "@fromContext"])';
+export const FEDERATION2_LINK_WITH_FULL_IMPORTS = '@link(url: "https://specs.apollo.dev/federation/v2.9", import: ["@key", "@requires", "@provides", "@external", "@tag", "@extends", "@shareable", "@inaccessible", "@override", "@composeDirective", "@interfaceObject", "@authenticated", "@requiresScopes", "@policy", "@sourceAPI", "@sourceType", "@sourceField", "@context", "@fromContext", "@cost", "@listSize"])';
 // This is the full @link declaration that is added when upgrading fed v1 subgraphs to v2 version. It should only be used by tests.
-export const FEDERATION2_LINK_WITH_AUTO_EXPANDED_IMPORTS = '@link(url: "https://specs.apollo.dev/federation/v2.8", import: ["@key", "@requires", "@provides", "@external", "@tag", "@extends", "@shareable", "@inaccessible", "@override", "@composeDirective", "@interfaceObject"])';
+export const FEDERATION2_LINK_WITH_AUTO_EXPANDED_IMPORTS = '@link(url: "https://specs.apollo.dev/federation/v2.9", import: ["@key", "@requires", "@provides", "@external", "@tag", "@extends", "@shareable", "@inaccessible", "@override", "@composeDirective", "@interfaceObject"])';
 
 // This is the federation @link for tests that go through the SchemaUpgrader.
 export const FEDERATION2_LINK_WITH_AUTO_EXPANDED_IMPORTS_UPGRADED = '@link(url: "https://specs.apollo.dev/federation/v2.4", import: ["@key", "@requires", "@provides", "@external", "@tag", "@extends", "@shareable", "@inaccessible", "@override", "@composeDirective", "@interfaceObject"])';

package/src/index.ts

@@ -25,3 +25,4 @@ export * from './specs/authenticatedSpec';
 export * from './specs/requiresScopesSpec';
 export * from './specs/policySpec';
 export * from './specs/sourceSpec';
+export * from './specs/costSpec';

package/src/operations.ts

@@ -56,6 +56,8 @@ import { assert, mapKeys, mapValues, MapWithCachedArrays, MultiMap, SetMultiMap
 import { argumentsEquals, argumentsFromAST, isValidValue, valueToAST, valueToString } from "./values";
 import { v1 as uuidv1 } from 'uuid';
 
+export const DEFAULT_MIN_USAGES_TO_OPTIMIZE = 2;
+
 function validate(condition: any, message: () => string, sourceAST?: ASTNode): asserts condition {
   if (!condition) {
     throw ERRORS.INVALID_GRAPHQL.err(message(), { nodes: sourceAST });
@@ -934,25 +936,55 @@ export class Operation extends DirectiveTargetElement<Operation> {
       this.appliedDirectives,
     );
   }
+  
+  private collectUndefinedVariablesFromFragments(fragments: NamedFragments): Variable[] {
+    const collector = new VariableCollector();
+    for (const namedFragment of fragments.definitions()) {
+      namedFragment.selectionSet.usedVariables().forEach(v => {
+        if (!this.variableDefinitions.definition(v)) {
+          collector.add(v);
+        }
+      });
+    }
+    return collector.variables();
+  }
 
   // Returns a copy of this operation with the provided updated selection set and fragments.
-  private withUpdatedSelectionSetAndFragments(newSelectionSet: SelectionSet, newFragments: NamedFragments | undefined): Operation {
+  private withUpdatedSelectionSetAndFragments(
+    newSelectionSet: SelectionSet,
+    newFragments: NamedFragments | undefined,
+    allAvailableVariables?: VariableDefinitions,
+  ): Operation {
     if (this.selectionSet === newSelectionSet && newFragments === this.fragments) {
       return this;
     }
+    
+    let newVariableDefinitions = this.variableDefinitions;
+    if (allAvailableVariables && newFragments) {
+      const undefinedVariables = this.collectUndefinedVariablesFromFragments(newFragments);
+      if (undefinedVariables.length > 0) {
+        newVariableDefinitions = new VariableDefinitions();
+        newVariableDefinitions.addAll(this.variableDefinitions);
+        newVariableDefinitions.addAll(allAvailableVariables.filter(undefinedVariables));
+      }
+    }
 
     return new Operation(
       this.schema(),
       this.rootKind,
       newSelectionSet,
-      this.variableDefinitions,
+      newVariableDefinitions,
       newFragments,
       this.name,
       this.appliedDirectives,
     );
   }
 
-  optimize(fragments?: NamedFragments, minUsagesToOptimize: number = 2): Operation {
+  optimize(
+    fragments?: NamedFragments,
+    minUsagesToOptimize: number = DEFAULT_MIN_USAGES_TO_OPTIMIZE,
+    allAvailableVariables?: VariableDefinitions,
+  ): Operation {
     assert(minUsagesToOptimize >= 1, `Expected 'minUsagesToOptimize' to be at least 1, but got ${minUsagesToOptimize}`)
     if (!fragments || fragments.isEmpty()) {
       return this;
@@ -1001,11 +1033,16 @@ export class Operation extends DirectiveTargetElement<Operation> {
       }
     }
 
-    return this.withUpdatedSelectionSetAndFragments(optimizedSelection, finalFragments ?? undefined);
+    return this.withUpdatedSelectionSetAndFragments(
+      optimizedSelection,
+      finalFragments ?? undefined,
+      allAvailableVariables,
+    );
   }
 
   generateQueryFragments(): Operation {
     const [minimizedSelectionSet, fragments] = this.selectionSet.minimizeSelectionSet();
+    
     return new Operation(
       this.schema(),
       this.rootKind,

package/src/specs/coreSpec.ts

@@ -552,6 +552,27 @@ export class CoreSpecDefinition extends FeatureDefinition {
     return feature.addElementsToSchema(schema);
   }
 
+  applyFeatureAsLink(schema: Schema, feature: FeatureDefinition, purpose?: CorePurpose, imports?: CoreImport[]): GraphQLError[] {
+    const existing = schema.schemaDefinition.appliedDirectivesOf(linkDirectiveDefaultName).find((link) => link.arguments().url === feature.toString());
+    if (existing) {
+      existing.remove();
+    }
+
+    const coreDirective = this.coreDirective(schema);
+    const args: LinkDirectiveArgs = {
+      url: feature.toString(),
+      import: (existing?.arguments().import ?? []).concat(imports?.map((i) => i.as ? { name: `@${i.name}`, as: `@${i.as}` } : `@${i.name}`)),
+      feature: undefined,
+    };
+
+    if (this.supportPurposes() && purpose) {
+      args.for = purpose;
+    }
+
+    schema.schemaDefinition.applyDirective(coreDirective, args);
+    return feature.addElementsToSchema(schema);
+  }
+
   extractFeatureUrl(args: CoreOrLinkDirectiveArgs): FeatureUrl {
     return FeatureUrl.parse(args[this.urlArgName()]!);
   }

package/src/specs/costSpec.ts

@@ -0,0 +1,60 @@
+import { DirectiveLocation } from 'graphql';
+import { createDirectiveSpecification } from '../directiveAndTypeSpecification';
+import { FeatureDefinition, FeatureDefinitions, FeatureUrl, FeatureVersion } from './coreSpec';
+import { ListType, NonNullType } from '../definitions';
+import { registerKnownFeature } from '../knownCoreFeatures';
+import { ARGUMENT_COMPOSITION_STRATEGIES } from '../argumentCompositionStrategies';
+
+export const costIdentity = 'https://specs.apollo.dev/cost';
+
+export class CostSpecDefinition extends FeatureDefinition {
+  constructor(version: FeatureVersion, readonly minimumFederationVersion: FeatureVersion) {
+    super(new FeatureUrl(costIdentity, 'cost', version), minimumFederationVersion);
+
+    this.registerDirective(createDirectiveSpecification({
+      name: 'cost',
+      locations: [
+        DirectiveLocation.ARGUMENT_DEFINITION,
+        DirectiveLocation.ENUM,
+        DirectiveLocation.FIELD_DEFINITION,
+        DirectiveLocation.INPUT_FIELD_DEFINITION,
+        DirectiveLocation.OBJECT,
+        DirectiveLocation.SCALAR
+      ],
+      args: [{ name: 'weight', type: (schema) => new NonNullType(schema.intType()), compositionStrategy: ARGUMENT_COMPOSITION_STRATEGIES.MAX }],
+      composes: true,
+      repeatable: false,
+      supergraphSpecification: (fedVersion) => COST_VERSIONS.getMinimumRequiredVersion(fedVersion),
+    }));
+
+    this.registerDirective(createDirectiveSpecification({
+      name: 'listSize',
+      locations: [DirectiveLocation.FIELD_DEFINITION],
+      args: [
+        { name: 'assumedSize', type: (schema) => schema.intType(), compositionStrategy: ARGUMENT_COMPOSITION_STRATEGIES.NULLABLE_MAX },
+        { name: 'slicingArguments', type: (schema) => new ListType(new NonNullType(schema.stringType())), compositionStrategy: ARGUMENT_COMPOSITION_STRATEGIES.NULLABLE_UNION },
+        { name: 'sizedFields', type: (schema) => new ListType(new NonNullType(schema.stringType())), compositionStrategy: ARGUMENT_COMPOSITION_STRATEGIES.NULLABLE_UNION },
+        { name: 'requireOneSlicingArgument', type: (schema) => schema.booleanType(), defaultValue: true, compositionStrategy: ARGUMENT_COMPOSITION_STRATEGIES.NULLABLE_AND },
+      ],
+      composes: true,
+      repeatable: false,
+      supergraphSpecification: (fedVersion) => COST_VERSIONS.getMinimumRequiredVersion(fedVersion)
+    }));
+  }
+}
+
+export const COST_VERSIONS = new FeatureDefinitions<CostSpecDefinition>(costIdentity)
+  .add(new CostSpecDefinition(new FeatureVersion(0, 1), new FeatureVersion(2, 9)));
+
+registerKnownFeature(COST_VERSIONS);
+
+export interface CostDirectiveArguments {
+  weight: number;
+}
+
+export interface ListSizeDirectiveArguments {
+  assumedSize?: number;
+  slicingArguments?: string[];
+  sizedFields?: string[];
+  requireOneSlicingArgument?: boolean;
+}

package/src/specs/federationSpec.ts

@@ -20,6 +20,7 @@ import { REQUIRES_SCOPES_VERSIONS } from "./requiresScopesSpec";
 import { POLICY_VERSIONS } from './policySpec';
 import { SOURCE_VERSIONS } from './sourceSpec';
 import { CONTEXT_VERSIONS } from './contextSpec';
+import { COST_VERSIONS } from "./costSpec";
 
 export const federationIdentity = 'https://specs.apollo.dev/federation';
 
@@ -48,6 +49,8 @@ export enum FederationDirectiveName {
   SOURCE_FIELD = 'sourceField',
   CONTEXT = 'context',
   FROM_CONTEXT = 'fromContext',
+  COST = 'cost',
+  LIST_SIZE = 'listSize',
 }
 
 const fieldSetTypeSpec = createScalarTypeSpecification({ name: FederationTypeName.FIELD_SET });
@@ -182,6 +185,10 @@ export class FederationSpecDefinition extends FeatureDefinition {
     if (version.gte(new FeatureVersion(2, 8))) {
       this.registerSubFeature(CONTEXT_VERSIONS.find(new FeatureVersion(0, 1))!);
     }
+
+    if (version.gte(new FeatureVersion(2, 9))) {
+      this.registerSubFeature(COST_VERSIONS.find(new FeatureVersion(0, 1))!);
+    }
   }
 }
 
@@ -194,6 +201,7 @@ export const FEDERATION_VERSIONS = new FeatureDefinitions<FederationSpecDefiniti
   .add(new FederationSpecDefinition(new FeatureVersion(2, 5)))
   .add(new FederationSpecDefinition(new FeatureVersion(2, 6)))
   .add(new FederationSpecDefinition(new FeatureVersion(2, 7)))
-  .add(new FederationSpecDefinition(new FeatureVersion(2, 8)));
+  .add(new FederationSpecDefinition(new FeatureVersion(2, 8)))
+  .add(new FederationSpecDefinition(new FeatureVersion(2, 9)));
 
 registerKnownFeature(FEDERATION_VERSIONS);

package/src/supergraphs.ts

@@ -40,6 +40,7 @@ export const ROUTER_SUPPORTED_SUPERGRAPH_FEATURES = new Set([
   'https://specs.apollo.dev/policy/v0.1',
   'https://specs.apollo.dev/source/v0.1',
   'https://specs.apollo.dev/context/v0.1',
+  'https://specs.apollo.dev/cost/v0.1',
 ]);
 
 const coreVersionZeroDotOneUrl = FeatureUrl.parse('https://specs.apollo.dev/core/v0.1');