feat: options.complexityThreshold

astahmer · Oct 25, 2022 · dd361cc · dd361cc
1 parent ed3e320
commit dd361cc
Show file tree

Hide file tree

Showing 20 changed files with 665 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -229,7 +229,7 @@ const endpoints = makeApi([
                 schema: z.number().optional(),
             },
         ],
-        response: Pets,
+        response: z.array(Pet),
     },
     {
         method: "post",

diff --git a/src/CodeMeta.ts b/src/CodeMeta.ts
@@ -1,6 +1,7 @@
 import type { ReferenceObject, SchemaObject } from "openapi3-ts";
 import { isReferenceObject } from "openapi3-ts";
 
+import { getSchemaComplexity } from "./schema-complexity";
 import { getRefName } from "./utils";
 
 export type ConversionTypeContext = {
@@ -51,6 +52,10 @@ export class CodeMeta {
         return getRefName(this.ref!);
     }
 
+    get complexity(): number {
+        return getSchemaComplexity({ current: 0, schema: this.schema });
+    }
+
     assign(code: string) {
         this.code = code;
 

diff --git a/src/cli.ts b/src/cli.ts
@@ -34,6 +34,10 @@ cli.command("<input>", "path/url to OpenAPI/Swagger document as json/yaml")
         "--group-strategy",
         "groups endpoints by a given strategy, possible values are: 'none' | 'tag' | 'method' | 'tag-file' | 'method-file'"
     )
+    .option(
+        "--complexity-threshold",
+        "schema complexity threshold to determine which one (using less than `<` operator) should be assigned to a variable"
+    )
     .action(async (input, options) => {
         console.log("Retrieving OpenAPI document from", input);
         const openApiDoc = (await SwaggerParser.bundle(input)) as OpenAPIObject;
@@ -55,6 +59,7 @@ cli.command("<input>", "path/url to OpenAPI/Swagger document as json/yaml")
                 withImplicitRequiredProps: options.implicitRequired,
                 withDeprecatedEndpoints: options.withDeprecated,
                 groupStrategy: options.groupStrategy,
+                complexityThreshold: options.complexityThreshold,
             },
         });
         console.log(`Done generating <${distPath}> !`);

diff --git a/src/generateZodClientFromOpenAPI.test.ts b/src/generateZodClientFromOpenAPI.test.ts
@@ -133,7 +133,7 @@ test("getZodClientTemplateContext", async () => {
                   "parameters": [
                       {
                           "name": "status",
-                          "schema": "status",
+                          "schema": "z.enum(["available", "pending", "sold"]).optional()",
                           "type": "Query",
                       },
                   ],
@@ -155,7 +155,7 @@ test("getZodClientTemplateContext", async () => {
                   "parameters": [
                       {
                           "name": "tags",
-                          "schema": "tags",
+                          "schema": "z.array(z.string()).optional()",
                           "type": "Query",
                       },
                   ],
@@ -298,7 +298,7 @@ test("getZodClientTemplateContext", async () => {
                       {
                           "description": undefined,
                           "name": "body",
-                          "schema": "createUsersWithListInput_Body",
+                          "schema": "z.array(User)",
                           "type": "Body",
                       },
                   ],
@@ -356,9 +356,6 @@ test("getZodClientTemplateContext", async () => {
               "Pet": "z.object({ id: z.number().int().optional(), name: z.string(), category: Category.optional(), photoUrls: z.array(z.string()), tags: z.array(Tag).optional(), status: z.enum(["available", "pending", "sold"]).optional() })",
               "Tag": "z.object({ id: z.number().int(), name: z.string() }).partial()",
               "User": "z.object({ id: z.number().int(), username: z.string(), firstName: z.string(), lastName: z.string(), email: z.string(), password: z.string(), phone: z.string(), userStatus: z.number().int() }).partial()",
-              "createUsersWithListInput_Body": "z.array(User)",
-              "status": "z.enum(["available", "pending", "sold"]).optional()",
-              "tags": "z.array(z.string()).optional()",
           },
           "types": {},
       }
@@ -382,8 +379,6 @@ describe("generateZodClientFromOpenAPI", () => {
             tags: z.array(Tag).optional(),
             status: z.enum(["available", "pending", "sold"]).optional(),
           });
-          const status = z.enum(["available", "pending", "sold"]).optional();
-          const tags = z.array(z.string()).optional();
           const ApiResponse = z
             .object({ code: z.number().int(), type: z.string(), message: z.string() })
             .partial();
@@ -409,7 +404,6 @@ describe("generateZodClientFromOpenAPI", () => {
               userStatus: z.number().int(),
             })
             .partial();
-          const createUsersWithListInput_Body = z.array(User);
 
           const endpoints = makeApi([
             {
@@ -519,7 +513,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "status",
                   type: "Query",
-                  schema: status,
+                  schema: z.enum(["available", "pending", "sold"]).optional(),
                 },
               ],
               response: z.array(Pet),
@@ -540,7 +534,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "tags",
                   type: "Query",
-                  schema: tags,
+                  schema: z.array(z.string()).optional(),
                 },
               ],
               response: z.array(Pet),
@@ -675,7 +669,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "body",
                   type: "Body",
-                  schema: createUsersWithListInput_Body,
+                  schema: z.array(User),
                 },
               ],
               response: User,
@@ -738,8 +732,6 @@ describe("generateZodClientFromOpenAPI", () => {
             tags: z.array(Tag).optional(),
             status: z.enum(["available", "pending", "sold"]).optional(),
           });
-          const status = z.enum(["available", "pending", "sold"]).optional();
-          const tags = z.array(z.string()).optional();
           const ApiResponse = z
             .object({ code: z.number().int(), type: z.string(), message: z.string() })
             .partial();
@@ -765,7 +757,6 @@ describe("generateZodClientFromOpenAPI", () => {
               userStatus: z.number().int(),
             })
             .partial();
-          const createUsersWithListInput_Body = z.array(User);
 
           const endpoints = makeApi([
             {
@@ -880,7 +871,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "status",
                   type: "Query",
-                  schema: status,
+                  schema: z.enum(["available", "pending", "sold"]).optional(),
                 },
               ],
               response: z.array(Pet),
@@ -902,7 +893,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "tags",
                   type: "Query",
-                  schema: tags,
+                  schema: z.array(z.string()).optional(),
                 },
               ],
               response: z.array(Pet),
@@ -1044,7 +1035,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "body",
                   type: "Body",
-                  schema: createUsersWithListInput_Body,
+                  schema: z.array(User),
                 },
               ],
               response: User,
