refactor: replace hardcode sendEchoMessage method in py websocket client (#1572)

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

Author: Adi-204

packages/helpers/src/index.js

@@ -1,6 +1,6 @@
 const { getMessageExamples, getOperationMessages } = require('./operations');
 const { getServerUrl, getServer }  = require('./servers');
-const { getClientName, listFiles, getInfo } = require('./utils');
+const { getClientName, listFiles, getInfo, toSnakeCase } = require('./utils');
 const { getQueryParams } = require('./bindings');
 
 module.exports = {
@@ -11,5 +11,6 @@ module.exports = {
   getQueryParams,
   getOperationMessages,
   getMessageExamples,
-  getInfo
+  getInfo,
+  toSnakeCase
 };

packages/helpers/src/utils.js

@@ -57,9 +57,24 @@ const getInfo = (asyncapi) => {
   return info;
 };
 
+/**
+ * Convert a camelCase or PascalCase string to snake_case.
+ * If the string is already in snake_case, it will be returned unchanged.
+ * 
+ * @param {string} camelStr - The string to convert to snake_case
+ * @returns {string} The converted snake_case string
+ */
+const toSnakeCase = (inputStr) => {
+  return inputStr
+    .replace(/\W+/g, ' ')
+    .split(/ |\B(?=[A-Z])/)
+    .map((word) => word.toLowerCase())
+    .join('_');
+};
+
 module.exports = {
   getClientName,
   listFiles,
-  getInfo
+  getInfo,
+  toSnakeCase
 };
-  

packages/helpers/test/__fixtures__/asyncapi-websocket-query.yml

@@ -137,6 +137,20 @@ operations:
       - $ref: '#/channels/marketDataV1/messages/oneExample'
       - $ref: '#/channels/marketDataV1/messages/multipleExamples'
 
+  PascalCaseOperation:
+    action: receive
+    channel:
+      $ref: '#/channels/marketDataV1'
+    messages:
+      - $ref: '#/channels/marketDataV1/messages/noExamples'
+    
+  operation_with_snake_case:
+    action: send
+    channel:
+      $ref: '#/channels/marketDataV1'
+    messages:
+      - $ref: '#/channels/marketDataV1/messages/noExamples'
+
 components:
   parameters:
     symbol:
@@ -146,4 +160,4 @@ components:
       enum:
         - btcusd
         - ethbtc
-        - ethusd
+        - ethusd

packages/helpers/test/utils.test.js

@@ -1,6 +1,6 @@
 const path = require('path');
 const { Parser, fromFile } = require('@asyncapi/parser');
-const { getClientName, getInfo } = require('@asyncapi/generator-helpers');
+const { getClientName, getInfo, toSnakeCase } = require('@asyncapi/generator-helpers');
 
 const parser = new Parser();
 const asyncapi_v3_path = path.resolve(__dirname, './__fixtures__/asyncapi-websocket-query.yml');
@@ -80,4 +80,41 @@ describe('getInfo integration test with AsyncAPI', () => {
       getInfo(null);
     }).toThrow('Make sure you pass AsyncAPI document as an argument.');
   });
+});
+
+describe('toSnakeCase integration test with AsyncAPI', () => {
+  let parsedAsyncAPIDocument, operations;
+
+  beforeAll(async () => {
+    const parseResult = await fromFile(parser, asyncapi_v3_path).parse();
+    parsedAsyncAPIDocument = parseResult.document;
+    operations = parsedAsyncAPIDocument.operations();
+  });
+
+  it('should convert PascalCase operation names to snake_case format', () => {
+    const operation = operations.get('PascalCaseOperation');
+    const actualOperationId = toSnakeCase(operation.id());
+    const expectedOperationId = 'pascal_case_operation';
+    expect(actualOperationId).toBe(expectedOperationId);
+  });
+
+  it('should leave already snake_case operation names unchanged', () => {
+    const operation = operations.get('operation_with_snake_case');
+    const actualOperationId = toSnakeCase(operation.id());
+    const expectedOperationId = 'operation_with_snake_case';
+    expect(actualOperationId).toBe(expectedOperationId);
+  });
+
+  it('should convert camelCase operation names to snake_case format', () => {
+    const operation = operations.get('noSummaryNoDescriptionOperations');
+    const actualOperationId = toSnakeCase(operation.id());
+    const expectedOperationId = 'no_summary_no_description_operations';
+    expect(actualOperationId).toBe(expectedOperationId);
+  });
+
+  it('should return empty string', () => {
+    const actualOperationId = toSnakeCase('');
+    const expectedOperationId = '';
+    expect(actualOperationId).toBe(expectedOperationId);
+  });
 });

packages/templates/clients/websocket/javascript/test/components/__snapshots__/AvailableOperations.test.js.snap

@@ -97,5 +97,15 @@ client.mixedMessageExamples(false);
 **Example:**
 \`\`\`javascript
 client.mixedMessageExamples(123);
-\`\`\`"
+\`\`\`
+
+
+
+#### \`PascalCaseOperation(payload)\`
+
+
+
+
+
+#### \`operation_with_snake_case(payload)\`"
 `;

