feat: tegg plugin support ModuleConfig (#162)

killagu · web-flow · commit 58bd9fafdd0d · 2023-11-02T23:02:36.000+08:00
diff --git a/.gitignore b/.gitignore
@@ -28,6 +28,7 @@ plugin/**/dist
 plugin/oneapi/test/fixtures/modules/*/oneapi
 plugin/dal/test/fixtures/modules/*/dal/
 
+plugin/tegg/test/fixtures/apps/**/*.js
 !core/common-util/test/fixtures/**/node_modules
 !core/common-util/test/fixtures/**/node_modules/**/*.js
 !plugin/*/test/fixtures/**/*.js
@@ -37,6 +38,5 @@ plugin/dal/test/fixtures/modules/*/dal/
 !core/eventbus-decorator/src/type.d.ts
 !plugin/orm/test/fixtures/prepare.js
 !benchmark/**/*.js
-plugin/tegg/test/fixtures/apps/**/*.js
 !standalone/standalone/test/fixtures/**/node_modules
 !standalone/standalone/test/fixtures/**/node_modules/**/*.js
diff --git a/core/common-util/index.ts b/core/common-util/index.ts
@@ -6,5 +6,6 @@ export * from './src/FSUtil';
 export * from './src/StackUtil';
 export * from './src/ProxyUtil';
 export * from './src/ModuleConfig';
+export * from './src/ModuleConfigs';
 export * from './src/TimerUtil';
 export * from './src/RuntimeConfig';
diff --git a/core/common-util/src/ModuleConfigs.ts b/core/common-util/src/ModuleConfigs.ts
@@ -1,5 +1,4 @@
-import { ModuleConfig } from 'egg';
-import { ModuleReference } from '@eggjs/tegg-common-util';
+import { ModuleConfig, ModuleReference } from './ModuleConfig';
 
 export interface ModuleConfigHolder {
   name: string;
diff --git a/core/core-decorator/index.ts b/core/core-decorator/index.ts
@@ -6,6 +6,7 @@ export * from './src/decorator/ContextProto';
 export * from './src/decorator/SingletonProto';
 export * from './src/decorator/EggQualifier';
 export * from './src/decorator/MultiInstanceProto';
+export * from './src/decorator/ConfigSource';
 
 export * from './src/enum/AccessLevel';
 export * from './src/enum/ObjectInitType';
diff --git a/core/core-decorator/src/decorator/ConfigSource.ts b/core/core-decorator/src/decorator/ConfigSource.ts
@@ -1,4 +1,5 @@
-import { QualifierUtil, EggProtoImplClass } from '@eggjs/tegg';
+import { QualifierUtil } from '../util/QualifierUtil';
+import { EggProtoImplClass } from '../model/EggPrototypeInfo';
 
 export const ConfigSourceQualifierAttribute = Symbol.for('Qualifier.ConfigSource');
 
diff --git a/core/tegg/index.ts b/core/tegg/index.ts
@@ -7,4 +7,4 @@ export * from '@eggjs/tegg-background-task';
 export * as aop from '@eggjs/aop-decorator';
 export * as orm from '@eggjs/tegg-orm-decorator';
 export * as schedule from '@eggjs/tegg-schedule-decorator';
-export { RuntimeConfig } from '@eggjs/tegg-common-util';
+export { RuntimeConfig, ModuleConfigs, ModuleConfigHolder } from '@eggjs/tegg-common-util';
diff --git a/plugin/tegg/app.ts b/plugin/tegg/app.ts
@@ -9,13 +9,15 @@ import { EggContextHandler } from './lib/EggContextHandler';
 import { hijackRunInBackground } from './lib/run_in_background';
 import { EggQualifierProtoHook } from './lib/EggQualifierProtoHook';
 import { LoadUnitMultiInstanceProtoHook } from '@eggjs/tegg-metadata';
+import { ConfigSourceLoadUnitHook } from './lib/ConfigSourceLoadUnitHook';
 
 export default class App {
   private readonly app: Application;
   private compatibleHook?: EggContextCompatibleHook;
   private eggContextHandler: EggContextHandler;
   private eggQualifierProtoHook: EggQualifierProtoHook;
   private loadUnitMultiInstanceProtoHook: LoadUnitMultiInstanceProtoHook;
+  private configSourceEggPrototypeHook: ConfigSourceLoadUnitHook;
 
   constructor(app: Application) {
     this.app = app;
@@ -40,6 +42,10 @@ export default class App {
     // wait all file loaded, so app/ctx has all properties
     this.eggQualifierProtoHook = new EggQualifierProtoHook(this.app);
     this.app.loadUnitLifecycleUtil.registerLifecycle(this.eggQualifierProtoHook);
+
+    this.configSourceEggPrototypeHook = new ConfigSourceLoadUnitHook();
+    this.app.loadUnitLifecycleUtil.registerLifecycle(this.configSourceEggPrototypeHook);
+
     // start load tegg objects
     await this.app.moduleHandler.init();
     this.compatibleHook = new EggContextCompatibleHook(this.app.moduleHandler);
@@ -55,5 +61,8 @@ export default class App {
     if (this.eggQualifierProtoHook) {
       this.app.loadUnitLifecycleUtil.deleteLifecycle(this.eggQualifierProtoHook);
     }
+    if (this.configSourceEggPrototypeHook) {
+      this.app.loadUnitLifecycleUtil.deleteLifecycle(this.configSourceEggPrototypeHook);
+    }
   }
 }
diff --git a/plugin/tegg/lib/ConfigSourceLoadUnitHook.ts b/plugin/tegg/lib/ConfigSourceLoadUnitHook.ts
@@ -0,0 +1,27 @@
+import { LoadUnit, LoadUnitLifecycleContext } from '@eggjs/tegg-metadata';
+import {
+  LifecycleHook,
+  PrototypeUtil,
+  QualifierUtil,
+  ConfigSourceQualifier,
+  ConfigSourceQualifierAttribute,
+} from '@eggjs/tegg';
+
+/**
+ * Copy from standalone/src/ConfigSourceLoadUnitHook
+ * Hook for inject moduleConfig.
+ * Add default qualifier value is current module name.
+ */
+export class ConfigSourceLoadUnitHook implements LifecycleHook<LoadUnitLifecycleContext, LoadUnit> {
+  async preCreate(ctx: LoadUnitLifecycleContext, loadUnit: LoadUnit): Promise<void> {
+    const classList = ctx.loader.load();
+    for (const clazz of classList) {
+      const injectObjects = PrototypeUtil.getInjectObjects(clazz);
+      const moduleConfigObject = injectObjects.find(t => t.objName === 'moduleConfig');
+      const configSourceQualifier = QualifierUtil.getProperQualifier(clazz, 'moduleConfig', ConfigSourceQualifierAttribute);
+      if (moduleConfigObject && !configSourceQualifier) {
+        ConfigSourceQualifier(loadUnit.name)(clazz.prototype, moduleConfigObject.refName);
+      }
+    }
+  }
+}
diff --git a/plugin/tegg/lib/EggAppLoader.ts b/plugin/tegg/lib/EggAppLoader.ts
@@ -15,8 +15,12 @@ import { ObjectUtils } from '@eggjs/tegg-common-util';
 import { COMPATIBLE_PROTO_IMPLE_TYPE } from './EggCompatibleProtoImpl';
 import { BackgroundTaskHelper } from '@eggjs/tegg-background-task';
 import { EggObjectFactory } from '@eggjs/tegg-dynamic-inject-runtime';
+import { ModuleConfigLoader } from './ModuleConfigLoader';
 
-export const APP_CLAZZ_BLACK_LIST = [ 'eggObjectFactory' ];
+export const APP_CLAZZ_BLACK_LIST = [
+  'eggObjectFactory',
+  'moduleConfigs',
+];
 
 export const CONTEXT_CLAZZ_BLACK_LIST = [
   // just use the app.logger, ctx logger is deprecated.
@@ -29,9 +33,11 @@ export const DEFAULT_CONTEXT_CLAZZ = [
 
 export class EggAppLoader implements Loader {
   private readonly app: Application;
+  private readonly moduleConfigLoader: ModuleConfigLoader;
 
   constructor(app) {
     this.app = app;
+    this.moduleConfigLoader = new ModuleConfigLoader(this.app);
   }
 
   private buildClazz(name: string, eggType: EggType): EggProtoImplClass {
@@ -124,11 +130,13 @@ export class EggAppLoader implements Loader {
     const allSingletonClazzs = allSingletonClazzNames.map(name => this.buildClazz(name, EggType.APP));
     const allContextClazzs = allContextClazzNames.map(name => this.buildClazz(name, EggType.CONTEXT));
     const appLoggerClazzs = loggerNames.map(name => this.buildAppLoggerClazz(name));
+    const moduleConfigList = this.moduleConfigLoader.loadModuleConfigList();
 
     return [
       ...allSingletonClazzs,
       ...allContextClazzs,
       ...appLoggerClazzs,
+      ...moduleConfigList,
 
       // inner helper class list
       // TODO: should auto the inner class
diff --git a/plugin/tegg/lib/ModuleConfigLoader.ts b/plugin/tegg/lib/ModuleConfigLoader.ts
@@ -0,0 +1,90 @@
+import {
+  AccessLevel,
+  EggProtoImplClass,
+  EggQualifierAttribute,
+  EggType,
+  InitTypeQualifierAttribute,
+  LoadUnitNameQualifierAttribute, ModuleConfigs,
+  ObjectInitType,
+  PrototypeUtil,
+  QualifierUtil,
+  ModuleConfigHolder, ConfigSourceQualifierAttribute,
+} from '@eggjs/tegg';
+import { ModuleConfigUtil } from '@eggjs/tegg/helper';
+import { COMPATIBLE_PROTO_IMPLE_TYPE } from './EggCompatibleProtoImpl';
+import { Application } from 'egg';
+
+export class ModuleConfigLoader {
+  constructor(readonly app: Application) {
+  }
+
+  private loadModuleConfigs(moduleConfigMap: Record<string, ModuleConfigHolder>): EggProtoImplClass {
+    const moduleConfigs = new ModuleConfigs(moduleConfigMap);
+    const func: EggProtoImplClass = function() {
+      return moduleConfigs;
+    } as any;
+    const name = 'moduleConfigs';
+    Object.defineProperty(func, 'name', {
+      value: name,
+      writable: false,
+      enumerable: false,
+      configurable: true,
+    });
+    PrototypeUtil.setIsEggPrototype(func);
+    PrototypeUtil.setFilePath(func, 'mock_file_path');
+    PrototypeUtil.setProperty(func, {
+      name,
+      initType: ObjectInitType.SINGLETON,
+      accessLevel: AccessLevel.PUBLIC,
+      protoImplType: COMPATIBLE_PROTO_IMPLE_TYPE,
+    });
+    QualifierUtil.addProtoQualifier(func, LoadUnitNameQualifierAttribute, 'app');
+    QualifierUtil.addProtoQualifier(func, InitTypeQualifierAttribute, ObjectInitType.SINGLETON);
+    QualifierUtil.addProtoQualifier(func, EggQualifierAttribute, EggType.APP);
+    return func;
+  }
+
+  loadModuleConfigList(): EggProtoImplClass[] {
+    const result: EggProtoImplClass[] = [];
+    const moduleConfigMap: Record<string, ModuleConfigHolder> = {};
+    for (const reference of this.app.moduleReferences) {
+      const moduleName = ModuleConfigUtil.readModuleNameSync(reference.path);
+      const config = ModuleConfigUtil.loadModuleConfigSync(reference.path, undefined, this.app.config.env) || {};
+      moduleConfigMap[moduleName] = {
+        name: moduleName,
+        reference: {
+          name: moduleName,
+          path: reference.path,
+        },
+        config,
+      };
+
+      const func: EggProtoImplClass = function() {
+        return config;
+      } as any;
+      const name = 'moduleConfig';
+      Object.defineProperty(func, 'name', {
+        value: name,
+        writable: false,
+        enumerable: false,
+        configurable: true,
+      });
+      PrototypeUtil.setIsEggPrototype(func);
+      PrototypeUtil.setFilePath(func, 'mock_file_path');
+      PrototypeUtil.setProperty(func, {
+        name,
+        initType: ObjectInitType.SINGLETON,
+        accessLevel: AccessLevel.PUBLIC,
+        protoImplType: COMPATIBLE_PROTO_IMPLE_TYPE,
+      });
+      QualifierUtil.addProtoQualifier(func, LoadUnitNameQualifierAttribute, 'app');
+      QualifierUtil.addProtoQualifier(func, InitTypeQualifierAttribute, ObjectInitType.SINGLETON);
+      QualifierUtil.addProtoQualifier(func, EggQualifierAttribute, EggType.APP);
+      QualifierUtil.addProtoQualifier(func, ConfigSourceQualifierAttribute, moduleName);
+      result.push(func);
+    }
+    const moduleConfigs = this.loadModuleConfigs(moduleConfigMap);
+    result.push(moduleConfigs);
+    return result;
+  }
+}
diff --git a/plugin/tegg/test/ModuleConfig.test.ts b/plugin/tegg/test/ModuleConfig.test.ts
@@ -0,0 +1,40 @@
+import mm from 'egg-mock';
+import assert from 'assert';
+import path from 'path';
+
+describe('test/ModuleConfig.test.ts', () => {
+  let app;
+  const fixtureDir = path.join(__dirname, 'fixtures/apps/inject-module-config');
+
+  after(async () => {
+    await app.close();
+  });
+
+  afterEach(() => {
+    mm.restore();
+  });
+
+  before(async () => {
+    mm(process.env, 'EGG_TYPESCRIPT', true);
+    mm(process, 'cwd', () => {
+      return path.join(__dirname, '..');
+    });
+    app = mm.app({
+      baseDir: fixtureDir,
+      framework: require.resolve('egg'),
+    });
+    await app.ready();
+  });
+
+  it('should work', async () => {
+    await app.httpRequest()
+      .get('/config')
+      .expect(200)
+      .expect(res => {
+        assert.deepStrictEqual(res.body, {
+          moduleConfigs: { features: { dynamic: { foo: 'bar', bar: 'foo' } } },
+          moduleConfig: { features: { dynamic: { foo: 'bar', bar: 'foo' } } },
+        });
+      });
+  });
+});
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/app/controller/app.ts b/plugin/tegg/test/fixtures/apps/inject-module-config/app/controller/app.ts
@@ -0,0 +1,8 @@
+import { Controller } from 'egg';
+
+export default class App extends Controller {
+  async baseDir() {
+    const configs = await this.ctx.module.simple.foo.getConfig();
+    this.ctx.body = configs;
+  }
+}
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/app/extend/application.unittest.ts b/plugin/tegg/test/fixtures/apps/inject-module-config/app/extend/application.unittest.ts
@@ -0,0 +1,11 @@
+import { MockApplication } from 'egg-mock';
+
+export default {
+  mockUser(this: MockApplication) {
+    this.mockContext({
+      user: {
+        userName: 'mock_user',
+      },
+    });
+  },
+};
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/app/extend/context.ts b/plugin/tegg/test/fixtures/apps/inject-module-config/app/extend/context.ts
@@ -0,0 +1,14 @@
+const COUNTER = Symbol('Context#counter');
+
+export default {
+  get counter() {
+    if (!this[COUNTER]) {
+      this[COUNTER] = 0;
+    }
+    return this[COUNTER]++;
+  },
+
+  get user() {
+    return {};
+  },
+};
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/app/router.ts b/plugin/tegg/test/fixtures/apps/inject-module-config/app/router.ts
@@ -0,0 +1,5 @@
+import { Application } from 'egg';
+
+module.exports = (app: Application) => {
+  app.router.get('/config', app.controller.app.baseDir);
+};
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/app/typings/index.d.ts b/plugin/tegg/test/fixtures/apps/inject-module-config/app/typings/index.d.ts
@@ -0,0 +1,10 @@
+import 'egg';
+import { Foo } from '../../modules/module-with-config/foo';
+
+declare module 'egg' {
+  export interface EggModule {
+    simple: {
+      foo: Foo;
+    }
+  }
+}
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/config/config.default.js b/plugin/tegg/test/fixtures/apps/inject-module-config/config/config.default.js
@@ -0,0 +1,20 @@
+'use strict';
+
+const path = require('path');
+
+module.exports = function(appInfo) {
+  const config = {
+    keys: 'test key',
+    customLogger: {
+      xxLogger: {
+        file: path.join(appInfo.root, 'logs/xx.log'),
+      },
+    },
+    security: {
+      csrf: {
+        ignoreJSON: false,
+      }
+    },
+  };
+  return config;
+};
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/config/plugin.js b/plugin/tegg/test/fixtures/apps/inject-module-config/config/plugin.js
@@ -0,0 +1,13 @@
+'use strict';
+
+exports.tracer = {
+  package: 'egg-tracer',
+  enable: true,
+};
+
+exports.teggConfig = {
+  package: '@eggjs/tegg-config',
+  enable: true,
+};
+
+exports.watcher = false;
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/foo.ts b/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/foo.ts
@@ -0,0 +1,19 @@
+import { AccessLevel, ContextProto, Inject, ModuleConfigs } from '@eggjs/tegg';
+
+@ContextProto({
+  accessLevel: AccessLevel.PUBLIC,
+})
+export class Foo {
+  @Inject()
+  moduleConfigs: ModuleConfigs;
+
+  @Inject()
+  moduleConfig: Record<string, any>;
+
+  async getConfig(): Promise<object> {
+    return {
+      moduleConfigs: this.moduleConfigs.get('simple'),
+      moduleConfig: this.moduleConfig,
+    };
+  }
+}
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/module.unittest.yml b/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/module.unittest.yml
@@ -0,0 +1,3 @@
+features:
+  dynamic:
+    bar: 'foo'
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/module.yml b/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/module.yml
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/package.json b/plugin/tegg/test/fixtures/apps/inject-module-config/modules/module-with-config/package.json
diff --git a/plugin/tegg/test/fixtures/apps/inject-module-config/package.json b/plugin/tegg/test/fixtures/apps/inject-module-config/package.json
diff --git a/standalone/standalone/src/ConfigSourceLoadUnitHook.ts b/standalone/standalone/src/ConfigSourceLoadUnitHook.ts
diff --git a/standalone/standalone/src/Runner.ts b/standalone/standalone/src/Runner.ts
diff --git a/standalone/standalone/test/fixtures/dependency/foo.ts b/standalone/standalone/test/fixtures/dependency/foo.ts
diff --git a/standalone/standalone/test/fixtures/module-with-config/foo.ts b/standalone/standalone/test/fixtures/module-with-config/foo.ts
diff --git a/standalone/standalone/test/fixtures/module-with-env-config/foo.ts b/standalone/standalone/test/fixtures/module-with-env-config/foo.ts
diff --git a/standalone/standalone/test/fixtures/multi-modules/foo/foo.ts b/standalone/standalone/test/fixtures/multi-modules/foo/foo.ts
diff --git a/standalone/standalone/test/index.test.ts b/standalone/standalone/test/index.test.ts
