feat: support importConfigs and add test case

packages/midway-core/package.json

@@ -24,7 +24,8 @@
   "license": "MIT",
   "devDependencies": {
     "chai": "^4.2.0",
-    "midway-bin": "^1.16.3"
+    "midway-bin": "^1.16.3",
+    "mm": "^2.5.0"
   },
   "dependencies": {
     "@midwayjs/decorator": "^1.16.3",

packages/midway-core/src/container.ts

@@ -353,6 +353,10 @@ export class MidwayContainer extends Container implements IMidwayContainer {
 
   async ready() {
     super.ready();
+    // register handler for container
+    this.registerDataHandler(MidwayHandlerKey.CONFIG, (key: string) => {
+      return this.configService.getConfiguration(key);
+    });
     // 加载配置
     await this.configService.load();
   }

packages/midway-core/src/interface.ts

@@ -20,7 +20,7 @@ export interface IConfigService {
   add(configFilePaths: string[]);
   addObject(obj: object);
   load();
-  getConfiguration();
+  getConfiguration(configKey?: string);
 }
 
 export interface IEnvironmentService {

packages/midway-core/src/service/configService.ts

@@ -2,6 +2,7 @@ import * as extend from 'extend2';
 import * as is from 'is-type-of';
 import { basename } from 'path';
 import { IConfigService, IMidwayContainer } from '../interface';
+import { safelyGet } from '../util';
 
 const debug = require('debug')('midway:config');
 
@@ -78,12 +79,12 @@ export class MidwayConfigService implements IConfigService {
       }
     }
     this.configuration = target;
+    this.isReady = true;
   }
 
-  async getConfiguration() {
-    if (!this.isReady) {
-      await this.load();
-      this.isReady = true;
+  getConfiguration(configKey) {
+    if (configKey) {
+      return safelyGet(configKey, this.configuration);
     }
     return this.configuration;
   }

packages/midway-core/src/service/environmentService.ts

@@ -5,7 +5,7 @@ export class MidwayEnvironmentService implements IEnvironmentService {
 
   getCurrentEnvironment() {
     if (!this.environment) {
-      this.environment = process['MIDWAY_SERVER_ENV'] || process['NODE_ENV'] || 'production';
+      this.environment = process.env['MIDWAY_SERVER_ENV'] || process.env['NODE_ENV'] || 'production';
     }
     return this.environment;
   }

packages/midway-core/src/util.ts

@@ -18,3 +18,34 @@ export const isPath = (p): boolean => {
   }
   return false;
 };
+
+/**
+ *  safelyGet(['a','b'],{a: {b: 2}})  // => 2
+ *  safelyGet(['a','b'],{c: {b: 2}})  // => undefined
+ *  safelyGet(['a','1'],{a: {"1": 2}})  // => 2
+ *  safelyGet(['a','1'],{a: {b: 2}})  // => undefined
+ *  safelyGet('a.b',{a: {b: 2}})  // => 2
+ *  safelyGet('a.b',{c: {b: 2}})  // => undefined
+ */
+export function safelyGet(list: string | string[], obj?: object): any {
+  if (arguments.length === 1) {
+    return (_obj: object) => safelyGet(list, _obj);
+  }
+
+  if (typeof obj === 'undefined' || typeof obj !== 'object' || obj === null) {
+    return void 0;
+  }
+  const pathArrValue = typeof list === 'string' ? list.split('.') : list;
+  let willReturn: any = obj;
+
+  for (const key of pathArrValue) {
+    if (typeof willReturn === 'undefined' || willReturn === null) {
+      return void 0;
+    } else if (typeof willReturn !== 'object') {
+      return void 0;
+    }
+    willReturn = willReturn[key];
+  }
+
+  return willReturn;
+}

packages/midway-core/test/fixtures/app-with-configuration/base-app-decorator/src/configuration.ts

@@ -1,6 +1,9 @@
 import { Configuration } from '@midwayjs/decorator';
 
 @Configuration({
-  imports: ['../../midway-plugin-mock/src'],
+  imports: [
+    '../../midway-plugin-mock/src',
+    '../../midway-plugin-ok/src'
+  ],
 })
 export class AutoConfiguraion {}

packages/midway-core/test/fixtures/app-with-configuration/midway-plugin-ok/src/articleManager.ts → packages/midway-core/test/fixtures/app-with-configuration/midway-plugin-mock/src/replaceManager.ts

@@ -1,8 +1,8 @@
 import { Provide } from '@midwayjs/decorator';
 
 @Provide()
-export class ArticleManager {
+export class ReplaceManager {
   async getOne() {
-    return 'ok';
+    return 'one article';
   }
 }

packages/midway-core/test/fixtures/app-with-configuration/midway-plugin-ok/src/config/config.default.ts

@@ -0,0 +1,5 @@
+export = {
+  ok: {
+    text: 'ok'
+  }
+};

packages/midway-core/test/fixtures/app-with-configuration/midway-plugin-ok/src/config/config.local.ts

@@ -0,0 +1,5 @@
+export = {
+  ok: {
+    text: 'ok1'
+  }
+};

packages/midway-core/test/fixtures/app-with-configuration/midway-plugin-ok/src/configuration.ts

@@ -1,6 +1,10 @@
 import { Configuration } from '@midwayjs/decorator';
 
 @Configuration({
-  namespace: 'ok'
+  namespace: 'ok',
+  importConfigs: [
+    './config/config.default',
+    './config/config.local'
+  ]
 })
 export class AutoConfiguraion {}

packages/midway-core/test/fixtures/app-with-configuration/midway-plugin-ok/src/replaceManager.ts

@@ -0,0 +1,12 @@
+import { Config, Provide } from '@midwayjs/decorator';
+
+@Provide()
+export class ReplaceManager {
+
+  @Config('ok.text')
+  config;
+
+  async getOne() {
+    return this.config;
+  }
+}

packages/midway-core/test/loader.test.ts

@@ -7,6 +7,7 @@ import {
 import * as assert from 'assert';
 import * as path from 'path';
 import { ContainerLoader, MidwayRequestContainer } from '../src';
+import * as mm from 'mm';
 
 @Provide()
 class TestModule {
@@ -194,4 +195,47 @@ describe('/test/loader.test.ts', () => {
     const baseService: any = await appCtx.getAsync('baseService');
     assert(await baseService.getInformation() === 'harry,one article');
   });
+
+  it('should load config.*.ts by default env', async () => {
+    const loader = new ContainerLoader({
+      baseDir: path.join(__dirname, './fixtures/app-with-configuration/base-app-decorator/src'),
+    });
+    loader.initialize();
+    loader.loadDirectory();
+    await loader.refresh();
+
+    const appCtx = loader.getApplicationContext();
+    const replaceManager: any = await appCtx.getAsync('replaceManager');
+    assert(await replaceManager.getOne() === 'ok');
+  });
+
+  it('should load config.*.ts by process.env', async () => {
+    mm(process.env, 'NODE_ENV', 'local');
+    const loader = new ContainerLoader({
+      baseDir: path.join(__dirname, './fixtures/app-with-configuration/base-app-decorator/src'),
+    });
+    loader.initialize();
+    loader.loadDirectory();
+    await loader.refresh();
+
+    const appCtx = loader.getApplicationContext();
+    const replaceManager: any = await appCtx.getAsync('replaceManager');
+    assert(await replaceManager.getOne() === 'ok1');
+    mm.restore();
+  });
+
+  it('should load config.*.ts by process.env MIDWAY_SERVER_ENV', async () => {
+    mm(process.env, 'MIDWAY_SERVER_ENV', 'local');
+    const loader = new ContainerLoader({
+      baseDir: path.join(__dirname, './fixtures/app-with-configuration/base-app-decorator/src'),
+    });
+    loader.initialize();
+    loader.loadDirectory();
+    await loader.refresh();
+
+    const appCtx = loader.getApplicationContext();
+    const replaceManager: any = await appCtx.getAsync('replaceManager');
+    assert(await replaceManager.getOne() === 'ok1');
+    mm.restore();
+  });
 });

packages/midway-web/src/loader/webLoader.ts

@@ -14,7 +14,7 @@ import * as fs from 'fs';
 import { ContainerLoader, MidwayContainer, MidwayHandlerKey, getClassMetadata, getPropertyDataFromClass, getProviderId, listModule } from '@midwayjs/core';
 import * as path from 'path';
 import { Middleware, MiddlewareParamArray, MidwayLoaderOptions, WebMiddleware } from '../interface';
-import { isTypeScriptEnvironment, safelyGet } from '../utils';
+import { isTypeScriptEnvironment } from '../utils';
 
 const debug = require('debug')(`midway:loader:${process.pid}`);
 const EggLoader = require('egg-core').EggLoader;
@@ -79,11 +79,6 @@ export class MidwayWebLoader extends EggLoader {
     // 如果没有关闭autoLoad 则进行load
     this.containerLoader.loadDirectory(containerConfig);
 
-    // register handler for container
-    this.containerLoader.registerHook(MidwayHandlerKey.CONFIG, (key: string) => {
-      return safelyGet(key, this.config);
-    });
-
     this.containerLoader.registerHook(MidwayHandlerKey.PLUGIN, (key: string) => {
       return this.app[key] || this.pluginContext.get(key);
     });

packages/midway-web/src/utils.ts

@@ -45,34 +45,3 @@ export function getMethodNames(obj: object): string[] {
 export function isTypeScriptEnvironment(): boolean {
   return !!require.extensions['.ts'] || process.env.MIDWAY_TS_MODE === 'true';
 }
-
-/**
- *  safelyGet(['a','b'],{a: {b: 2}})  // => 2
- *  safelyGet(['a','b'],{c: {b: 2}})  // => undefined
- *  safelyGet(['a','1'],{a: {"1": 2}})  // => 2
- *  safelyGet(['a','1'],{a: {b: 2}})  // => undefined
- *  safelyGet('a.b',{a: {b: 2}})  // => 2
- *  safelyGet('a.b',{c: {b: 2}})  // => undefined
- */
-export function safelyGet(list: string | string[], obj?: object): any {
-  if (arguments.length === 1) {
-    return (_obj: object) => safelyGet(list, _obj);
-  }
-
-  if (typeof obj === 'undefined' || typeof obj !== 'object' || obj === null) {
-    return void 0;
-  }
-  const pathArrValue = typeof list === 'string' ? list.split('.') : list;
-  let willReturn: any = obj;
-
-  for (const key of pathArrValue) {
-    if (typeof willReturn === 'undefined' || willReturn === null) {
-      return void 0;
-    } else if (typeof willReturn !== 'object') {
-      return void 0;
-    }
-    willReturn = willReturn[key];
-  }
-
-  return willReturn;
-}