@axinom/mosaic-cli 0.18.4 → 0.18.5-rc.1

package/src/commands/msg-codegen/utils.ts

@@ -0,0 +1,258 @@
+import {
+  ConstrainedArrayModel,
+  ConstrainedMetaModel,
+  ConstrainedObjectPropertyModel,
+  ConstrainedUnionModel,
+  FormatHelpers,
+} from '@asyncapi/modelina';
+import {
+  AsyncAPIDocumentInterface,
+  ChannelInterface,
+  MessageInterface,
+  SpecTypesV2,
+} from '@asyncapi/parser';
+import * as fs from 'fs';
+import * as path from 'path';
+
+export function getRelativeDir(from: string, to: string): string {
+  return fs.statSync(to).isFile()
+    ? path.dirname(path.relative(from, to))
+    : path.relative(from, to);
+}
+
+export function getMessageTitle(message: MessageInterface): string {
+  const messageTitle =
+    message.payload()?.title() ??
+    message.extensions().get('x-parser-message-name')?.value() ??
+    message.payload()?.extensions().get('x-parser-schema-id')?.value();
+
+  if (messageTitle === undefined) {
+    throw new Error('Unable to determine message title.');
+  }
+
+  return messageTitle;
+}
+
+/**
+ * Retrieve Service Title from AsyncAPI document.
+ * As Title returned value set in info.title property of document.
+ * @param asyncAPIDocument - AsyncAPI document.
+ */
+export function getServiceTitle(
+  asyncAPIDocument: AsyncAPIDocumentInterface,
+): string {
+  return asyncAPIDocument.info().title();
+}
+
+/**
+ * Retrieve Service Id from AsyncAPI document.
+ * As Id returned value set in extension property `x-service-id`.
+ * If extension property is not set - returned Service Title in lower-kebab-case.
+ * @param asyncAPIDocument - AsyncAPI document.
+ */
+export function getServiceId(
+  asyncAPIDocument: AsyncAPIDocumentInterface,
+): string {
+  const serviceId =
+    asyncAPIDocument.extensions().get('x-service-id')?.value() ??
+    asyncAPIDocument.info().title();
+
+  return FormatHelpers.toParamCase(serviceId);
+}
+
+/**
+ * Retrieves whether a channel is for subscribing or publishing.
+ * Currently, only channels with a single operation are supported.
+ * @param channel - Channel object.
+ */
+export function getChannelAction(
+  channel: ChannelInterface,
+): 'subscribe' | 'publish' {
+  const operations = channel.operations();
+  if (operations.length === 0) {
+    throw new Error('Channel has no operations');
+  }
+  if (operations.length > 1) {
+    throw new Error('Channel has more than one operation');
+  }
+
+  const action = operations[0].action();
+
+  if (action !== 'subscribe' && action !== 'publish') {
+    throw new Error(`Channel has unsupported action: ${action}`);
+  }
+
+  return action;
+}
+
+/**
+ * Retrieves the payload model name for a channel.
+ * Currently, only channels with a single message are supported.
+ * @param channel - Channel object.
+ */
+export function getPayloadTitle(channel: ChannelInterface): string | undefined {
+  const messages = channel.messages();
+  if (messages.length === 0) {
+    throw new Error('Channel has no messages');
+  }
+  if (messages.length > 1) {
+    throw new Error('Channel has more than one message');
+  }
+
+  return messages[0].payload()?.title();
+}
+
+/**
+ * Converts a path into a POSIX path by replacing current path separator with `/`.
+ * @param p - Path to convert.
+ */
+export function toPosixPath(p: string): string {
+  return path.posix.join(...p.split(path.sep));
+}
+
+/**
+ * Generating the path prefix for model.
+ * model name ends with "command" - prefix "commands"
+ * model name ends with "event" - prefix "events"
+ * default prefix "types"
+ * @param modelName - name of the model, defined in json schema, or AsyncAPI document
+ */
+export function getModelPathPrefix(modelName: string): string {
+  return modelName
+    ? modelName.toLowerCase().endsWith('command')
+      ? 'commands'
+      : modelName.toLowerCase().endsWith('event')
+      ? 'events'
+      : 'types'
+    : 'types';
+}
+
+export function removeXParserProperties(
+  obj: SpecTypesV2.AsyncAPISchemaObject,
+): SpecTypesV2.AsyncAPISchemaObject {
+  if (Array.isArray(obj)) {
+    return obj.map(removeXParserProperties);
+  } else if (obj !== null && typeof obj === 'object') {
+    const newObj = {};
+    for (const [key, value] of Object.entries(obj)) {
+      if (!key.startsWith('x-parser-')) {
+        newObj[key] = removeXParserProperties(value);
+      }
+    }
+    return newObj;
+  } else {
+    return obj;
+  }
+}
+
+/**
+ * Replaces the `any` type in a type string.
+ */
+export function replaceAnyType(type: string, replacement: string): string {
+  const pattern = /\b(any)\b/g;
+  return type.replace(pattern, replacement);
+}
+
+export function indexOfNullPlain(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (
+    model.property instanceof ConstrainedMetaModel &&
+    model.property.originalInput?.nullable === true
+  ) {
+    return 1; // Append null to the end of the type.
+  }
+  return -1;
+}
+
+export function indexOfNullUnion(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (model.property instanceof ConstrainedUnionModel) {
+    return model.property.originalInput?.type?.indexOf('null') ?? -1;
+  }
+  return -1;
+}
+
+export function indexOfNullOneOf(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (model.property instanceof ConstrainedUnionModel) {
+    const types = model.property.originalInput?.oneOf?.map((m) => m.type);
+    return types?.indexOf('null') ?? -1;
+  }
+  return -1;
+}
+
+export function indexOfNullArrayPlain(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (
+    model.property instanceof ConstrainedArrayModel &&
+    model.property.originalInput?.items?.nullable === true
+  ) {
+    return 1; // Append null to the end of the type.
+  }
+  return -1;
+}
+
+export function indexOfNullArrayUnion(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (model.property instanceof ConstrainedArrayModel) {
+    return model.property.originalInput?.items?.type?.indexOf('null') ?? -1;
+  }
+  return -1;
+}
+
+export function indexOfNullArrayOneOf(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (model.property instanceof ConstrainedArrayModel) {
+    const types = model.property.originalInput?.items?.oneOf?.map(
+      (m) => m.type,
+    );
+    return types?.indexOf('null') ?? -1;
+  }
+  return -1;
+}
+
+export function indexOfNullObjectProperty(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (indexOfNullPlain(model) > -1) {
+    return indexOfNullPlain(model);
+  }
+  if (indexOfNullUnion(model) > -1) {
+    return indexOfNullUnion(model);
+  }
+  if (indexOfNullOneOf(model) > -1) {
+    return indexOfNullOneOf(model);
+  }
+  return -1;
+}
+
+export function indexOfNullArrayProperty(
+  model: ConstrainedObjectPropertyModel,
+): number {
+  if (indexOfNullArrayPlain(model) > -1) {
+    return indexOfNullArrayPlain(model);
+  }
+  if (indexOfNullArrayUnion(model) > -1) {
+    return indexOfNullArrayUnion(model);
+  }
+  if (indexOfNullArrayOneOf(model) > -1) {
+    return indexOfNullArrayOneOf(model);
+  }
+  return -1;
+}
+
+export function ensureNullable(type: string, index: number): string {
+  const types = type.split('|').map((t) => t.trim());
+  if (types[index] === 'any') {
+    types[index] = replaceAnyType(types[index], 'null');
+  } else {
+    types.splice(index, 0, 'null');
+  }
+  return types.join(' | ');
+}

