feat: add backgroundTask.timeout config (#101)

Author: killagu

README.md

@@ -632,6 +632,8 @@ export default class BackgroundService {
 
 - **推荐方式：将异步任务转发给单例对象（SingletonProto）来执行，单例对象永远不会释放**
 - 调整超时时间，对 `backgroundTaskHelper.timeout` 进行赋值即可
+- 如果将超时时间设置为 `Infinity`，框架将不会超时
+- 可以在 config 文件中指定 `backgroundTask.timeout` 来全局覆盖默认的超时时间
 
 ### 动态注入
 

core/background-task/src/BackgroundTaskHelper.ts

@@ -1,6 +1,6 @@
 import assert from 'assert';
 import { AccessLevel, ContextProto, Inject } from '@eggjs/core-decorator';
-import type { EggLogger } from 'egg';
+import type { EggLogger, EggAppConfig } from 'egg';
 import { EggObjectLifecycle } from '@eggjs/tegg-lifecycle';
 import { ContextHandler, EggContextLifecycleUtil } from '@eggjs/tegg-runtime';
 
@@ -14,6 +14,9 @@ export class BackgroundTaskHelper implements EggObjectLifecycle {
   // default timeout for async task
   timeout = 5000;
 
+  @Inject()
+  config: EggAppConfig;
+
   private backgroundTasks: Array<Promise<void>> = [];
 
   async init() {
@@ -24,6 +27,9 @@ export class BackgroundTaskHelper implements EggObjectLifecycle {
         await this.doPreDestroy();
       },
     });
+    if (this.config.backgroundTask?.timeout) {
+      this.timeout = this.config.backgroundTask.timeout;
+    }
   }
 
   run(fn: () => Promise<void>) {
@@ -52,18 +58,21 @@ export class BackgroundTaskHelper implements EggObjectLifecycle {
   async doPreDestroy(): Promise<void> {
     // quick quit
     if (!this.backgroundTasks.length) return;
-
-    const { promise: timeout, resolve } = this.sleep();
     const backgroundTasks = this.backgroundTasks.slice();
+    if (this.timeout <= 0 || this.timeout === Infinity) {
+      await Promise.all(backgroundTasks);
+    } else {
+      const { promise: timeout, resolve } = this.sleep();
 
-    await Promise.race([
-      // not block the pre destroy process too long
-      timeout,
-      // ensure all background task are done before destroy the context
-      Promise.all(backgroundTasks),
-    ]);
-    // always resolve the sleep promise
-    resolve();
+      await Promise.race([
+        // not block the pre destroy process too long
+        timeout,
+        // ensure all background task are done before destroy the context
+        Promise.all(backgroundTasks),
+      ]);
+      // always resolve the sleep promise
+      resolve();
+    }
     if (this.backgroundTasks.length !== backgroundTasks.length) {
       this.backgroundTasks = this.backgroundTasks.slice(backgroundTasks.length);
       return this.doPreDestroy();

plugin/tegg/test/BackgroundTask.test.ts

@@ -67,4 +67,11 @@ describe('test/BackgroundTask.test.ts', () => {
     const lifecycleList = EggContextLifecycleUtil.getObjectLifecycleList(teggCtx!);
     assert(lifecycleList.length === 0);
   });
+
+  it('config should work', async () => {
+    await app.mockModuleContextScope(async ctx => {
+      const backgroundTaskHelper = await ctx.getEggObject(BackgroundTaskHelper);
+      assert(backgroundTaskHelper.timeout === Infinity);
+    });
+  });
 });

plugin/tegg/test/fixtures/apps/background-app/config/config.default.js

@@ -15,6 +15,9 @@ module.exports = function(appInfo) {
         ignoreJSON: false,
       }
     },
+    backgroundTask: {
+      timeout: Infinity,
+    },
   };
   return config;
 };

plugin/tegg/test/fixtures/apps/background-app/modules/multi-module-background/BackgroundService.ts

@@ -23,6 +23,7 @@ export default class BackgroundService {
   private readonly countService: CountService;
 
   async backgroundAdd(delay = 1000) {
+    this.backgroundTaskHelper.timeout = 5000;
     this.backgroundTaskHelper.run(async () => {
       await sleep(delay);
       assert(this.testObj.ok);