@eggjs/tegg-background-task 4.0.0-beta.4 → 4.0.0-beta.6

package/README.md

@@ -1,5 +1,17 @@
 # `@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

package/dist/BackgroundTaskHelper.d.ts

@@ -0,0 +1,16 @@
+import { EggObjectLifecycle } from "@eggjs/tegg-types";
+import { EggAppConfig, EggLogger } from "egg";
+
+//#region src/BackgroundTaskHelper.d.ts
+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;
+}
+//#endregion
+export { BackgroundTaskHelper };

package/dist/BackgroundTaskHelper.js

@@ -0,0 +1,78 @@
+import { __decorateMetadata } from "./_virtual/_@oxc-project_runtime@0.93.0/helpers/decorateMetadata.js";
+import { __decorate } from "./_virtual/_@oxc-project_runtime@0.93.0/helpers/decorate.js";
+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";
+
+//#region src/BackgroundTaskHelper.ts
+let BackgroundTaskHelper = class BackgroundTaskHelper$1 {
+	logger;
+	timeout = 5e3;
+	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().then(resolve).catch((e) => {
+					e.message = "[BackgroundTaskHelper] background throw error:" + e.message;
+					this.logger.error(e);
+					resolve();
+				});
+			} catch (e) {
+				e.message = "[BackgroundTaskHelper] create background throw error:" + e.message;
+				this.logger.error(e);
+				resolve();
+			}
+		});
+		this.backgroundTasks.push(backgroundTask);
+	}
+	async doPreDestroy() {
+		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([timeout, Promise.all(backgroundTasks)]);
+			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() {
+			clearTimeout(timer);
+			promiseResolve();
+		}
+		return {
+			promise: p,
+			resolve
+		};
+	}
+};
+__decorate([Inject(), __decorateMetadata("design:type", Object)], BackgroundTaskHelper.prototype, "logger", void 0);
+__decorate([Inject(), __decorateMetadata("design:type", Object)], BackgroundTaskHelper.prototype, "config", void 0);
+BackgroundTaskHelper = __decorate([ContextProto({ accessLevel: AccessLevel.PUBLIC })], BackgroundTaskHelper);
+
+//#endregion
+export { BackgroundTaskHelper };

package/dist/_virtual/_@oxc-project_runtime@0.93.0/helpers/decorate.js

@@ -0,0 +1,10 @@
+//#region \0@oxc-project+runtime@0.93.0/helpers/decorate.js
+function __decorate(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;
+}
+
+//#endregion
+export { __decorate };

package/dist/_virtual/_@oxc-project_runtime@0.93.0/helpers/decorateMetadata.js

@@ -0,0 +1,7 @@
+//#region \0@oxc-project+runtime@0.93.0/helpers/decorateMetadata.js
+function __decorateMetadata(k, v) {
+	if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+
+//#endregion
+export { __decorateMetadata };

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { BackgroundTaskHelper } from "./BackgroundTaskHelper.js";
+export { BackgroundTaskHelper };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { BackgroundTaskHelper } from "./BackgroundTaskHelper.js";
+
+export { BackgroundTaskHelper };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@eggjs/tegg-background-task",
   "description": "background util for tegg",
-  "version": "4.0.0-beta.4",
+  "version": "4.0.0-beta.6",
   "keywords": [
     "egg",
     "typescript",
@@ -11,22 +11,13 @@
   ],
   "type": "module",
   "exports": {
-    ".": {
-      "types": "./src/index.d.ts",
-      "default": "./src/index.js"
-    }
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
   },
   "files": [
-    "src/**/*.js",
-    "src/**/*.d.ts"
+    "dist"
   ],
-  "scripts": {
-    "clean": "tsc -b --clean",
-    "tsc": "npm run clean && tsc -p ./tsconfig.json",
-    "tsc:pub": "npm run tsc",
-    "prepublishOnly": "npm run tsc"
-  },
-  "homepage": "https://github.com/eggjs/tegg",
+  "homepage": "https://github.com/eggjs/tegg/tree/next/core/background-task",
   "bugs": {
     "url": "https://github.com/eggjs/tegg/issues"
   },
@@ -36,26 +27,34 @@
     "directory": "core/background-task"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=22.18.0"
   },
   "author": "killagu <killa123@126.com>",
   "license": "MIT",
   "dependencies": {
-    "@eggjs/core-decorator": "^4.0.0-beta.4",
-    "@eggjs/tegg-lifecycle": "^4.0.0-beta.4",
-    "@eggjs/tegg-runtime": "^4.0.0-beta.4",
-    "@eggjs/tegg-types": "^4.0.0-beta.4"
+    "@eggjs/core-decorator": "4.0.0-beta.6",
+    "@eggjs/tegg-types": "4.0.0-beta.6",
+    "@eggjs/tegg-runtime": "4.0.0-beta.6"
+  },
+  "peerDependencies": {
+    "egg": "beta"
   },
   "devDependencies": {
-    "@eggjs/tegg-common-util": "^4.0.0-beta.4",
-    "@types/node": "22",
-    "egg": "4",
-    "mocha": "10",
-    "ts-node": "10",
-    "typescript": "5"
+    "@types/node": "^22.10.5",
+    "typescript": "^5.9.3",
+    "tsdown": "^0.15.6",
+    "unplugin-unused": "^0.5.3",
+    "@eggjs/tegg-common-util": "4.0.0-beta.6"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "9ba90bed3ab9f641ceaa6a7db560095817b7e52c"
-}
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/src/BackgroundTaskHelper.d.ts

@@ -1,12 +0,0 @@
-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/src/BackgroundTaskHelper.js