package/src/commands/msg-diff/msg-diff.spec.ts

@@ -1,4 +1,9 @@
-import { AsyncAPIDocument, parse } from '@asyncapi/parser';
+import {
+  AsyncAPIDocumentInterface,
+  Diagnostic,
+  fromFile,
+  Parser,
+} from '@asyncapi/parser';
 import * as fs from 'fs';
 import 'jest-extended';
 import { MessageDiffOptions } from './message-diff-options';
@@ -23,16 +28,28 @@ describe('sanity', () => {
   const loadDocument = async (
     file: string,
     editJson?: (any) => void,
-  ): Promise<AsyncAPIDocument> => {
-    const doc = await parse((await fs.promises.readFile(file)).toString(), {
-      path: file,
-    });
+  ): Promise<AsyncAPIDocumentInterface> => {
+    let document: AsyncAPIDocumentInterface | undefined;
+    let diagnostics: Diagnostic[] | undefined;
+    const parser = new Parser();
+    ({ document, diagnostics } = await fromFile(parser, file).parse());
+    if (document === undefined) {
+      throw new Error(`Failed to parse ${file}: ${diagnostics}`);
+    }
+
     if (!editJson) {
-      return doc;
+      return document;
     }
-    const json = doc.json();
+    const json = document.json();
     editJson(json);
-    return parse(json);
+
+    ({ document, diagnostics } = await parser.parse(JSON.stringify(json)));
+
+    if (document === undefined) {
+      throw new Error(`Failed to parse edited JSON: ${diagnostics}`);
+    }
+
+    return document;
   };
 
   beforeEach(async () => {
@@ -127,7 +144,7 @@ describe('sanity', () => {
         `${resources}/0/1-asyncapi.yml`,
         (json) => {
           // remove an event
-          delete json.channels['evt-channel'].publish.message;
+          delete json.channels['evt-channel']?.publish?.message;
         },
       );
 
@@ -246,8 +263,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert
@@ -272,8 +289,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert
@@ -291,11 +308,11 @@ describe('sanity', () => {
         },
       );
 
+      const channel1 = document1.channels().get('evt-channel');
+      const channel2 = document2.channels().get('evt-channel');
+
       // Act
-      const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
-      );
+      const result = await msgDiff.payloadDiff(channel1, channel2);
 
       // Assert
       expect(result).toBe('changed');
@@ -314,8 +331,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert
@@ -338,8 +355,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert
@@ -359,8 +376,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert
@@ -380,8 +397,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert
@@ -401,8 +418,8 @@ describe('sanity', () => {
 
       // Act
       const result = await msgDiff.payloadDiff(
-        document1.channels()['evt-channel'],
-        document2.channels()['evt-channel'],
+        document1.channels().get('evt-channel'),
+        document2.channels().get('evt-channel'),
       );
 
       // Assert

package/src/commands/msg-diff/msg-diff.ts

@@ -1,7 +1,12 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable no-console */
 import { diff, DiffOutputItem } from '@asyncapi/diff';
-import { AsyncAPIDocument, Channel, parse } from '@asyncapi/parser';
+import Parser, {
+  AsyncAPIDocumentInterface,
+  ChannelInterface,
+  fromFile,
+  SchemaInterface,
+} from '@asyncapi/parser';
 import { green, red, white } from 'chalk';
 import * as jsonDiff from 'diff';
 import * as fs from 'fs';
@@ -177,13 +182,17 @@ export class MessageDiff {
     console.log(
       `Comparing asyncapi document '${file2}'. Changes from branch '${this.branch}':`,
     );
-    let document1: AsyncAPIDocument;
-    let document2: AsyncAPIDocument;
+    let document1: AsyncAPIDocumentInterface;
+    let document2: AsyncAPIDocumentInterface;
 
     // load asyncapi document from git
     try {
-      const text = fs.readFileSync(file1, 'utf8');
-      document1 = await parse(text, { path: file1 });
+      const parser = new Parser();
+      const { document, diagnostics } = await fromFile(parser, file1).parse();
+      if (!document) {
+        throw `Error parsing ${file1}: ${diagnostics}`;
+      }
+      document1 = document;
     } catch (e: any) {
       throw `Error reading ${file1}: ${e}`;
     }
@@ -199,8 +208,12 @@ export class MessageDiff {
         this.results.breaking++;
         return;
       }
-      const text = fs.readFileSync(file2, 'utf8');
-      document2 = await parse(text, { path: file2 });
+      const parser = new Parser();
+      const { document, diagnostics } = await fromFile(parser, file2).parse();
+      if (!document) {
+        throw `Error parsing ${file2}: ${diagnostics}`;
+      }
+      document2 = document;
     } catch (e: any) {
       throw `Error reading ${file2}: ${e}`;
     }
@@ -214,14 +227,16 @@ export class MessageDiff {
 
     // diff payloads for channels which exist in both documents
     // removed / renamed channels are already marked as breaking
-    for (const [k, channel1] of Object.entries(channels1)) {
-      if (!(k in channels2)) {
+    for (const channel1 of channels1) {
+      if (channels2.has(channel1.id()) === false) {
         continue;
       }
       console.log(
-        `Comparing payload for channel ${k} in document ${file2}. Changes from branch ${this.branch}`,
+        `Comparing payload for channel ${channel1.id()} in document ${file2}. Changes from branch ${
+          this.branch
+        }`,
       );
-      const channel2 = channels2[k];
+      const channel2 = channels2.get(channel1.id());
       const resultKey = await this.payloadDiff(channel1, channel2);
       this.results[resultKey]++;
     }
@@ -232,8 +247,8 @@ export class MessageDiff {
    * Note: non standard rules are defined in file: asyncapi-override.ts
    */
   public async documentDiff(
-    document1: AsyncAPIDocument,
-    document2: AsyncAPIDocument,
+    document1: AsyncAPIDocumentInterface,
+    document2: AsyncAPIDocumentInterface,
   ): Promise<keyof Results> {
     // generate diff
     // overrides are applied through options here:
@@ -291,27 +306,38 @@ export class MessageDiff {
    * If any other version is used (in local file or git) then the comparison result will be 'skipped'.
    */
   public async payloadDiff(
-    channel1: Channel,
-    channel2: Channel,
+    channel1: ChannelInterface | undefined,
+    channel2: ChannelInterface | undefined,
   ): Promise<keyof Results> {
-    const getChannelPayload = (channel: Channel): any => {
-      const json = channel.json();
-      return (json.subscribe ?? json.publish)?.message?.payload;
+    const getChannelPayload = (
+      channel: ChannelInterface | undefined,
+    ): SchemaInterface | undefined => {
+      if (channel === undefined) {
+        return undefined;
+      }
+
+      const messages = channel.messages();
+      if (messages.length > 1) {
+        throw new Error(
+          `Channel ${channel.id()} has more than one message. This is currently not supported.`,
+        );
+      }
+      return messages[0].payload();
     };
     const schema1 = getChannelPayload(channel1);
     const schema2 = getChannelPayload(channel2);
     if (schema1 === undefined) {
-      throw `Could not find payload schema in ${this.branch}`;
+      throw new Error(`Could not find payload schema in ${this.branch}`);
     }
     if (schema2 === undefined) {
-      throw `Could not find payload schema`;
+      throw new Error(`Could not find payload schema`);
     }
 
     let result: jsonSchemaDiff.DiffResult;
     try {
       result = await jsonSchemaDiff.diffSchemas({
-        sourceSchema: schema1,
-        destinationSchema: schema2,
+        sourceSchema: schema1.json(),
+        destinationSchema: schema2.json(),
       });
     } catch (e: any) {
       // Skip if unsupported schema version is used by either payload

package/src/commands/msg-diff/test-resources/0/1-asyncapi.yml

@@ -1,4 +1,4 @@
-asyncapi: 2.0.0
+asyncapi: 2.2.0
 info:
   title: Service 1
   version: '1.0.0'
@@ -8,7 +8,7 @@ info:
 x-service-id: ax-service-template
 
 channels:
- # commands
+  # commands
   'cmd-channel':
     bindings:
       amqp:

package/src/commands/msg-diff/test-resources/0/2-asyncapi.yml

@@ -1,4 +1,4 @@
-asyncapi: 2.0.0
+asyncapi: 2.2.0
 info:
   title: Service 2
   version: '1.0.0'
@@ -6,7 +6,7 @@ info:
     Testing 2
 
 channels:
- # commands
+  # commands
   'cmd-channel':
     bindings:
       amqp:

package/src/commands/msg-diff/test-resources/1/1-asyncapi.yml

@@ -1,4 +1,4 @@
-asyncapi: 2.0.0
+asyncapi: 2.2.0
 info:
   title: Template Service
   version: '1.0.0'