feat: initial support for field resolvers

Author: Noroth

composition-go/index.global.js

@@ -17,6 +17,9 @@ export const CONFIGURE_DESCRIPTION = 'openfed__configureDescription';
 export const CONFIGURE_CHILD_DESCRIPTIONS = 'openfed__configureChildDescriptions';
 export const CONSUMER_INACTIVE_THRESHOLD = 'consumerInactiveThreshold';
 export const CONSUMER_NAME = 'consumerName';
+export const CONNECT_CONFIGURE_RESOLVER = 'connect__configureResolver';
+export const CONTEXT = 'context';
+export const CONNECT_FIELDSET_SCALAR = 'connect__FieldSet';
 export const DEFAULT = 'default';
 export const DEFAULT_EDFS_PROVIDER_ID = 'default';
 export const DEFAULT_MUTATION = 'Mutation';

composition/src/utils/string-constants.ts

@@ -4,6 +4,7 @@ import {
   COMPOSE_DIRECTIVE_DEFINITION,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION,
   CONFIGURE_DESCRIPTION_DEFINITION,
+  CONNECT_CONFIGURE_RESOLVER_DEFINITION,
   DEPRECATED_DEFINITION,
   EDFS_KAFKA_PUBLISH_DEFINITION,
   EDFS_KAFKA_SUBSCRIBE_DEFINITION,
@@ -45,6 +46,9 @@ import {
   CONDITION,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_CONFIGURE_RESOLVER,
+  CONNECT_FIELDSET_SCALAR,
+  CONTEXT,
   DEFAULT_EDFS_PROVIDER_ID,
   DEPRECATED,
   DESCRIPTION_OVERRIDE,
@@ -205,6 +209,27 @@ export const CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION_DATA: DirectiveDefinitionDa
   requiredArgumentNames: new Set<string>(),
 };
 
+export const CONNECT_CONFIGURE_RESOLVER_DEFINITION_DATA: DirectiveDefinitionData = {
+  argumentTypeNodeByName: new Map<string, ArgumentData>([
+    [
+      CONTEXT,
+      {
+        name: CONTEXT,
+        typeNode: {
+          kind: Kind.NON_NULL_TYPE,
+          type: stringToNamedTypeNode(CONNECT_FIELDSET_SCALAR),
+        },
+      },
+    ],
+  ]),
+  isRepeatable: false,
+  locations: new Set<string>([FIELD_DEFINITION_UPPER]),
+  name: CONNECT_CONFIGURE_RESOLVER,
+  node: CONNECT_CONFIGURE_RESOLVER_DEFINITION,
+  optionalArgumentNames: new Set<string>(),
+  requiredArgumentNames: new Set<string>([CONTEXT]),
+};
+
 export const DEPRECATED_DEFINITION_DATA: DirectiveDefinitionData = {
   argumentTypeNodeByName: new Map<string, ArgumentData>([
     [

composition/src/v1/normalization/directive-definition-data.ts

@@ -58,6 +58,8 @@ import {
   BASE_SCALARS,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION,
   CONFIGURE_DESCRIPTION_DEFINITION,
+  CONNECT_CONFIGURE_RESOLVER_DEFINITION,
+  CONNECT_FIELDSET_SCALAR_DEFINITION,
   EDFS_NATS_STREAM_CONFIGURATION_DEFINITION,
   EVENT_DRIVEN_DIRECTIVE_DEFINITIONS_BY_DIRECTIVE_NAME,
   FIELD_SET_SCALAR_DEFINITION,
@@ -276,6 +278,8 @@ import {
   CHANNELS,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_CONFIGURE_RESOLVER,
+  CONNECT_FIELDSET_SCALAR,
   CONSUMER_INACTIVE_THRESHOLD,
   CONSUMER_NAME,
   DEFAULT_EDFS_PROVIDER_ID,
@@ -523,6 +527,8 @@ export class NormalizationFactory {
           // intentional fallthrough
           case SCOPE_SCALAR:
           // intentional fallthrough
+          case CONNECT_FIELDSET_SCALAR:
+          // intentional fallthrough
           case STRING_SCALAR: {
             return argumentValue.kind === Kind.STRING;
           }
@@ -3498,6 +3504,12 @@ export class NormalizationFactory {
     if (this.schemaData.operationTypes.size > 0) {
       definitions.push(this.getSchemaNodeByData(this.schemaData));
     }
+
+    // connect definitions
+    if (this.referencedDirectiveNames.has(CONNECT_CONFIGURE_RESOLVER)) {
+      definitions.push(CONNECT_FIELDSET_SCALAR_DEFINITION);
+      definitions.push(CONNECT_CONFIGURE_RESOLVER_DEFINITION);
+    }
     /*
      * Sometimes an @openfed__configureDescription directive is defined before a description is, e.g., on an extension.
      * If at this stage there is still no description, it is propagated as an error.

composition/src/v1/normalization/normalization-factory.ts

@@ -25,6 +25,7 @@ import {
   COMPOSE_DIRECTIVE_DEFINITION_DATA,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION_DATA,
   CONFIGURE_DESCRIPTION_DEFINITION_DATA,
+  CONNECT_CONFIGURE_RESOLVER_DEFINITION_DATA,
   DEPRECATED_DEFINITION_DATA,
   EXTENDS_DEFINITION_DATA,
   EXTERNAL_DEFINITION_DATA,
@@ -56,6 +57,7 @@ import {
   COMPOSE_DIRECTIVE,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_CONFIGURE_RESOLVER,
   DEPRECATED,
   EDFS_KAFKA_PUBLISH,
   EDFS_KAFKA_SUBSCRIBE,
@@ -394,6 +396,7 @@ export function initializeDirectiveDefinitionDatas(): Map<string, DirectiveDefin
     [COMPOSE_DIRECTIVE, COMPOSE_DIRECTIVE_DEFINITION_DATA],
     [CONFIGURE_DESCRIPTION, CONFIGURE_DESCRIPTION_DEFINITION_DATA],
     [CONFIGURE_CHILD_DESCRIPTIONS, CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION_DATA],
+    [CONNECT_CONFIGURE_RESOLVER, CONNECT_CONFIGURE_RESOLVER_DEFINITION_DATA],
     [DEPRECATED, DEPRECATED_DEFINITION_DATA],
     [EDFS_KAFKA_PUBLISH, KAFKA_PUBLISH_DEFINITION_DATA],
     [EDFS_KAFKA_SUBSCRIBE, KAFKA_SUBSCRIBE_DEFINITION_DATA],

composition/src/v1/normalization/utils.ts

@@ -13,6 +13,7 @@ import {
   BASE_SCALARS,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION,
   CONFIGURE_DESCRIPTION_DEFINITION,
+  CONNECT_CONFIGURE_RESOLVER_DEFINITION,
   SUBSCRIPTION_FILTER_DEFINITION,
   V2_DIRECTIVE_DEFINITION_BY_DIRECTIVE_NAME,
 } from '../utils/constants';
@@ -34,6 +35,7 @@ import {
   ANY_SCALAR,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_CONFIGURE_RESOLVER,
   ENTITY_UNION,
   IGNORED_FIELDS,
   PARENT_DEFINITION_DATA,
@@ -80,6 +82,14 @@ export function upsertDirectiveSchemaAndEntityDefinitions(nf: NormalizationFacto
             );
             break;
           }
+          case CONNECT_CONFIGURE_RESOLVER: {
+            nf.directiveDefinitionByDirectiveName.set(
+              CONNECT_CONFIGURE_RESOLVER,
+              CONNECT_CONFIGURE_RESOLVER_DEFINITION,
+            );
+
+            break;
+          }
         }
         nf.referencedDirectiveNames.add(name);
       },

composition/src/v1/normalization/walkers.ts

@@ -26,6 +26,9 @@ import {
   CONDITION,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_CONFIGURE_RESOLVER,
+  CONTEXT,
+  CONNECT_FIELDSET_SCALAR,
   CONSUMER_INACTIVE_THRESHOLD,
   CONSUMER_NAME,
   DEFAULT_EDFS_PROVIDER_ID,
@@ -44,6 +47,7 @@ import {
   EXECUTION,
   EXTENDS,
   EXTERNAL,
+  FIELD,
   FIELD_DEFINITION_UPPER,
   FIELD_PATH,
   FIELD_SET_SCALAR,
@@ -778,6 +782,30 @@ export const SUBSCRIPTION_FILTER_DEFINITION: DirectiveDefinitionNode = {
   repeatable: false,
 };
 
+// scalar connect__FieldSet
+export const CONNECT_FIELDSET_SCALAR_DEFINITION: ScalarTypeDefinitionNode = {
+  kind: Kind.SCALAR_TYPE_DEFINITION,
+  name: stringToNameNode(CONNECT_FIELDSET_SCALAR),
+};
+
+// directive @connect__configureResolver(context: connect__FieldSet!) on FIELD_DEFINITION
+export const CONNECT_CONFIGURE_RESOLVER_DEFINITION: DirectiveDefinitionNode = {
+  arguments: [
+    {
+      kind: Kind.INPUT_VALUE_DEFINITION,
+      name: stringToNameNode(CONTEXT),
+      type: {
+        kind: Kind.NON_NULL_TYPE,
+        type: stringToNamedTypeNode(CONNECT_FIELDSET_SCALAR),
+      },
+    },
+  ],
+  kind: Kind.DIRECTIVE_DEFINITION,
+  locations: stringArrayToNameNodeArray([FIELD_DEFINITION_UPPER]),
+  name: stringToNameNode(CONNECT_CONFIGURE_RESOLVER),
+  repeatable: false,
+};
+
 /* input openfed__SubscriptionFilterCondition {
  *   AND: [openfed__SubscriptionFilterCondition!]
  *   IN: openfed__SubscriptionFieldCondition

composition/src/v1/utils/constants.ts

@@ -0,0 +1,70 @@
+import { describe, expect, test } from 'vitest';
+import {
+  NormalizationFailure,
+  NormalizationSuccess,
+  normalizeSubgraph,
+  ROUTER_COMPATIBILITY_VERSION_ONE,
+  Subgraph,
+} from '../../../src';
+import { parse, printSchema } from 'graphql';
+
+describe('@connect__configureResolver tests', () => {
+  test('that @connect__configureResolver is automatically included in the subgraph schema if it is referenced', () => {
+    const result = normalizeSubgraph(
+      subgraphWithConnectConfigureResolver.definitions,
+      subgraphWithConnectConfigureResolver.name,
+      undefined,
+      ROUTER_COMPATIBILITY_VERSION_ONE,
+    );
+
+    expect(result.success).toBe(true);
+    const normalizationSuccess = result as NormalizationSuccess;
+    expect(normalizationSuccess.warnings).toHaveLength(0);
+    expect(normalizationSuccess.subgraphString).toContain(
+      `directive @connect__configureResolver(context: connect__FieldSet!) on FIELD_DEFINITION`,
+    );
+    expect(normalizationSuccess.subgraphString).toContain(`scalar connect__FieldSet`);
+  });
+
+  test('that @connect__configureResolver needs to have a context', () => {
+    const result = normalizeSubgraph(
+      subgraphWithConnectConfigureResolverWithoutContext.definitions,
+      subgraphWithConnectConfigureResolverWithoutContext.name,
+      undefined,
+      ROUTER_COMPATIBILITY_VERSION_ONE,
+    );
+
+    expect(result.success).toBe(false);
+    const normalizationFailure = result as NormalizationFailure;
+    expect(normalizationFailure.errors).toHaveLength(1);
+    expect(normalizationFailure.errors[0].message).toContain(
+      'The definition for "@connect__configureResolver" defines the following 1 required argument: "context".\n However, no arguments are defined on this instance.',
+    );
+  });
+});
+
+const subgraphWithConnectConfigureResolver: Subgraph = {
+  name: 'connect-configure-resolver',
+  url: '',
+  definitions: parse(`
+      type Foo {
+        id: ID!
+        bar(baz: String!): String @connect__configureResolver(context: "id")  
+      }
+
+      type Query {
+        foo: Foo!
+      }
+    `),
+};
+
+const subgraphWithConnectConfigureResolverWithoutContext: Subgraph = {
+  name: 'connect-configure-resolver-without-context',
+  url: '',
+  definitions: parse(`
+      type Foo {
+        id: ID!
+        bar(baz: String!): String @connect__configureResolver
+      }
+    `),
+};

composition/tests/v1/directives/connect-configure-resolver.test.ts

@@ -1,10 +1,6 @@
 extend schema
 @link(url: "https://specs.apollo.dev/federation/v2.5", import: ["@authenticated", "@composeDirective", "@external", "@extends", "@inaccessible", "@interfaceObject", "@override", "@provides", "@key", "@requires", "@requiresScopes", "@shareable", "@tag"])
 
-scalar connect__FieldSet
-directive @configureResolver(context: connect__FieldSet!) on FIELD_DEFINITION
-
-
 schema {
   query: Query
   mutation: Mutation
@@ -109,10 +105,10 @@ type Project implements Node & Timestamped @key(fields: "id") {
   milestoneGroups: [[Milestone]]  # nested lists: nullable list of nullable lists
   priorityMatrix: [[[Task!]!]!]  # triple nested: non-nullable list of non-nullable lists of non-nullable lists
 
-  # Computed fields with @configureResolver
-  filteredTasks(status: TaskStatus, priority: TaskPriority, limit: Int): [Task!]! @configureResolver(context: "id")
-  completionRate(includeSubtasks: Boolean): Float! @configureResolver(context: "id startDate endDate status")
-  estimatedDaysRemaining(fromDate: String): Int @configureResolver(context: "id endDate status")
+  # Computed fields with @connect__configureResolver
+  filteredTasks(status: TaskStatus, priority: TaskPriority, limit: Int): [Task!]! @connect__configureResolver(context: "id")
+  completionRate(includeSubtasks: Boolean): Float! @connect__configureResolver(context: "id startDate endDate status")
+  estimatedDaysRemaining(fromDate: String): Int @connect__configureResolver(context: "id endDate status")
 }
 
 # New types - simplified with ID references only
@@ -131,9 +127,9 @@ type Milestone implements Node & Timestamped @key(fields: "id") {
   subtasks: [Task]  # nullable list of nullable tasks
   reviewers: [Employee!]  # nullable list of non-nullable employees
 
-  # Computed fields with @configureResolver
-  isAtRisk(threshold: Float): Boolean! @configureResolver(context: "id endDate status completionPercentage")
-  daysUntilDue(fromDate: String): Int @configureResolver(context: "endDate")
+  # Computed fields with @connect__configureResolver
+  isAtRisk(threshold: Float): Boolean! @connect__configureResolver(context: "id endDate status completionPercentage")
+  daysUntilDue(fromDate: String): Int @connect__configureResolver(context: "endDate")
 }
 
 type Task implements Node & Assignable @key(fields: "id") {
@@ -157,9 +153,9 @@ type Task implements Node & Assignable @key(fields: "id") {
   attachmentUrls: [String!]!  # non-nullable list of non-nullable URLs
   reviewerIds: [Int]  # nullable list of nullable reviewer IDs
 
-  # Computed fields with @configureResolver
-  isBlocked(checkDependencies: Boolean): Boolean! @configureResolver(context: "id status")
-  totalEffort(includeSubtasks: Boolean): Float @configureResolver(context: "id estimatedHours actualHours")
+  # Computed fields with @connect__configureResolver
+  isBlocked(checkDependencies: Boolean): Boolean! @connect__configureResolver(context: "id status")
+  totalEffort(includeSubtasks: Boolean): Float @connect__configureResolver(context: "id estimatedHours actualHours")
 }
 
 type ProjectUpdate implements Node {
@@ -231,9 +227,9 @@ type Employee @key(fields: "id") {
   certifications: [String!]  # nullable list of non-nullable certifications
   projectHistory: [[Project!]]!  # non-nullable list of nullable lists of non-nullable projects
 
-  # Computed fields with @configureResolver
-  currentWorkload(includeCompleted: Boolean, projectId: ID): Int! @configureResolver(context: "id")
-  averageTaskCompletionDays(projectId: ID, priority: TaskPriority): Float @configureResolver(context: "id")
+  # Computed fields with @connect__configureResolver
+  currentWorkload(includeCompleted: Boolean, projectId: ID): Int! @connect__configureResolver(context: "id")
+  averageTaskCompletionDays(projectId: ID, priority: TaskPriority): Float @connect__configureResolver(context: "id")
 }
 
 type Product @key(fields: "upc") {

demo/pkg/subgraphs/projects/src/schema.graphql

@@ -295,7 +295,6 @@ export class GraphQLToProtoVisitor {
     this.mapping.operationMappings.push(operationMapping);
   }
 
-
   private createLookupMapping(type: LookupType, typeName: string, field: GraphQLField<any, any>): void {
     const methodName = createResolverMethodName(typeName, field.name);
 
@@ -305,7 +304,7 @@ export class GraphQLToProtoVisitor {
       rpc: methodName,
       request: createRequestMessageName(methodName),
       response: createResponseMessageName(methodName),
-    })
+    });
 
     this.mapping.resolveMappings.push(lookupMapping);
   }
@@ -482,7 +481,6 @@ export class GraphQLToProtoVisitor {
     });
   }
 
-
   /**
    * Create argument mappings for a GraphQL field
    *