feat: initial support for field resolvers in connect (#2290)

Author: Noroth

composition-go/index.global.js

@@ -17,6 +17,8 @@ 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_FIELD_RESOLVER = 'connect__fieldResolver';
+export const CONTEXT = 'context';
 export const DEFAULT = 'default';
 export const DEFAULT_EDFS_PROVIDER_ID = 'default';
 export const DEFAULT_MUTATION = 'Mutation';

composition/src/utils/string-constants.ts

@@ -5,6 +5,7 @@ import {
   COMPOSE_DIRECTIVE,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_FIELD_RESOLVER,
   DEPRECATED,
   EDFS_KAFKA_PUBLISH,
   EDFS_KAFKA_SUBSCRIBE,
@@ -43,6 +44,7 @@ import {
   COMPOSE_DIRECTIVE_DEFINITION,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION,
   CONFIGURE_DESCRIPTION_DEFINITION,
+  CONNECT_FIELD_RESOLVER_DEFINITION,
   DEPRECATED_DEFINITION,
   EDFS_KAFKA_PUBLISH_DEFINITION,
   EDFS_KAFKA_SUBSCRIBE_DEFINITION,
@@ -78,6 +80,7 @@ export const DIRECTIVE_DEFINITION_BY_NAME: ReadonlyMap<DirectiveName, DirectiveD
   [COMPOSE_DIRECTIVE, COMPOSE_DIRECTIVE_DEFINITION],
   [CONFIGURE_DESCRIPTION, CONFIGURE_DESCRIPTION_DEFINITION],
   [CONFIGURE_CHILD_DESCRIPTIONS, CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION],
+  [CONNECT_FIELD_RESOLVER, CONNECT_FIELD_RESOLVER_DEFINITION],
   [DEPRECATED, DEPRECATED_DEFINITION],
   [EDFS_KAFKA_PUBLISH, EDFS_KAFKA_PUBLISH_DEFINITION],
   [EDFS_KAFKA_SUBSCRIBE, EDFS_KAFKA_SUBSCRIBE_DEFINITION],

composition/src/v1/constants/constants.ts

@@ -14,6 +14,8 @@ import {
   CONDITION,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_FIELD_RESOLVER,
+  CONTEXT,
   DEFAULT_EDFS_PROVIDER_ID,
   DEPRECATED,
   DESCRIPTION_OVERRIDE,
@@ -30,7 +32,6 @@ import {
   EXTENDS,
   EXTERNAL,
   FIELD_DEFINITION_UPPER,
-  FIELD_SET_SCALAR,
   FIELDS,
   FOR,
   FROM,
@@ -184,6 +185,21 @@ export const CONFIGURE_DESCRIPTION_DEFINITION: DirectiveDefinitionNode = {
   repeatable: false,
 };
 
+// directive @connect__fieldResolver(context: openfed__FieldSet!) on FIELD_DEFINITION
+export const CONNECT_FIELD_RESOLVER_DEFINITION: DirectiveDefinitionNode = {
+  arguments: [
+    {
+      kind: Kind.INPUT_VALUE_DEFINITION,
+      name: stringToNameNode(CONTEXT),
+      type: REQUIRED_FIELDSET_TYPE_NODE,
+    },
+  ],
+  kind: Kind.DIRECTIVE_DEFINITION,
+  locations: stringArrayToNameNodeArray([FIELD_DEFINITION_UPPER]),
+  name: stringToNameNode(CONNECT_FIELD_RESOLVER),
+  repeatable: false,
+};
+
 export const DEPRECATED_DEFINITION: DirectiveDefinitionNode = {
   arguments: [
     {

composition/src/v1/constants/directive-definitions.ts

@@ -2,6 +2,7 @@ import {
   AND_UPPER,
   ARGUMENT_DEFINITION_UPPER,
   BOOLEAN_SCALAR,
+  CONNECT_FIELD_RESOLVER,
   CONSUMER_INACTIVE_THRESHOLD,
   CONSUMER_NAME,
   DEPRECATED,
@@ -108,6 +109,7 @@ export const DEPENDENCIES_BY_DIRECTIVE_NAME: ReadonlyMap<DirectiveName, Array<De
   DirectiveName,
   Array<DefinitionNode>
 >([
+  [CONNECT_FIELD_RESOLVER, [FIELD_SET_SCALAR_DEFINITION]],
   [EDFS_NATS_SUBSCRIBE, [EDFS_NATS_STREAM_CONFIGURATION_DEFINITION]],
   [KEY, [FIELD_SET_SCALAR_DEFINITION]],
   [LINK, [LINK_IMPORT_DEFINITION, LINK_PURPOSE_DEFINITION]],

composition/src/v1/constants/strings.ts

@@ -12,6 +12,8 @@ import {
   CONDITION,
   CONFIGURE_CHILD_DESCRIPTIONS,
   CONFIGURE_DESCRIPTION,
+  CONNECT_FIELD_RESOLVER,
+  CONTEXT,
   DEFAULT_EDFS_PROVIDER_ID,
   DEPRECATED,
   DESCRIPTION_OVERRIDE,
@@ -79,6 +81,7 @@ import {
   COMPOSE_DIRECTIVE_DEFINITION,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION,
   CONFIGURE_DESCRIPTION_DEFINITION,
+  CONNECT_FIELD_RESOLVER_DEFINITION,
   DEPRECATED_DEFINITION,
   EDFS_KAFKA_PUBLISH_DEFINITION,
   EDFS_KAFKA_SUBSCRIBE_DEFINITION,
@@ -206,6 +209,24 @@ export const CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION_DATA: DirectiveDefinitionDa
   requiredArgumentNames: new Set<string>(),
 };
 
+export const CONNECT_FIELD_RESOLVER_DEFINITION_DATA: DirectiveDefinitionData = {
+  argumentTypeNodeByName: new Map<string, ArgumentData>([
+    [
+      CONTEXT,
+      {
+        name: CONTEXT,
+        typeNode: REQUIRED_FIELDSET_TYPE_NODE,
+      },
+    ],
+  ]),
+  isRepeatable: false,
+  locations: new Set<string>([FIELD_DEFINITION_UPPER]),
+  name: CONNECT_FIELD_RESOLVER,
+  node: CONNECT_FIELD_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

@@ -25,6 +25,7 @@ import {
   COMPOSE_DIRECTIVE_DEFINITION_DATA,
   CONFIGURE_CHILD_DESCRIPTIONS_DEFINITION_DATA,
   CONFIGURE_DESCRIPTION_DEFINITION_DATA,
+  CONNECT_FIELD_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_FIELD_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_FIELD_RESOLVER, CONNECT_FIELD_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

@@ -0,0 +1,87 @@
+import { describe, expect, test } from 'vitest';
+import {
+  CONNECT_FIELD_RESOLVER,
+  CONTEXT,
+  invalidDirectiveError,
+  NormalizationFailure,
+  NormalizationSuccess,
+  normalizeSubgraph,
+  ROUTER_COMPATIBILITY_VERSION_ONE,
+  Subgraph,
+  undefinedRequiredArgumentsErrorMessage,
+} from '../../../src';
+import { parse, printSchema } from 'graphql';
+import {
+  normalizeString,
+  normalizeSubgraphFailure,
+  normalizeSubgraphSuccess,
+  schemaToSortedNormalizedString,
+} from '../../utils/utils';
+import { CONNECT_FIELD_RESOLVER_DIRECTIVE, OPENFED_FIELD_SET, SCHEMA_QUERY_DEFINITION } from '../utils/utils';
+
+describe('@connect__fieldResolver tests', () => {
+  test('that @connect__fieldResolver is automatically included in the subgraph schema if it is referenced', () => {
+    const { schema, warnings } = normalizeSubgraphSuccess(
+      subgraphWithConnectConfigureResolver,
+      ROUTER_COMPATIBILITY_VERSION_ONE,
+    );
+    expect(warnings).toHaveLength(0);
+    expect(schemaToSortedNormalizedString(schema)).toBe(
+      normalizeString(
+        SCHEMA_QUERY_DEFINITION +
+          CONNECT_FIELD_RESOLVER_DIRECTIVE +
+          `
+        type Foo {
+          bar(baz: String!): String @connect__fieldResolver(context: "id")
+          id: ID!
+        }
+  
+        type Query {
+          foo: Foo!
+        }
+      ` +
+          OPENFED_FIELD_SET,
+      ),
+    );
+  });
+
+  test('that @connect__fieldResolver needs to have a context', () => {
+    const { errors } = normalizeSubgraphFailure(
+      subgraphWithConnectConfigureResolverWithoutContext,
+      ROUTER_COMPATIBILITY_VERSION_ONE,
+    );
+
+    expect(errors).toHaveLength(1);
+    expect(errors[0]).toStrictEqual(
+      invalidDirectiveError(CONNECT_FIELD_RESOLVER, `Foo.bar`, `1st`, [
+        undefinedRequiredArgumentsErrorMessage(CONNECT_FIELD_RESOLVER, [CONTEXT], []),
+      ]),
+    );
+  });
+});
+
+const subgraphWithConnectConfigureResolver: Subgraph = {
+  name: 'connect-configure-resolver',
+  url: '',
+  definitions: parse(`
+      type Foo {
+        bar(baz: String!): String @connect__fieldResolver(context: "id")
+        id: ID!
+      }
+
+      type Query {
+        foo: Foo!
+      }
+    `),
+};
+
+const subgraphWithConnectConfigureResolverWithoutContext: Subgraph = {
+  name: 'connect-configure-resolver-without-context',
+  url: '',
+  definitions: parse(`
+      type Foo {
+        bar(baz: String!): String @connect__fieldResolver
+        id: ID!
+      }
+    `),
+};

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

@@ -9,6 +9,10 @@ export const CONFIGURE_DESCRIPTION_DIRECTIVE = `
   directive @openfed__configureDescription(descriptionOverride: String, propagate: Boolean! = true) on ARGUMENT_DEFINITION | ENUM | ENUM_VALUE | FIELD_DEFINITION | INPUT_FIELD_DEFINITION | INPUT_OBJECT | INTERFACE | OBJECT | SCALAR | SCHEMA | UNION
 `;
 
+export const CONNECT_FIELD_RESOLVER_DIRECTIVE = `
+  directive @connect__fieldResolver(context: openfed__FieldSet!) on FIELD_DEFINITION
+`;
+
 export const EDFS_NATS_PUBLISH_DIRECTIVE = `
   directive @edfs__natsPublish(providerId: String! = "default", subject: String!) on FIELD_DEFINITION
 `;