fix: load egg router before midway container ready (#909)

packages/web/app.js

@@ -61,6 +61,7 @@ class AppBootHook {
       }
     }
 
+    this.app.use(this.app.router.middleware());
     await this.app.webFramework.loadMidwayController();
   }
 

packages/web/src/base.ts

@@ -7,7 +7,9 @@ import { safelyGet, safeRequire } from '@midwayjs/core';
 import { join } from 'path';
 import { existsSync, readFileSync } from 'fs';
 import { createLoggers } from './logger';
+import { EggRouter as Router } from '@eggjs/router';
 
+const ROUTER = Symbol('EggCore#router');
 const EGG_LOADER = Symbol.for('egg#loader');
 const EGG_PATH = Symbol.for('egg#eggPath');
 const LOGGERS = Symbol('EggApplication#loggers');
@@ -272,6 +274,17 @@ export const createEggApplication = () => {
       }
       return (this as any)[LOGGERS];
     }
+
+    get router() {
+      if ((this as any)[ROUTER]) {
+        return (this as any)[ROUTER];
+      }
+      const router = ((this as any)[ROUTER] = new Router(
+        { sensitive: true },
+        this
+      ));
+      return router;
+    }
   }
 
   return EggApplication as any;

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

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

packages/web/test/fixtures/issue/base-app-egg-router/src/app/controller/eggTest.ts

@@ -0,0 +1,9 @@
+import { Controller } from 'egg';
+
+export default class EggTestController extends Controller {
+  public test() {
+    this.ctx.body = {
+      data: '中间件运行结果：' + this.ctx.test,
+    };
+  }
+}

packages/web/test/fixtures/issue/base-app-egg-router/src/app/router.ts

@@ -0,0 +1,10 @@
+import { Application } from 'egg';
+
+export default (app: Application) => {
+  const { controller, router } = app;
+
+  router.get(
+    '/api/egg-test',
+    controller.eggTest.test,
+  );
+};

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

@@ -0,0 +1,21 @@
+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 + '_1615306124396_5113';
+
+  // add your config here
+  config.middleware = ['clientCheckerMiddleware'];
+
+  config.midwayFeature = {
+    // true 代表使用 midway logger
+    // false 或者为空代表使用 egg-logger
+    replaceEggLogger: true
+  }
+
+  return config;
+};

packages/web/test/fixtures/issue/base-app-egg-router/src/config/config.unittest.ts

@@ -0,0 +1,3 @@
+export const security = {
+  csrf: false
+}

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

@@ -0,0 +1,5 @@
+import { EggPlugin } from 'egg';
+export default {
+  logrotator: false,  // disable when use @midwayjs/logger
+  static: false,
+} as EggPlugin;

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

@@ -0,0 +1,13 @@
+import { App, Configuration } from '@midwayjs/decorator';
+import { ILifeCycle } from '@midwayjs/core';
+import { Application } from 'egg';
+
+@Configuration()
+export class ContainerLifeCycle implements ILifeCycle {
+
+  @App()
+  app: Application;
+
+  async onReady() {
+  }
+}

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

@@ -0,0 +1,17 @@
+import { Controller, Get, Inject, Provide } from '@midwayjs/decorator';
+import { Context } from 'egg';
+
+@Provide()
+@Controller('/')
+export class HomeController {
+
+  @Inject()
+  ctx: Context;
+
+  @Get('/')
+  async home() {
+    return {
+      data: '中间件运行结果：' + this.ctx.test,
+    };
+  }
+}

packages/web/test/fixtures/issue/base-app-egg-router/src/interface.ts

@@ -0,0 +1,6 @@
+/**
+ * @description User-Service parameters
+ */
+export interface IUserOptions {
+  uid: number;
+}

packages/web/test/fixtures/issue/base-app-egg-router/src/middleware/client_checker.ts

@@ -0,0 +1,14 @@
+import { Provide } from '@midwayjs/decorator';
+import { IWebMiddleware, IMidwayWebNext } from '../../../../../../src';
+import { Context } from 'egg';
+
+@Provide()
+export class ClientCheckerMiddleware implements IWebMiddleware {
+  resolve() {
+    return async (ctx: Context, next: IMidwayWebNext) => {
+      console.log('运行了 ClientCheckerMiddleware');
+      ctx.test = '来自 ClientCheckerMiddleware 的值';
+      await next();
+    };
+  }
+}

packages/web/test/issue.test.ts

@@ -75,5 +75,17 @@ describe('/test/issue.test.ts', () => {
     expect(result.text).toEqual('Hello Midwayjs!');
     await closeApp(app);
   });
+
+  it('test #894 issue load egg router after midway container ready', async () => {
+    const app = await creatApp('issue/base-app-egg-router');
+    let result = await createHttpRequest(app).get('/');
+    expect(result.status).toEqual(200);
+    expect(result.text).toMatch('来自 ClientCheckerMiddleware 的值');
+
+    result = await createHttpRequest(app).get('/api/egg-test');
+    expect(result.status).toEqual(200);
+    expect(result.text).toMatch('来自 ClientCheckerMiddleware 的值');
+    await closeApp(app);
+  });
 });