@midwayjs/socketio 3.3.5 → 3.4.0-beta.11

package/dist/framework.d.ts

@@ -1,11 +1,11 @@
-import { BaseFramework, IMidwayBootstrapOptions, MidwayFrameworkType } from '@midwayjs/core';
-import { IMidwaySocketIOApplication, IMidwaySocketIOConfigurationOptions, IMidwaySocketIOContext } from './interface';
-export declare class MidwaySocketIOFramework extends BaseFramework<IMidwaySocketIOApplication, IMidwaySocketIOContext, IMidwaySocketIOConfigurationOptions> {
+import { BaseFramework, CommonMiddlewareUnion, ContextMiddlewareManager, MidwayFrameworkType } from '@midwayjs/core';
+import { Application, IMidwaySocketIOOptions, Context, NextFunction } from './interface';
+export declare class MidwaySocketIOFramework extends BaseFramework<Application, Context, IMidwaySocketIOOptions> {
     private namespaceList;
-    configure(): IMidwaySocketIOConfigurationOptions;
-    applicationInitialize(options: IMidwayBootstrapOptions): void;
-    app: IMidwaySocketIOApplication;
-    protected afterContainerReady(options: Partial<IMidwayBootstrapOptions>): Promise<void>;
+    app: Application;
+    protected connectionMiddlewareManager: ContextMiddlewareManager<Context, unknown, unknown>;
+    configure(): IMidwaySocketIOOptions;
+    applicationInitialize(): void;
     run(): Promise<void>;
     protected beforeStop(): Promise<void>;
     getFrameworkType(): MidwayFrameworkType;
@@ -13,5 +13,7 @@ export declare class MidwaySocketIOFramework extends BaseFramework<IMidwaySocket
     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

@@ -16,17 +16,24 @@ let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseF
     constructor() {
         super(...arguments);
         this.namespaceList = [];
+        this.connectionMiddlewareManager = this.createMiddlewareManager();
     }
     configure() {
         return this.configService.getConfiguration('socketIO');
     }
-    applicationInitialize(options) {
+    applicationInitialize() {
         this.app = new socket_io_1.Server(this.configurationOptions);
-    }
-    async afterContainerReady(options) {
-        await this.loadMidwayController();
+        this.defineApplicationProperties({
+            useConnectionMiddleware: (middleware) => {
+                return this.useConnectionMiddleware(middleware);
+            },
+            getConnectionMiddleware: () => {
+                return this.getConnectionMiddleware();
+            },
+        });
     }
     async run() {
+        await this.loadMidwayController();
         if (this.configurationOptions.adapter) {
             this.app.adapter(this.configurationOptions.adapter);
             this.logger.debug('[midway:socketio] init socket.io-redis ready!');
@@ -61,9 +68,12 @@ let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseF
         }
     }
     async addNamespace(target) {
+        var _a, _b;
         const controllerOption = (0, decorator_1.getClassMetadata)(decorator_1.WS_CONTROLLER_KEY, target);
         const nsp = this.app.of(controllerOption.namespace);
         this.namespaceList.push(controllerOption.namespace);
+        const controllerMiddleware = (_a = controllerOption.routerOptions.middleware) !== null && _a !== void 0 ? _a : [];
+        const controllerConnectionMiddleware = (_b = controllerOption.routerOptions.connectionMiddleware) !== null && _b !== void 0 ? _b : [];
         nsp.use((socket, next) => {
             this.app.createAnonymousContext(socket);
             socket.requestContext.registerObject('socket', socket);
@@ -71,6 +81,13 @@ let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseF
             next();
         });
         nsp.on('connect', async (socket) => {
+            var _a;
+            // 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 = {};
@@ -81,7 +98,14 @@ let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseF
                     // on connection
                     if (wsEventInfo.eventType === decorator_1.WSEventTypeEnum.ON_CONNECTION) {
                         try {
-                            const result = await controller[wsEventInfo.propertyName].apply(controller, [socket]);
+                            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]);
+                                },
+                            ], this.app);
+                            const result = await fn(socket);
                             await this.bindSocketResponse(result, socket, wsEventInfo.propertyName, methodMap);
                         }
                         catch (err) {
@@ -94,8 +118,17 @@ let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseF
                             debug('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
@@ -158,6 +191,12 @@ let MidwaySocketIOFramework = class MidwaySocketIOFramework extends core_1.BaseF
     getFrameworkName() {
         return 'midway:socketIO';
     }
+    useConnectionMiddleware(middleware) {
+        this.connectionMiddlewareManager.insertLast(middleware);
+    }
+    getConnectionMiddleware() {
+        return this.connectionMiddlewareManager;
+    }
 };
 MidwaySocketIOFramework = __decorate([
     (0, decorator_1.Framework)()

package/dist/interface.d.ts

@@ -1,18 +1,22 @@
 import * as SocketIO from 'socket.io';
-import { IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction } from '@midwayjs/core';
-export declare type IMidwaySocketIOApplication = IMidwayApplication<IMidwaySocketIOContext, {
-    use(fn: (socket: IMidwaySocketIOContext, fn: (err?: any) => void) => void): SocketIO.Namespace;
+import { CommonMiddlewareUnion, ContextMiddlewareManager, IConfigurationOptions, IMidwayApplication, IMidwayContext, NextFunction as BaseNextFunction } from '@midwayjs/core';
+export declare type Application = IMidwayApplication<Context, {
+    use(fn: (socket: Context, fn: (err?: any) => void) => void): SocketIO.Namespace;
+    useConnectionMiddleware: (middleware: CommonMiddlewareUnion<Context, NextFunction, undefined>) => void;
+    getConnectionMiddleware: ContextMiddlewareManager<Context, NextFunction, undefined>;
 } & SocketIO.Server>;
-export declare type IMidwaySocketIOConfigurationOptions = {
+export declare type IMidwaySocketIOOptions = {
     port?: number;
     pubClient?: any;
     subClient?: any;
 } & Partial<SocketIO.ServerOptions> & IConfigurationOptions;
-export declare type IMidwaySocketIOContext = IMidwayContext<SocketIO.Socket & {
-    app: IMidwaySocketIOApplication;
+export declare type Context = IMidwayContext<SocketIO.Socket & {
+    app: Application;
 }>;
-export declare type Application = IMidwaySocketIOApplication;
-export interface Context extends IMidwaySocketIOContext {
-}
 export declare type NextFunction = BaseNextFunction;
+declare module '@midwayjs/core/dist/interface' {
+    interface MidwayConfig {
+        socketIO?: IMidwaySocketIOOptions;
+    }
+}
 //# sourceMappingURL=interface.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/socketio",
-  "version": "3.3.5",
+  "version": "3.4.0-beta.11",
   "description": "Midway Web Framework for socket.io",
   "main": "dist/index",
   "typings": "index.d.ts",
@@ -24,14 +24,14 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/decorator": "^3.3.4",
-    "@midwayjs/mock": "^3.3.5",
+    "@midwayjs/decorator": "^3.4.0-beta.11",
+    "@midwayjs/mock": "^3.4.0-beta.11",
     "@types/socket.io-client": "1.4.36",
     "fs-extra": "10.0.1",
     "socket.io-client": "4.4.1"
   },
   "dependencies": {
-    "@midwayjs/core": "^3.3.5",
+    "@midwayjs/core": "^3.4.0-beta.11",
     "@midwayjs/logger": "^2.15.0",
     "socket.io": "4.4.1",
     "socket.io-redis": "^6.1.0"
@@ -44,5 +44,5 @@
   "engines": {
     "node": ">=12"
   },
-  "gitHead": "5a835008aaa26e1b3c7d99c525f4a9fdaa3e41d1"
+  "gitHead": "b1c7a439b0df37d3e381cd182ea3b9e74323107b"
 }