support for custom enum custom type (#1587)

lolopinto · Aug 8, 2023 · 706783e · 706783e
1 parent 93987f6
commit 706783e
Show file tree

Hide file tree

Showing 9 changed files with 255 additions and 39 deletions.
diff --git a/examples/simple/package-lock.json b/examples/simple/package-lock.json
diff --git a/examples/simple/package.json b/examples/simple/package.json
@@ -33,7 +33,7 @@
     "tsconfig-paths": "^3.11.0"
   },
   "dependencies": {
-    "@snowtop/ent": "^0.1.5",
+    "@snowtop/ent": "^0.1.8",
     "@snowtop/ent-email": "^0.1.0-rc1",
     "@snowtop/ent-passport": "^0.1.0-rc1",
     "@snowtop/ent-password": "^0.1.0-rc1",

diff --git a/examples/simple/src/graphql/generated/mutations/bulk_upload_contact_type.ts b/examples/simple/src/graphql/generated/mutations/bulk_upload_contact_type.ts
diff --git a/examples/simple/src/graphql/generated/schema.gql b/examples/simple/src/graphql/generated/schema.gql
diff --git a/examples/simple/src/graphql/mutations/custom_enum.ts b/examples/simple/src/graphql/mutations/custom_enum.ts
@@ -0,0 +1,30 @@
+import { GraphQLEnumType } from "graphql";
+
+export enum ContactLabel2 {
+  Work = "work",
+  Home = "home",
+  Default = "default",
+  Unknown = "unknown",
+  Self = "self",
+}
+
+export const GraphQLContactLabel2 = new GraphQLEnumType({
+  name: "ContactLabel2",
+  values: {
+    WORK: {
+      value: "work",
+    },
+    HOME: {
+      value: "home",
+    },
+    DEFAULT: {
+      value: "default",
+    },
+    UNKNOWN: {
+      value: "unknown",
+    },
+    SELF: {
+      value: "self",
+    },
+  },
+});
diff --git a/examples/simple/src/graphql/mutations/import_contact.ts b/examples/simple/src/graphql/mutations/import_contact.ts
@@ -16,6 +16,7 @@ import {
 } from "../../ent/generated/user/actions/user_builder";
 import { ExampleViewer } from "../../viewer/viewer";
 import { ContactLabel } from "../../ent/generated/types";
+import { ContactLabel2 } from "./custom_enum";
 
 export class ImportContactResolver {
   @gqlMutation({
@@ -36,6 +37,15 @@ export class ImportContactResolver {
         type: "ContactLabel",
         nullable: true,
       },
+      {
+        name: "defaultLabel2",
+        type: {
+          type: "GraphQLContactLabel2",
+          importPath: "src/graphql/mutations/custom_enum",
+          tsType: "ContactLabel2",
+          tsImportPath: "src/graphql/mutations/custom_enum",
+        },
+      },
     ],
     async: true,
   })
@@ -44,6 +54,7 @@ export class ImportContactResolver {
     userID: ID,
     file: Promise<FileUpload>,
     label?: ContactLabel,
+    _label2?: ContactLabel2,
   ) {
     const file2 = await file;
 

diff --git a/ts/package.json b/ts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@snowtop/ent",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "snowtop ent framework",
   "main": "index.js",
   "types": "index.d.ts",

diff --git a/ts/src/graphql/graphql.test.ts b/ts/src/graphql/graphql.test.ts
@@ -11,6 +11,8 @@ import {
   GraphQLString,
   GraphQLScalarType,
   GraphQLError,
+  GraphQLEnumType,
+  GraphQLBoolean,
 } from "graphql";
 import { Kind, ValueNode } from "graphql/language";
 
@@ -523,6 +525,142 @@ describe("property", () => {
           tsImportPath: "",
         },
       ]);
+      GQLCapture.resolve([]);
+    });
+  });
+
+  describe("enabled. custom enum ", () => {
+    enum RequestStatus {
+      PENDING = "pending",
+      ACCEPTED = "accepted",
+      REJECTED = "rejected",
+    }
+
+    const GraphQLRequestStatus = new GraphQLEnumType({
+      name: "RequestStatus",
+      values: {
+        PENDING: {
+          value: "pending",
+        },
+        ACCEPTED: {
+          value: "accepted",
+        },
+        REJECTED: {
+          value: "rejected",
+        },
+      },
+    });
+
+    test("enabled. custom enum used incorrectly", () => {
+      try {
+        class Request {
+          @gqlField({
+            class: "User",
+            type: GraphQLRequestStatus,
+          })
+          status: RequestStatus;
+        }
+        throw new Error(`should have thrown`);
+      } catch (err) {
+        expect(err.message).toMatch(
+          /custom enum type RequestStatus is not supported this way. use CustomType syntax/,
+        );
+      }
+
+      validateNoCustom();
+    });
+
+    test("enabled. custom enum", () => {
+      class Request {
+        @gqlField({
+          class: "User",
+          type: {
+            type: "GraphQLRequestStatus",
+            importPath: "",
+            tsType: "RequestStatus",
+            tsImportPath: "",
+          },
+        })
+        status: RequestStatus;
+      }
+      validateOneCustomField({
+        nodeName: "User",
+        functionName: "status",
+        gqlName: "status",
+        fieldType: CustomFieldType.Field,
+        results: [
+          {
+            type: "GraphQLRequestStatus",
+            name: "",
+            tsType: "RequestStatus",
+            needsResolving: true,
+          },
+        ],
+        args: [],
+      });
+
+      validateCustomTypes([
+        {
+          type: "GraphQLRequestStatus",
+          importPath: "",
+          tsType: "RequestStatus",
+          tsImportPath: "",
+        },
+      ]);
+      GQLCapture.resolve([]);
+    });
+
+    test.only("enabled. custom enum as arg", () => {
+      class Request {
+        @gqlField({
+          class: "User",
+          type: GraphQLBoolean,
+          args: [
+            {
+              name: "status",
+              type: {
+                type: "GraphQLRequestStatus",
+                importPath: "",
+                tsType: "RequestStatus",
+                tsImportPath: "",
+              },
+            },
+          ],
+        })
+        async doSomething(status: RequestStatus) {
+          return true;
+        }
+      }
+      validateOneCustomField({
+        nodeName: "User",
+        functionName: "doSomething",
+        gqlName: "doSomething",
+        fieldType: CustomFieldType.Function,
+        results: [
+          {
+            type: "Boolean",
+            name: "",
+          },
+        ],
+        args: [
+          {
+            name: "status",
+            type: "GraphQLRequestStatus",
+            tsType: "RequestStatus",
+            needsResolving: true,
+          },
+        ],
+      });
+
+      validateCustomTypes([
+        {
+          type: "GraphQLRequestStatus",
+          importPath: "",
+          tsType: "RequestStatus",
+          tsImportPath: "",
+        },
+      ]);
+      GQLCapture.resolve([]);
     });
   });
 });