feat([openapi]): if service version is lower than latest add a service version in versioned folder

Author: glc-omid

package.json

@@ -20,6 +20,7 @@
     "@types/fs-extra": "^11.0.4",
     "@types/lodash": "^4.17.7",
     "@types/node": "^20.16.1",
+    "@types/semver": "^7.5.8",
     "prettier": "^3.3.3",
     "tsup": "^8.1.0",
     "typescript": "^5.5.3",
@@ -38,6 +39,7 @@
     "@eventcatalog/sdk": "^0.1.4",
     "chalk": "^4",
     "openapi-types": "^12.1.3",
+    "semver": "^7.6.3",
     "slugify": "^1.6.6"
   }
 }

pnpm-lock.yaml

@@ -11,6 +11,7 @@ import { Domain, Service } from './types';
 import { getMessageTypeUtils } from './utils/catalog-shorthand';
 import { OpenAPI } from 'openapi-types';
 import checkLicense from './utils/checkLicense';
+import * as semver from 'semver';
 
 type Props = {
   services: Service[];
@@ -50,6 +51,7 @@ export default async (_: any, options: Props) => {
 
   const services = options.services ?? [];
   validateOptions(options);
+
   for (const serviceSpec of services) {
     console.log(chalk.green(`Processing ${serviceSpec.path}`));
 
@@ -66,9 +68,11 @@ export default async (_: any, options: Props) => {
     const version = document.info.version;
 
     const service = buildService(serviceSpec, document);
-    let serviceMarkdown = service.markdown;
-    let serviceSpecificationsFiles = [];
-    let serviceSpecifications = service.specifications;
+    let serviceCatalogPath = service.id;
+    let markdown = service.markdown;
+    let specFiles = [];
+    let specifications = service.specifications;
+    let { sends, receives } = await processMessagesForOpenAPISpec(serviceSpec.path, document);
 
     // Manage domain
     if (options.domain) {
@@ -104,64 +108,66 @@ export default async (_: any, options: Props) => {
       await addServiceToDomain(domainId, { id: service.id, version: service.version }, domainVersion);
     }
 
-    // Process all messages for the OpenAPI spec
-    let { sends, receives } = await processMessagesForOpenAPISpec(serviceSpec.path, document);
-
     // Check if service is already defined... if the versions do not match then create service.
     const latestServiceInCatalog = await getService(service.id, 'latest');
+    const existingVersionInCatalog = await getService(service.id, version);
+
     console.log(chalk.blue(`Processing service: ${document.info.title} (v${version})`));
 
+    // Found a service, and versions do not match, we need to version the one already there
     if (latestServiceInCatalog) {
-      serviceMarkdown = latestServiceInCatalog.markdown;
-      serviceSpecificationsFiles = await getSpecificationFilesForService(service.id, 'latest');
-      sends = latestServiceInCatalog.sends || ([] as any);
-
-      // persist any specifications that are already in the catalog
-      serviceSpecifications = {
-        ...serviceSpecifications,
-        ...latestServiceInCatalog.specifications,
-      };
-
-      // Found a service, and versions do not match, we need to version the one already there
-      if (latestServiceInCatalog.version !== version) {
+      if (isHigherVersion(version, latestServiceInCatalog.version)) {
         await versionService(service.id);
         console.log(chalk.cyan(` - Versioned previous service (v${latestServiceInCatalog.version})`));
+      } else {
+        serviceCatalogPath = serviceCatalogPath.concat(`/versioned/${version}`);
+        console.log(chalk.yellow(` - Service (v${latestServiceInCatalog.version}) already exists, skipped creation...`));
       }
+    }
+
+    if (existingVersionInCatalog) {
+      markdown = existingVersionInCatalog.markdown;
+      specFiles = await getSpecificationFilesForService(service.id, version);
+      sends = existingVersionInCatalog.sends || ([] as any);
+      receives = [...(existingVersionInCatalog.receives ?? []), ...receives];
+
+      // persist any specifications that are already in the catalog
+      specifications = {
+        ...specifications,
+        ...existingVersionInCatalog.specifications,
+      };
 
       // Match found, override it
-      if (latestServiceInCatalog.version === version) {
-        receives = latestServiceInCatalog.receives ? [...latestServiceInCatalog.receives, ...receives] : receives;
-        await rmServiceById(service.id);
-      }
+      await rmServiceById(service.id, version);
     }
 
     await writeService(
       {
         ...service,
-        markdown: serviceMarkdown,
-        specifications: serviceSpecifications,
+        markdown: markdown,
+        specifications: specifications,
         sends,
         receives,
       },
-      { path: service.id }
+      { path: serviceCatalogPath }
     );
 
     // What files need added to the service (speficiation files)
-    const specFiles = [
+    const existingSpecFiles = [
       // add any previous spec files to the list
-      ...serviceSpecificationsFiles,
+      ...specFiles,
       {
         content: openAPIFile,
         fileName: service.schemaPath,
       },
     ];
 
-    for (const specFile of specFiles) {
+    for (const spec of existingSpecFiles) {
       await addFileToService(
         service.id,
         {
-          fileName: specFile.fileName,
-          content: specFile.content,
+          fileName: spec.fileName,
+          content: spec.content,
         },
         version
       );
@@ -248,3 +254,6 @@ const processMessagesForOpenAPISpec = async (pathToSpec: string, document: OpenA
   }
   return { receives, sends: [] };
 };
+function isHigherVersion(sourceVersion: string, targetVersion: string) {
+  return semver.gt(sourceVersion, targetVersion);
+}

src/index.ts

@@ -286,13 +286,69 @@ describe('OpenAPI EventCatalog Plugin', () => {
         expect(service.specifications?.openapiPath).toEqual('petstore.yml');
       });
 
+      it('if the service already has higher version the new one with lowert version will be created as versioned', async () => {
+        const { getService, writeService } = utils(catalogDir);
+
+        await writeService(
+          {
+            id: 'swagger-petstore',
+            version: '2.0.0',
+            name: 'swagger-petstore',
+            markdown: 'My content',
+          },
+          { path: 'swagger-petstore' }
+        );
+
+        await plugin(config, { services: [{ path: join(openAPIExamples, 'petstore.yml'), id: 'swagger-petstore' }] });
+
+        const service = await getService('swagger-petstore', '1.0.0');
+        const latestservice = await getService('swagger-petstore', '2.0.0');
+        expect(service).toBeDefined();
+        expect(latestservice).toBeDefined();
+      });
+
+      it('if the service already has higher version the new one with lowert version will be created as versioned', async () => {
+        const { getService, writeService } = utils(catalogDir);
+
+        await writeService(
+          {
+            id: 'swagger-petstore',
+            version: '2.0.0',
+            name: 'swagger-petstore',
+            markdown: 'My content',
+          },
+          { path: 'swagger-petstore' }
+        );
+
+        await writeService(
+          {
+            id: 'swagger-petstore',
+            version: '1.0.0',
+            name: 'swagger-petstore',
+            markdown: 'My content',
+          },
+          { path: 'swagger-petstore/versioned/1.0.0' }
+        );
+
+        await plugin(config, { services: [{ path: join(openAPIExamples, 'petstore.yml'), id: 'swagger-petstore' }] });
+
+        const service = await getService('swagger-petstore', '1.0.0');
+        const latestservice = await getService('swagger-petstore', '2.0.0');
+
+        expect(latestservice).toBeDefined();
+        expect(service).toBeDefined();
+
+        expect(service.receives?.length).toBe(4);
+        expect(service.markdown).toBe('My content');
+      });
+
       it('if the service already has specifications they are persisted and the openapi one is added on', async () => {
         const { getService, writeService, addFileToService } = utils(catalogDir);
 
         await writeService(
           {
             id: 'swagger-petstore',
-            version: '0.0.1',
+            version: '1.0.0',
             name: 'Swagger Petstore',
             specifications: {
               asyncapiPath: 'asyncapi.yml',
@@ -308,7 +364,7 @@ describe('OpenAPI EventCatalog Plugin', () => {
             fileName: 'asyncapi.yml',
             content: 'Some content',
           },
-          '0.0.1'
+          '1.0.0'
         );
 
         await plugin(config, { services: [{ path: join(openAPIExamples, 'petstore.yml'), id: 'swagger-petstore' }] });