@kne/fastify-task 3.0.0-alpha.0 → 3.0.0-alpha.10
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 +1052 -255
- package/index.js +14 -4
- package/libs/controllers/main.js +4 -3
- package/libs/helpers/task-service-context.js +556 -0
- package/libs/models/task.js +6 -1
- package/libs/services/append.js +45 -0
- package/libs/services/callback.js +109 -0
- package/libs/services/executor.js +10 -0
- package/libs/services/main.js +7 -674
- package/libs/services/scheduler.js +230 -0
- package/libs/services/statistics.js +614 -38
- package/libs/services/task.js +224 -0
- package/package.json +3 -2
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
const fp = require('fastify-plugin');
|
|
2
|
+
const getTaskServiceContext = require('../helpers/task-service-context');
|
|
3
|
+
|
|
4
|
+
module.exports = fp(async (fastify, options) => {
|
|
5
|
+
const context = getTaskServiceContext(fastify, options);
|
|
6
|
+
const { models, Op } = context;
|
|
7
|
+
const SORTABLE_FIELDS = new Set(['id', 'targetId', 'targetType', 'type', 'status', 'runnerType', 'priority', 'createdAt', 'updatedAt', 'startTime', 'startedAt', 'completedAt']);
|
|
8
|
+
|
|
9
|
+
const cancel = async ({ id, targetId, targetType, type }) => {
|
|
10
|
+
if (!id && !(targetId && targetType && type)) {
|
|
11
|
+
throw new Error('必须提供 id 或 targetId+targetType+type');
|
|
12
|
+
}
|
|
13
|
+
if (targetId && targetType && type) {
|
|
14
|
+
const bulkWhere = {
|
|
15
|
+
targetId,
|
|
16
|
+
targetType,
|
|
17
|
+
type,
|
|
18
|
+
status: {
|
|
19
|
+
[Op.in]: ['pending', 'running']
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
const tasksToCancel = await models.task.findAll({ where: bulkWhere, raw: true });
|
|
23
|
+
const completedAt = new Date();
|
|
24
|
+
const [affectedCount] = await models.task.update(
|
|
25
|
+
{
|
|
26
|
+
status: 'canceled',
|
|
27
|
+
completedAt
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
where: bulkWhere
|
|
31
|
+
}
|
|
32
|
+
);
|
|
33
|
+
for (const row of tasksToCancel) {
|
|
34
|
+
context.collectTaskStatistics(Object.assign({}, row, { status: 'canceled', completedAt }));
|
|
35
|
+
}
|
|
36
|
+
return affectedCount;
|
|
37
|
+
}
|
|
38
|
+
if (id) {
|
|
39
|
+
const task = await context.detail({ id });
|
|
40
|
+
const transitioned = await context.updateTaskByStatus({
|
|
41
|
+
task,
|
|
42
|
+
allowedStatuses: ['pending', 'running'],
|
|
43
|
+
updateData: {
|
|
44
|
+
status: 'canceled',
|
|
45
|
+
completedAt: new Date()
|
|
46
|
+
}
|
|
47
|
+
});
|
|
48
|
+
if (!transitioned) {
|
|
49
|
+
return;
|
|
50
|
+
}
|
|
51
|
+
context.collectTaskStatistics(task);
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
|
|
55
|
+
const complete = async ({ id, userId, output, ...props }) => {
|
|
56
|
+
const task = await context.detail({ id });
|
|
57
|
+
if (props.status === 'success') {
|
|
58
|
+
try {
|
|
59
|
+
await context.finalizeSuccess({ task, output, userId });
|
|
60
|
+
} catch (e) {
|
|
61
|
+
await context.failTask({ task, error: e, updateData: Object.assign({}, props, { output, completedUserId: userId }) });
|
|
62
|
+
throw e;
|
|
63
|
+
}
|
|
64
|
+
} else {
|
|
65
|
+
await context.failTask({ task, error: props.error || '任务失败', updateData: Object.assign({}, props, { completedUserId: userId }) });
|
|
66
|
+
}
|
|
67
|
+
};
|
|
68
|
+
|
|
69
|
+
const waitingComplete = async ({ id, pollInterval = 1000, maxPollTimes = 20 }) => {
|
|
70
|
+
let task = await context.detail({ id });
|
|
71
|
+
|
|
72
|
+
if (task.status === 'pending') {
|
|
73
|
+
await context.updateTaskByStatus({
|
|
74
|
+
task,
|
|
75
|
+
allowedStatuses: ['pending'],
|
|
76
|
+
updateData: { priority: Number.MAX_SAFE_INTEGER }
|
|
77
|
+
});
|
|
78
|
+
const claimedTask = await fastify[options.name].services.claimTask(task);
|
|
79
|
+
if (claimedTask) {
|
|
80
|
+
await fastify[options.name].services.processSystemTask(claimedTask, { claimed: true });
|
|
81
|
+
task = claimedTask;
|
|
82
|
+
}
|
|
83
|
+
await task.reload();
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
if (task.status === 'success') {
|
|
87
|
+
return task.output;
|
|
88
|
+
}
|
|
89
|
+
if (task.status === 'failed') {
|
|
90
|
+
throw new Error(task.error || '任务失败');
|
|
91
|
+
}
|
|
92
|
+
if (task.status === 'canceled') {
|
|
93
|
+
throw new Error(task.error || '任务取消');
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
let pollCount = 0;
|
|
97
|
+
return await new Promise((resolve, reject) => {
|
|
98
|
+
const executePolling = async () => {
|
|
99
|
+
try {
|
|
100
|
+
pollCount++;
|
|
101
|
+
if (pollCount > maxPollTimes) {
|
|
102
|
+
reject(new Error('任务超时'));
|
|
103
|
+
return;
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
await task.reload();
|
|
107
|
+
const { status, output, error } = task;
|
|
108
|
+
|
|
109
|
+
if (status === 'success') {
|
|
110
|
+
resolve(output);
|
|
111
|
+
return;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
if (status === 'failed' || status === 'canceled') {
|
|
115
|
+
reject(new Error(error || `任务${status === 'failed' ? '失败' : '取消'}`));
|
|
116
|
+
return;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
setTimeout(executePolling, pollInterval);
|
|
120
|
+
} catch (e) {
|
|
121
|
+
reject(e);
|
|
122
|
+
}
|
|
123
|
+
};
|
|
124
|
+
setTimeout(executePolling, pollInterval);
|
|
125
|
+
});
|
|
126
|
+
};
|
|
127
|
+
|
|
128
|
+
const getTimeQuery = fieldValue => {
|
|
129
|
+
const { startTime, endTime } = fieldValue;
|
|
130
|
+
if (!!startTime && !!endTime) {
|
|
131
|
+
return {
|
|
132
|
+
[Op.between]: [new Date(startTime), new Date(endTime)]
|
|
133
|
+
};
|
|
134
|
+
} else if (!!startTime) {
|
|
135
|
+
return {
|
|
136
|
+
[Op.gte]: new Date(startTime)
|
|
137
|
+
};
|
|
138
|
+
} else if (!!endTime) {
|
|
139
|
+
return {
|
|
140
|
+
[Op.lte]: new Date(endTime)
|
|
141
|
+
};
|
|
142
|
+
}
|
|
143
|
+
};
|
|
144
|
+
|
|
145
|
+
const list = async ({ filter, perPage = 20, currentPage = 1, sort }) => {
|
|
146
|
+
const whereQuery = {};
|
|
147
|
+
|
|
148
|
+
['id', 'targetId', 'type', 'status', 'runnerType'].forEach(key => {
|
|
149
|
+
if (filter && filter[key]) {
|
|
150
|
+
whereQuery[key] = filter[key];
|
|
151
|
+
}
|
|
152
|
+
});
|
|
153
|
+
|
|
154
|
+
if (filter && filter.createdAt) {
|
|
155
|
+
whereQuery.createdAt = getTimeQuery(filter.createdAt);
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
if (filter && filter.completedAt) {
|
|
159
|
+
whereQuery.completedAt = getTimeQuery(filter.completedAt);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
let order = [['createdAt', 'DESC']];
|
|
163
|
+
|
|
164
|
+
if (sort && Object.keys(sort).length > 0) {
|
|
165
|
+
order = Object.entries(sort).map(([key, direction]) => {
|
|
166
|
+
if (!SORTABLE_FIELDS.has(key)) {
|
|
167
|
+
throw new Error(`不支持的排序字段:${key}`);
|
|
168
|
+
}
|
|
169
|
+
const normalizedDirection = String(direction || '').toUpperCase();
|
|
170
|
+
if (!['ASC', 'DESC'].includes(normalizedDirection)) {
|
|
171
|
+
throw new Error(`不支持的排序方向:${direction}`);
|
|
172
|
+
}
|
|
173
|
+
return [key, normalizedDirection];
|
|
174
|
+
});
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
const { rows, count } = await models.task.findAndCountAll({
|
|
178
|
+
where: Object.assign({}, whereQuery),
|
|
179
|
+
offset: perPage * (currentPage - 1),
|
|
180
|
+
limit: perPage,
|
|
181
|
+
order: order
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
return {
|
|
185
|
+
pageData: rows,
|
|
186
|
+
totalCount: count
|
|
187
|
+
};
|
|
188
|
+
};
|
|
189
|
+
|
|
190
|
+
const retryFunc = async ({ id }) => {
|
|
191
|
+
const task = await context.detail({ id });
|
|
192
|
+
if (['failed', 'canceled'].indexOf(task.status) === -1) {
|
|
193
|
+
throw new Error('只有失败或取消的任务允许重试');
|
|
194
|
+
}
|
|
195
|
+
await task.update({
|
|
196
|
+
status: 'pending',
|
|
197
|
+
completedAt: null,
|
|
198
|
+
completedUserId: null,
|
|
199
|
+
retryCount: 0,
|
|
200
|
+
error: null
|
|
201
|
+
});
|
|
202
|
+
};
|
|
203
|
+
|
|
204
|
+
const retry = async ({ id, taskIds }) => {
|
|
205
|
+
if (id) {
|
|
206
|
+
await retryFunc({ id });
|
|
207
|
+
}
|
|
208
|
+
if (taskIds && taskIds.length > 0) {
|
|
209
|
+
for (const taskId of taskIds) {
|
|
210
|
+
await retryFunc({ id: taskId });
|
|
211
|
+
}
|
|
212
|
+
}
|
|
213
|
+
};
|
|
214
|
+
|
|
215
|
+
Object.assign(fastify[options.name].services, {
|
|
216
|
+
create: context.create,
|
|
217
|
+
detail: context.detail,
|
|
218
|
+
list,
|
|
219
|
+
complete,
|
|
220
|
+
cancel,
|
|
221
|
+
retry,
|
|
222
|
+
waitingComplete
|
|
223
|
+
});
|
|
224
|
+
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kne/fastify-task",
|
|
3
|
-
"version": "3.0.0-alpha.
|
|
3
|
+
"version": "3.0.0-alpha.10",
|
|
4
4
|
"description": "一个 Fastify 插件,用于任务编排、追踪任务执行状态和结果。支持系统自动执行和手动执行两种模式,提供完整的任务生命周期管理",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -56,7 +56,8 @@
|
|
|
56
56
|
"sqlite3": "^5.1.7"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@kne/fastify-statistics": "^0.1.
|
|
59
|
+
"@kne/fastify-statistics": "^0.1.1",
|
|
60
|
+
"dayjs": "^1.11.20",
|
|
60
61
|
"fastify-cron": "^1.4.0",
|
|
61
62
|
"fs-extra": "^11.3.0"
|
|
62
63
|
}
|