[resolvers] CODEGEN-500: Support semanticNonNull custom directive (#10315)

* Refactor FieldDefinition to bring related logic together

* Implement customDirectives.semanticNonNull

* Add changeset

* Use graphql-sock to transform schema when generating

* Fix doc and errors

Author: eddeee888

.changeset/old-gorillas-taste.md

@@ -0,0 +1,6 @@
+---
+'@graphql-codegen/visitor-plugin-common': minor
+'@graphql-codegen/typescript-resolvers': minor
+---
+
+Implement semanticNonNull custom directive

packages/plugins/other/visitor-plugin-common/src/base-resolvers-visitor.ts

@@ -549,6 +549,40 @@ export interface RawResolversConfig extends RawConfig {
    * ```
    */
   enumSuffix?: boolean;
+  /**
+   * @description Configures behavior for custom directives from various GraphQL libraries.
+   * @exampleMarkdown
+   * ## `@semanticNonNull`
+   * First, install `graphql-sock` peer dependency:
+   *
+   * ```sh npm2yarn
+   * npm install -D graphql-sock
+   * ```
+   *
+   * Now, you can enable support for `@semanticNonNull` directive:
+   *
+   * ```ts filename="codegen.ts"
+   *  import type { CodegenConfig } from '@graphql-codegen/cli';
+   *
+   *  const config: CodegenConfig = {
+   *    // ...
+   *    generates: {
+   *      'path/to/file.ts': {
+   *        plugins: ['typescript-resolvers'],
+   *        config: {
+   *          customDirectives: {
+   *            semanticNonNull: true
+   *          }
+   *        },
+   *      },
+   *    },
+   *  };
+   *  export default config;
+   * ```
+   */
+  customDirectives?: {
+    semanticNonNull?: boolean;
+  };
   /**
    * @default false
    * @description Sets the `__resolveType` field as optional field.
@@ -1449,8 +1483,6 @@ export class BaseResolversVisitor<
 
     return (parentName, avoidResolverOptionals) => {
       const original: FieldDefinitionNode = parent[key];
-      const baseType = getBaseTypeNode(original.type);
-      const realType = baseType.name.value;
       const parentType = this.schema.getType(parentName);
 
       if (this._federation.skipField({ fieldNode: original, parentType })) {
@@ -1459,11 +1491,6 @@ export class BaseResolversVisitor<
 
       const contextType = this.getContextType(parentName, node);
 
-      const typeToUse = this.getTypeToUse(realType);
-      const mappedType = this._variablesTransformer.wrapAstTypeWithModifiers(typeToUse, original.type);
-      const subscriptionType = this._schema.getSubscriptionType();
-      const isSubscriptionType = subscriptionType && subscriptionType.name === parentName;
-
       let argsType = hasArguments
         ? this.convertName(
             parentName +
@@ -1499,15 +1526,41 @@ export class BaseResolversVisitor<
         parentType,
         parentTypeSignature: this.getParentTypeForSignature(node),
       });
-      const mappedTypeKey = isSubscriptionType ? `${mappedType}, "${node.name}"` : mappedType;
 
-      const directiveMappings =
-        node.directives
-          ?.map(directive => this._directiveResolverMappings[directive.name as any])
-          .filter(Boolean)
-          .reverse() ?? [];
+      const { mappedTypeKey, resolverType } = ((): { mappedTypeKey: string; resolverType: string } => {
+        const baseType = getBaseTypeNode(original.type);
+        const realType = baseType.name.value;
+        const typeToUse = this.getTypeToUse(realType);
+        /**
+         * Turns GraphQL type to TypeScript types (`mappedType`) e.g.
+         * - String!  -> ResolversTypes['String']>
+         * - String   -> Maybe<ResolversTypes['String']>
+         * - [String] -> Maybe<Array<Maybe<ResolversTypes['String']>>>
+         * - [String!]! -> Array<ResolversTypes['String']>
+         */
+        const mappedType = this._variablesTransformer.wrapAstTypeWithModifiers(typeToUse, original.type);
+
+        const subscriptionType = this._schema.getSubscriptionType();
+        const isSubscriptionType = subscriptionType && subscriptionType.name === parentName;
+
+        if (isSubscriptionType) {
+          return {
+            mappedTypeKey: `${mappedType}, "${node.name}"`,
+            resolverType: 'SubscriptionResolver',
+          };
+        }
+
+        const directiveMappings =
+          node.directives
+            ?.map(directive => this._directiveResolverMappings[directive.name as any])
+            .filter(Boolean)
+            .reverse() ?? [];
 
-      const resolverType = isSubscriptionType ? 'SubscriptionResolver' : directiveMappings[0] ?? 'Resolver';
+        return {
+          mappedTypeKey: mappedType,
+          resolverType: directiveMappings[0] ?? 'Resolver',
+        };
+      })();
 
       const signature: {
         name: string;

packages/plugins/typescript/resolvers/package.json

@@ -21,10 +21,12 @@
     "tslib": "~2.6.0"
   },
   "peerDependencies": {
-    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+    "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
+    "graphql-sock": "^1.0.0"
   },
   "devDependencies": {
-    "graphql-subscriptions": "3.0.0"
+    "graphql-subscriptions": "3.0.0",
+    "graphql-sock": "1.0.0"
   },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

packages/plugins/typescript/resolvers/src/index.ts

@@ -17,7 +17,7 @@ export const plugin: PluginFunction<
   Types.ComplexPluginOutput<{
     generatedResolverTypes: RootResolver['generatedResolverTypes'];
   }>
-> = (schema: GraphQLSchema, documents: Types.DocumentFile[], config: TypeScriptResolversPluginConfig) => {
+> = async (schema: GraphQLSchema, documents: Types.DocumentFile[], config: TypeScriptResolversPluginConfig) => {
   const imports = [];
   if (!config.customResolveInfo) {
     imports.push('GraphQLResolveInfo');
@@ -75,7 +75,11 @@ export type Resolver${capitalizedDirectiveName}WithResolve<TResult, TParent, TCo
     }
   }
 
-  const transformedSchema = config.federation ? addFederationReferencesToSchema(schema) : schema;
+  let transformedSchema = config.federation ? addFederationReferencesToSchema(schema) : schema;
+  transformedSchema = config.customDirectives?.semanticNonNull
+    ? await semanticToStrict(transformedSchema)
+    : transformedSchema;
+
   const visitor = new TypeScriptResolversVisitor({ ...config, directiveResolverMappings }, transformedSchema);
   const namespacedImportPrefix = visitor.config.namespacedImportName ? `${visitor.config.namespacedImportName}.` : '';
 
@@ -302,3 +306,14 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
 };
 
 export { TypeScriptResolversPluginConfig, TypeScriptResolversVisitor };
+
+const semanticToStrict = async (schema: GraphQLSchema): Promise<GraphQLSchema> => {
+  try {
+    const sock = await import('graphql-sock');
+    return sock.semanticToStrict(schema);
+  } catch {
+    throw new Error(
+      "To use the `customDirective.semanticNonNull` option, you must install the 'graphql-sock' package."
+    );
+  }
+};

packages/plugins/typescript/resolvers/tests/ts-resolvers.config.customDirectives.spec.ts

@@ -0,0 +1,69 @@
+import { buildSchema } from 'graphql';
+import '@graphql-codegen/testing';
+import { plugin } from '../src/index.js';
+
+describe('customDirectives.sematicNonNull', () => {
+  it('allowSemanticNonNull - should build strict type if annotated by @semanticNonNull directive', async () => {
+    const testingSchema = buildSchema(/* GraphQL */ `
+      directive @semanticNonNull(levels: [Int] = [0]) on FIELD_DEFINITION
+
+      type TestingType {
+        field: String @semanticNonNull
+        fieldLevel0: String @semanticNonNull(levels: [0])
+        fieldLevel1: String @semanticNonNull(levels: [1])
+        fieldBothLevels: String @semanticNonNull(levels: [0, 1])
+        list: [String] @semanticNonNull
+        listLevel0: [String] @semanticNonNull(levels: [0])
+        listLevel1: [String] @semanticNonNull(levels: [1])
+        listBothLevels: [String] @semanticNonNull(levels: [0, 1])
+        nonNullableList: [String]! @semanticNonNull
+        nonNullableListLevel0: [String]! @semanticNonNull(levels: [0])
+        nonNullableListLevel1: [String]! @semanticNonNull(levels: [1])
+        nonNullableListBothLevels: [String]! @semanticNonNull(levels: [0, 1])
+        listWithNonNullableItem: [String!] @semanticNonNull
+        listWithNonNullableItemLevel0: [String!] @semanticNonNull(levels: [0])
+        listWithNonNullableItemLevel1: [String!] @semanticNonNull(levels: [1])
+        listWithNonNullableItemBothLevels: [String!] @semanticNonNull(levels: [0, 1])
+        nonNullableListWithNonNullableItem: [String!]! @semanticNonNull
+        nonNullableListWithNonNullableItemLevel0: [String!]! @semanticNonNull(levels: [0])
+        nonNullableListWithNonNullableItemLevel1: [String!]! @semanticNonNull(levels: [1])
+        nonNullableListWithNonNullableItemBothLevels: [String!]! @semanticNonNull(levels: [0, 1])
+      }
+    `);
+
+    const result = await plugin(
+      testingSchema,
+      [],
+      {
+        customDirectives: { semanticNonNull: true },
+      },
+      { outputFile: '' }
+    );
+
+    expect(result.content).toBeSimilarStringTo(`
+      export type TestingTypeResolvers<ContextType = any, ParentType extends ResolversParentTypes['TestingType'] = ResolversParentTypes['TestingType']> = {
+        field?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+        fieldLevel0?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+        fieldLevel1?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
+        fieldBothLevels?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+        list?: Resolver<Array<Maybe<ResolversTypes['String']>>, ParentType, ContextType>;
+        listLevel0?: Resolver<Array<Maybe<ResolversTypes['String']>>, ParentType, ContextType>;
+        listLevel1?: Resolver<Maybe<Array<ResolversTypes['String']>>, ParentType, ContextType>;
+        listBothLevels?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        nonNullableList?: Resolver<Array<Maybe<ResolversTypes['String']>>, ParentType, ContextType>;
+        nonNullableListLevel0?: Resolver<Array<Maybe<ResolversTypes['String']>>, ParentType, ContextType>;
+        nonNullableListLevel1?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        nonNullableListBothLevels?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        listWithNonNullableItem?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        listWithNonNullableItemLevel0?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        listWithNonNullableItemLevel1?: Resolver<Maybe<Array<ResolversTypes['String']>>, ParentType, ContextType>;
+        listWithNonNullableItemBothLevels?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        nonNullableListWithNonNullableItem?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        nonNullableListWithNonNullableItemLevel0?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        nonNullableListWithNonNullableItemLevel1?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        nonNullableListWithNonNullableItemBothLevels?: Resolver<Array<ResolversTypes['String']>, ParentType, ContextType>;
+        __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+      };
+    `);
+  });
+});

yarn.lock

@@ -9094,6 +9094,11 @@ graphql-request@^6.0.0:
     "@graphql-typed-document-node/core" "^3.2.0"
     cross-fetch "^3.1.5"
 
+graphql-sock@1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/graphql-sock/-/graphql-sock-1.0.0.tgz#efdfb991cbd8a37da91d7e2e81c2955945c6df37"
+  integrity sha512-pvODB7YaQ/K80pBOG7AnQC65R0UgE4hZv67VtwVjyQ0u2N+KMKVy8HEcAnYTK27BfVyTQCunSfX114u0xHOBMQ==
+
 graphql-subscriptions@3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/graphql-subscriptions/-/graphql-subscriptions-3.0.0.tgz#820c846ef271414c08f64827b5c9a192801e1b6f"