@eggjs/tegg-background-task 3.51.2 → 4.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/package.json +24 -22
- package/src/BackgroundTaskHelper.js +114 -0
- package/src/index.d.ts +1 -0
- package/src/index.js +2 -0
- package/dist/index.d.ts +0 -1
- package/dist/index.js +0 -18
- package/dist/src/BackgroundTaskHelper.js +0 -121
- /package/{dist/src → src}/BackgroundTaskHelper.d.ts +0 -0
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
# `@eggjs/tegg-background-task`
|
|
2
2
|
|
|
3
3
|
## install
|
|
4
|
+
|
|
4
5
|
```sh
|
|
5
6
|
npm i --save @eggjs/tegg-background-task
|
|
6
7
|
```
|
|
@@ -31,6 +32,6 @@ Please use the `backgroundTaskHelper`, the release process will wait all the bac
|
|
|
31
32
|
## Timeout
|
|
32
33
|
|
|
33
34
|
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
|
|
35
|
+
|
|
34
36
|
- use the `SingletonProto` to do the work, `SingletonProto` never release
|
|
35
37
|
- set longer timeout to `backgroundTaskHelper.timeout`
|
|
36
|
-
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@eggjs/tegg-background-task",
|
|
3
3
|
"description": "background util for tegg",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "4.0.0-beta.1",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"egg",
|
|
7
7
|
"typescript",
|
|
@@ -9,18 +9,22 @@
|
|
|
9
9
|
"async",
|
|
10
10
|
"tegg"
|
|
11
11
|
],
|
|
12
|
-
"
|
|
12
|
+
"type": "module",
|
|
13
|
+
"exports": {
|
|
14
|
+
".": {
|
|
15
|
+
"types": "./src/index.d.ts",
|
|
16
|
+
"default": "./src/index.js"
|
|
17
|
+
}
|
|
18
|
+
},
|
|
13
19
|
"files": [
|
|
14
|
-
"
|
|
15
|
-
"
|
|
20
|
+
"src/**/*.js",
|
|
21
|
+
"src/**/*.d.ts"
|
|
16
22
|
],
|
|
17
|
-
"typings": "dist/index.d.ts",
|
|
18
23
|
"scripts": {
|
|
19
|
-
"test": "cross-env NODE_ENV=test NODE_OPTIONS='--no-deprecation' mocha",
|
|
20
24
|
"clean": "tsc -b --clean",
|
|
21
25
|
"tsc": "npm run clean && tsc -p ./tsconfig.json",
|
|
22
|
-
"tsc:pub": "npm run
|
|
23
|
-
"prepublishOnly": "npm run tsc
|
|
26
|
+
"tsc:pub": "npm run tsc",
|
|
27
|
+
"prepublishOnly": "npm run tsc"
|
|
24
28
|
},
|
|
25
29
|
"homepage": "https://github.com/eggjs/tegg",
|
|
26
30
|
"bugs": {
|
|
@@ -32,28 +36,26 @@
|
|
|
32
36
|
"directory": "core/background-task"
|
|
33
37
|
},
|
|
34
38
|
"engines": {
|
|
35
|
-
"node": ">=
|
|
39
|
+
"node": ">=20.0.0"
|
|
36
40
|
},
|
|
37
41
|
"author": "killagu <killa123@126.com>",
|
|
38
42
|
"license": "MIT",
|
|
39
43
|
"dependencies": {
|
|
40
|
-
"@eggjs/core-decorator": "^
|
|
41
|
-
"@eggjs/tegg-lifecycle": "^
|
|
42
|
-
"@eggjs/tegg-runtime": "^
|
|
43
|
-
"@eggjs/tegg-types": "^
|
|
44
|
+
"@eggjs/core-decorator": "^4.0.0-beta.1",
|
|
45
|
+
"@eggjs/tegg-lifecycle": "^4.0.0-beta.1",
|
|
46
|
+
"@eggjs/tegg-runtime": "^4.0.0-beta.1",
|
|
47
|
+
"@eggjs/tegg-types": "^4.0.0-beta.1"
|
|
44
48
|
},
|
|
45
49
|
"devDependencies": {
|
|
46
|
-
"@eggjs/tegg-common-util": "^
|
|
47
|
-
"@types/
|
|
48
|
-
"
|
|
49
|
-
"
|
|
50
|
-
"
|
|
51
|
-
"
|
|
52
|
-
"ts-node": "^10.9.1",
|
|
53
|
-
"typescript": "^5.0.4"
|
|
50
|
+
"@eggjs/tegg-common-util": "^4.0.0-beta.1",
|
|
51
|
+
"@types/node": "22",
|
|
52
|
+
"egg": "4",
|
|
53
|
+
"mocha": "10",
|
|
54
|
+
"ts-node": "10",
|
|
55
|
+
"typescript": "5"
|
|
54
56
|
},
|
|
55
57
|
"publishConfig": {
|
|
56
58
|
"access": "public"
|
|
57
59
|
},
|
|
58
|
-
"gitHead": "
|
|
60
|
+
"gitHead": "79a22905272d6de7fe06152231dff65d213d9166"
|
|
59
61
|
}
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
2
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
3
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
4
|
+
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;
|
|
5
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
6
|
+
};
|
|
7
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
8
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
9
|
+
};
|
|
10
|
+
import assert from 'node:assert';
|
|
11
|
+
import { ContextProto, Inject } from '@eggjs/core-decorator';
|
|
12
|
+
import { AccessLevel } from '@eggjs/tegg-types';
|
|
13
|
+
import { ContextHandler, EggContextLifecycleUtil } from '@eggjs/tegg-runtime';
|
|
14
|
+
let BackgroundTaskHelper = class BackgroundTaskHelper {
|
|
15
|
+
logger;
|
|
16
|
+
// default timeout for async task
|
|
17
|
+
timeout = 5000;
|
|
18
|
+
config;
|
|
19
|
+
backgroundTasks = [];
|
|
20
|
+
async init() {
|
|
21
|
+
const ctx = ContextHandler.getContext();
|
|
22
|
+
assert(ctx, 'background task helper must be init in context');
|
|
23
|
+
EggContextLifecycleUtil.registerObjectLifecycle(ctx, {
|
|
24
|
+
preDestroy: async () => {
|
|
25
|
+
await this.doPreDestroy();
|
|
26
|
+
},
|
|
27
|
+
});
|
|
28
|
+
if (this.config.backgroundTask?.timeout) {
|
|
29
|
+
this.timeout = this.config.backgroundTask.timeout;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
run(fn) {
|
|
33
|
+
const backgroundTask = new Promise(resolve => {
|
|
34
|
+
try {
|
|
35
|
+
fn()
|
|
36
|
+
// fn is resolve, resolve the task
|
|
37
|
+
.then(resolve)
|
|
38
|
+
.catch(e => {
|
|
39
|
+
e.message = '[BackgroundTaskHelper] background throw error:' + e.message;
|
|
40
|
+
this.logger.error(e);
|
|
41
|
+
// fn is rejected, resolve the task
|
|
42
|
+
resolve();
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
catch (e) {
|
|
46
|
+
e.message = '[BackgroundTaskHelper] create background throw error:' + e.message;
|
|
47
|
+
this.logger.error(e);
|
|
48
|
+
// create task failed, resolve the task
|
|
49
|
+
resolve();
|
|
50
|
+
}
|
|
51
|
+
});
|
|
52
|
+
this.backgroundTasks.push(backgroundTask);
|
|
53
|
+
}
|
|
54
|
+
async doPreDestroy() {
|
|
55
|
+
// quick quit
|
|
56
|
+
if (!this.backgroundTasks.length)
|
|
57
|
+
return;
|
|
58
|
+
const backgroundTasks = this.backgroundTasks.slice();
|
|
59
|
+
if (this.timeout <= 0 || this.timeout === Infinity) {
|
|
60
|
+
await Promise.all(backgroundTasks);
|
|
61
|
+
}
|
|
62
|
+
else {
|
|
63
|
+
const { promise: timeout, resolve } = this.sleep();
|
|
64
|
+
await Promise.race([
|
|
65
|
+
// not block the pre destroy process too long
|
|
66
|
+
timeout,
|
|
67
|
+
// ensure all background task are done before destroy the context
|
|
68
|
+
Promise.all(backgroundTasks),
|
|
69
|
+
]);
|
|
70
|
+
// always resolve the sleep promise
|
|
71
|
+
resolve();
|
|
72
|
+
}
|
|
73
|
+
if (this.backgroundTasks.length !== backgroundTasks.length) {
|
|
74
|
+
this.backgroundTasks = this.backgroundTasks.slice(backgroundTasks.length);
|
|
75
|
+
return this.doPreDestroy();
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
sleep() {
|
|
79
|
+
let timer;
|
|
80
|
+
let promiseResolve;
|
|
81
|
+
const now = Date.now();
|
|
82
|
+
const p = new Promise(r => {
|
|
83
|
+
promiseResolve = r;
|
|
84
|
+
timer = setTimeout(() => {
|
|
85
|
+
this.logger.error(`[BackgroundTaskHelper] task is timeout actual is ${Date.now() - now} expect is ${this.timeout}`);
|
|
86
|
+
r();
|
|
87
|
+
}, this.timeout);
|
|
88
|
+
});
|
|
89
|
+
function resolve() {
|
|
90
|
+
// clear timeout and resolve the promise
|
|
91
|
+
clearTimeout(timer);
|
|
92
|
+
promiseResolve();
|
|
93
|
+
}
|
|
94
|
+
return {
|
|
95
|
+
promise: p,
|
|
96
|
+
resolve,
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
};
|
|
100
|
+
__decorate([
|
|
101
|
+
Inject(),
|
|
102
|
+
__metadata("design:type", Function)
|
|
103
|
+
], BackgroundTaskHelper.prototype, "logger", void 0);
|
|
104
|
+
__decorate([
|
|
105
|
+
Inject(),
|
|
106
|
+
__metadata("design:type", Object)
|
|
107
|
+
], BackgroundTaskHelper.prototype, "config", void 0);
|
|
108
|
+
BackgroundTaskHelper = __decorate([
|
|
109
|
+
ContextProto({
|
|
110
|
+
accessLevel: AccessLevel.PUBLIC,
|
|
111
|
+
})
|
|
112
|
+
], BackgroundTaskHelper);
|
|
113
|
+
export { BackgroundTaskHelper };
|
|
114
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFja2dyb3VuZFRhc2tIZWxwZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyJCYWNrZ3JvdW5kVGFza0hlbHBlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSxPQUFPLE1BQU0sTUFBTSxhQUFhLENBQUM7QUFFakMsT0FBTyxFQUFFLFlBQVksRUFBRSxNQUFNLEVBQUUsTUFBTSx1QkFBdUIsQ0FBQztBQUM3RCxPQUFPLEVBQUUsV0FBVyxFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFFaEQsT0FBTyxFQUFFLGNBQWMsRUFBRSx1QkFBdUIsRUFBRSxNQUFNLHFCQUFxQixDQUFDO0FBS3ZFLElBQU0sb0JBQW9CLEdBQTFCLE1BQU0sb0JBQW9CO0lBRS9CLE1BQU0sQ0FBWTtJQUVsQixpQ0FBaUM7SUFDakMsT0FBTyxHQUFHLElBQUksQ0FBQztJQUdmLE1BQU0sQ0FBZTtJQUViLGVBQWUsR0FBeUIsRUFBRSxDQUFDO0lBRW5ELEtBQUssQ0FBQyxJQUFJO1FBQ1IsTUFBTSxHQUFHLEdBQUcsY0FBYyxDQUFDLFVBQVUsRUFBRSxDQUFDO1FBQ3hDLE1BQU0sQ0FBQyxHQUFHLEVBQUUsZ0RBQWdELENBQUMsQ0FBQztRQUM5RCx1QkFBdUIsQ0FBQyx1QkFBdUIsQ0FBQyxHQUFHLEVBQUU7WUFDbkQsVUFBVSxFQUFFLEtBQUssSUFBSSxFQUFFO2dCQUNyQixNQUFNLElBQUksQ0FBQyxZQUFZLEVBQUUsQ0FBQztZQUM1QixDQUFDO1NBQ0YsQ0FBQyxDQUFDO1FBQ0gsSUFBSSxJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsRUFBRSxPQUFPLEVBQUUsQ0FBQztZQUN4QyxJQUFJLENBQUMsT0FBTyxHQUFHLElBQUksQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLE9BQU8sQ0FBQztRQUNwRCxDQUFDO0lBQ0gsQ0FBQztJQUVELEdBQUcsQ0FBQyxFQUF1QjtRQUN6QixNQUFNLGNBQWMsR0FBRyxJQUFJLE9BQU8sQ0FBTyxPQUFPLENBQUMsRUFBRTtZQUNqRCxJQUFJLENBQUM7Z0JBQ0gsRUFBRSxFQUFFO29CQUNGLGtDQUFrQztxQkFDakMsSUFBSSxDQUFDLE9BQU8sQ0FBQztxQkFDYixLQUFLLENBQUMsQ0FBQyxDQUFDLEVBQUU7b0JBQ1QsQ0FBQyxDQUFDLE9BQU8sR0FBRyxnREFBZ0QsR0FBRyxDQUFDLENBQUMsT0FBTyxDQUFDO29CQUN6RSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztvQkFDckIsbUNBQW1DO29CQUNuQyxPQUFPLEVBQUUsQ0FBQztnQkFDWixDQUFDLENBQUMsQ0FBQztZQUNQLENBQUM7WUFBQyxPQUFPLENBQU0sRUFBRSxDQUFDO2dCQUNoQixDQUFDLENBQUMsT0FBTyxHQUFHLHVEQUF1RCxHQUFHLENBQUMsQ0FBQyxPQUFPLENBQUM7Z0JBQ2hGLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNyQix1Q0FBdUM7Z0JBQ3ZDLE9BQU8sRUFBRSxDQUFDO1lBQ1osQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7SUFDNUMsQ0FBQztJQUVELEtBQUssQ0FBQyxZQUFZO1FBQ2hCLGFBQWE7UUFDYixJQUFJLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxNQUFNO1lBQUUsT0FBTztRQUN6QyxNQUFNLGVBQWUsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3JELElBQUksSUFBSSxDQUFDLE9BQU8sSUFBSSxDQUFDLElBQUksSUFBSSxDQUFDLE9BQU8sS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUNuRCxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDckMsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsR0FBRyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7WUFFbkQsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDO2dCQUNqQiw2Q0FBNkM7Z0JBQzdDLE9BQU87Z0JBQ1AsaUVBQWlFO2dCQUNqRSxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQzthQUM3QixDQUFDLENBQUM7WUFDSCxtQ0FBbUM7WUFDbkMsT0FBTyxFQUFFLENBQUM7UUFDWixDQUFDO1FBQ0QsSUFBSSxJQUFJLENBQUMsZUFBZSxDQUFDLE1BQU0sS0FBSyxlQUFlLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDM0QsSUFBSSxDQUFDLGVBQWUsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7WUFDMUUsT0FBTyxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUM7SUFFTyxLQUFLO1FBQ1gsSUFBSSxLQUFxQixDQUFDO1FBQzFCLElBQUksY0FBMEIsQ0FBQztRQUMvQixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFFdkIsTUFBTSxDQUFDLEdBQUcsSUFBSSxPQUFPLENBQU8sQ0FBQyxDQUFDLEVBQUU7WUFDOUIsY0FBYyxHQUFHLENBQUMsQ0FBQztZQUNuQixLQUFLLEdBQUcsVUFBVSxDQUFDLEdBQUcsRUFBRTtnQkFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsb0RBQW9ELElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxHQUFHLGNBQWMsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7Z0JBQ3BILENBQUMsRUFBRSxDQUFDO1lBQ04sQ0FBQyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNuQixDQUFDLENBQUMsQ0FBQztRQUVILFNBQVMsT0FBTztZQUNkLHdDQUF3QztZQUN4QyxZQUFZLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDcEIsY0FBYyxFQUFFLENBQUM7UUFDbkIsQ0FBQztRQUVELE9BQU87WUFDTCxPQUFPLEVBQUUsQ0FBQztZQUNWLE9BQU87U0FDUixDQUFDO0lBQ0osQ0FBQztDQUNGLENBQUE7QUE5RkM7SUFEQyxNQUFNLEVBQUU7O29EQUNTO0FBTWxCO0lBREMsTUFBTSxFQUFFOztvREFDWTtBQVJWLG9CQUFvQjtJQUhoQyxZQUFZLENBQUM7UUFDWixXQUFXLEVBQUUsV0FBVyxDQUFDLE1BQU07S0FDaEMsQ0FBQztHQUNXLG9CQUFvQixDQWdHaEMifQ==
|
package/src/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './BackgroundTaskHelper.js';
|
package/src/index.js
ADDED
package/dist/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from './src/BackgroundTaskHelper';
|
package/dist/index.js
DELETED
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
-
if (k2 === undefined) k2 = k;
|
|
4
|
-
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
-
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
-
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
-
}
|
|
8
|
-
Object.defineProperty(o, k2, desc);
|
|
9
|
-
}) : (function(o, m, k, k2) {
|
|
10
|
-
if (k2 === undefined) k2 = k;
|
|
11
|
-
o[k2] = m[k];
|
|
12
|
-
}));
|
|
13
|
-
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
-
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
-
};
|
|
16
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
-
__exportStar(require("./src/BackgroundTaskHelper"), exports);
|
|
18
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsNkRBQTJDIn0=
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
-
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
-
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
-
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;
|
|
6
|
-
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
-
};
|
|
8
|
-
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
-
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
-
};
|
|
11
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
-
};
|
|
14
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.BackgroundTaskHelper = void 0;
|
|
16
|
-
const node_assert_1 = __importDefault(require("node:assert"));
|
|
17
|
-
const core_decorator_1 = require("@eggjs/core-decorator");
|
|
18
|
-
const tegg_types_1 = require("@eggjs/tegg-types");
|
|
19
|
-
const tegg_runtime_1 = require("@eggjs/tegg-runtime");
|
|
20
|
-
let BackgroundTaskHelper = class BackgroundTaskHelper {
|
|
21
|
-
constructor() {
|
|
22
|
-
// default timeout for async task
|
|
23
|
-
this.timeout = 5000;
|
|
24
|
-
this.backgroundTasks = [];
|
|
25
|
-
}
|
|
26
|
-
async init() {
|
|
27
|
-
var _a;
|
|
28
|
-
const ctx = tegg_runtime_1.ContextHandler.getContext();
|
|
29
|
-
(0, node_assert_1.default)(ctx, 'background task helper must be init in context');
|
|
30
|
-
tegg_runtime_1.EggContextLifecycleUtil.registerObjectLifecycle(ctx, {
|
|
31
|
-
preDestroy: async () => {
|
|
32
|
-
await this.doPreDestroy();
|
|
33
|
-
},
|
|
34
|
-
});
|
|
35
|
-
if ((_a = this.config.backgroundTask) === null || _a === void 0 ? void 0 : _a.timeout) {
|
|
36
|
-
this.timeout = this.config.backgroundTask.timeout;
|
|
37
|
-
}
|
|
38
|
-
}
|
|
39
|
-
run(fn) {
|
|
40
|
-
const backgroundTask = new Promise(resolve => {
|
|
41
|
-
try {
|
|
42
|
-
fn()
|
|
43
|
-
// fn is resolve, resolve the task
|
|
44
|
-
.then(resolve)
|
|
45
|
-
.catch(e => {
|
|
46
|
-
e.message = '[BackgroundTaskHelper] background throw error:' + e.message;
|
|
47
|
-
this.logger.error(e);
|
|
48
|
-
// fn is rejected, resolve the task
|
|
49
|
-
resolve();
|
|
50
|
-
});
|
|
51
|
-
}
|
|
52
|
-
catch (e) {
|
|
53
|
-
e.message = '[BackgroundTaskHelper] create background throw error:' + e.message;
|
|
54
|
-
this.logger.error(e);
|
|
55
|
-
// create task failed, resolve the task
|
|
56
|
-
resolve();
|
|
57
|
-
}
|
|
58
|
-
});
|
|
59
|
-
this.backgroundTasks.push(backgroundTask);
|
|
60
|
-
}
|
|
61
|
-
async doPreDestroy() {
|
|
62
|
-
// quick quit
|
|
63
|
-
if (!this.backgroundTasks.length)
|
|
64
|
-
return;
|
|
65
|
-
const backgroundTasks = this.backgroundTasks.slice();
|
|
66
|
-
if (this.timeout <= 0 || this.timeout === Infinity) {
|
|
67
|
-
await Promise.all(backgroundTasks);
|
|
68
|
-
}
|
|
69
|
-
else {
|
|
70
|
-
const { promise: timeout, resolve } = this.sleep();
|
|
71
|
-
await Promise.race([
|
|
72
|
-
// not block the pre destroy process too long
|
|
73
|
-
timeout,
|
|
74
|
-
// ensure all background task are done before destroy the context
|
|
75
|
-
Promise.all(backgroundTasks),
|
|
76
|
-
]);
|
|
77
|
-
// always resolve the sleep promise
|
|
78
|
-
resolve();
|
|
79
|
-
}
|
|
80
|
-
if (this.backgroundTasks.length !== backgroundTasks.length) {
|
|
81
|
-
this.backgroundTasks = this.backgroundTasks.slice(backgroundTasks.length);
|
|
82
|
-
return this.doPreDestroy();
|
|
83
|
-
}
|
|
84
|
-
}
|
|
85
|
-
sleep() {
|
|
86
|
-
let timer;
|
|
87
|
-
let promiseResolve;
|
|
88
|
-
const now = Date.now();
|
|
89
|
-
const p = new Promise(r => {
|
|
90
|
-
promiseResolve = r;
|
|
91
|
-
timer = setTimeout(() => {
|
|
92
|
-
this.logger.error(`[BackgroundTaskHelper] task is timeout actual is ${Date.now() - now} expect is ${this.timeout}`);
|
|
93
|
-
r();
|
|
94
|
-
}, this.timeout);
|
|
95
|
-
});
|
|
96
|
-
function resolve() {
|
|
97
|
-
// clear timeout and resolve the promise
|
|
98
|
-
clearTimeout(timer);
|
|
99
|
-
promiseResolve();
|
|
100
|
-
}
|
|
101
|
-
return {
|
|
102
|
-
promise: p,
|
|
103
|
-
resolve,
|
|
104
|
-
};
|
|
105
|
-
}
|
|
106
|
-
};
|
|
107
|
-
exports.BackgroundTaskHelper = BackgroundTaskHelper;
|
|
108
|
-
__decorate([
|
|
109
|
-
(0, core_decorator_1.Inject)(),
|
|
110
|
-
__metadata("design:type", Object)
|
|
111
|
-
], BackgroundTaskHelper.prototype, "logger", void 0);
|
|
112
|
-
__decorate([
|
|
113
|
-
(0, core_decorator_1.Inject)(),
|
|
114
|
-
__metadata("design:type", Object)
|
|
115
|
-
], BackgroundTaskHelper.prototype, "config", void 0);
|
|
116
|
-
exports.BackgroundTaskHelper = BackgroundTaskHelper = __decorate([
|
|
117
|
-
(0, core_decorator_1.ContextProto)({
|
|
118
|
-
accessLevel: tegg_types_1.AccessLevel.PUBLIC,
|
|
119
|
-
})
|
|
120
|
-
], BackgroundTaskHelper);
|
|
121
|
-
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmFja2dyb3VuZFRhc2tIZWxwZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvQmFja2dyb3VuZFRhc2tIZWxwZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsOERBQWlDO0FBRWpDLDBEQUE2RDtBQUM3RCxrREFBZ0Q7QUFFaEQsc0RBQThFO0FBS3ZFLElBQU0sb0JBQW9CLEdBQTFCLE1BQU0sb0JBQW9CO0lBQTFCO1FBSUwsaUNBQWlDO1FBQ2pDLFlBQU8sR0FBRyxJQUFJLENBQUM7UUFLUCxvQkFBZSxHQUF5QixFQUFFLENBQUM7SUFzRnJELENBQUM7SUFwRkMsS0FBSyxDQUFDLElBQUk7O1FBQ1IsTUFBTSxHQUFHLEdBQUcsNkJBQWMsQ0FBQyxVQUFVLEVBQUUsQ0FBQztRQUN4QyxJQUFBLHFCQUFNLEVBQUMsR0FBRyxFQUFFLGdEQUFnRCxDQUFDLENBQUM7UUFDOUQsc0NBQXVCLENBQUMsdUJBQXVCLENBQUMsR0FBRyxFQUFFO1lBQ25ELFVBQVUsRUFBRSxLQUFLLElBQUksRUFBRTtnQkFDckIsTUFBTSxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7WUFDNUIsQ0FBQztTQUNGLENBQUMsQ0FBQztRQUNILElBQUksTUFBQSxJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsMENBQUUsT0FBTyxFQUFFLENBQUM7WUFDeEMsSUFBSSxDQUFDLE9BQU8sR0FBRyxJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxPQUFPLENBQUM7UUFDcEQsQ0FBQztJQUNILENBQUM7SUFFRCxHQUFHLENBQUMsRUFBdUI7UUFDekIsTUFBTSxjQUFjLEdBQUcsSUFBSSxPQUFPLENBQU8sT0FBTyxDQUFDLEVBQUU7WUFDakQsSUFBSSxDQUFDO2dCQUNILEVBQUUsRUFBRTtvQkFDRixrQ0FBa0M7cUJBQ2pDLElBQUksQ0FBQyxPQUFPLENBQUM7cUJBQ2IsS0FBSyxDQUFDLENBQUMsQ0FBQyxFQUFFO29CQUNULENBQUMsQ0FBQyxPQUFPLEdBQUcsZ0RBQWdELEdBQUcsQ0FBQyxDQUFDLE9BQU8sQ0FBQztvQkFDekUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7b0JBQ3JCLG1DQUFtQztvQkFDbkMsT0FBTyxFQUFFLENBQUM7Z0JBQ1osQ0FBQyxDQUFDLENBQUM7WUFDUCxDQUFDO1lBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztnQkFDWCxDQUFDLENBQUMsT0FBTyxHQUFHLHVEQUF1RCxHQUFHLENBQUMsQ0FBQyxPQUFPLENBQUM7Z0JBQ2hGLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxDQUFDO2dCQUNyQix1Q0FBdUM7Z0JBQ3ZDLE9BQU8sRUFBRSxDQUFDO1lBQ1osQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7SUFDNUMsQ0FBQztJQUVELEtBQUssQ0FBQyxZQUFZO1FBQ2hCLGFBQWE7UUFDYixJQUFJLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxNQUFNO1lBQUUsT0FBTztRQUN6QyxNQUFNLGVBQWUsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssRUFBRSxDQUFDO1FBQ3JELElBQUksSUFBSSxDQUFDLE9BQU8sSUFBSSxDQUFDLElBQUksSUFBSSxDQUFDLE9BQU8sS0FBSyxRQUFRLEVBQUUsQ0FBQztZQUNuRCxNQUFNLE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDckMsQ0FBQzthQUFNLENBQUM7WUFDTixNQUFNLEVBQUUsT0FBTyxFQUFFLE9BQU8sRUFBRSxPQUFPLEVBQUUsR0FBRyxJQUFJLENBQUMsS0FBSyxFQUFFLENBQUM7WUFFbkQsTUFBTSxPQUFPLENBQUMsSUFBSSxDQUFDO2dCQUNqQiw2Q0FBNkM7Z0JBQzdDLE9BQU87Z0JBQ1AsaUVBQWlFO2dCQUNqRSxPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsQ0FBQzthQUM3QixDQUFDLENBQUM7WUFDSCxtQ0FBbUM7WUFDbkMsT0FBTyxFQUFFLENBQUM7UUFDWixDQUFDO1FBQ0QsSUFBSSxJQUFJLENBQUMsZUFBZSxDQUFDLE1BQU0sS0FBSyxlQUFlLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDM0QsSUFBSSxDQUFDLGVBQWUsR0FBRyxJQUFJLENBQUMsZUFBZSxDQUFDLEtBQUssQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7WUFDMUUsT0FBTyxJQUFJLENBQUMsWUFBWSxFQUFFLENBQUM7UUFDN0IsQ0FBQztJQUNILENBQUM7SUFFTyxLQUFLO1FBQ1gsSUFBSSxLQUFLLENBQUM7UUFDVixJQUFJLGNBQWMsQ0FBQztRQUNuQixNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUM7UUFFdkIsTUFBTSxDQUFDLEdBQUcsSUFBSSxPQUFPLENBQU8sQ0FBQyxDQUFDLEVBQUU7WUFDOUIsY0FBYyxHQUFHLENBQUMsQ0FBQztZQUNuQixLQUFLLEdBQUcsVUFBVSxDQUFDLEdBQUcsRUFBRTtnQkFDdEIsSUFBSSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsb0RBQW9ELElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxHQUFHLGNBQWMsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDLENBQUM7Z0JBQ3BILENBQUMsRUFBRSxDQUFDO1lBQ04sQ0FBQyxFQUFFLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNuQixDQUFDLENBQUMsQ0FBQztRQUVILFNBQVMsT0FBTztZQUNkLHdDQUF3QztZQUN4QyxZQUFZLENBQUMsS0FBSyxDQUFDLENBQUM7WUFDcEIsY0FBYyxFQUFFLENBQUM7UUFDbkIsQ0FBQztRQUVELE9BQU87WUFDTCxPQUFPLEVBQUUsQ0FBQztZQUNWLE9BQU87U0FDUixDQUFDO0lBQ0osQ0FBQztDQUNGLENBQUE7QUFoR1ksb0RBQW9CO0FBRS9CO0lBREMsSUFBQSx1QkFBTSxHQUFFOztvREFDUztBQU1sQjtJQURDLElBQUEsdUJBQU0sR0FBRTs7b0RBQ1k7K0JBUlYsb0JBQW9CO0lBSGhDLElBQUEsNkJBQVksRUFBQztRQUNaLFdBQVcsRUFBRSx3QkFBVyxDQUFDLE1BQU07S0FDaEMsQ0FBQztHQUNXLG9CQUFvQixDQWdHaEMifQ==
|
|
File without changes
|