@nestjs/websockets 9.2.1 → 9.3.0-beta.2

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2022 Kamil Mysliwiec <https://kamilmysliwiec.com>
+Copyright (c) 2017-2023 Kamil Mysliwiec <https://kamilmysliwiec.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/Readme.md

@@ -80,7 +80,8 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td><td>
 <a href="https://fuseautotech.com/" target="_blank"><img src="https://nestjs.com/img/fuse-logo.svg" width="105" valign="middle" /></a></td>
 <td>
-<a href="https://ridicorp.com/career/" target="_blank"><img src="https://nestjs.com/img/ridi-logo.svg" width="105" valign="middle" /></a></td></</tr></table>
+<a href="https://ridicorp.com/career/" target="_blank"><img src="https://nestjs.com/img/ridi-logo.svg" width="105" valign="middle" /></a></td><td>
+<a href="https://www.movavi.com/imovie-for-windows.html" target="_blank"><img src="https://nestjs.com/img/movavi-logo.svg" width="105" valign="middle" /></a></td></</tr></table>
 
 #### Silver Sponsors
 
@@ -93,7 +94,8 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td><a href="https://www.tinystacks.com" target="_blank"><img src="https://nestjs.com/img/tinystacks-logo.png#1" width="140" valign="middle" /></td>
 <td><a href="https://n.inc" target="_blank"><img src="https://nestjs.com/img/n-inc-logo.svg" width="120" valign="middle" /></td></tr><tr>
 <td><a href="https://bilberrry.com/" target="_blank"><img src="https://nestjs.com/img/bilberrry-logo.svg" width="180" valign="middle" /></td>
-<td><a href="https://ipinfo.ai/" target="_blank"><img src="https://nestjs.com/img/ipinfo-logo.png" width="130" valign="middle" /></td></tr>
+<td><a href="https://ipinfo.ai/" target="_blank"><img src="https://nestjs.com/img/ipinfo-logo.png" width="130" valign="middle" /></td>
+<td><a href="https://chax.at" target="_blank"><img src="https://nestjs.com/img/chaxat-logo.png" width="100" valign="middle" /></td></tr>
 </table>
 
 #### Sponsors
@@ -134,7 +136,8 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
    <td align="center" valign="middle"><a href="https://mobilereality.pl/" target="_blank"><img src="https://nestjs.com/img/mobile-reality-logo.png" width="45" valign="middle" /></a></td>
      <td align="center" valign="middle"><a href="https://boringowl.io/" target="_blank"><img src="https://nestjs.com/img/boringowl-logo.svg" width="120" valign="middle" /></a></td>
  <td align="center" valign="middle"><a href="https://www.mobilefactory.jp/" target="_blank"><img src="https://nestjs.com/img/mobilefactory-logo.png" width="100" valign="middle" /></a></td>
- <td align="center" valign="middle"><a href="https://db.nordbot.app/" target="_blank"><img src="https://nestjs.com/img/nord-logo.png" width="50" valign="middle" /></a></td>
+ <td align="center" valign="middle"><a href="https://nordbot.app/" target="_blank"><img src="https://nestjs.com/img/nordbot-logo.png" width="120" valign="middle" /></a></td>
+ <td align="center" valign="middle"><a href="https://doppio.sh/" target="_blank"><img src="https://nestjs.com/img/dopiosh-logo.png" width="50" valign="middle" /></a></td>
   </tr></table>
 
 ## Backers

package/interfaces/websockets-entrypoint-metadata.interface.d.ts

@@ -0,0 +1,4 @@
+export declare type WebsocketEntrypointMetadata = {
+    port: number;
+    message: unknown;
+};

