fix: log the name of the message if it is absent

package.json

@@ -38,6 +38,7 @@
     "eslint-plugin-react": "^7.34.1",
     "filenamify": "^4.3.0",
     "js-beautify": "^1.15.1",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "markdown-toc": "^1.2.0"
   },
@@ -75,6 +76,10 @@
       "certFilesDir": {
         "description": "Directory where application certificates are located. This parameter is needed when you use X509 security scheme and your cert files are not located in the root of your application.",
         "default": "./"
+      },
+      "messageRuntimeValidation": {
+        "description": "Enable or disable runtime validation of messages against schemas provided in AsyncAPI document.",
+        "default": true
       }
     },
     "nonRenderableFiles": [

template/src/api/middlewares/error-logger.js

@@ -1,8 +1,11 @@
-const { red, gray } = require('chalk');
+const { red, gray, green } = require('chalk');
 
 module.exports = (err, message, next) => {
   if (err.name === 'AsyncAPIValidationError') {
     console.error(red(`❗  Message Rejected. ${err.message}`));
+    if(err.warning) {
+      console.warn(green(`⛔ ${err.warning}`));
+    }
   } else {
     console.error(red(`❗  ${err.message}`));
     if (err.stack)

template/src/api/routes/route.js

@@ -2,7 +2,7 @@
 import { File } from '@asyncapi/generator-react-sdk';
 import { camelCase, convertToFilename, toHermesTopic } from '../../../../helpers/index';
 
-function receiveHandler(operation, channelName, channelAddress, isSpecV3) {
+function receiveHandler(operation, channelName, channelAddress, isSpecV3, messageRuntimeValidation) {
   if (!operation.isReceive()) {
     return '';
   }
@@ -22,7 +22,7 @@ function receiveHandler(operation, channelName, channelAddress, isSpecV3) {
 
   ${
     operation.messages().all().map(message => `try {
-      nValidated = await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','publish', nValidated);
+      nValidated = await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','publish', ${messageRuntimeValidation}, nValidated);
     } catch { };`).join('\n')
   }
 
@@ -31,7 +31,7 @@ function receiveHandler(operation, channelName, channelAddress, isSpecV3) {
     next()
   } else {
     throw new Error(\`\${nValidated} of ${ operation.messages().length } message schemas matched when exactly 1 should match\`);
-  }` : `await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','publish');`;
+  }` : `await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','publish', ${messageRuntimeValidation});`;
 
   return `
   ${operation.hasSummary()  ? `
@@ -51,7 +51,7 @@ function receiveHandler(operation, channelName, channelAddress, isSpecV3) {
   `;
 }
 
-function sendHandler(operation, channelName, channelAddress, isSpecV3) {
+function sendHandler(operation, channelName, channelAddress, isSpecV3, messageRuntimeValidation) {
   if (!operation.isSend()) {
     return '';
   }
@@ -65,7 +65,7 @@ function sendHandler(operation, channelName, channelAddress, isSpecV3) {
 
   ${
     operation.messages().all().map(message => `try {
-      nValidated = await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','subscribe', nValidated);
+      nValidated = await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','subscribe', nValidated, ${messageRuntimeValidation});
     } catch { };`).join('\n')
   }
 
@@ -74,7 +74,7 @@ function sendHandler(operation, channelName, channelAddress, isSpecV3) {
     next()
   } else {
     throw new Error(\`\${nValidated} of ${ operation.messages().length } message schemas matched when exactly 1 should match\`);
-  }` : `await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','subscribe');`;
+  }` : `await validateMessage(message.payload,'${ channelAddress }','${ message.name() }','subscribe', ${messageRuntimeValidation});`;
 
   return `
   ${operation.hasSummary()  ? `
@@ -94,7 +94,7 @@ function sendHandler(operation, channelName, channelAddress, isSpecV3) {
   `;
 }
 
-function routeCode(channel, isSpecV3) {
+function routeCode(channel, isSpecV3, messageRuntimeValidation) {
   const channelName = channel.id();
   const generalImport = `
   const Router = require('hermesjs/lib/router');
@@ -110,20 +110,21 @@ function routeCode(channel, isSpecV3) {
 
   for (const operation of channel.operations()) {
     if (operation.isSend()) {
-      routeHandler += sendHandler(operation, channel.id(), channel.address(), isSpecV3);
+      routeHandler += sendHandler(operation, channel.id(), channel.address(), isSpecV3, messageRuntimeValidation);
     }
     if (operation.isReceive()) {
-      routeHandler += receiveHandler(operation, channel.id(), channel.address(), isSpecV3);
+      routeHandler += receiveHandler(operation, channel.id(), channel.address(), isSpecV3, messageRuntimeValidation);
     }
   }
 
   return <File name={`${convertToFilename(channelName)}.js`}>{routeHandler}</File>;
 }
 
-export default function routeRender({asyncapi}) {
+export default function routeRender({asyncapi, params}) {
   const majorSpecVersion = parseInt(asyncapi.version().split('.')[0], 10);
   const isSpecV3 = (majorSpecVersion === 3);
+  const messageRuntimeValidation = params.messageRuntimeValidation;
   return asyncapi.channels().all().map(channel => {
-    return routeCode(channel, isSpecV3);
+    return routeCode(channel, isSpecV3, messageRuntimeValidation);
   });
 }

template/src/lib/message-validator.js

@@ -1,20 +1,69 @@
+const yaml = require('js-yaml');
+const fs = require('fs');
 const path = require('path');
 const AsyncApiValidator = require('asyncapi-validator');
 
+function validateMessageIdentifiers(asyncApiSpec) {
+  const messages = asyncApiSpec.components.messages;
+  const missingNames = [];
+
+  for (const [messageName, messageObj] of Object.entries(messages)) {
+    if (!messageObj.name) {
+      missingNames.push(messageName);
+    }
+  }
+
+  return missingNames;
+}
+
+function performPreGenValidation(asyncApiFilePath, messageRuntimeValidation) {
+  if (messageRuntimeValidation === false) {
+    return;
+  }
+  const fileContents = fs.readFileSync(asyncApiFilePath, 'utf8');
+  const asyncApiSpec = yaml.load(fileContents);
+
+  const missingNames = validateMessageIdentifiers(asyncApiSpec);
+
+  if (missingNames.length > 0) {
+    const errorMessage = `msgIdentifier "name" does not exist for message(s): ${missingNames.join(', ')}`;
+    const warningMessage = 'If you are not able to modify your AsyncAPI document to add missing message IDs, then disable runtime validation logic by passing parameter messageRuntimeValidation set to false';
+    const error = new Error(errorMessage);
+    error.warning = warningMessage;
+    error.name = 'AsyncAPIValidationError';
+    throw error;
+  }
+}
+
 // Try to parse the payload, and increment nValidated if parsing was successful.
-module.exports.validateMessage = async (
+async function validateMessage (
   payload,
   channelName,
   messageName,
   operation,
+  messageRuntimeValidation,
   nValidated = 0
-) => {
-  const asyncApiFilePath = path.resolve(__dirname, '../../asyncapi.yaml');
-  const va = await AsyncApiValidator.fromSource(asyncApiFilePath, {
-    msgIdentifier: 'name',
-  });
-  va.validate(messageName, payload, channelName, operation);
-  nValidated++;
-
-  return nValidated;
+) {
+  if (messageRuntimeValidation === false) {
+    return nValidated + 1;
+  }
+
+  const asyncApiFilePath = path.resolve(__dirname, "../../asyncapi.yaml");
+  try {
+    performPreGenValidation(asyncApiFilePath, messageRuntimeValidation);
+    const va = await AsyncApiValidator.fromSource(asyncApiFilePath, {
+      msgIdentifier: "name",
+    });
+    va.validate(messageName, payload, channelName, operation);
+    nValidated++;
+
+    return nValidated;
+  } catch (error) {
+    error.name = "AsyncAPIValidationError";
+    throw error;
+  }
 };
+
+module.exports = {
+  validateMessage
+};