refactor: replace hardcode sendEchoMessage method in py websocket client

Author: Adi-204

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

@@ -4,12 +4,13 @@ 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, sendOperations }) {
   return (
     <Text>
       <Text newLines={2}>
@@ -22,7 +23,8 @@ export function ClientClass({ clientName, serverUrl, title, queryParams }) {
       <RegisterOutgoingProcessor />
       <HandleMessage />
       <HandleError />
-      <SendEchoMessage />
+      <SendOperation sendOperations={sendOperations} clientName={clientName} />
+      {sendOperations.length > 0 && <Send />}
       <CloseConnection />
     </Text>
   );

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

@@ -0,0 +1,29 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function Send() {
+  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,48 @@
+import { Text } from '@asyncapi/generator-react-sdk';
+
+export function SendOperation({ sendOperations, clientName }) {
+  if (!sendOperations || sendOperations.length === 0) {
+    return null;
+  }
+
+  return (
+    <>
+      {
+        sendOperations.map((operation) => {
+          const staticMethodName = `${operation.id()}_static`;
+          
+          return (
+            <Text newLines={2} indent={2}>
+              {`async def ${operation.id()}(self, message):
+    """
+    Send a ${operation.id()} 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 ${operation.id()} 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>
+          );
+        })
+      }
+    </>
+  );
+}

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

@@ -31,7 +31,7 @@ def main():
     # Send multiple messages to test stream handling
     for i in range(5):
         message = f'Hello, Echo Yo! {i}'
-        client.send_message(message)
+        client.sendEchoMessage(message)
         time.sleep(2)  # Wait for a response
 
     # Keep program alive for a while to allow message processing

packages/templates/clients/websocket/python/example.py

@@ -11,6 +11,7 @@ export default function ({ asyncapi, params }) {
   const queryParams = getQueryParams(asyncapi.channels());
   const clientName = getClientName(info, params.appendClientSuffix, params.customClientName);
   const serverUrl = getServerUrl(server);
+  const sendOperations = asyncapi.operations().filterBySend();
   return (
     // The clientFileName default values can be found and modified under the package.json
     <File name={params.clientFileName}>
@@ -19,7 +20,7 @@ export default function ({ asyncapi, params }) {
         server={server}
       />
       <Requires query={queryParams} />
-      <ClientClass clientName={clientName} serverUrl={serverUrl} title={title} queryParams={queryParams} />
+      <ClientClass clientName={clientName} serverUrl={serverUrl} title={title} queryParams={queryParams} sendOperations={sendOperations} />
     </File>
   );
 }

packages/templates/clients/websocket/python/template/client.py.js

@@ -723,51 +723,6 @@ class SlackWebsocketAPIClient:
         for handler in self.error_handlers:
           handler(error)
 
-  async def send_message(self, message):
-      \\"\\"\\"
-      Send a 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 send_message_static(message, socket):
-      \\"\\"\\"
-      Send a 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 HoppscotchEchoWebSocketClient._send(message, socket)
-
-  @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)
-
   def close(self):
       \\"\\"\\"Cleanly close the WebSocket connection.\\"\\"\\"
       self._stop_event.set()
@@ -904,9 +859,9 @@ class HoppscotchClient:
         for handler in self.error_handlers:
           handler(error)
 
-  async def send_message(self, message):
+  async def sendEchoMessage(self, message):
       \\"\\"\\"
-      Send a message using the WebSocket connection attached to this instance.
+      Send a sendEchoMessage 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.
@@ -917,9 +872,9 @@ class HoppscotchClient:
       await self._send(message, self.ws_app)
 
   @staticmethod
-  async def send_message_static(message, socket):
+  async def sendEchoMessage_static(message, socket):
       \\"\\"\\"
-      Send a message using a provided WebSocket connection, without needing an instance.
+      Send a sendEchoMessage message using a provided WebSocket connection, without needing an instance.
 
       Args:
           message (dict or str): The message to send.
@@ -928,7 +883,8 @@ class HoppscotchClient:
       Raises:
           Exception: If sending fails or the socket is not connected.
       \\"\\"\\"
-      await HoppscotchEchoWebSocketClient._send(message, socket)
+      await HoppscotchClient._send(message, socket)
+
 
   @staticmethod
   async def _send(message, socket):
@@ -1085,9 +1041,9 @@ class HoppscotchEchoWebSocketClient:
         for handler in self.error_handlers:
           handler(error)
 
-  async def send_message(self, message):
+  async def sendEchoMessage(self, message):
       \\"\\"\\"
-      Send a message using the WebSocket connection attached to this instance.
+      Send a sendEchoMessage 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.
@@ -1098,9 +1054,9 @@ class HoppscotchEchoWebSocketClient:
       await self._send(message, self.ws_app)
 
   @staticmethod
-  async def send_message_static(message, socket):
+  async def sendEchoMessage_static(message, socket):
       \\"\\"\\"
-      Send a message using a provided WebSocket connection, without needing an instance.
+      Send a sendEchoMessage message using a provided WebSocket connection, without needing an instance.
 
       Args:
           message (dict or str): The message to send.
@@ -1111,6 +1067,7 @@ class HoppscotchEchoWebSocketClient:
       \\"\\"\\"
       await HoppscotchEchoWebSocketClient._send(message, socket)
 
+
   @staticmethod
   async def _send(message, socket):
       \\"\\"\\"
@@ -1267,9 +1224,9 @@ class PostmanEchoWebSocketClientClient:
         for handler in self.error_handlers:
           handler(error)
 
-  async def send_message(self, message):
+  async def sendEchoMessage(self, message):
       \\"\\"\\"
-      Send a message using the WebSocket connection attached to this instance.
+      Send a sendEchoMessage 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.
@@ -1280,9 +1237,9 @@ class PostmanEchoWebSocketClientClient:
       await self._send(message, self.ws_app)
 
   @staticmethod
-  async def send_message_static(message, socket):
+  async def sendEchoMessage_static(message, socket):
       \\"\\"\\"
-      Send a message using a provided WebSocket connection, without needing an instance.
+      Send a sendEchoMessage message using a provided WebSocket connection, without needing an instance.
 
       Args:
           message (dict or str): The message to send.
@@ -1291,7 +1248,8 @@ class PostmanEchoWebSocketClientClient:
       Raises:
           Exception: If sending fails or the socket is not connected.
       \\"\\"\\"
-      await HoppscotchEchoWebSocketClient._send(message, socket)
+      await PostmanEchoWebSocketClientClient._send(message, socket)
+
 
   @staticmethod
   async def _send(message, socket):

packages/templates/clients/websocket/python/test/__snapshots__/integration.test.js.snap

@@ -63,7 +63,7 @@ async def handler(websocket):
         # Most improtant part of test where we test clients send message
         #
         ###############
-        await HoppscotchEchoWebSocketClient.send_message_static(expected_outgoing_message, websocket)
+        await HoppscotchEchoWebSocketClient.sendEchoMessage_static(expected_outgoing_message, websocket)
 
     # Start the WebSocket server
     server = await websockets.serve(handler, port=port)