package/interfaces/websockets-entrypoint-metadata.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/websockets",
-  "version": "9.2.1",
+  "version": "9.3.0-beta.2",
   "description": "Nest - modern, fast, powerful node.js web framework (@websockets)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -17,8 +17,8 @@
     "tslib": "2.4.1"
   },
   "devDependencies": {
-    "@nestjs/common": "9.2.1",
-    "@nestjs/core": "9.2.1"
+    "@nestjs/common": "^9.3.0-beta.2",
+    "@nestjs/core": "^9.3.0-beta.2"
   },
   "peerDependencies": {
     "@nestjs/common": "^9.0.0",

package/socket-module.d.ts

@@ -1,15 +1,18 @@
 import { Injectable } from '@nestjs/common/interfaces/injectable.interface';
+import { NestApplicationContextOptions } from '@nestjs/common/interfaces/nest-application-context-options.interface';
 import { ApplicationConfig } from '@nestjs/core/application-config';
 import { NestContainer } from '@nestjs/core/injector/container';
 import { InstanceWrapper } from '@nestjs/core/injector/instance-wrapper';
 import { InstanceToken } from '@nestjs/core/injector/module';
-export declare class SocketModule<HttpServer = any> {
+import { GraphInspector } from '@nestjs/core/inspector/graph-inspector';
+export declare class SocketModule<THttpServer = any, TAppOptions extends NestApplicationContextOptions = NestApplicationContextOptions> {
     private readonly socketsContainer;
     private applicationConfig;
     private webSocketsController;
     private isAdapterInitialized;
     private httpServer;
-    register(container: NestContainer, config: ApplicationConfig, httpServer?: HttpServer): void;
+    private appOptions;
+    register(container: NestContainer, applicationConfig: ApplicationConfig, graphInspector: GraphInspector, appOptions: TAppOptions, httpServer?: THttpServer): void;
     connectAllGateways(providers: Map<InstanceToken, InstanceWrapper<Injectable>>, moduleName: string): void;
     connectGatewayToServer(wrapper: InstanceWrapper<Injectable>, moduleName: string): void;
     close(): Promise<any>;

package/socket-module.js

@@ -20,12 +20,13 @@ class SocketModule {
     constructor() {
         this.socketsContainer = new sockets_container_1.SocketsContainer();
     }
-    register(container, config, httpServer) {
-        this.applicationConfig = config;
+    register(container, applicationConfig, graphInspector, appOptions, httpServer) {
+        this.applicationConfig = applicationConfig;
+        this.appOptions = appOptions;
         this.httpServer = httpServer;
         const contextCreator = this.getContextCreator(container);
-        const serverProvider = new socket_server_provider_1.SocketServerProvider(this.socketsContainer, config);
-        this.webSocketsController = new web_sockets_controller_1.WebSocketsController(serverProvider, config, contextCreator);
+        const serverProvider = new socket_server_provider_1.SocketServerProvider(this.socketsContainer, applicationConfig);
+        this.webSocketsController = new web_sockets_controller_1.WebSocketsController(serverProvider, applicationConfig, contextCreator, graphInspector, this.appOptions);
         const modules = container.getModules();
         modules.forEach(({ providers }, moduleName) => this.connectAllGateways(providers, moduleName));
     }
@@ -43,7 +44,7 @@ class SocketModule {
         if (!this.isAdapterInitialized) {
             this.initializeAdapter();
         }
-        this.webSocketsController.connectGatewayToServer(instance, metatype, moduleName);
+        this.webSocketsController.connectGatewayToServer(instance, metatype, moduleName, wrapper.id);
     }
     async close() {
         if (!this.applicationConfig) {

package/web-sockets-controller.d.ts

@@ -1,5 +1,7 @@
+import { NestApplicationContextOptions } from '@nestjs/common/interfaces/nest-application-context-options.interface';
 import { Type } from '@nestjs/common/interfaces/type.interface';
 import { ApplicationConfig } from '@nestjs/core/application-config';
+import { GraphInspector } from '@nestjs/core/inspector/graph-inspector';
 import { Observable, Subject } from 'rxjs';
 import { WsContextCreator } from './context/ws-context-creator';
 import { MessageMappingProperties } from './gateway-metadata-explorer';
@@ -11,11 +13,13 @@ export declare class WebSocketsController {
     private readonly socketServerProvider;
     private readonly config;
     private readonly contextCreator;
+    private readonly graphInspector;
+    private readonly appOptions;
     private readonly logger;
     private readonly metadataExplorer;
-    constructor(socketServerProvider: SocketServerProvider, config: ApplicationConfig, contextCreator: WsContextCreator);
-    connectGatewayToServer(instance: NestGateway, metatype: Type<unknown> | Function, moduleKey: string): void;
-    subscribeToServerEvents<T extends GatewayMetadata>(instance: NestGateway, options: T, port: number, moduleKey: string): void;
+    constructor(socketServerProvider: SocketServerProvider, config: ApplicationConfig, contextCreator: WsContextCreator, graphInspector: GraphInspector, appOptions?: NestApplicationContextOptions);
+    connectGatewayToServer(instance: NestGateway, metatype: Type<unknown> | Function, moduleKey: string, instanceWrapperId: string): void;
+    subscribeToServerEvents<T extends GatewayMetadata>(instance: NestGateway, options: T, port: number, moduleKey: string, instanceWrapperId: string): void;
     subscribeEvents(instance: NestGateway, subscribersMap: MessageMappingProperties[], observableServer: ServerAndEventStreamsHost): void;
     getConnectionHandler(context: WebSocketsController, instance: NestGateway, subscribersMap: MessageMappingProperties[], disconnect: Subject<any>, connection: Subject<any>): (...args: unknown[]) => void;
     subscribeInitEvent(instance: NestGateway, event: Subject<any>): void;
@@ -23,6 +27,7 @@ export declare class WebSocketsController {
     subscribeDisconnectEvent(instance: NestGateway, event: Subject<any>): void;
     subscribeMessages<T = any>(subscribersMap: MessageMappingProperties[], client: T, instance: NestGateway): void;
     pickResult(deferredResult: Promise<any>): Promise<Observable<any>>;
+    inspectEntrypointDefinitions(instance: NestGateway, port: number, messageHandlers: MessageMappingProperties[], instanceWrapperId: string): void;
     private assignServerToProperties;
     private printSubscriptionLogs;
 }

package/web-sockets-controller.js

@@ -10,30 +10,36 @@ const invalid_socket_port_exception_1 = require("./errors/invalid-socket-port.ex
 const gateway_metadata_explorer_1 = require("./gateway-metadata-explorer");
 const compare_element_util_1 = require("./utils/compare-element.util");
 class WebSocketsController {
-    constructor(socketServerProvider, config, contextCreator) {
+    constructor(socketServerProvider, config, contextCreator, graphInspector, appOptions = {}) {
         this.socketServerProvider = socketServerProvider;
         this.config = config;
         this.contextCreator = contextCreator;
+        this.graphInspector = graphInspector;
+        this.appOptions = appOptions;
         this.logger = new logger_service_1.Logger(WebSocketsController.name, {
             timestamp: true,
         });
         this.metadataExplorer = new gateway_metadata_explorer_1.GatewayMetadataExplorer(new metadata_scanner_1.MetadataScanner());
     }
-    connectGatewayToServer(instance, metatype, moduleKey) {
+    connectGatewayToServer(instance, metatype, moduleKey, instanceWrapperId) {
         const options = Reflect.getMetadata(constants_1.GATEWAY_OPTIONS, metatype) || {};
         const port = Reflect.getMetadata(constants_1.PORT_METADATA, metatype) || 0;
         if (!Number.isInteger(port)) {
             throw new invalid_socket_port_exception_1.InvalidSocketPortException(port, metatype);
         }
-        this.subscribeToServerEvents(instance, options, port, moduleKey);
+        this.subscribeToServerEvents(instance, options, port, moduleKey, instanceWrapperId);
     }
-    subscribeToServerEvents(instance, options, port, moduleKey) {
+    subscribeToServerEvents(instance, options, port, moduleKey, instanceWrapperId) {
         const nativeMessageHandlers = this.metadataExplorer.explore(instance);
         const messageHandlers = nativeMessageHandlers.map(({ callback, message, methodName }) => ({
             message,
             methodName,
             callback: this.contextCreator.create(instance, callback, moduleKey, methodName),
         }));
+        this.inspectEntrypointDefinitions(instance, port, messageHandlers, instanceWrapperId);
+        if (this.appOptions.preview) {
+            return;
+        }
         const observableServer = this.socketServerProvider.scanForSocketServer(options, port);
         this.assignServerToProperties(instance, observableServer.server);
         this.subscribeEvents(instance, messageHandlers, observableServer);
@@ -96,6 +102,22 @@ class WebSocketsController {
         }
         return (0, rxjs_1.of)(result);
     }
+    inspectEntrypointDefinitions(instance, port, messageHandlers, instanceWrapperId) {
+        messageHandlers.forEach(handler => {
+            var _a;
+            this.graphInspector.insertEntrypointDefinition({
+                type: 'websocket',
+                methodName: handler.methodName,
+                className: (_a = instance.constructor) === null || _a === void 0 ? void 0 : _a.name,
+                classNodeId: instanceWrapperId,
+                metadata: {
+                    port,
+                    key: handler.message,
+                    message: handler.message,
+                },
+            }, instanceWrapperId);
+        });
+    }
     assignServerToProperties(instance, server) {
         for (const propertyKey of this.metadataExplorer.scanForServerHooks(instance)) {
             Reflect.set(instance, propertyKey, server);