feat: multi host decorator (#68)

elrrrrrrr · web-flow · commit f6679de14950 · 2022-12-15T21:51:22.000+08:00
diff --git a/core/controller-decorator/src/decorator/http/Host.ts b/core/controller-decorator/src/decorator/http/Host.ts
@@ -2,26 +2,31 @@ import ControllerInfoUtil from '../../util/ControllerInfoUtil';
 import { EggProtoImplClass } from '@eggjs/core-decorator';
 import MethodInfoUtil from '../../util/MethodInfoUtil';
 import assert from 'assert';
+import { HostType } from '../../model';
+
+export function Host(host: HostType) {
+
+  function parseHost(): string[] {
+    return Array.isArray(host) ? host : [ host ];
+  }
 
-export function Host(host: string) {
   function classHost(constructor: EggProtoImplClass) {
-    ControllerInfoUtil.addControllerHost(host, constructor);
+    ControllerInfoUtil.addControllerHosts(parseHost(), constructor);
   }
 
-  function methodHOst(target: any, propertyKey: PropertyKey) {
+  function methodHost(target: any, propertyKey: PropertyKey) {
     assert(typeof propertyKey === 'string',
       `[controller/${target.name}] expect method name be typeof string, but now is ${String(propertyKey)}`);
     const controllerClazz = target.constructor as EggProtoImplClass;
     const methodName = propertyKey as string;
-
-    MethodInfoUtil.setMethodHost(host, controllerClazz, methodName);
+    MethodInfoUtil.setMethodHosts(parseHost(), controllerClazz, methodName);
   }
 
   return function(target: any, propertyKey?: PropertyKey) {
     if (propertyKey === undefined) {
       classHost(target);
     } else {
-      methodHOst(target, propertyKey);
+      methodHost(target, propertyKey);
     }
   };
 }
diff --git a/core/controller-decorator/src/impl/http/HTTPControllerMetaBuilder.ts b/core/controller-decorator/src/impl/http/HTTPControllerMetaBuilder.ts
@@ -43,9 +43,9 @@ export class HTTPControllerMetaBuilder {
     const protoName = property!.name as string;
     const needAcl = ControllerInfoUtil.hasControllerAcl(this.clazz);
     const aclCode = ControllerInfoUtil.getControllerAcl(this.clazz);
-    const host = ControllerInfoUtil.getControllerHost(this.clazz);
+    const hosts = ControllerInfoUtil.getControllerHosts(this.clazz);
     const metadata = new HTTPControllerMeta(
-      clazzName, protoName, controllerName, httpPath, httpMiddlewares, methods, needAcl, aclCode, host);
+      clazzName, protoName, controllerName, httpPath, httpMiddlewares, methods, needAcl, aclCode, hosts);
     ControllerMetadataUtil.setControllerMetadata(this.clazz, metadata);
     for (const method of metadata.methods) {
       const realPath = metadata.getMethodRealPath(method);
@@ -63,4 +63,3 @@ export class HTTPControllerMetaBuilder {
 }
 
 ControllerMetaBuilderFactory.registerControllerMetaBuilder(ControllerType.HTTP, HTTPControllerMetaBuilder.create);
-
diff --git a/core/controller-decorator/src/impl/http/HTTPControllerMethodMetaBuilder.ts b/core/controller-decorator/src/impl/http/HTTPControllerMethodMetaBuilder.ts
@@ -105,13 +105,13 @@ export class HTTPControllerMethodMetaBuilder {
     const middlewares = MethodInfoUtil.getMethodMiddlewares(this.clazz, this.methodName);
     const needAcl = MethodInfoUtil.hasMethodAcl(this.clazz, this.methodName);
     const aclCode = MethodInfoUtil.getMethodAcl(this.clazz, this.methodName);
-    const host = MethodInfoUtil.getMethodHost(this.clazz, this.methodName);
+    const hosts = MethodInfoUtil.getMethodHosts(this.clazz, this.methodName);
     const realPath = parentPath
       ? path.posix.join(parentPath, httpPath)
       : httpPath;
     const paramTypeMap = this.buildParamType(realPath);
     const priority = this.getPriority();
     return new HTTPMethodMeta(
-      this.methodName, httpPath!, httpMethod!, middlewares, contextIndex, paramTypeMap, priority, needAcl, aclCode, host);
+      this.methodName, httpPath!, httpMethod!, middlewares, contextIndex, paramTypeMap, priority, needAcl, aclCode, hosts);
   }
 }
diff --git a/core/controller-decorator/src/model/HTTPControllerMeta.ts b/core/controller-decorator/src/model/HTTPControllerMeta.ts
@@ -14,7 +14,7 @@ export class HTTPControllerMeta implements ControllerMetadata {
   public readonly methods: readonly HTTPMethodMeta[];
   public readonly needAcl: boolean;
   public readonly aclCode?: string;
-  public readonly host?: string;
+  public readonly hosts?: string[];
 
   constructor(
     className: string,
@@ -25,7 +25,7 @@ export class HTTPControllerMeta implements ControllerMetadata {
     methods: HTTPMethodMeta[],
     needAcl: boolean,
     aclCode: string | undefined,
-    host: string | undefined,
+    hosts: string[] | undefined,
   ) {
     this.protoName = protoName;
     this.controllerName = controllerName;
@@ -35,7 +35,7 @@ export class HTTPControllerMeta implements ControllerMetadata {
     this.methods = methods;
     this.needAcl = needAcl;
     this.aclCode = aclCode;
-    this.host = host;
+    this.hosts = hosts;
   }
 
   getMethodRealPath(method: HTTPMethodMeta) {
@@ -45,11 +45,11 @@ export class HTTPControllerMeta implements ControllerMetadata {
     return method.path;
   }
 
-  getMethodHost(method: HTTPMethodMeta): string | undefined {
-    if (this.host) {
-      return this.host;
+  getMethodHosts(method: HTTPMethodMeta): string[] | undefined {
+    if (this.hosts) {
+      return this.hosts;
     }
-    return method.host;
+    return method.hosts;
   }
 
   getMethodName(method: HTTPMethodMeta) {
diff --git a/core/controller-decorator/src/model/HTTPMethodMeta.ts b/core/controller-decorator/src/model/HTTPMethodMeta.ts
@@ -73,7 +73,7 @@ export class HTTPMethodMeta implements MethodMeta {
   public readonly priority: number;
   public readonly needAcL: boolean;
   public readonly aclCode: string | undefined;
-  public readonly host: string | undefined;
+  public readonly hosts: string[] | undefined;
 
   constructor(
     name: string,
@@ -85,7 +85,7 @@ export class HTTPMethodMeta implements MethodMeta {
     priority: number,
     needAcl: boolean,
     aclCode: string | undefined,
-    host: string | undefined,
+    hosts: string[] | undefined,
   ) {
     this.name = name;
     this.path = path;
@@ -96,7 +96,7 @@ export class HTTPMethodMeta implements MethodMeta {
     this.priority = priority;
     this.needAcL = needAcl;
     this.aclCode = aclCode;
-    this.host = host;
+    this.hosts = hosts;
   }
 }
 
diff --git a/core/controller-decorator/src/model/types.ts b/core/controller-decorator/src/model/types.ts
@@ -10,6 +10,8 @@ export enum ControllerType {
   MGW_RPC = 'MGW_RPC',
 }
 
+export type HostType = string | string [];
+
 export type ControllerTypeLike = ControllerType | string;
 
 export enum MethodType {
diff --git a/core/controller-decorator/src/util/ControllerInfoUtil.ts b/core/controller-decorator/src/util/ControllerInfoUtil.ts
@@ -45,11 +45,11 @@ export default class ControllerInfoUtil {
     return MetadataUtil.getMetaData(CONTROLLER_ACL, clazz);
   }
 
-  static addControllerHost(host: string, clazz: EggProtoImplClass) {
-    MetadataUtil.defineMetaData(CONTROLLER_HOST, host, clazz);
+  static addControllerHosts(hosts: string[], clazz: EggProtoImplClass) {
+    MetadataUtil.defineMetaData(CONTROLLER_HOST, hosts, clazz);
   }
 
-  static getControllerHost(clazz: EggProtoImplClass): string | undefined {
+  static getControllerHosts(clazz: EggProtoImplClass): string[] | undefined {
     return MetadataUtil.getMetaData(CONTROLLER_HOST, clazz);
   }
 }
diff --git a/core/controller-decorator/src/util/MethodInfoUtil.ts b/core/controller-decorator/src/util/MethodInfoUtil.ts
@@ -8,7 +8,7 @@ const METHOD_CONTEXT_INDEX = Symbol.for('EggPrototype#controller#method#context'
 const METHOD_MIDDLEWARES = Symbol.for('EggPrototype#method#middlewares');
 const METHOD_ACL = Symbol.for('EggPrototype#method#acl');
 
-type METHOD_MAP = Map<string, ControllerTypeLike>;
+type METHOD_MAP = Map<string, ControllerTypeLike | string[]>;
 type MethodContextIndexMap = Map<string, number>;
 type MethodMiddlewareMap = Map<string, MiddlewareFunc[]>;
 type MethodAclMap = Map<string, string | undefined>;
@@ -21,7 +21,7 @@ export default class MethodInfoUtil {
 
   static getMethodControllerType(clazz: EggProtoImplClass, methodName: string): ControllerTypeLike | undefined {
     const methodControllerMap: METHOD_MAP | undefined = MetadataUtil.getMetaData(METHOD_CONTROLLER_TYPE_MAP, clazz);
-    return methodControllerMap?.get(methodName);
+    return methodControllerMap?.get(methodName) as ControllerTypeLike | undefined;
   }
 
   static setMethodContextIndexInArgs(index: number, clazz: EggProtoImplClass, methodName: string) {
@@ -60,13 +60,13 @@ export default class MethodInfoUtil {
     return methodAclMap?.get(methodName);
   }
 
-  static setMethodHost(host: string, clazz: EggProtoImplClass, methodName: string) {
+  static setMethodHosts(hosts: string[], clazz: EggProtoImplClass, methodName: string) {
     const methodControllerMap: METHOD_MAP = MetadataUtil.initOwnMapMetaData(METHOD_CONTROLLER_HOST, clazz, new Map());
-    methodControllerMap.set(methodName, host);
+    methodControllerMap.set(methodName, hosts);
   }
 
-  static getMethodHost(clazz: EggProtoImplClass, methodName: string): string | undefined {
+  static getMethodHosts(clazz: EggProtoImplClass, methodName: string): string[] | undefined {
     const methodControllerMap: METHOD_MAP | undefined = MetadataUtil.getMetaData(METHOD_CONTROLLER_HOST, clazz);
-    return methodControllerMap?.get(methodName);
+    return methodControllerMap?.get(methodName) as string[] | undefined;
   }
 }
diff --git a/core/controller-decorator/test/Acl.test.ts b/core/controller-decorator/test/Acl.test.ts
@@ -1,7 +1,7 @@
 import assert from 'assert';
 import { AclController } from './fixtures/AclController';
 import { ControllerMetaBuilderFactory } from '../src/builder/ControllerMetaBuilderFactory';
-import { ControllerType } from '../src/model';
+import { ControllerType, HTTPControllerMeta } from '../src/model';
 
 describe('test/Context.test.ts', () => {
   it('should work', () => {
diff --git a/core/controller-decorator/test/http/Host.test.ts b/core/controller-decorator/test/http/Host.test.ts
@@ -5,12 +5,12 @@ import MethodInfoUtil from '../../src/util/MethodInfoUtil';
 
 describe('test/Host.test.ts', () => {
   it('controller Host work', () => {
-    const controllerHost = ControllerInfoUtil.getControllerHost(HostController);
-    assert(controllerHost === 'foo.eggjs.com');
+    const controllerHost = ControllerInfoUtil.getControllerHosts(HostController);
+    assert(controllerHost![0] === 'foo.eggjs.com');
   });
 
   it('method Host work', () => {
-    const methodHost = MethodInfoUtil.getMethodHost(HostController, 'bar');
-    assert(methodHost === 'bar.eggjs.com');
+    const methodHost = MethodInfoUtil.getMethodHosts(HostController, 'bar');
+    assert(methodHost![0] === 'bar.eggjs.com');
   });
 });
diff --git a/plugin/controller/lib/impl/http/HTTPMethodRegister.ts b/plugin/controller/lib/impl/http/HTTPMethodRegister.ts
@@ -118,18 +118,20 @@ export class HTTPMethodRegister {
 
     // 2. check duplicate with host tegg controller
     let hostRouter;
-    const host = this.controllerMeta.getMethodHost(this.methodMeta);
-    if (host) {
-      hostRouter = this.checkRouters.get(host);
-      if (!hostRouter) {
-        hostRouter = new EggRouter({ sensitive: true }, {});
-        this.checkRouters.set(host, hostRouter!);
+    const hosts = this.controllerMeta.getMethodHosts(this.methodMeta) || [];
+    hosts.forEach(h => {
+      if (h) {
+        hostRouter = this.checkRouters.get(h);
+        if (!hostRouter) {
+          hostRouter = new EggRouter({ sensitive: true }, {});
+          this.checkRouters.set(h, hostRouter!);
+        }
       }
-    }
-    if (hostRouter) {
-      this.checkDuplicateInRouter(hostRouter);
-      this.registerToRouter(hostRouter);
-    }
+      if (hostRouter) {
+        this.checkDuplicateInRouter(hostRouter);
+        this.registerToRouter(hostRouter);
+      }
+    });
   }
 
   private registerToRouter(router: KoaRouter<any, Context>) {
@@ -159,19 +161,20 @@ export class HTTPMethodRegister {
     if (aclMiddleware) {
       methodMiddlewares.push(aclMiddleware);
     }
-    const host = this.controllerMeta.getMethodHost(this.methodMeta);
-    const handler = this.createHandler(this.methodMeta, host);
-    Reflect.apply(routerFunc, this.router,
-      [ methodName, methodRealPath, ...methodMiddlewares, handler ]);
-
-    // https://github.com/eggjs/egg-core/blob/0af6178022e7734c4a8b17bb56d592b315207883/lib/egg.js#L279
-    const regExp = pathToRegexp(methodRealPath, {
-      sensitive: true,
+    const hosts = this.controllerMeta.getMethodHosts(this.methodMeta) || [ undefined ];
+    hosts.forEach(h => {
+      const handler = this.createHandler(this.methodMeta, h);
+      Reflect.apply(routerFunc, this.router,
+        [ methodName, methodRealPath, ...methodMiddlewares, handler ]);
+      // https://github.com/eggjs/egg-core/blob/0af6178022e7734c4a8b17bb56d592b315207883/lib/egg.js#L279
+      const regExp = pathToRegexp(methodRealPath, {
+        sensitive: true,
+      });
+      rootProtoManager.registerRootProto(this.methodMeta.method, (ctx: EggContext) => {
+        if (regExp.test(ctx.path)) {
+          return this.proto;
+        }
+      }, h || '');
     });
-    rootProtoManager.registerRootProto(this.methodMeta.method, (ctx: EggContext) => {
-      if (regExp.test(ctx.path)) {
-        return this.proto;
-      }
-    }, host || '');
   }
 }
diff --git a/plugin/controller/test/fixtures/apps/host-controller-app/app/controller/AppController2.ts b/plugin/controller/test/fixtures/apps/host-controller-app/app/controller/AppController2.ts
@@ -5,7 +5,6 @@ import {
   Host,
 } from '@eggjs/tegg';
 
-@Host('bar.eggjs.com')
 @HTTPController({
   path: '/apps',
 })
@@ -14,6 +13,7 @@ export class AppController2 {
     method: HTTPMethodEnum.GET,
     path: '/:id',
   })
+  @Host('bar.eggjs.com')
   async get() {
     return 'bar';
   }
diff --git a/plugin/controller/test/fixtures/apps/host-controller-app/app/controller/MultiHostController.ts b/plugin/controller/test/fixtures/apps/host-controller-app/app/controller/MultiHostController.ts
@@ -0,0 +1,29 @@
+import {
+  HTTPController,
+  HTTPMethod,
+  HTTPMethodEnum,
+  Host,
+} from '@eggjs/tegg';
+
+@Host([ 'apple.eggjs.com', 'a.eggjs.com' ])
+@HTTPController({
+  controllerName: 'MultiHostController',
+  path: '/apps',
+})
+export class MultiHostController {
+  @HTTPMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/apple',
+  })
+  async apple() {
+    return 'apple';
+  }
+
+  @HTTPMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/a',
+  })
+  async a() {
+    return 'a';
+  }
+}
diff --git a/plugin/controller/test/fixtures/apps/host-controller-app/app/controller/MultiMethodHostController.ts b/plugin/controller/test/fixtures/apps/host-controller-app/app/controller/MultiMethodHostController.ts
@@ -0,0 +1,30 @@
+import {
+  HTTPController,
+  HTTPMethod,
+  HTTPMethodEnum,
+  Host,
+} from '@eggjs/tegg';
+
+@HTTPController({
+  controllerName: 'MultiMethodHostController',
+  path: '/apps',
+})
+export class MultiMethodHostController {
+  @HTTPMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/orange',
+  })
+  @Host([ 'orange.eggjs.com', 'o.eggjs.com' ])
+  async orange() {
+    return 'orange';
+  }
+
+  @HTTPMethod({
+    method: HTTPMethodEnum.GET,
+    path: '/juice',
+  })
+  @Host('juice.eggjs.com')
+  async juice() {
+    return 'juice';
+  }
+}
diff --git a/plugin/controller/test/http/host.test.ts b/plugin/controller/test/http/host.test.ts

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ export enum ControllerType {`
`10`	`10`	`MGW_RPC = 'MGW_RPC',`
`11`	`11`	`}`
`12`	`12`
	`13`	`+export type HostType = string \| string [];`
	`14`	`+`
`13`	`15`	`export type ControllerTypeLike = ControllerType \| string;`
`14`	`16`
`15`	`17`	`export enum MethodType {`
Original file line number	Diff line number	Diff line change
`@@ -45,11 +45,11 @@ export default class ControllerInfoUtil {`
`45`	`45`	`return MetadataUtil.getMetaData(CONTROLLER_ACL, clazz);`
`46`	`46`	`}`
`47`	`47`
`48`		`- static addControllerHost(host: string, clazz: EggProtoImplClass) {`
`49`		`- MetadataUtil.defineMetaData(CONTROLLER_HOST, host, clazz);`
	`48`	`+ static addControllerHosts(hosts: string[], clazz: EggProtoImplClass) {`
	`49`	`+ MetadataUtil.defineMetaData(CONTROLLER_HOST, hosts, clazz);`
`50`	`50`	`}`
`51`	`51`
`52`		`- static getControllerHost(clazz: EggProtoImplClass): string \| undefined {`
	`52`	`+ static getControllerHosts(clazz: EggProtoImplClass): string[] \| undefined {`
`53`	`53`	`return MetadataUtil.getMetaData(CONTROLLER_HOST, clazz);`
`54`	`54`	`}`
`55`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ const METHOD_CONTEXT_INDEX = Symbol.for('EggPrototype#controller#method#context'`
`8`	`8`	`const METHOD_MIDDLEWARES = Symbol.for('EggPrototype#method#middlewares');`
`9`	`9`	`const METHOD_ACL = Symbol.for('EggPrototype#method#acl');`
`10`	`10`
`11`		`-type METHOD_MAP = Map<string, ControllerTypeLike>;`
	`11`	`+type METHOD_MAP = Map<string, ControllerTypeLike \| string[]>;`
`12`	`12`	`type MethodContextIndexMap = Map<string, number>;`
`13`	`13`	`type MethodMiddlewareMap = Map<string, MiddlewareFunc[]>;`
`14`	`14`	`type MethodAclMap = Map<string, string \| undefined>;`
`@@ -21,7 +21,7 @@ export default class MethodInfoUtil {`
`21`	`21`
`22`	`22`	`static getMethodControllerType(clazz: EggProtoImplClass, methodName: string): ControllerTypeLike \| undefined {`
`23`	`23`	`const methodControllerMap: METHOD_MAP \| undefined = MetadataUtil.getMetaData(METHOD_CONTROLLER_TYPE_MAP, clazz);`
`24`		`- return methodControllerMap?.get(methodName);`
	`24`	`+ return methodControllerMap?.get(methodName) as ControllerTypeLike \| undefined;`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`static setMethodContextIndexInArgs(index: number, clazz: EggProtoImplClass, methodName: string) {`
`@@ -60,13 +60,13 @@ export default class MethodInfoUtil {`
`60`	`60`	`return methodAclMap?.get(methodName);`
`61`	`61`	`}`
`62`	`62`
`63`		`- static setMethodHost(host: string, clazz: EggProtoImplClass, methodName: string) {`
	`63`	`+ static setMethodHosts(hosts: string[], clazz: EggProtoImplClass, methodName: string) {`
`64`	`64`	`const methodControllerMap: METHOD_MAP = MetadataUtil.initOwnMapMetaData(METHOD_CONTROLLER_HOST, clazz, new Map());`
`65`		`- methodControllerMap.set(methodName, host);`
	`65`	`+ methodControllerMap.set(methodName, hosts);`
`66`	`66`	`}`
`67`	`67`
`68`		`- static getMethodHost(clazz: EggProtoImplClass, methodName: string): string \| undefined {`
	`68`	`+ static getMethodHosts(clazz: EggProtoImplClass, methodName: string): string[] \| undefined {`
`69`	`69`	`const methodControllerMap: METHOD_MAP \| undefined = MetadataUtil.getMetaData(METHOD_CONTROLLER_HOST, clazz);`
`70`		`- return methodControllerMap?.get(methodName);`
	`70`	`+ return methodControllerMap?.get(methodName) as string[] \| undefined;`
`71`	`71`	`}`
`72`	`72`	`}`