feat: support multiple parameters in message body (#538)

Author: attilaorosz

README.md

@@ -152,7 +152,22 @@ export class MessageController {
 
 If you specify a class type to parameter that is decorated with `@MessageBody()`,
 socket-controllers will use [class-transformer][1] to create instance of the given class type with the data received in the message.
-To disable this behaviour you need to specify a `{ transformOption: { transform: false ] }` in SocketControllerOptions when creating a server.
+To disable this behaviour you need to specify `{ transformOption: { transform: false ] }` in SocketControllerOptions when creating a server.
+
+You can define an index to get multiple parameters from the socket event.
+
+```typescript
+import { SocketController, OnMessage, MessageBody } from 'socket-controllers';
+
+@SocketController()
+export class MessageController {
+  @OnMessage('save')
+  save(@MessageBody({index: 0}) param1: any, @MessageBody({index: 1}) param2: any) {
+    console.log('received message: ', message1);
+    console.log('received message: ', message2);
+  }
+}
+```
 
 #### `@SocketQueryParam()` decorator
 

src/SocketControllers.ts

@@ -187,8 +187,15 @@ export class SocketControllers {
     }
 
     for (const messageAction of messageActions) {
-      socket.on(messageAction.options.name, (message: any) => {
-        this.executeAction(socket, controller, messageAction, message);
+      socket.on(messageAction.options.name, (...args: any[]) => {
+        const messages: any[] = args.slice(0, -1);
+        const ack: any = args[args.length - 1];
+
+        if (!(ack instanceof Function)) {
+          messages.push(ack);
+        }
+
+        this.executeAction(socket, controller, messageAction, messages);
       });
     }
   }
@@ -197,7 +204,7 @@ export class SocketControllers {
     socket: Socket,
     controller: HandlerMetadata<any, ControllerMetadata>,
     action: ActionMetadata,
-    data?: any
+    data?: any[]
   ) {
     const parameters = this.resolveParameters(socket, controller.metadata, action.parameters || [], data);
     try {
@@ -241,7 +248,7 @@ export class SocketControllers {
     socket: Socket,
     controllerMetadata: ControllerMetadata,
     parameterMetadatas: ParameterMetadata[],
-    data: any
+    data?: any[]
   ) {
     const parameters = [];
 
@@ -258,7 +265,7 @@ export class SocketControllers {
     return parameters;
   }
 
-  private resolveParameter(socket: Socket, controller: ControllerMetadata, parameter: ParameterMetadata, data: any) {
+  private resolveParameter(socket: Socket, controller: ControllerMetadata, parameter: ParameterMetadata, data?: any[]) {
     switch (parameter.type) {
       case ParameterType.CONNECTED_SOCKET:
         return socket;
@@ -269,7 +276,7 @@ export class SocketControllers {
       case ParameterType.SOCKET_ROOMS:
         return socket.rooms;
       case ParameterType.MESSAGE_BODY:
-        return data;
+        return data?.[(parameter.options.index as number) || 0];
       case ParameterType.SOCKET_QUERY_PARAM:
         return socket.handshake.query[parameter.options.name as string];
       case ParameterType.SOCKET_REQUEST:

src/decorators/MessageBody.ts

@@ -2,7 +2,7 @@ import { addParameterToActionMetadata } from '../util/add-parameter-to-action-me
 import { ParameterType } from '../types/enums/ParameterType';
 import { ActionTransformOptions } from '../types/ActionTransformOptions';
 
-export function MessageBody(options?: ActionTransformOptions) {
+export function MessageBody(options?: ActionTransformOptions & { index?: number }) {
   return function (object: Object, methodName: string, index: number) {
     const format = (Reflect as any).getMetadata('design:paramtypes', object, methodName)[index];
     addParameterToActionMetadata(object.constructor, methodName, {

test/functional/socket-message-body.spec.ts

@@ -62,6 +62,16 @@ describe('MessageBody', () => {
         testResult = data;
         socket.emit('return');
       }
+
+      @OnMessage('test2')
+      test2(
+        @MessageBody({ index: 1 }) data1: any,
+        @MessageBody({ index: 0 }) data0: any,
+        @ConnectedSocket() socket: Socket
+      ) {
+        testResult = { data1, data0 };
+        socket.emit('return2');
+      }
     }
 
     socketControllers = new SocketControllers({
@@ -74,8 +84,13 @@ describe('MessageBody', () => {
     await waitForEvent(wsClient, 'connected');
 
     wsClient.emit('test', 'test data');
-
     await waitForEvent(wsClient, 'return');
     expect(testResult).toEqual('test data');
+
+    wsClient.emit('test2', 'test data 0', 'test data 1', 'test data 2', ack => {
+      console.log(ack);
+    });
+    await waitForEvent(wsClient, 'return2');
+    expect(testResult).toEqual({ data0: 'test data 0', data1: 'test data 1' });
   });
 });