@midwayjs/ws 3.14.4 → 3.14.7

package/dist/configuration.js

@@ -16,7 +16,10 @@ WebSocketConfiguration = __decorate([
         importConfigs: [
             {
                 default: {
-                    webSocket: {},
+                    webSocket: {
+                        enableServerHeartbeatCheck: false,
+                        serverHeartbeatInterval: 30000,
+                    },
                 },
             },
         ],

package/dist/framework.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import { BaseFramework, CommonMiddlewareUnion, ContextMiddlewareManager, IMidwayBootstrapOptions, MidwayFrameworkType } from '@midwayjs/core';
 import * as http from 'http';
 import { Application, Context, IMidwayWSApplication, IMidwayWSConfigurationOptions, NextFunction } from './interface';
 export declare class MidwayWSFramework extends BaseFramework<Application, Context, IMidwayWSConfigurationOptions> {
     server: http.Server;
+    protected heartBeatInterval: NodeJS.Timeout;
     protected connectionMiddlewareManager: ContextMiddlewareManager<Context, unknown, unknown>;
     configure(): IMidwayWSConfigurationOptions;
     applicationInitialize(options: IMidwayBootstrapOptions): void;
@@ -18,5 +20,6 @@ export declare class MidwayWSFramework extends BaseFramework<Application, Contex
     getFrameworkName(): string;
     useConnectionMiddleware(middleware: CommonMiddlewareUnion<Context, NextFunction, undefined>): void;
     getConnectionMiddleware(): ContextMiddlewareManager<Context, NextFunction, undefined>;
+    startHeartBeat(): void;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -56,6 +56,9 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
             await new Promise(resolve => {
                 server.listen(this.configurationOptions.port, () => {
                     this.logger.info(`[midway:ws] WebSocket server port = ${this.configurationOptions.port} start success.`);
+                    if (this.configurationOptions.enableServerHeartbeatCheck) {
+                        this.startHeartBeat();
+                    }
                     resolve();
                 });
             });
@@ -89,6 +92,13 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
         const controllerConnectionMiddleware = (_b = controllerOption.routerOptions.connectionMiddleware) !== null && _b !== void 0 ? _b : [];
         this.app.on('connection', async (socket, request) => {
             var _a;
+            socket.isAlive = true;
+            socket.on('error', error => {
+                this.logger.error(`socket got error: ${error}`);
+            });
+            socket.on('pong', () => {
+                socket.isAlive = true;
+            });
             // create request context
             this.app.createAnonymousContext(socket);
             socket.requestContext.registerObject('socket', socket);
@@ -181,9 +191,12 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
             }
         });
         this.app.on('error', err => {
-            this.logger.error('socket server close', err);
+            this.logger.error('socket server got error', err);
         });
         this.app.on('close', () => {
+            if (this.heartBeatInterval) {
+                clearInterval(this.heartBeatInterval);
+            }
             this.logger.info('socket server close');
         });
     }
@@ -222,6 +235,18 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
     getConnectionMiddleware() {
         return this.connectionMiddlewareManager;
     }
+    startHeartBeat() {
+        this.heartBeatInterval = setInterval(() => {
+            this.app.clients.forEach((socket) => {
+                if (socket.isAlive === false) {
+                    debug('[ws]: socket terminate');
+                    return socket.terminate();
+                }
+                socket.isAlive = false;
+                socket.ping();
+            });
+        }, this.configurationOptions.serverHeartbeatInterval);
+    }
 };
 MidwayWSFramework = __decorate([
     (0, core_1.Framework)()

package/dist/interface.d.ts

@@ -7,9 +7,18 @@ export type IMidwayWSApplication = IMidwayApplication<IMidwayWSContext, {
 export type IMidwayWSConfigurationOptions = {
     pubClient?: any;
     subClient?: any;
+    /**
+     * enable server heartbeat check, default is false
+     */
+    enableServerHeartbeatCheck?: boolean;
+    /**
+     * server heartbeat interval, default is 30000ms
+     */
+    serverHeartbeatInterval?: number;
 } & Partial<WebSocket.ServerOptions> & IConfigurationOptions;
 export type IMidwayWSContext = IMidwayContext<WebSocket & {
     app: IMidwayWSApplication;
+    isAlive: boolean;
 }>;
 export type Application = IMidwayWSApplication;
 export type NextFunction = BaseNextFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/ws",
-  "version": "3.14.4",
+  "version": "3.14.7",
   "description": "Midway Web Framework for ws",
   "main": "dist/index.js",
   "typings": "index.d.ts",
@@ -23,7 +23,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/mock": "^3.14.4",
+    "@midwayjs/mock": "^3.14.7",
     "@types/ws": "8.5.10",
     "fs-extra": "11.2.0"
   },
@@ -39,5 +39,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "72aacdfd87ef730f100690557de48dcbd4d806a7"
+  "gitHead": "148356ccd4b97404dde43d4a06edd51da039828a"
 }