@midwayjs/ws 3.4.0-beta.6 → 3.4.0-beta.7

package/dist/framework.d.ts

@@ -1,9 +1,10 @@
 /// <reference types="node" />
-import { BaseFramework, IMidwayBootstrapOptions, MidwayFrameworkType } from '@midwayjs/core';
+import { BaseFramework, CommonMiddlewareUnion, ContextMiddlewareManager, IMidwayBootstrapOptions, MidwayFrameworkType } from '@midwayjs/core';
 import * as http from 'http';
-import { IMidwayWSApplication, IMidwayWSConfigurationOptions, IMidwayWSContext } from './interface';
-export declare class MidwayWSFramework extends BaseFramework<IMidwayWSApplication, IMidwayWSContext, IMidwayWSConfigurationOptions> {
+import { Application, Context, IMidwayWSApplication, IMidwayWSConfigurationOptions, NextFunction } from './interface';
+export declare class MidwayWSFramework extends BaseFramework<Application, Context, IMidwayWSConfigurationOptions> {
     server: http.Server;
+    protected connectionMiddlewareManager: ContextMiddlewareManager<Context, unknown, unknown>;
     configure(): IMidwayWSConfigurationOptions;
     applicationInitialize(options: IMidwayBootstrapOptions): void;
     app: IMidwayWSApplication;
@@ -15,5 +16,7 @@ export declare class MidwayWSFramework extends BaseFramework<IMidwayWSApplicatio
     private addNamespace;
     private bindSocketResponse;
     getFrameworkName(): string;
+    useConnectionMiddleware(middleware: CommonMiddlewareUnion<Context, NextFunction, undefined>): void;
+    getConnectionMiddleware(): ContextMiddlewareManager<Context, NextFunction, undefined>;
 }
 //# sourceMappingURL=framework.d.ts.map

package/dist/framework.js

@@ -14,6 +14,10 @@ const debug = (0, util_1.debuglog)('midway:debug');
 const WebSocket = require("ws");
 const decorator_1 = require("@midwayjs/decorator");
 let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
+    constructor() {
+        super(...arguments);
+        this.connectionMiddlewareManager = this.createMiddlewareManager();
+    }
     configure() {
         return this.configService.getConfiguration('webSocket');
     }
@@ -21,6 +25,14 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
         this.configurationOptions.noServer = true;
         const opts = Object.assign({}, this.configurationOptions, { port: null });
         this.app = new WebSocket.Server(opts);
+        this.defineApplicationProperties({
+            useConnectionMiddleware: (middleware) => {
+                return this.useConnectionMiddleware(middleware);
+            },
+            getConnectionMiddleware: () => {
+                return this.getConnectionMiddleware();
+            },
+        });
     }
     async afterContainerReady(options) {
         await this.loadMidwayController();
@@ -72,11 +84,22 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
         }
     }
     async addNamespace(target) {
+        var _a, _b;
+        const controllerOption = (0, decorator_1.getClassMetadata)(decorator_1.WS_CONTROLLER_KEY, target);
+        const controllerMiddleware = (_a = controllerOption.routerOptions.middleware) !== null && _a !== void 0 ? _a : [];
+        const controllerConnectionMiddleware = (_b = controllerOption.routerOptions.connectionMiddleware) !== null && _b !== void 0 ? _b : [];
         this.app.on('connection', async (socket, request) => {
+            var _a;
             // create request context
             this.app.createAnonymousContext(socket);
             socket.requestContext.registerObject('socket', socket);
             socket.app = this.app;
+            // run connection middleware
+            const connectFn = await this.middlewareService.compose([
+                ...this.connectionMiddlewareManager,
+                ...controllerConnectionMiddleware,
+            ], this.app);
+            await connectFn(socket);
             const wsEventInfos = (0, decorator_1.getClassMetadata)(decorator_1.WS_EVENT_KEY, target);
             // 存储方法对应的响应处理
             const methodMap = {};
@@ -87,7 +110,14 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
                     // on connection
                     if (wsEventInfo.eventType === decorator_1.WSEventTypeEnum.ON_CONNECTION) {
                         try {
-                            const result = await controller[wsEventInfo.propertyName].apply(controller, [socket, request]);
+                            const fn = await this.middlewareService.compose([
+                                ...(((_a = wsEventInfo === null || wsEventInfo === void 0 ? void 0 : wsEventInfo.eventOptions) === null || _a === void 0 ? void 0 : _a.middleware) || []),
+                                async (ctx, next) => {
+                                    // eslint-disable-next-line prefer-spread
+                                    return controller[wsEventInfo.propertyName].apply(controller, [socket, request]);
+                                },
+                            ], this.app);
+                            const result = await fn(socket);
                             await this.bindSocketResponse(result, socket, wsEventInfo.propertyName, methodMap);
                         }
                         catch (err) {
@@ -100,8 +130,17 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
                             debug('[ws]: got message', wsEventInfo.messageEventName, args);
                             try {
                                 const result = await (await this.applyMiddleware(async (ctx, next) => {
-                                    // eslint-disable-next-line prefer-spread
-                                    return controller[wsEventInfo.propertyName].apply(controller, args);
+                                    var _a;
+                                    // add controller middleware
+                                    const fn = await this.middlewareService.compose([
+                                        ...controllerMiddleware,
+                                        ...(((_a = wsEventInfo === null || wsEventInfo === void 0 ? void 0 : wsEventInfo.eventOptions) === null || _a === void 0 ? void 0 : _a.middleware) || []),
+                                        async (ctx, next) => {
+                                            // eslint-disable-next-line prefer-spread
+                                            return controller[wsEventInfo.propertyName].apply(controller, args);
+                                        },
+                                    ], this.app);
+                                    return await fn(ctx, next);
                                 }))(socket);
                                 if (typeof args[args.length - 1] === 'function') {
                                     // ack
@@ -172,6 +211,12 @@ let MidwayWSFramework = class MidwayWSFramework extends core_1.BaseFramework {
     getFrameworkName() {
         return 'midway:ws';
     }
+    useConnectionMiddleware(middleware) {
+        this.connectionMiddlewareManager.insertLast(middleware);
+    }
+    getConnectionMiddleware() {
+        return this.connectionMiddlewareManager;
+    }
 };
 MidwayWSFramework = __decorate([
     (0, decorator_1.Framework)()

package/dist/interface.d.ts

@@ -1,6 +1,9 @@
 import * as WebSocket from 'ws';
-import { IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction } from '@midwayjs/core';
-export declare type IMidwayWSApplication = IMidwayApplication<IMidwayWSContext> & WebSocket.Server;
+import { CommonMiddlewareUnion, ContextMiddlewareManager, IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction } from '@midwayjs/core';
+export declare type IMidwayWSApplication = IMidwayApplication<IMidwayWSContext, {
+    useConnectionMiddleware: (middleware: CommonMiddlewareUnion<Context, NextFunction, undefined>) => void;
+    getConnectionMiddleware: ContextMiddlewareManager<Context, NextFunction, undefined>;
+}> & WebSocket.Server;
 export declare type IMidwayWSConfigurationOptions = {
     pubClient?: any;
     subClient?: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/ws",
-  "version": "3.4.0-beta.6",
+  "version": "3.4.0-beta.7",
   "description": "Midway Web Framework for ws",
   "main": "dist/index",
   "typings": "index.d.ts",
@@ -23,13 +23,13 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.4.0-beta.6",
-    "@midwayjs/mock": "^3.4.0-beta.6",
+    "@midwayjs/decorator": "^3.4.0-beta.7",
+    "@midwayjs/mock": "^3.4.0-beta.7",
     "@types/ws": "8.5.3",
     "fs-extra": "10.0.1"
   },
   "dependencies": {
-    "@midwayjs/core": "^3.4.0-beta.6",
+    "@midwayjs/core": "^3.4.0-beta.7",
     "@midwayjs/logger": "^2.15.0",
     "ws": "8.8.0"
   },
@@ -41,5 +41,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "8e187c4593d4832de32b6745af3e195f6b90816c"
+  "gitHead": "4d5cc59a7a33e49beeaf20fcfaf766438649959c"
 }