bugfix(@nestjs/websockets) handle invalid payloads (nestjs#683)

Author: kamilmysliwiec

packages/websockets/adapters/io-adapter.ts

@@ -1,11 +1,11 @@
-import * as io from 'socket.io';
-import { Server } from 'http';
-import { MessageMappingProperties } from '../gateway-metadata-explorer';
-import { CONNECTION_EVENT, DISCONNECT_EVENT } from '../constants';
 import { WebSocketAdapter } from '@nestjs/common';
-import { Observable, fromEvent } from 'rxjs';
-import { filter, tap, mergeMap } from 'rxjs/operators';
 import { isFunction } from '@nestjs/common/utils/shared.utils';
+import { Server } from 'http';
+import { Observable, fromEvent } from 'rxjs';
+import { filter, mergeMap } from 'rxjs/operators';
+import * as io from 'socket.io';
+import { CONNECTION_EVENT, DISCONNECT_EVENT } from '../constants';
+import { MessageMappingProperties } from '../gateway-metadata-explorer';
 
 export class IoAdapter implements WebSocketAdapter {
   constructor(private readonly httpServer: Server | null = null) {}
@@ -32,23 +32,23 @@ export class IoAdapter implements WebSocketAdapter {
     return io(port, options);
   }
 
-  public bindClientConnect(server, callback: (...args) => void) {
+  public bindClientConnect(server: any, callback: (...args) => void) {
     server.on(CONNECTION_EVENT, callback);
   }
 
-  public bindClientDisconnect(client, callback: (...args) => void) {
+  public bindClientDisconnect(client: any, callback: (...args) => void) {
     client.on(DISCONNECT_EVENT, callback);
   }
 
   public bindMessageHandlers(
-    client,
+    client: any,
     handlers: MessageMappingProperties[],
-    process: (data: any) => Observable<any>,
+    transform: (data: any) => Observable<any>,
   ) {
     handlers.forEach(({ message, callback }) =>
       fromEvent(client, message)
         .pipe(
-          mergeMap(data => process(callback(data))),
+          mergeMap(data => transform(callback(data))),
           filter(result => !!result && result.event),
         )
         .subscribe(({ event, data }) => client.emit(event, data)),
@@ -59,7 +59,7 @@ export class IoAdapter implements WebSocketAdapter {
     server.use(middleware);
   }
 
-  public close(server) {
+  public close(server: any) {
     isFunction(server.close) && server.close();
   }
 }

packages/websockets/adapters/ws-adapter.ts

@@ -1,16 +1,11 @@
+import { Logger, WebSocketAdapter } from '@nestjs/common';
+import { loadPackage } from '@nestjs/common/utils/load-package.util';
+import { isFunction } from '@nestjs/common/utils/shared.utils';
 import { Server } from 'http';
+import { EMPTY as empty, Observable, fromEvent } from 'rxjs';
+import { filter, mergeMap } from 'rxjs/operators';
+import { CLOSE_EVENT, CONNECTION_EVENT, ERROR_EVENT } from '../constants';
 import { MessageMappingProperties } from '../gateway-metadata-explorer';
-import {
-  CONNECTION_EVENT,
-  DISCONNECT_EVENT,
-  CLOSE_EVENT,
-  ERROR_EVENT,
-} from '../constants';
-import { WebSocketAdapter, Logger } from '@nestjs/common';
-import { Observable, fromEvent, EMPTY as empty } from 'rxjs';
-import { mergeMap, filter, tap } from 'rxjs/operators';
-import { isFunction } from '@nestjs/common/utils/shared.utils';
-import { loadPackage } from '@nestjs/common/utils/load-package.util';
 
 let wsPackage: any = {};
 
@@ -54,11 +49,11 @@ export class WsAdapter implements WebSocketAdapter {
   public bindMessageHandlers(
     client: WebSocket,
     handlers: MessageMappingProperties[],
-    process: (data: any) => Observable<any>,
+    transform: (data: any) => Observable<any>,
   ) {
     fromEvent(client, 'message')
       .pipe(
-        mergeMap(data => this.bindMessageHandler(data, handlers, process)),
+        mergeMap(data => this.bindMessageHandler(data, handlers, transform)),
         filter(result => !!result),
       )
       .subscribe(response => client.send(JSON.stringify(response)));
@@ -67,17 +62,19 @@ export class WsAdapter implements WebSocketAdapter {
   public bindMessageHandler(
     buffer,
     handlers: MessageMappingProperties[],
-    process: (data: any) => Observable<any>,
+    transform: (data: any) => Observable<any>,
   ): Observable<any> {
-    const message = JSON.parse(buffer.data);
-    const messageHandler = handlers.find(
-      handler => handler.message === message.event,
-    );
-    if (!messageHandler) {
+    try {
+      const message = JSON.parse(buffer.data);
+      const messageHandler = handlers.find(
+        handler => handler.message === message.event,
+      );
+      const { callback } = messageHandler;
+      return transform(callback(message.data));
+    }
+    catch {
       return empty;
     }
-    const { callback } = messageHandler;
-    return process(callback(message.data));
   }
 
   public close(server) {