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

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');