small refactors

Author: danadajian

eslint.config.js

@@ -13,6 +13,7 @@ export default [
       },
     },
     rules: {
+      "no-console": "error",
       "@typescript-eslint/no-non-null-assertion": "error",
       "@typescript-eslint/no-unsafe-argument": "error",
       "@typescript-eslint/no-unsafe-call": "error",

src/config.ts

@@ -46,11 +46,11 @@ export const configSchema = object({
   dependentTypesInScope: optional(array(string())),
   /**
    * Denotes Kotlin classes representing union types to be treated as interfaces rather than annotation classes.
-   * This should be used for types outside `dependentTypesInScope` that are not generated by the plugin.
+   * @description This should be used for types outside `dependentTypesInScope` that are not generated by the plugin. This also should only be used when unionGeneration is set to `ANNOTATION_CLASS`.
    */
   externalUnionsAsInterfaces: optional(array(string())),
   /**
-   * Additional imports to add to the generated file.
+   * Additional imports to add to the generated file. GraphQL Kotlin annotations are always imported.
    * @example ["com.example.additional.import.*"]
    */
   extraImports: optional(array(string())),
@@ -133,6 +133,7 @@ export const configSchema = object({
   ),
   /**
    * Denotes the generation strategy for union types. Defaults to `MARKER_INTERFACE`.
+   *
    * https://opensource.expediagroup.com/graphql-kotlin/docs/schema-generator/writing-schemas/unions/
    */
   unionGeneration: optional(

src/definitions/input.ts

@@ -47,7 +47,6 @@ export function buildInputObjectDefinition(
 
   const annotations = buildAnnotations({
     config,
-    inputDescription: node.description?.value,
     definitionNode: node,
   });
 

src/definitions/union.ts

@@ -13,7 +13,6 @@ limitations under the License.
 
 import { UnionTypeDefinitionNode } from "graphql";
 import { shouldIncludeTypeDefinition } from "../helpers/should-include-type-definition";
-import { buildDirectiveAnnotations } from "../helpers/build-directive-annotations";
 import { CodegenConfigWithDefaults } from "../config";
 import {
   buildAnnotations,
@@ -32,10 +31,9 @@ export function buildUnionTypeDefinition(
     definitionNode: node,
   });
   if (config.unionGeneration === "ANNOTATION_CLASS") {
-    const directiveAnnotations = buildDirectiveAnnotations(node, config);
     const possibleTypes =
       node.types?.map((type) => `${type.name.value}::class`).join(", ") || "";
-    return `${directiveAnnotations}@GraphQLUnion(
+    return `${annotations}@GraphQLUnion(
     name = "${node.name.value}",
     possibleTypes = [${possibleTypes}],
     description = "${trimDescription(node.description?.value)}"

src/helpers/add-dependent-types.ts renamed to src/helpers/add-dependent-types-to-only-types.ts

@@ -16,12 +16,12 @@ import { getDependentTypeNames } from "./get-dependent-type-names";
 import { dependentTypeIsInScope } from "./dependent-type-is-in-scope";
 import { GraphQLSchema } from "graphql";
 
-export function addDependentTypes(
+export function addDependentTypesToOnlyTypes(
   config: CodegenConfigWithDefaults,
   schema: GraphQLSchema,
 ) {
   if (!config.onlyTypes) {
-    throw new Error(`config.onlyTypes is required to add dependent types`);
+    throw new Error(`onlyTypes config is required to add dependent types`);
   }
   const onlyTypesNodes = config.onlyTypes
     .map((typeName) => schema.getType(typeName)?.astNode)

src/helpers/build-annotations.ts

@@ -16,6 +16,7 @@ import {
   EnumValueDefinitionNode,
   FieldDefinitionNode,
   InputValueDefinitionNode,
+  Kind,
   TypeDefinitionNode,
 } from "graphql";
 import { buildDirectiveAnnotations } from "./build-directive-annotations";
@@ -30,17 +31,14 @@ export type DefinitionNode =
 
 export function buildAnnotations({
   config,
-  inputDescription,
   definitionNode,
   resolvedType,
 }: {
   config: CodegenConfigWithDefaults;
-  inputDescription?: string;
   definitionNode?: DefinitionNode;
   resolvedType?: TypeMetadata;
 }) {
-  const description =
-    inputDescription ?? definitionNode?.description?.value ?? "";
+  const description = definitionNode?.description?.value ?? "";
   const isDeprecated = isDeprecatedDescription(description, resolvedType);
   const descriptionAnnotator = isDeprecated
     ? "@Deprecated"
@@ -49,15 +47,18 @@ export function buildAnnotations({
     ? description.replace("DEPRECATED: ", "")
     : description;
   const trimmedDescription = trimDescription(descriptionValue);
-  const descriptionAnnotation = description
-    ? `${descriptionAnnotator}("${trimmedDescription}")\n`
-    : "";
+  const descriptionAnnotation =
+    !description ||
+    (definitionNode?.kind === Kind.UNION_TYPE_DEFINITION &&
+      config.unionGeneration === "ANNOTATION_CLASS")
+      ? ""
+      : `${descriptionAnnotator}("${trimmedDescription}")\n`;
 
   const directiveAnnotations = definitionNode
     ? buildDirectiveAnnotations(
         definitionNode,
         config,
-        description,
+        isDeprecated,
         resolvedType,
       )
     : "";

src/helpers/build-config-with-defaults.ts

@@ -13,7 +13,7 @@ export function buildConfigWithDefaults(
     ...config,
     extraImports: [
       "com.expediagroup.graphql.generator.annotations.*",
-      ...(config.extraImports ?? ([] satisfies string[])),
+      ...(config.extraImports ?? []),
     ],
   } as const;
 }

src/helpers/build-directive-annotations.ts

@@ -12,46 +12,39 @@ limitations under the License.
 */
 
 import { CodegenConfigWithDefaults } from "../config";
-import {
-  DefinitionNode,
-  isDeprecatedDescription,
-  trimDescription,
-} from "./build-annotations";
+import { DefinitionNode, trimDescription } from "./build-annotations";
 import { getFederationDirectiveReplacement } from "./get-federation-directive-replacement";
 import { TypeMetadata } from "./build-type-metadata";
 import { ConstDirectiveNode } from "graphql/language";
 
 export function buildDirectiveAnnotations(
-  incomingNode: DefinitionNode,
+  definitionNode: DefinitionNode,
   config: CodegenConfigWithDefaults,
-  description?: string,
+  isDeprecated?: boolean,
   resolvedType?: TypeMetadata,
 ) {
-  const kind = incomingNode.kind;
-  const directives = incomingNode.directives ?? [];
+  const kind = definitionNode.kind;
+  const directives = definitionNode.directives ?? [];
 
   return directives
     .map((directive) => {
       const directiveName = directive.name.value;
-      if (
-        directiveName === "deprecated" &&
-        !isDeprecatedDescription(description)
-      ) {
+      if (directiveName === "deprecated" && !isDeprecated) {
         const deprecatedReasonNode = directive.arguments?.find(
           (arg) => arg.name.value === "reason",
         )?.value;
         const deprecatedReason =
           deprecatedReasonNode?.kind === "StringValue"
             ? deprecatedReasonNode.value
             : "";
-        if (incomingNode.description?.value && resolvedType?.unionAnnotation) {
+        if (
+          definitionNode.description?.value &&
+          resolvedType?.unionAnnotation
+        ) {
           return "";
         }
-        const descriptionAnnotator = resolvedType?.unionAnnotation
-          ? "@GraphQLDescription"
-          : "@Deprecated";
         const trimmedDeprecatedReason = trimDescription(deprecatedReason);
-        return `${descriptionAnnotator}("${trimmedDeprecatedReason}")\n`;
+        return `@Deprecated("${trimmedDeprecatedReason}")\n`;
       }
       const federationReplacement =
         getFederationDirectiveReplacement(directive);

src/plugin.ts

@@ -22,7 +22,7 @@ import {
 } from "@graphql-codegen/visitor-plugin-common";
 import { Input, safeParse } from "valibot";
 import { configSchema } from "./config";
-import { addDependentTypes } from "./helpers/add-dependent-types";
+import { addDependentTypesToOnlyTypes } from "./helpers/add-dependent-types-to-only-types";
 import { visit } from "graphql";
 import { buildConfigWithDefaults } from "./helpers/build-config-with-defaults";
 
@@ -56,7 +56,7 @@ export const plugin: PluginFunction<GraphQLKotlinCodegenConfig> = (
     configWithDefaults.onlyTypes &&
     configWithDefaults.includeDependentTypes
   ) {
-    addDependentTypes(configWithDefaults, schema);
+    addDependentTypesToOnlyTypes(configWithDefaults, schema);
   }
   const visitor = new KotlinVisitor(configWithDefaults, schema);
   const astNode = getCachedDocumentNodeFromSchema(schema);
@@ -67,7 +67,10 @@ export const plugin: PluginFunction<GraphQLKotlinCodegenConfig> = (
       .map((annotation) => `import ${annotation}`)
       .join("\n") + "\n";
   const typeDefinitions = definitions
-    .filter((d: unknown) => typeof d === "string" && d.length)
+    .filter(
+      (definition: unknown) =>
+        typeof definition === "string" && definition.length,
+    )
     .join("\n\n");
 
   return [packageName, imports, typeDefinitions].join("\n") + "\n";

test/unit/should_honor_union_generation_config/expected.kt

@@ -24,5 +24,14 @@ data class UnionForHonoringUnionGenerationConfig(
     val field: Any? = null,
     @UnionAsAnnotation
     @GraphQLDescription("DEPRECATED: It uses the GraphQLDescription annotation for union annotations")
-    val field2: Any? = null
+    val deprecated1: Any? = null,
+    @UnionAsAnnotation
+    @GraphQLDescription("DEPRECATED: It uses the GraphQLDescription annotation for union types")
+    val deprecated2: Any? = null,
+    @UnionAsAnnotation
+    @Deprecated("It uses the GraphQLDescription annotation for union types")
+    val deprecated3: Any? = null,
+    @UnionAsAnnotation
+    @GraphQLDescription("When there is a description")
+    val deprecated4: Any? = null
 )

test/unit/should_honor_union_generation_config/schema.graphql

@@ -18,5 +18,15 @@ type UnionForHonoringUnionGenerationConfig {
   "A description for field"
   field: UnionAsAnnotation
   "DEPRECATED: It uses the GraphQLDescription annotation for union annotations"
-  field2: UnionAsAnnotation
+  deprecated1: UnionAsAnnotation
+    @deprecated(reason: "when you have multiple deprecated annotations")
+  "DEPRECATED: It uses the GraphQLDescription annotation for union types"
+  deprecated2: UnionAsAnnotation
+  deprecated3: UnionAsAnnotation
+    @deprecated(
+      reason: "It uses the GraphQLDescription annotation for union types"
+    )
+  "When there is a description"
+  deprecated4: UnionAsAnnotation
+    @deprecated(reason: "It uses the @Deprecated annotation for the reason")
 }