@@ -1111,8 +1102,6 @@ describe("generateZodClientFromOpenAPI", () => {
             tags: z.array(Tag).optional(),
             status: z.enum(["available", "pending", "sold"]).optional(),
           });
-          const status = z.enum(["available", "pending", "sold"]).optional();
-          const tags = z.array(z.string()).optional();
           const ApiResponse = z
             .object({ code: z.number().int(), type: z.string(), message: z.string() })
             .partial();
@@ -1138,7 +1127,6 @@ describe("generateZodClientFromOpenAPI", () => {
               userStatus: z.number().int(),
             })
             .partial();
-          const createUsersWithListInput_Body = z.array(User);
 
           const endpoints = makeApi([
             {
@@ -1248,7 +1236,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "status",
                   type: "Query",
-                  schema: status,
+                  schema: z.enum(["available", "pending", "sold"]).optional(),
                 },
               ],
               response: z.array(Pet),
@@ -1269,7 +1257,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "tags",
                   type: "Query",
-                  schema: tags,
+                  schema: z.array(z.string()).optional(),
                 },
               ],
               response: z.array(Pet),
@@ -1404,7 +1392,7 @@ describe("generateZodClientFromOpenAPI", () => {
                 {
                   name: "body",
                   type: "Body",
-                  schema: createUsersWithListInput_Body,
+                  schema: z.array(User),
                 },
               ],
               response: User,

diff --git a/src/getZodiosEndpointDefinitionList.test.ts b/src/getZodiosEndpointDefinitionList.test.ts
@@ -418,7 +418,7 @@ test("getZodiosEndpointDefinitionFromOpenApiDoc /pet/findXXX", () => {
                   "parameters": [
                       {
                           "name": "status",
-                          "schema": "status",
+                          "schema": "z.enum(["available", "pending", "sold"]).optional()",
                           "type": "Query",
                       },
                   ],
@@ -440,7 +440,7 @@ test("getZodiosEndpointDefinitionFromOpenApiDoc /pet/findXXX", () => {
                   "parameters": [
                       {
                           "name": "tags",
-                          "schema": "tags",
+                          "schema": "z.array(z.string()).optional()",
                           "type": "Query",
                       },
                   ],
@@ -456,16 +456,11 @@ test("getZodiosEndpointDefinitionFromOpenApiDoc /pet/findXXX", () => {
                   "#/components/schemas/Tag",
               },
           },
-          "schemaByName": {
-              "z.array(z.string()).optional()": "tags",
-              "z.enum(["available", "pending", "sold"]).optional()": "status",
-          },
+          "schemaByName": {},
           "zodSchemaByName": {
               "Category": "z.object({ id: z.number().int(), name: z.string() }).partial()",
               "Pet": "z.object({ id: z.number().int().optional(), name: z.string(), category: Category.optional(), photoUrls: z.array(z.string()), tags: z.array(Tag).optional(), status: z.enum(["available", "pending", "sold"]).optional() })",
               "Tag": "z.object({ id: z.number().int(), name: z.string() }).partial()",
-              "status": "z.enum(["available", "pending", "sold"]).optional()",
-              "tags": "z.array(z.string()).optional()",
           },
       }
     `);
@@ -553,7 +548,7 @@ test("petstore.yaml", async () => {
                   "parameters": [
                       {
                           "name": "status",
-                          "schema": "status",
+                          "schema": "z.enum(["available", "pending", "sold"]).optional()",
                           "type": "Query",
                       },
                   ],
@@ -575,7 +570,7 @@ test("petstore.yaml", async () => {
                   "parameters": [
                       {
                           "name": "tags",
-                          "schema": "tags",
+                          "schema": "z.array(z.string()).optional()",
                           "type": "Query",
                       },
                   ],
@@ -803,7 +798,7 @@ test("petstore.yaml", async () => {
                       {
                           "description": undefined,
                           "name": "body",
-                          "schema": "createUsersWithListInput_Body",
+                          "schema": "z.array(User)",
                           "type": "Body",
                       },
                   ],
@@ -932,21 +927,14 @@ test("petstore.yaml", async () => {
                   "#/components/schemas/Tag",
               },
           },
-          "schemaByName": {
-              "z.array(User)": "createUsersWithListInput_Body",
-              "z.array(z.string()).optional()": "tags",
-              "z.enum(["available", "pending", "sold"]).optional()": "status",
-          },
+          "schemaByName": {},
           "zodSchemaByName": {
               "ApiResponse": "z.object({ code: z.number().int(), type: z.string(), message: z.string() }).partial()",
               "Category": "z.object({ id: z.number().int(), name: z.string() }).partial()",
               "Order": "z.object({ id: z.number().int(), petId: z.number().int(), quantity: z.number().int(), shipDate: z.string(), status: z.enum(["placed", "approved", "delivered"]), complete: z.boolean() }).partial()",
               "Pet": "z.object({ id: z.number().int().optional(), name: z.string(), category: Category.optional(), photoUrls: z.array(z.string()), tags: z.array(Tag).optional(), status: z.enum(["available", "pending", "sold"]).optional() })",
               "Tag": "z.object({ id: z.number().int(), name: z.string() }).partial()",
               "User": "z.object({ id: z.number().int(), username: z.string(), firstName: z.string(), lastName: z.string(), email: z.string(), password: z.string(), phone: z.string(), userStatus: z.number().int() }).partial()",
-              "createUsersWithListInput_Body": "z.array(User)",
-              "status": "z.enum(["available", "pending", "sold"]).optional()",
-              "tags": "z.array(z.string()).optional()",
           },
       }
     `);

diff --git a/src/getZodiosEndpointDefinitionList.ts b/src/getZodiosEndpointDefinitionList.ts
@@ -16,6 +16,7 @@ import { sync } from "whence";
 import type { CodeMeta, ConversionTypeContext } from "./CodeMeta";
 import { getOpenApiDependencyGraph } from "./getOpenApiDependencyGraph";
 import { getZodChainablePresence, getZodSchema } from "./openApiToZod";
+import { getSchemaComplexity } from "./schema-complexity";
 import type { TemplateContext } from "./template-context";
 import { getRefFromName, normalizeString, pathToVariableName } from "./utils";
 
@@ -53,19 +54,24 @@ export const getZodiosEndpointDefinitionList = (doc: OpenAPIObject, options?: Te
     }
 
     const ctx: ConversionTypeContext = { getSchemaByRef, zodSchemaByName: {}, schemaByName: {} };
+    const complexityThreshold = options?.complexityThreshold ?? 4;
     const getZodVarName = (input: CodeMeta, fallbackName?: string) => {
         const result = input.toString();
 
+        // special value, inline everything (= no variable used)
+        if (complexityThreshold === -1) {
+            return input.ref ? ctx.zodSchemaByName[result]! : result;
+        }
+
         if (result.startsWith("z.") && fallbackName) {
             // result is simple enough that it doesn't need to be assigned to a variable
-            if (!complexType.some((type) => result.startsWith(type))) {
-                // if (input.complexity < 10) {
+            if (input.complexity < complexityThreshold) {
                 return result;
             }
 
             const safeName = normalizeString(fallbackName);
 
-            // if schema is already assigned to a variable, re-use that variable
+            // if schema is already assigned to a variable, re-use that variable name
             if (ctx.schemaByName[result]) {
                 return ctx.schemaByName[result]!;
             }
@@ -87,7 +93,14 @@ export const getZodiosEndpointDefinitionList = (doc: OpenAPIObject, options?: Te
         }
 
         // result is a reference to another schema
-        if (ctx.zodSchemaByName[result]) {
+        if (input.ref && ctx.zodSchemaByName[result]) {
+            const complexity = getSchemaComplexity({ current: 0, schema: getSchemaByRef(input.ref) });
+
+            // ref result is simple enough that it doesn't need to be assigned to a variable
+            if (complexity < complexityThreshold) {
+                return ctx.zodSchemaByName[result]!;
+            }
+
             return result;
         }
 
@@ -186,7 +199,6 @@ export const getZodiosEndpointDefinitionList = (doc: OpenAPIObject, options?: Te
 
                     if (isMainResponseStatus(status) || (statusCode === "default" && !endpointDescription.response)) {
                         endpointDescription.response = schemaString;
-                        // console.log({ schema, schemaString });
 
                         if (
                             !endpointDescription.description &&
@@ -235,5 +247,4 @@ export type EndpointDescriptionWithRefs = Omit<
     errors: Array<Omit<Required<ZodiosEndpointDefinition<any>>["errors"][number], "schema"> & { schema: string }>;
 };
 
-const complexType = ["z.object", "z.array", "z.union", "z.enum"] as const;
 const pathParamRegex = /{(\w+)}/g;