fix: faas missing config in framework (#1413)

midwayjs · Dec 9, 2021 · 7ab16a2 · 7ab16a2
1 parent bfafbdf
commit 7ab16a2
Show file tree

Hide file tree

Showing 14 changed files with 152 additions and 18 deletions.
diff --git a/packages-serverless/egg-layer/index.js b/packages-serverless/egg-layer/index.js
@@ -30,9 +30,11 @@ module.exports = engine => {
         try {
           const bootstrap = require(join(baseDir, 'bootstrap'));
           eggApp = await bootstrap({
-            globalConfig: {
-              default: require('./framework/config/config.default'),
-            },
+            globalConfig: [
+              {
+                default: require('./framework/config/config.default'),
+              },
+            ],
           });
         } catch (e) {
           console.error(e);

diff --git a/packages-serverless/serverless-worker-starter/package.json b/packages-serverless/serverless-worker-starter/package.json
@@ -13,7 +13,8 @@
     "@midwayjs/decorator": "^3.0.0-beta.8",
     "@midwayjs/jest-environment-service-worker": "^0.0.1-alpha.5",
     "@midwayjs/jsdom-service-worker": "^0.0.1-alpha.5",
-    "@midwayjs/runtime-mock": "^3.0.0-beta.8"
+    "@midwayjs/runtime-mock": "^3.0.0-beta.8",
+    "@midwayjs/logger": "^3.0.0-beta.8"
   },
   "engines": {
     "node": ">=12"

diff --git a/packages-serverless/serverless-worker-starter/src/runtime.ts b/packages-serverless/serverless-worker-starter/src/runtime.ts
@@ -2,6 +2,11 @@ import { ServerlessLightRuntime } from '@midwayjs/runtime-engine';
 import { Application, HTTPResponse } from '@midwayjs/serverless-http-parser';
 import { types } from 'util';
 import { HTTPRequest } from './http-request';
+import { loggers } from '@midwayjs/logger';
+
+loggers.addLogger('coreLogger', console);
+loggers.addLogger('appLogger', console);
+loggers.addLogger('logger', console);
 
 const { isAnyArrayBuffer, isArrayBufferView } = types;
 

diff --git a/packages/core/src/common/webRouterCollector.ts b/packages/core/src/common/webRouterCollector.ts
@@ -21,6 +21,7 @@ import { joinURLPath } from '../util';
 import { MidwayContainer } from '../context/container';
 import { DirectoryFileDetector } from './fileDetector';
 import * as util from 'util';
+import { MidwayCommonError } from '../error';
 
 const debug = util.debuglog('midway:debug');
 
@@ -200,6 +201,12 @@ export class WebRouterCollector {
       prefix = ignorePrefix;
     }
 
+    if (/\*/.test(prefix)) {
+      throw new MidwayCommonError(
+        `Router prefix ${prefix} can't set string with *`
+      );
+    }
+
     // set prefix
     if (!this.routes.has(prefix)) {
       this.routes.set(prefix, []);

diff --git a/packages/core/src/context/container.ts b/packages/core/src/context/container.ts
@@ -102,9 +102,17 @@ class ContainerConfiguration {
     });
   }
 
-  addImportConfigs(importConfigs: string[]) {
-    if (importConfigs && importConfigs.length) {
-      this.container.get(MidwayConfigService).add(importConfigs);
+  addImportConfigs(
+    importConfigs:
+      | Array<{ [environmentName: string]: Record<string, any> }>
+      | Record<string, any>
+  ) {
+    if (importConfigs) {
+      if (Array.isArray(importConfigs)) {
+        this.container.get(MidwayConfigService).add(importConfigs);
+      } else {
+        this.container.get(MidwayConfigService).addObject(importConfigs);
+      }
     }
   }
 

diff --git a/packages/core/src/interface.ts b/packages/core/src/interface.ts
@@ -487,9 +487,7 @@ export interface IMidwayBootstrapOptions {
   moduleDetector?: 'file' | IFileDetector | false;
   logger?: boolean | ILogger;
   ignore?: string[];
-  globalConfig?: {
-    [environmentName: string]: Record<string, any>;
-  }
+  globalConfig?: Array<{[environmentName: string]: Record<string, any>;}> | Record<string, any>;
 }
 
 export interface IConfigurationOptions {

diff --git a/packages/core/src/setup.ts b/packages/core/src/setup.ts
@@ -108,7 +108,11 @@ export async function initializeGlobalApplicationContext(
   await applicationContext.ready();
 
   if (globalOptions.globalConfig) {
-    configService.add([globalOptions.globalConfig]);
+    if (Array.isArray(globalOptions.globalConfig)) {
+      configService.add(globalOptions.globalConfig);
+    } else {
+      configService.addObject(globalOptions.globalConfig);
+    }
   }
 
   // merge config

diff --git a/packages/core/test/baseFramework.test.ts b/packages/core/test/baseFramework.test.ts
@@ -670,4 +670,15 @@ describe('/test/baseFramework.test.ts', () => {
     expect(await composeMiddleware({})).toEqual('hello world gogogo, zhangting');
   });
 
+  it('load object config in configuration', async () => {
+    mm(process.env, 'MIDWAY_SERVER_ENV', '');
+    const framework = await createLightFramework(path.join(
+      __dirname,
+      './fixtures/app-with-configuration-config-object/src'
+    ));
+
+    expect(framework.getConfiguration('bbb')).toEqual(222);
+    expect(framework.getConfiguration('ccc')).toEqual(333);
+  });
+
 });
diff --git a/packages/core/test/fixtures/app-with-configuration-config-object/package.json b/packages/core/test/fixtures/app-with-configuration-config-object/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "ali-demo"
+}
diff --git a/packages/core/test/fixtures/app-with-configuration-config-object/src/configuration.ts b/packages/core/test/fixtures/app-with-configuration-config-object/src/configuration.ts
@@ -0,0 +1,12 @@
+import { Configuration } from '@midwayjs/decorator';
+
+@Configuration({
+  importConfigs: {
+    bbb: 222,
+    ccc: 333,
+  },
+})
+class AutoConfiguration {
+}
+
+module.exports = AutoConfiguration;
diff --git a/packages/core/test/setup.test.ts b/packages/core/test/setup.test.ts
@@ -41,6 +41,84 @@ describe('/test/setup.test.ts', () => {
     await destroyGlobalApplicationContext(container);
   });
 
+  it('should test setup global config', async () => {
+    const baseDir = join(
+      __dirname,
+      './fixtures/base-app-config/src'
+    );
+    const container = await initializeGlobalApplicationContext({
+      baseDir,
+      configurationModule: [require(join(baseDir, 'configuration'))],
+      globalConfig: {
+        ccc: 222
+      }
+    });
+
+    const configService = await container.getAsync(MidwayConfigService);
+    const config = configService.getConfiguration();
+    expect(config).toHaveProperty('hello',
+      {
+        'a': 1,
+        'b': 4,
+        'c': 3,
+        'd': [
+          1,
+          2,
+          3
+        ]
+      });
+
+    expect(config).toHaveProperty('plugins',
+      {
+        'bucLogin': false
+      });
+
+    expect(config).toHaveProperty('ccc', 222);
+
+    await destroyGlobalApplicationContext(container);
+  });
+
+  it('should test setup global config with env', async () => {
+    const baseDir = join(
+      __dirname,
+      './fixtures/base-app-config/src'
+    );
+    const container = await initializeGlobalApplicationContext({
+      baseDir,
+      configurationModule: [require(join(baseDir, 'configuration'))],
+      globalConfig: [
+        {
+          default: {
+            ccc: 333
+          }
+        }
+      ]
+    });
+
+    const configService = await container.getAsync(MidwayConfigService);
+    const config = configService.getConfiguration();
+    expect(config).toHaveProperty('hello',
+      {
+        'a': 1,
+        'b': 4,
+        'c': 3,
+        'd': [
+          1,
+          2,
+          3
+        ]
+      });
+
+    expect(config).toHaveProperty('plugins',
+      {
+        'bucLogin': false
+      });
+
+    expect(config).toHaveProperty('ccc', 333);
+
+    await destroyGlobalApplicationContext(container);
+  });
+
   it('should test setup a framework and get from container', async () => {
     /**
      * 一个全量的空框架

diff --git a/packages/decorator/src/decorator/common/configuration.ts b/packages/decorator/src/decorator/common/configuration.ts
@@ -14,7 +14,9 @@ export interface ResolveFilter {
 export interface InjectionConfigurationOptions {
   imports?: Array<string | IComponentInfo | { Configuration: any }>;
   importObjects?: Record<string, unknown>;
-  importConfigs?: any[];
+  importConfigs?:
+    | Array<{ [environmentName: string]: Record<string, any> }>
+    | Record<string, any>;
   namespace?: string;
   directoryResolveFilter?: ResolveFilter[];
   conflictCheck?: boolean;

diff --git a/packages/faas/src/configuration.ts b/packages/faas/src/configuration.ts
@@ -69,6 +69,8 @@ export class FaaSConfiguration {
   async onReady(container) {}
 
   async onServerReady() {
-    await this.framework.run();
+    if (!this.framework.isEnable()) {
+      await this.framework.run();
+    }
   }
 }
diff --git a/packages/faas/src/framework.ts b/packages/faas/src/framework.ts
@@ -40,6 +40,7 @@ export class MidwayFaaSFramework extends BaseFramework<
   public app: IMidwayFaaSApplication;
   private isReplaceLogger =
     process.env['MIDWAY_SERVERLESS_REPLACE_LOGGER'] === 'true';
+  private developmentRun = false;
 
   @Inject()
   environmentService: MidwayEnvironmentService;
@@ -48,16 +49,16 @@ export class MidwayFaaSFramework extends BaseFramework<
   middlewareService: MidwayMiddlewareService<FaaSContext, any>;
 
   configure(options: IFaaSConfigurationOptions) {
-    const faasConfig = this.configService.getConfiguration('faas');
-    if (faasConfig) {
-      this.configurationOptions = faasConfig;
-    } else {
+    if (options) {
+      this.developmentRun = true;
       this.configurationOptions = options;
+    } else {
+      return this.configService.getConfiguration('faas');
     }
   }
 
   isEnable(): boolean {
-    return false;
+    return !this.developmentRun;
   }
 
   async applicationInitialize(options: IMidwayBootstrapOptions) {