feat: improve oas converter error output (#184)

api7 · Sep 6, 2024 · 8bd118d · 8bd118d
1 parent 79edaa7
commit 8bd118d
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 4 deletions.
diff --git a/libs/converter-openapi/src/index.ts b/libs/converter-openapi/src/index.ts
@@ -3,6 +3,7 @@ import { Listr } from 'listr2';
 import { isEmpty } from 'lodash';
 import { OpenAPIV3 } from 'openapi-types';
 import slugify from 'slugify';
+import { ZodError } from 'zod';
 
 import { ExtKey, parseExtPlugins } from './extension';
 import { parseSeprateService, parseUpstream } from './parser';
@@ -17,9 +18,27 @@ export class OpenAPIConverter implements ADCSDK.Converter {
     return new Listr<{ local: ADCSDK.Configuration }>([
       {
         title: 'Validate OpenAPI document',
-        task: () => {
-          const res = schema.safeParse(oas);
-          if (!res.success) throw new Error(res.error.toString()); //TODO optimize it
+        task: (ctx, task) => {
+          const result = schema.safeParse(oas);
+
+          if (!result.success) {
+            let err =
+              'Validate OpenAPI document\nThe following errors were found in OpenAPI document:\n';
+
+            if ('error' in result) {
+              (result.error as ZodError).errors.forEach((error, idx) => {
+                err += `#${idx + 1} ${error.message}, field: "${(
+                  error.path ?? []
+                ).join('.')}"\n`;
+                task.output = this.buildDebugOutput([
+                  `#${idx + 1} raw error: `,
+                  JSON.stringify(error),
+                ]);
+              });
+            }
+
+            throw new Error(err);
+          }
         },
       },
       {

diff --git a/libs/converter-openapi/src/schema.ts b/libs/converter-openapi/src/schema.ts
@@ -37,7 +37,12 @@ export const schema = z.object({
   servers: z
     .array(
       z.object({
-        url: z.string().regex(/https?:\/\//g),
+        url: z
+          .string()
+          .regex(
+            /https?:\/\//g,
+            'The URL must be start with "https://" or "http://"',
+          ),
         variables: z.optional(
           z.record(
             z.string(),

diff --git a/libs/converter-openapi/tsconfig.lib.json b/libs/converter-openapi/tsconfig.lib.json
@@ -4,6 +4,7 @@
     "module": "commonjs",
     "outDir": "../../dist/out-tsc",
     "declaration": true,
+    "esModuleInterop": true,
     "types": [
       "node"
     ],