feat([openapi]): options validation by zod

Author: glc-omid

.changeset/thick-mangos-explain.md

@@ -0,0 +1,5 @@
+---
+"@eventcatalog/generator-openapi": patch
+---
+
+feat(plugin): added validation on inputs and ability to parse the spec file

package.json

@@ -38,6 +38,7 @@
     "@eventcatalog/sdk": "^0.1.4",
     "chalk": "^4",
     "openapi-types": "^12.1.3",
-    "slugify": "^1.6.6"
+    "slugify": "^1.6.6",
+    "zod": "^3.23.8"
   }
 }

pnpm-lock.yaml

@@ -7,17 +7,40 @@ import { defaultMarkdown as generateMarkdownForDomain } from './utils/domains';
 import { buildService } from './utils/services';
 import { buildMessage } from './utils/messages';
 import { getOperationsByType } from './utils/openapi';
-import { Domain, Service } from './types';
 import { getMessageTypeUtils } from './utils/catalog-shorthand';
 import { OpenAPI } from 'openapi-types';
 import checkLicense from './utils/checkLicense';
-
-type Props = {
-  services: Service[];
-  domain?: Domain;
-  debug?: boolean;
+import { z } from 'zod';
+
+const optionsSchema = z.object({
+  services: z.array(
+    z.object({
+      id: z.string({ required_error: 'The service id is required. please provide the service id' }),
+      path: z.string({ required_error: 'The service path is required. please provide the path to specification file' }),
+      name: z.string().optional(),
+    }),
+    { message: 'Please provide correct services configuration' }
+  ),
+  domain: z
+    .object({
+      id: z.string({ required_error: 'The domain id is required. please provide a domain id' }),
+      name: z.string({ required_error: 'The domain name is required. please provide a domain name' }),
+      version: z.string({ required_error: 'The domain version is required. please provide a domain version' }),
+    })
+    .optional(),
+  debug: z.boolean().optional(),
+  saveParsedSpecFile: z.boolean({ invalid_type_error: 'The saveParsedSpecFile is not a boolean in options' }).optional(),
+});
+
+type Props = z.infer<typeof optionsSchema>;
+
+const validateOptions = (options: Props) => {
+  try {
+    optionsSchema.parse(options);
+  } catch (error: any) {
+    if (error instanceof z.ZodError) throw new Error(JSON.stringify(error.issues, null, 2));
+  }
 };
-
 export default async (_: any, options: Props) => {
   if (!process.env.PROJECT_DIR) {
     throw new Error('Please provide catalog url (env variable PROJECT_DIR)');
@@ -37,6 +60,7 @@ export default async (_: any, options: Props) => {
   } = utils(process.env.PROJECT_DIR);
 
   const services = options.services ?? [];
+  validateOptions(options);
   for (const serviceSpec of services) {
     console.log(chalk.green(`Processing ${serviceSpec.path}`));
 

src/index.ts

@@ -510,6 +510,77 @@ describe('OpenAPI EventCatalog Plugin', () => {
 
             expect(service).toBeDefined();
           });
+
+          it('[id] if the `id` not provided in the service config options, The generator throw an explicit error', async () => {
+            await expect(
+              plugin(config, {
+                services: [
+                  {
+                    path: join(openAPIExamples, 'petstore.yml'),
+                  } as any,
+                ],
+              })
+            ).rejects.toThrow('The service id is required');
+          });
+          it('[services] if the `services` not provided in options, The generator throw an explicit error', async () => {
+            await expect(plugin(config, {} as any)).rejects.toThrow('Please provide correct services configuration');
+          });
+          it('[services] if the `services` is undefiend in options, The generator throw an explicit error', async () => {
+            await expect(plugin(config, { services: undefined } as any)).rejects.toThrow(
+              'Please provide correct services configuration'
+            );
+          });
+          it('[services::path] if the `services::path` not provided in options, The generator throw an explicit error', async () => {
+            await expect(plugin(config, { services: [{ id: 'service_id' }] } as any)).rejects.toThrow(
+              'The service path is required. please provide the path to specification file'
+            );
+          });
+          it('[services::id] if the `services::id` not provided in options, The generator throw an explicit error', async () => {
+            await expect(plugin(config, { services: [{ path: 'path/to/spec' }] } as any)).rejects.toThrow(
+              'The service id is required. please provide the service id'
+            );
+          });
+          it('[path] if the `path` not provided in service config options, The generator throw an explicit error', async () => {
+            await expect(
+              plugin(config, {
+                services: [
+                  {
+                    name: 'Awesome account service',
+                    id: 'awsome-service',
+                  } as any,
+                ],
+              })
+            ).rejects.toThrow('The service path is required. please provide the path to specification file');
+          });
+          it('[services::saveParsedSpecFile] if the `services::saveParsedSpecFile` not a boolean in options, The generator throw an explicit error', async () => {
+            await expect(
+              plugin(config, { services: [{ path: 'path/to/spec', id: 'sevice_id' }], saveParsedSpecFile: 'true' } as any)
+            ).rejects.toThrow('The saveParsedSpecFile is not a boolean in options');
+          });
+          it('[domain::id] if the `domain::id` not provided in options, The generator throw an explicit error', async () => {
+            await expect(
+              plugin(config, {
+                domain: { name: 'domain_name', version: '1.0.0' },
+                services: [{ path: 'path/to/spec', id: 'sevice_id' }],
+              } as any)
+            ).rejects.toThrow('The domain id is required. please provide a domain id');
+          });
+          it('[domain::name] if the `domain::name` not provided in options, The generator throw an explicit error', async () => {
+            await expect(
+              plugin(config, {
+                domain: { id: 'domain_name', version: '1.0.0' },
+                services: [{ path: 'path/to/spec', id: 'sevice_id' }],
+              } as any)
+            ).rejects.toThrow('The domain name is required. please provide a domain name');
+          });
+          it('[domain::version] if the `domain::version` not provided in options, The generator throw an explicit error', async () => {
+            await expect(
+              plugin(config, {
+                domain: { id: 'domain_name', name: 'domain_name' },
+                services: [{ path: 'path/to/spec', id: 'sevice_id' }],
+              } as any)
+            ).rejects.toThrow('The domain version is required. please provide a domain version');
+          });
         });
       });
     });