fix: egg socket io missing session middleware (#835)

packages/typegoose/package.json

@@ -18,7 +18,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/cli": "^1.2.38",
+    "@midwayjs/cli": "^1.2.36",
     "@midwayjs/koa": "^2.7.2",
     "@midwayjs/mock": "^2.7.2",
     "@typegoose/typegoose": "^7.4.7",

packages/web/app.js

@@ -18,6 +18,12 @@ class AppBootHook {
   }
 
   async didLoad() {
+    if (this.app.loader['useEggSocketIO']) {
+      // socketio 下会提前加入 session 中间件，这里删除，防止重复加载
+      if (this.app.middleware.length && this.app.middleware[this.app.middleware.length - 1]._name === 'session') {
+        this.app.middleware.pop();
+      }
+    }
     const middlewareNames = this.coreMiddleware.concat(this.appMiddleware);
     // 等 midway 加载完成后，再去 use 中间件
     for (const name of middlewareNames) {

packages/web/package.json

@@ -31,6 +31,7 @@
     "@midwayjs/mock": "^2.7.2",
     "dayjs": "^1.10.4",
     "egg-view-nunjucks": "^2.2.0",
+    "egg-socket.io": "^4.1.6",
     "fake-egg": "1.0.0",
     "fs-extra": "^8.0.1",
     "pedding": "^1.1.0",

packages/web/src/base.ts

@@ -37,6 +37,7 @@ export const createAppWorkerLoader = () => {
     app: any;
     framework;
     bootstrap;
+    useEggSocketIO = false;
 
     getEggPaths() {
       if (!this.appDir) {
@@ -130,6 +131,19 @@ export const createAppWorkerLoader = () => {
         await this.framework.loadLifeCycles();
       });
     }
+
+    loadMiddleware() {
+      super.loadMiddleware();
+      if (this.plugins['io']) {
+        this.useEggSocketIO = true;
+        const sessionMiddleware = this.app.middlewares['session'](
+          this.app.config['session'],
+          this.app
+        );
+        sessionMiddleware._name = 'session';
+        this.app.use(sessionMiddleware);
+      }
+    }
   }
 
   return EggAppWorkerLoader as any;

packages/web/test/fixtures/issue/base-app-socketio/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "ali-demo"
+}

packages/web/test/fixtures/issue/base-app-socketio/src/config/config.default.ts

@@ -0,0 +1,26 @@
+import { EggAppConfig, EggAppInfo, PowerPartial } from 'egg';
+
+export type DefaultConfig = PowerPartial<EggAppConfig>;
+
+export default (appInfo: EggAppInfo) => {
+  const config = {} as DefaultConfig;
+
+  // use for cookie sign key, should change to your own and keep security
+  config.keys = appInfo.name + '_1611657289809_5801';
+
+  // add your config here
+  config.middleware = [];
+
+  // socket.io配置
+  config.io = {
+    init: {}, // passed to engine.io
+    namespace: {
+      '/ws': {
+        connectionMiddleware: [],
+        packetMiddleware: [],
+      },
+    },
+  };
+
+  return config;
+};

packages/web/test/fixtures/issue/base-app-socketio/src/config/plugin.ts

@@ -0,0 +1,12 @@
+import { EggPlugin } from 'egg';
+
+// 启用socketio
+const io = {
+  enable: true,
+  package: 'egg-socket.io',
+};
+
+export default {
+  static: false, // default is true
+  io,
+} as EggPlugin;

packages/web/test/fixtures/issue/base-app-socketio/src/configuration.ts

@@ -0,0 +1,5 @@
+import { Configuration } from '@midwayjs/decorator';
+
+@Configuration()
+export class ContainerConfiguration {
+}

packages/web/test/fixtures/issue/base-app-socketio/src/controller/home.ts

@@ -0,0 +1,10 @@
+import { Controller, Get, Provide } from '@midwayjs/decorator';
+
+@Provide()
+@Controller('/')
+export class HomeController {
+  @Get('/')
+  async home() {
+    return 'Hello Midwayjs!';
+  }
+}

packages/web/test/issue.test.ts

@@ -67,5 +67,13 @@ describe('/test/issue.test.ts', () => {
     expect(result.text).toEqual('hello world');
     await closeApp(app);
   });
+
+  it('test #825 issue load socket io plugin error in egg.js', async () => {
+    const app = await creatApp('issue/base-app-socketio');
+    let result = await createHttpRequest(app).get('/');
+    expect(result.status).toEqual(200);
+    expect(result.text).toEqual('Hello Midwayjs!');
+    await closeApp(app);
+  });
 });