fix: should call config hook in idle callback (#218)

* fix: should call confighook in idle callback * feat: add PULL_REQUEST_TEMPLATE.md * chore: remove pr template * fix: add didLoad event * fix: trigger loader with order * fix: compatitble for custom loader * fix: add config dir * chore: remove useless comment
artusjs · Dec 5, 2022 · 3b4deac · 3b4deac
1 parent 9f3b77c
commit 3b4deac
Show file tree

Hide file tree

Showing 7 changed files with 106 additions and 14 deletions.
diff --git a/src/loader/factory.ts b/src/loader/factory.ts
@@ -1,6 +1,6 @@
 import * as path from 'path';
 import { isInjectable, Container } from '@artus/injection';
-import { ArtusInjectEnum, DEFAULT_LOADER, HOOK_FILE_LOADER, LOADER_NAME_META, ScanPolicy } from '../constant';
+import { ArtusInjectEnum, DEFAULT_LOADER, HOOK_FILE_LOADER, LOADER_NAME_META, ScanPolicy, DEFAULT_LOADER_LIST_WITH_ORDER } from '../constant';
 import {
   Manifest,
   ManifestItem,
@@ -65,23 +65,31 @@ export class LoaderFactory {
   }
 
   async loadItemList(itemList: ManifestItem[] = [], root?: string): Promise<void> {
-    let prevLoader = '';
+    const itemMap = new Map(DEFAULT_LOADER_LIST_WITH_ORDER.map(loaderName => [loaderName, []]));
+
+    // group by loader names
     for (const item of itemList) {
       item.path = root ? path.join(root, item.path) : item.path;
-      const curLoader = item.loader ?? DEFAULT_LOADER;
-      if (item.loader !== prevLoader) {
-        if (prevLoader) {
-          await this.loaderEmitter.emitAfter(prevLoader);
-        }
-        await this.loaderEmitter.emitBefore(curLoader);
-        prevLoader = curLoader;
+      item.loader = item.loader ?? DEFAULT_LOADER;
+      if (!itemMap.has(item.loader)) {
+        // compatible for custom loader
+        itemMap.set(item.loader, []);
       }
-      await this.loaderEmitter.emitBeforeEach(curLoader, item);
-      const result = await this.loadItem(item);
-      await this.loaderEmitter.emitAfterEach(curLoader, item, result);
+      itemMap.get(item.loader)!.push(item);
     }
-    if (prevLoader) {
-      await this.loaderEmitter.emitAfter(prevLoader);
+
+    // trigger loader
+    for (const [ loaderName, itemList ] of itemMap) {
+      await this.loaderEmitter.emitBefore(loaderName);
+
+      for (const item of itemList) {
+        const curLoader = item.loader;
+        await this.loaderEmitter.emitBeforeEach(curLoader, item);
+        const result = await this.loadItem(item);
+        await this.loaderEmitter.emitAfterEach(curLoader, item, result);
+      }
+
+      await this.loaderEmitter.emitAfter(loaderName);
     }
   }
 

diff --git a/test/fixtures/app_without_config/app.ts b/test/fixtures/app_without_config/app.ts
@@ -0,0 +1,43 @@
+import { LifecycleHookUnit, LifecycleHook } from '../../../src/decorator';
+import { ApplicationLifecycle } from '../../../src/types';
+import { Container, Inject } from '@artus/injection';
+import LifecycleList from './lifecyclelist';
+
+@LifecycleHookUnit()
+export default class MyLifecycle implements ApplicationLifecycle {
+  @Inject()
+  container: Container;
+
+  @Inject()
+  lifecycleList: LifecycleList;
+
+  @LifecycleHook()
+  async configWillLoad() {
+    this.lifecycleList.add('configWillLoad');
+  }
+
+  @LifecycleHook()
+  async configDidLoad() {
+    this.lifecycleList.add('configDidLoad');
+  }
+
+  @LifecycleHook()
+  async willReady() {
+    this.lifecycleList.add('willReady');
+  }
+
+  @LifecycleHook()
+  async  didLoad() {
+    this.lifecycleList.add('didLoad');
+  }
+
+  @LifecycleHook('didReady')
+  async didReady() {
+    this.lifecycleList.add('didReady');
+  }
+
+  @LifecycleHook()
+  async beforeClose() {
+    this.lifecycleList.add('beforeClose');
+  }
+}
diff --git a/test/fixtures/app_without_config/config/.gitkeep b/test/fixtures/app_without_config/config/.gitkeep
diff --git a/test/fixtures/app_without_config/lifecyclelist.ts b/test/fixtures/app_without_config/lifecyclelist.ts
@@ -0,0 +1,12 @@
+import { Injectable, ScopeEnum } from '../../../src';
+
+@Injectable({
+  scope: ScopeEnum.SINGLETON,
+})
+export default class LifecycleList {
+  lifecycleList: string[] = [];
+
+  async add(name: string) {
+    this.lifecycleList.push(name);
+  }
+}
diff --git a/test/fixtures/app_without_config/package.json b/test/fixtures/app_without_config/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "demo-app-repo-ts",
+  "main": "src/index.ts"
+}
diff --git a/test/fixtures/app_without_config/tsconfig.json b/test/fixtures/app_without_config/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "experimentalDecorators": true
+  },
+  "rootDir": "./",
+  "exclude": []
+}
diff --git a/test/lifecycle.test.ts b/test/lifecycle.test.ts
@@ -2,6 +2,7 @@ import path from 'path';
 import assert from 'assert';
 import { createApp } from './utils';
 import LifecycleList from './fixtures/app_with_lifecycle/lifecyclelist';
+import WithoutConfigLifecycleList from './fixtures/app_without_config/lifecyclelist';
 
 describe('test/lifecycle.test.ts', () => {
   it('should lifecycle works without error', async () => {
@@ -88,4 +89,20 @@ describe('test/lifecycle.test.ts', () => {
       'app_beforeClose',
     ]);
   });
+
+  it('should trigger configDidLoad without config file', async () => {
+    const appWithoutConfigPath = path.resolve(__dirname, './fixtures/app_without_config');
+    const app = await createApp(appWithoutConfigPath);
+    const lifecycleList = app.container.get(WithoutConfigLifecycleList).lifecycleList;
+    await app.close();
+
+    assert.deepStrictEqual(lifecycleList, [
+      'configWillLoad',
+      'configDidLoad',
+      'didLoad',
+      'willReady',
+      'didReady',
+      'beforeClose',
+    ]);
+  });
 });