refactor: move HandleMessage component to @asyncapi/generator-components (#1713)

Co-authored-by: Adi-204 <adiboghawala@gmail.com>

Author: Adi-204

packages/components/src/components/HandleMessage.js

@@ -0,0 +1,60 @@
+import { MethodGenerator } from './MethodGenerator';
+
+/**
+ * @typedef {'python' | 'javascript' | 'dart'} Language
+ * Supported programming languages.
+ */
+
+/**
+ * Configuration for WebSocket message handler method logic per language.
+ * @type {Record<Language, { methodDocs?: string, methodLogic: string }>}
+ */
+const websocketHandleMessageConfig = {
+  python: {
+    methodLogic: `if len(self.message_handlers) == 0:
+  print("\\033[94mReceived raw message:\\033[0m", message)
+else:
+    for handler in self.message_handlers:
+      handler(message)`
+  },
+  javascript: {
+    methodDocs: '// Method to handle message with callback',
+    methodLogic: 'if (cb) cb(message);'
+  },
+  dart: {
+    methodDocs: '/// Method to handle message with callback',
+    methodLogic: 'cb(message is String ? message : message.toString());'
+  }
+};
+
+/**
+ * Renders a WebSocket message handler method with optional pre and post execution logic.
+ *
+ * @param {Object} props - Component props.
+ * @param {Language} props.language - Programming language used for method formatting.
+ * @param {string} props.methodName='handleMessage' - Name of the method to generate.
+ * @param {string[]} props.methodParams=[] - List of parameters for the method.
+ * @param {string} props.preExecutionCode - Code to insert before the main function logic.
+ * @param {string} props.postExecutionCode - Code to insert after the main function logic.
+ * @returns {JSX.Element} Rendered method block with appropriate formatting.
+ */
+export function HandleMessage({ language, methodName = 'handleMessage', methodParams = [], preExecutionCode = '', postExecutionCode = '' }) {
+  const {
+    methodDocs = '',
+    methodLogic = ''
+  } = websocketHandleMessageConfig[language];
+
+  return (
+    <MethodGenerator
+      language={language}
+      methodName={methodName}
+      methodParams={methodParams}
+      methodDocs={methodDocs}
+      methodLogic={methodLogic}
+      preExecutionCode={preExecutionCode}
+      postExecutionCode={postExecutionCode}
+      indent={2}
+      newLines={2}
+    />
+  );
+}

packages/components/src/index.js

@@ -4,6 +4,7 @@ export { CloseConnection } from './components/CloseConnection';
 export { DependencyProvider } from './components/DependencyProvider';
 export { RegisterMessageHandler } from './components/RegisterMessageHandler';
 export { MethodGenerator } from './components/MethodGenerator';
+export { HandleMessage } from './components/HandleMessage';
 export { Connect } from './components/Connect';
 export { OnOpen } from './components/OnOpen';
 export { OnMessage } from './components/OnMessage';

packages/components/test/components/HandleMessage.test.js

@@ -0,0 +1,37 @@
+import { render } from '@asyncapi/generator-react-sdk';
+import { HandleMessage } from '../../src/index';
+
+describe('Testing of HandleMessage function', () => {
+  test('render javascript websocket message handler method', () => {
+    const result = render(
+      <HandleMessage language='javascript' methodParams={['message','cb']} />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+
+  test('render python websocket message handler method', () => {
+    const result = render(
+      <HandleMessage
+        language="python"
+        methodName='handle_message'
+        methodParams={['self', 'message']}
+        preExecutionCode='"""Pass the incoming message to all registered message handlers. """'
+      />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+
+  test('render dart websocket message handler method', () => {
+    const result = render(
+      <HandleMessage
+        language="dart" 
+        methodName="_handleMessage"
+        methodParams={['dynamic message', 'void Function(String) cb']}
+      />
+    );
+    const actual = result.trim();
+    expect(actual).toMatchSnapshot();
+  });
+});

packages/components/test/components/__snapshots__/HandleMessage.test.js.snap

@@ -0,0 +1,25 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing of HandleMessage function render dart websocket message handler method 1`] = `
+"/// Method to handle message with callback
+  void _handleMessage(dynamic message, void Function(String) cb) {
+    cb(message is String ? message : message.toString());
+  }"
+`;
+
+exports[`Testing of HandleMessage function render javascript websocket message handler method 1`] = `
+"// Method to handle message with callback
+   handleMessage(message, cb) {
+    if (cb) cb(message);
+  }"
+`;
+
+exports[`Testing of HandleMessage function render python websocket message handler method 1`] = `
+"def handle_message(self, message) :
+    \\"\\"\\"Pass the incoming message to all registered message handlers. \\"\\"\\"
+    if len(self.message_handlers) == 0:
+      print(\\"\\\\033[94mReceived raw message:\\\\033[0m\\", message)
+    else:
+        for handler in self.message_handlers:
+          handler(message)"
+`;

packages/templates/clients/websocket/dart/components/ClientClass.js

@@ -1,8 +1,7 @@
 import { Text } from '@asyncapi/generator-react-sdk';
 import { Constructor } from './Constructor';
-import { HandleMessage } from './HandleMessage';
 import { SendEchoMessage } from './SendEchoMessage';
-import { CloseConnection, RegisterMessageHandler, RegisterErrorHandler, Connect } from '@asyncapi/generator-components';
+import { CloseConnection, RegisterMessageHandler, RegisterErrorHandler, Connect, HandleMessage } from '@asyncapi/generator-components';
 import { ClientFields } from './ClientFields';
 
 export function ClientClass({ clientName, serverUrl, title }) {
@@ -22,7 +21,11 @@ export function ClientClass({ clientName, serverUrl, title }) {
         language="dart"
         methodParams={['void Function(Object) handler']}
       />
-      <HandleMessage />
+      <HandleMessage
+        language="dart" 
+        methodName="_handleMessage"
+        methodParams={['dynamic message', 'void Function(String) cb']}
+      />
       <SendEchoMessage />
       <CloseConnection language="dart" />
       <Text>

packages/templates/clients/websocket/dart/components/HandleMessage.js

@@ -1,7 +1,6 @@
 import { Text } from '@asyncapi/generator-react-sdk';
 import { Constructor } from './Constructor';
-import { HandleMessage } from './HandleMessage';
-import { CloseConnection, RegisterMessageHandler, RegisterErrorHandler, SendOperations, Connect } from '@asyncapi/generator-components';
+import { CloseConnection, RegisterMessageHandler, RegisterErrorHandler, SendOperations, Connect, HandleMessage } from '@asyncapi/generator-components';
 import { ModuleExport } from './ModuleExport';
 
 export function ClientClass({ clientName, serverUrl, title, sendOperations}) {
@@ -20,7 +19,10 @@ export function ClientClass({ clientName, serverUrl, title, sendOperations}) {
         language="javascript" 
         methodParams={['handler']}
       />
-      <HandleMessage />
+      <HandleMessage 
+        language="javascript" 
+        methodParams={['message', 'cb']}
+      />
       <SendOperations 
         language="javascript" 
         sendOperations={sendOperations} 

packages/templates/clients/websocket/javascript/components/ClientClass.js

@@ -2,8 +2,7 @@ import { Text } from '@asyncapi/generator-react-sdk';
 import { getClientName, getServerUrl, getServer, getQueryParams, getTitle } from '@asyncapi/generator-helpers';
 import { Send } from './Send';
 import { Constructor } from './Constructor';
-import { HandleMessage } from './HandleMessage';
-import { CloseConnection, RegisterMessageHandler, RegisterErrorHandler, SendOperations, Connect } from '@asyncapi/generator-components';
+import { CloseConnection, RegisterMessageHandler, RegisterErrorHandler, SendOperations, Connect, HandleMessage } from '@asyncapi/generator-components';
 import { RegisterOutgoingProcessor } from './RegisterOutgoingProcessor';
 import { HandleError } from './HandleError';
 
@@ -35,7 +34,12 @@ export function ClientClass({ asyncapi, params }) {
         preExecutionCode='"""Register a callable to process errors."""'
       />
       <RegisterOutgoingProcessor />
-      <HandleMessage />
+      <HandleMessage
+        language="python"
+        methodName='handle_message'
+        methodParams={['self', 'message']}
+        preExecutionCode='"""Pass the incoming message to all registered message handlers. """'
+      />
       <HandleError />
       <SendOperations 
         language="python"