packages/templates/clients/websocket/javascript/test/components/__snapshots__/SendOperation.test.js.snap

@@ -110,6 +110,34 @@ exports[`Testing of SendOperation function render websockets with send operation
       throw new Error('WebSocket connection not established. Call connect() first.');
     }
     GeminiMarketDataWebsocketAPI.mixedMessageExamples(message, this.websocket);
+  }
+  
+
+  /**
+   * Sends a operation_with_snake_case message over the WebSocket connection.
+   * 
+   * @param {Object} message - The message payload to send. Should match the schema defined in the AsyncAPI document.
+   * @param {WebSocket} [socket] - The WebSocket connection to use. If not provided, the client's own connection will be used.
+   * @throws {TypeError} If message cannot be stringified to JSON
+   * @throws {Error} If WebSocket connection is not in OPEN state
+   */
+  static operation_with_snake_case(message, socket) {
+    try {
+      socket.send(JSON.stringify(message));
+    } catch (error) {
+      console.error('Error sending operation_with_snake_case message:', error);
+    }
+  }
+  /**
+   * Instance method version of operation_with_snake_case that uses the client's own WebSocket connection.
+   * @param {Object} message - The message payload to send
+   * @throws {Error} If WebSocket connection is not established
+   */
+  operation_with_snake_case(message){
+    if(!this.websocket){
+      throw new Error('WebSocket connection not established. Call connect() first.');
+    }
+    GeminiMarketDataWebsocketAPI.operation_with_snake_case(message, this.websocket);
   }"
 `;
 

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

@@ -4,12 +4,14 @@ import { Connect } from './Connect';
 import { RegisterMessageHandler } from './RegisterMessageHandler';
 import { RegisterErrorHandler } from './RegisterErrorHandler';
 import { HandleMessage } from './HandleMessage';
-import { SendEchoMessage } from './SendEchoMessage';
+import { SendOperation } from './SendOperation';
+import { Send } from './Send';
 import { CloseConnection } from './CloseConnection';
 import { RegisterOutgoingProcessor } from './RegisterOutgoingProcessor';
 import { HandleError } from './HandleError';
 
-export function ClientClass({ clientName, serverUrl, title, queryParams }) {
+export function ClientClass({ clientName, serverUrl, title, queryParams, operations }) {
+  const sendOperations = operations.filterBySend();
   return (
     <Text>
       <Text newLines={2}>
@@ -22,7 +24,8 @@ export function ClientClass({ clientName, serverUrl, title, queryParams }) {
       <RegisterOutgoingProcessor />
       <HandleMessage />
       <HandleError />
-      <SendEchoMessage />
+      <SendOperation sendOperations={sendOperations} clientName={clientName} />
+      <Send sendOperations={sendOperations} />
       <CloseConnection />
     </Text>
   );

packages/templates/clients/websocket/python/components/Send.js

@@ -0,0 +1,33 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function Send({ sendOperations }) {
+  if (!sendOperations || sendOperations.length === 0) {
+    return null;
+  }
+
+  return (
+    <Text newLines={2} indent={2}>
+      {
+        `
+@staticmethod
+async def _send(message, socket):
+    """
+    Internal helper to handle the actual sending logic.
+
+    Args:
+        message (dict or str): The message to send.
+        socket (websockets.WebSocketCommonProtocol): The WebSocket to send through.
+
+    Notes:
+        If message is a dictionary, it will be automatically converted to JSON.
+    """
+    try:
+        if isinstance(message, dict):
+            message = json.dumps(message)
+        await socket.send(message)
+    except Exception as e:
+        print("Error sending:", e)`
+      }
+    </Text>
+  );
+}

packages/templates/clients/websocket/python/components/SendEchoMessage.js

@@ -0,0 +1,50 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+import { toSnakeCase } from '@asyncapi/generator-helpers';
+
+export function SendOperation({ sendOperations, clientName }) {
+  if (!sendOperations || sendOperations.length === 0) {
+    return null;
+  }
+
+  return (
+    <>
+      {
+        sendOperations.map((operation) => {
+          const methodName = toSnakeCase(operation.id());
+          const staticMethodName = `${methodName}_static`;
+          
+          return (
+            <Text newLines={2} indent={2}>
+              {`async def ${methodName}(self, message):
+    """
+    Send a ${methodName} message using the WebSocket connection attached to this instance.
+
+    Args:
+        message (dict or str): The message to send. Will be serialized to JSON if it's a dictionary.
+
+    Raises:
+        Exception: If sending fails or the socket is not connected.
+    """
+    await self._send(message, self.ws_app)
+
+@staticmethod
+async def ${staticMethodName}(message, socket):
+    """
+    Send a ${methodName} message using a provided WebSocket connection, without needing an instance.
+
+    Args:
+        message (dict or str): The message to send.
+        socket (websockets.WebSocketCommonProtocol): The WebSocket to send through.
+
+    Raises:
+        Exception: If sending fails or the socket is not connected.
+    """
+    await ${clientName}._send(message, socket)
+`}
+            </Text>
+          );
+        })
+      }
+    </>
+  );
+}