Merge pull request nestjs#1159 from nestjs/refactor/websockets

refactor(websockets) code cleanup, improvements, refactor

Author: kamilmysliwiec

packages/websockets/gateway-metadata-explorer.ts

@@ -1,12 +1,17 @@
-import { NestGateway } from './interfaces/nest-gateway.interface';
-import { isUndefined, isFunction } from '@nestjs/common/utils/shared.utils';
+import { isFunction, isUndefined } from '@nestjs/common/utils/shared.utils';
+import { MetadataScanner } from '@nestjs/core/metadata-scanner';
+import { Observable } from 'rxjs';
 import {
+  GATEWAY_SERVER_METADATA,
   MESSAGE_MAPPING_METADATA,
   MESSAGE_METADATA,
-  GATEWAY_SERVER_METADATA,
 } from './constants';
-import { MetadataScanner } from '@nestjs/core/metadata-scanner';
-import { Observable } from 'rxjs';
+import { NestGateway } from './interfaces/nest-gateway.interface';
+
+export interface MessageMappingProperties {
+  message: any;
+  callback: (...args) => Observable<any> | Promise<any> | any;
+}
 
 export class GatewayMetadataExplorer {
   constructor(private readonly metadataScanner: MetadataScanner) {}
@@ -42,22 +47,18 @@ export class GatewayMetadataExplorer {
 
   public *scanForServerHooks(instance: NestGateway): IterableIterator<string> {
     for (const propertyKey in instance) {
-      if (isFunction(propertyKey)) continue;
-
+      if (isFunction(propertyKey)) {
+        continue;
+      }
       const property = String(propertyKey);
       const isServer = Reflect.getMetadata(
         GATEWAY_SERVER_METADATA,
         instance,
         property,
       );
-      if (isUndefined(isServer)) continue;
-
-      yield property;
+      if (!isUndefined(isServer)) {
+        yield property;
+      }
     }
   }
 }
-
-export interface MessageMappingProperties {
-  message: any;
-  callback: (...args) => Observable<any> | Promise<any> | any;
-}

packages/websockets/interfaces/gateway-middleware.interface.ts

@@ -0,0 +1,3 @@
+export * from './on-gateway-connection.interface';
+export * from './on-gateway-disconnect.interface';
+export * from './on-gateway-init.interface';

packages/websockets/interfaces/hooks/index.ts

@@ -1,9 +1,5 @@
 export * from './gateway-metadata.interface';
-export * from './nest-gateway.interface';
+export * from './hooks';
 export * from './observable-socket-server.interface';
 export * from './web-socket-server.interface';
-export * from './on-gateway-init.interface';
-export * from './on-gateway-connection.interface';
-export * from './on-gateway-disconnect.interface';
-export * from './gateway-middleware.interface';
 export * from './ws-response.interface';

…faces/on-gateway-connection.interface.ts …hooks/on-gateway-connection.interface.tspackages/websockets/interfaces/on-gateway-connection.interface.ts renamed to packages/websockets/interfaces/hooks/on-gateway-connection.interface.ts packages/websockets/interfaces/on-gateway-connection.interface.ts renamed to packages/websockets/interfaces/hooks/on-gateway-connection.interface.ts

@@ -1,8 +1,8 @@
 import { ReplaySubject, Subject } from 'rxjs';
 
-export interface ObservableSocketServer {
-  server: any;
-  init: ReplaySubject<any>;
+export interface ObservableSocketServer<T = any> {
+  server: T;
+  init: ReplaySubject<T>;
   connection: Subject<any>;
   disconnect: Subject<any>;
 }

…faces/on-gateway-disconnect.interface.ts …hooks/on-gateway-disconnect.interface.tspackages/websockets/interfaces/on-gateway-disconnect.interface.ts renamed to packages/websockets/interfaces/hooks/on-gateway-disconnect.interface.ts packages/websockets/interfaces/on-gateway-disconnect.interface.ts renamed to packages/websockets/interfaces/hooks/on-gateway-disconnect.interface.ts

@@ -1,4 +1,4 @@
-export interface WebSocketServerData {
+export interface WebSocketServerOptions {
   port: number;
   namespace: string;
 }