@@ -1,114 +0,0 @@
-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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFja2dyb3VuZFRhc2tIZWxwZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJCYWNrZ3JvdW5kVGFza0hlbHBlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSxPQUFPLE1BQU0sTUFBTSxhQUFhLENBQUM7QUFFakMsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUM3RCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFFaEQsT0FBTyxFQUFFLGNBQWMsRUFBRSx1QkFBdUIsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBS3ZFLElBQU0sb0JBQW9CLEdBQTFCLE1BQU0sb0JBQW9CO0lBRS9CLE1BQU0sQ0FBWTtJQUVsQixpQ0FBaUM7SUFDakMsT0FBTyxHQUFHLElBQUksQ0FBQztJQUdmLE1BQU0sQ0FBZTtJQUViLGVBQWUsR0FBeUIsRUFBRSxDQUFDO0lBRW5ELEtBQUssQ0FBQyxJQUFJO1FBQ1IsTUFBTSxHQUFHLEdBQUcsY0FBYyxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQ3hDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsZ0RBQWdELENBQUMsQ0FBQztRQUM5RCx1QkFBdUIsQ0FBQyx1QkFBdUIsQ0FBQyxHQUFHLEVBQUU7WUFDbkQsVUFBVSxFQUFFLEtBQUssSUFBSSxFQUFFO2dCQUNyQixNQUFNLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztZQUM1QixDQUFDO1NBQ0YsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsRUFBRSxPQUFPLEVBQUUsQ0FBQztZQUN4QyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQztRQUNwRCxDQUFDO0lBQ0gsQ0FBQztJQUVELEdBQUcsQ0FBQyxFQUF1QjtRQUN6QixNQUFNLGNBQWMsR0FBRyxJQUFJLE9BQU8sQ0FBTyxPQUFPLENBQUMsRUFBRTtZQUNqRCxJQUFJLENBQUM7Z0JBQ0gsRUFBRSxFQUFFO29CQUNGLGtDQUFrQztxQkFDakMsSUFBSSxDQUFDLE9BQU8sQ0FBQztxQkFDYixLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUU7b0JBQ1QsQ0FBQyxDQUFDLE9BQU8sR0FBRyxnREFBZ0QsR0FBRyxDQUFDLENBQUMsT0FBTyxDQUFDO29CQUN6RSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztvQkFDckIsbUNBQW1DO29CQUNuQyxPQUFPLEVBQUUsQ0FBQztnQkFDWixDQUFDLENBQUMsQ0FBQztZQUNQLENBQUM7WUFBQyxPQUFPLENBQU0sRUFBRSxDQUFDO2dCQUNoQixDQUFDLENBQUMsT0FBTyxHQUFHLHVEQUF1RCxHQUFHLENBQUMsQ0FBQyxPQUFPLENBQUM7Z0JBQ2hGLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNyQix1Q0FBdUM7Z0JBQ3ZDLE9BQU8sRUFBRSxDQUFDO1lBQ1osQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7SUFDNUMsQ0FBQztJQUVELEtBQUssQ0FBQyxZQUFZO1FBQ2hCLGFBQWE7UUFDYixJQUFJLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxNQUFNO1lBQUUsT0FBTztRQUN6QyxNQUFNLGVBQWUsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3JELElBQUksSUFBSSxDQUFDLE9BQU8sSUFBSSxDQUFDLElBQUksSUFBSSxDQUFDLE9BQU8sS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUNuRCxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDckMsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsR0FBRyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7WUFFbkQsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDO2dCQUNqQiw2Q0FBNkM7Z0JBQzdDLE9BQU87Z0JBQ1AsaUVBQWlFO2dCQUNqRSxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQzthQUM3QixDQUFDLENBQUM7WUFDSCxtQ0FBbUM7WUFDbkMsT0FBTyxFQUFFLENBQUM7UUFDWixDQUFDO1FBQ0QsSUFBSSxJQUFJLENBQUMsZUFBZSxDQUFDLE1BQU0sS0FBSyxlQUFlLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDM0QsSUFBSSxDQUFDLGVBQWUsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7WUFDMUUsT0FBTyxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUM7SUFFTyxLQUFLO1FBQ1gsSUFBSSxLQUFxQixDQUFDO1FBQzFCLElBQUksY0FBMEIsQ0FBQztRQUMvQixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFFdkIsTUFBTSxDQUFDLEdBQUcsSUFBSSxPQUFPLENBQU8sQ0FBQyxDQUFDLEVBQUU7WUFDOUIsY0FBYyxHQUFHLENBQUMsQ0FBQztZQUNuQixLQUFLLEdBQUcsVUFBVSxDQUFDLEdBQUcsRUFBRTtnQkFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsb0RBQW9ELElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxHQUFHLGNBQWMsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7Z0JBQ3BILENBQUMsRUFBRSxDQUFDO1lBQ04sQ0FBQyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNuQixDQUFDLENBQUMsQ0FBQztRQUVILFNBQVMsT0FBTztZQUNkLHdDQUF3QztZQUN4QyxZQUFZLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDcEIsY0FBYyxFQUFFLENBQUM7UUFDbkIsQ0FBQztRQUVELE9BQU87WUFDTCxPQUFPLEVBQUUsQ0FBQztZQUNWLE9BQU87U0FDUixDQUFDO0lBQ0osQ0FBQztDQUNGLENBQUE7QUE5RkM7SUFEQyxNQUFNLEVBQUU7O29EQUNTO0FBTWxCO0lBREMsTUFBTSxFQUFFOztvREFDWTtBQVJWLG9CQUFvQjtJQUhoQyxZQUFZLENBQUM7UUFDWixXQUFXLEVBQUUsV0FBVyxDQUFDLE1BQU07S0FDaEMsQ0FBQztHQUNXLG9CQUFvQixDQWdHaEMifQ==

package/src/index.d.ts

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

package/src/index.js

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