@eggjs/background-task 4.0.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# `@eggjs/tegg-background-task`
+
+[![NPM version][npm-image]][npm-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/tegg-background-task.svg?style=flat)](https://nodejs.org/en/download/)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/tegg-background-task.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/tegg-background-task
+[snyk-image]: https://snyk.io/test/npm/@eggjs/tegg-background-task/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/@eggjs/tegg-background-task
+[download-image]: https://img.shields.io/npm/dm/@eggjs/tegg-background-task.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/tegg-background-task
+
+## install
+
+```sh
+npm i --save @eggjs/tegg-background-task
+```
+
+## Usage
+
+```ts
+import { BackgroundTaskHelper } from '@eggjs/tegg-background-task';
+
+@ContextProto()
+export default class BackgroundService {
+  @Inject()
+  private readonly backgroundTaskHelper: BackgroundTaskHelper;
+
+  async backgroundAdd() {
+    this.backgroundTaskHelper.run(async () => {
+      // do the background task
+    });
+  }
+}
+```
+
+## Background
+
+tegg release the request context after request is done. So use the `process.nextTick`, `setTimeout`, `setInterval` in request is not safe.
+Please use the `backgroundTaskHelper`, the release process will wait all the background tasks are done.
+
+## Timeout
+
+The release process will wait tasks done, but not forever. The default timeout is 5s, if task will cost more than 5s, two ways to resolve
+
+- use the `SingletonProto` to do the work, `SingletonProto` never release
+- set longer timeout to `backgroundTaskHelper.timeout`

package/dist/BackgroundTaskHelper.d.ts

@@ -0,0 +1,12 @@
+import type { EggLogger, EggAppConfig } from 'egg';
+import type { EggObjectLifecycle } from '@eggjs/tegg-types';
+export declare class BackgroundTaskHelper implements EggObjectLifecycle {
+    logger: EggLogger;
+    timeout: number;
+    config: EggAppConfig;
+    private backgroundTasks;
+    init(): Promise<void>;
+    run(fn: () => Promise<void>): void;
+    doPreDestroy(): Promise<void>;
+    private sleep;
+}

package/dist/BackgroundTaskHelper.js

@@ -0,0 +1,114 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import assert from 'node:assert';
+import { ContextProto, Inject } from '@eggjs/core-decorator';
+import { AccessLevel } from '@eggjs/tegg-types';
+import { ContextHandler, EggContextLifecycleUtil } from '@eggjs/tegg-runtime';
+let BackgroundTaskHelper = class BackgroundTaskHelper {
+    logger;
+    // default timeout for async task
+    timeout = 5000;
+    config;
+    backgroundTasks = [];
+    async init() {
+        const ctx = ContextHandler.getContext();
+        assert(ctx, 'background task helper must be init in context');
+        EggContextLifecycleUtil.registerObjectLifecycle(ctx, {
+            preDestroy: async () => {
+                await this.doPreDestroy();
+            },
+        });
+        if (this.config.backgroundTask?.timeout) {
+            this.timeout = this.config.backgroundTask.timeout;
+        }
+    }
+    run(fn) {
+        const backgroundTask = new Promise((resolve) => {
+            try {
+                fn()
+                    // fn is resolve, resolve the task
+                    .then(resolve)
+                    .catch((e) => {
+                    e.message = '[BackgroundTaskHelper] background throw error:' + e.message;
+                    this.logger.error(e);
+                    // fn is rejected, resolve the task
+                    resolve();
+                });
+            }
+            catch (e) {
+                e.message = '[BackgroundTaskHelper] create background throw error:' + e.message;
+                this.logger.error(e);
+                // create task failed, resolve the task
+                resolve();
+            }
+        });
+        this.backgroundTasks.push(backgroundTask);
+    }
+    async doPreDestroy() {
+        // quick quit
+        if (!this.backgroundTasks.length)
+            return;
+        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();
+        }
+        if (this.backgroundTasks.length !== backgroundTasks.length) {
+            this.backgroundTasks = this.backgroundTasks.slice(backgroundTasks.length);
+            return this.doPreDestroy();
+        }
+    }
+    sleep() {
+        let timer;
+        let promiseResolve;
+        const now = Date.now();
+        const p = new Promise((r) => {
+            promiseResolve = r;
+            timer = setTimeout(() => {
+                this.logger.error(`[BackgroundTaskHelper] task is timeout actual is ${Date.now() - now} expect is ${this.timeout}`);
+                r();
+            }, this.timeout);
+        });
+        function resolve() {
+            // clear timeout and resolve the promise
+            clearTimeout(timer);
+            promiseResolve();
+        }
+        return {
+            promise: p,
+            resolve,
+        };
+    }
+};
+__decorate([
+    Inject(),
+    __metadata("design:type", Function)
+], BackgroundTaskHelper.prototype, "logger", void 0);
+__decorate([
+    Inject(),
+    __metadata("design:type", Object)
+], BackgroundTaskHelper.prototype, "config", void 0);
+BackgroundTaskHelper = __decorate([
+    ContextProto({
+        accessLevel: AccessLevel.PUBLIC,
+    })
+], BackgroundTaskHelper);
+export { BackgroundTaskHelper };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFja2dyb3VuZFRhc2tIZWxwZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvQmFja2dyb3VuZFRhc2tIZWxwZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7O0FBQUEsT0FBTyxNQUFNLE1BQU0sYUFBYSxDQUFDO0FBR2pDLE9BQU8sRUFBRSxZQUFZLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFDN0QsT0FBTyxFQUFFLFdBQVcsRUFBRSxNQUFNLG1CQUFtQixDQUFDO0FBRWhELE9BQU8sRUFBRSxjQUFjLEVBQUUsdUJBQXVCLEVBQUUsTUFBTSxxQkFBcUIsQ0FBQztBQUt2RSxJQUFNLG9CQUFvQixHQUExQixNQUFNLG9CQUFvQjtJQUUvQixNQUFNLENBQVk7SUFFbEIsaUNBQWlDO0lBQ2pDLE9BQU8sR0FBRyxJQUFJLENBQUM7SUFHZixNQUFNLENBQWU7SUFFYixlQUFlLEdBQXlCLEVBQUUsQ0FBQztJQUVuRCxLQUFLLENBQUMsSUFBSTtRQUNSLE1BQU0sR0FBRyxHQUFHLGNBQWMsQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUN4QyxNQUFNLENBQUMsR0FBRyxFQUFFLGdEQUFnRCxDQUFDLENBQUM7UUFDOUQsdUJBQXVCLENBQUMsdUJBQXVCLENBQUMsR0FBRyxFQUFFO1lBQ25ELFVBQVUsRUFBRSxLQUFLLElBQUksRUFBRTtnQkFDckIsTUFBTSxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7WUFDNUIsQ0FBQztTQUNGLENBQUMsQ0FBQztRQUNILElBQUksSUFBSSxDQUFDLE1BQU0sQ0FBQyxjQUFjLEVBQUUsT0FBTyxFQUFFLENBQUM7WUFDeEMsSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUM7UUFDcEQsQ0FBQztJQUNILENBQUM7SUFFRCxHQUFHLENBQUMsRUFBdUI7UUFDekIsTUFBTSxjQUFjLEdBQUcsSUFBSSxPQUFPLENBQU8sQ0FBQyxPQUFPLEVBQUUsRUFBRTtZQUNuRCxJQUFJLENBQUM7Z0JBQ0gsRUFBRSxFQUFFO29CQUNGLGtDQUFrQztxQkFDakMsSUFBSSxDQUFDLE9BQU8sQ0FBQztxQkFDYixLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUUsRUFBRTtvQkFDWCxDQUFDLENBQUMsT0FBTyxHQUFHLGdEQUFnRCxHQUFHLENBQUMsQ0FBQyxPQUFPLENBQUM7b0JBQ3pFLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO29CQUNyQixtQ0FBbUM7b0JBQ25DLE9BQU8sRUFBRSxDQUFDO2dCQUNaLENBQUMsQ0FBQyxDQUFDO1lBQ1AsQ0FBQztZQUFDLE9BQU8sQ0FBTSxFQUFFLENBQUM7Z0JBQ2hCLENBQUMsQ0FBQyxPQUFPLEdBQUcsdURBQXVELEdBQUcsQ0FBQyxDQUFDLE9BQU8sQ0FBQztnQkFDaEYsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7Z0JBQ3JCLHVDQUF1QztnQkFDdkMsT0FBTyxFQUFFLENBQUM7WUFDWixDQUFDO1FBQ0gsQ0FBQyxDQUFDLENBQUM7UUFFSCxJQUFJLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQztJQUM1QyxDQUFDO0lBRUQsS0FBSyxDQUFDLFlBQVk7UUFDaEIsYUFBYTtRQUNiLElBQUksQ0FBQyxJQUFJLENBQUMsZUFBZSxDQUFDLE1BQU07WUFBRSxPQUFPO1FBQ3pDLE1BQU0sZUFBZSxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUMsS0FBSyxFQUFFLENBQUM7UUFDckQsSUFBSSxJQUFJLENBQUMsT0FBTyxJQUFJLENBQUMsSUFBSSxJQUFJLENBQUMsT0FBTyxLQUFLLFFBQVEsRUFBRSxDQUFDO1lBQ25ELE1BQU0sT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlLENBQUMsQ0FBQztRQUNyQyxDQUFDO2FBQU0sQ0FBQztZQUNOLE1BQU0sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxHQUFHLElBQUksQ0FBQyxLQUFLLEVBQUUsQ0FBQztZQUVuRCxNQUFNLE9BQU8sQ0FBQyxJQUFJLENBQUM7Z0JBQ2pCLDZDQUE2QztnQkFDN0MsT0FBTztnQkFDUCxpRUFBaUU7Z0JBQ2pFLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDO2FBQzdCLENBQUMsQ0FBQztZQUNILG1DQUFtQztZQUNuQyxPQUFPLEVBQUUsQ0FBQztRQUNaLENBQUM7UUFDRCxJQUFJLElBQUksQ0FBQyxlQUFlLENBQUMsTUFBTSxLQUFLLGVBQWUsQ0FBQyxNQUFNLEVBQUUsQ0FBQztZQUMzRCxJQUFJLENBQUMsZUFBZSxHQUFHLElBQUksQ0FBQyxlQUFlLENBQUMsS0FBSyxDQUFDLGVBQWUsQ0FBQyxNQUFNLENBQUMsQ0FBQztZQUMxRSxPQUFPLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztRQUM3QixDQUFDO0lBQ0gsQ0FBQztJQUVPLEtBQUs7UUFDWCxJQUFJLEtBQXFCLENBQUM7UUFDMUIsSUFBSSxjQUEwQixDQUFDO1FBQy9CLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztRQUV2QixNQUFNLENBQUMsR0FBRyxJQUFJLE9BQU8sQ0FBTyxDQUFDLENBQUMsRUFBRSxFQUFFO1lBQ2hDLGNBQWMsR0FBRyxDQUFDLENBQUM7WUFDbkIsS0FBSyxHQUFHLFVBQVUsQ0FBQyxHQUFHLEVBQUU7Z0JBQ3RCLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUNmLG9EQUFvRCxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsR0FBRyxjQUFjLElBQUksQ0FBQyxPQUFPLEVBQUUsQ0FDakcsQ0FBQztnQkFDRixDQUFDLEVBQUUsQ0FBQztZQUNOLENBQUMsRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLENBQUM7UUFDbkIsQ0FBQyxDQUFDLENBQUM7UUFFSCxTQUFTLE9BQU87WUFDZCx3Q0FBd0M7WUFDeEMsWUFBWSxDQUFDLEtBQUssQ0FBQyxDQUFDO1lBQ3BCLGNBQWMsRUFBRSxDQUFDO1FBQ25CLENBQUM7UUFFRCxPQUFPO1lBQ0wsT0FBTyxFQUFFLENBQUM7WUFDVixPQUFPO1NBQ1IsQ0FBQztJQUNKLENBQUM7Q0FDRixDQUFBO0FBaEdDO0lBREMsTUFBTSxFQUFFOztvREFDUztBQU1sQjtJQURDLE1BQU0sRUFBRTs7b0RBQ1k7QUFSVixvQkFBb0I7SUFIaEMsWUFBWSxDQUFDO1FBQ1osV0FBVyxFQUFFLFdBQVcsQ0FBQyxNQUFNO0tBQ2hDLENBQUM7R0FDVyxvQkFBb0IsQ0FrR2hDIn0=

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './BackgroundTaskHelper.ts';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./BackgroundTaskHelper.js";
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsY0FBYywyQkFBMkIsQ0FBQyJ9

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@eggjs/background-task",
+  "description": "background task util for tegg",
+  "version": "4.0.0-beta.0",
+  "keywords": [
+    "egg",
+    "typescript",
+    "background",
+    "async",
+    "tegg"
+  ],
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "homepage": "https://github.com/eggjs/egg/tree/next/tegg/core/background-task",
+  "bugs": {
+    "url": "https://github.com/eggjs/egg/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eggjs/egg.git",
+    "directory": "tegg/core/background-task"
+  },
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "author": "killagu <killa123@126.com>",
+  "license": "MIT",
+  "dependencies": {
+    "@eggjs/core-decorator": "4.0.0-beta.29",
+    "@eggjs/tegg-types": "4.0.0-beta.29",
+    "@eggjs/tegg-runtime": "4.0.0-beta.29"
+  },
+  "peerDependencies": {
+    "egg": "4.1.0-beta.29"
+  },
+  "devDependencies": {
+    "@types/node": "^24.9.1",
+    "tsdown": "0.15.9",
+    "typescript": "^5.9.3",
+    "unplugin-unused": "^0.5.4",
+    "@eggjs/tegg-common-util": "4.0.0-beta.29",
+    "egg": "4.1.0-beta.29"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist *.tsbuildinfo",
+    "build": "tsdown && npm run clean && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit"
+  }
+}