@balena/pinejs 18.1.0-build-joshbwlng-tasks-47304ed479923f6db2384964f2c0f6da27e45cc5-3 → 18.1.0-build-joshbwlng-listener-0b0f8758d06970eeb1cc188b8a5e3301897ba8ab-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.
@@ -1,40 +0,0 @@
1
- import type { Types } from '@balena/abstract-sql-to-typescript';
2
- export interface Task {
3
- Read: {
4
- created_at: Types['Date Time']['Read'];
5
- modified_at: Types['Date Time']['Read'];
6
- id: Types['Big Serial']['Read'];
7
- key: Types['Short Text']['Read'] | null;
8
- is_created_by__actor: Types['Integer']['Read'];
9
- is_executed_by__handler: Types['Short Text']['Read'];
10
- is_executed_with__parameter_set: Types['JSON']['Read'] | null;
11
- is_scheduled_with__cron_expression: Types['Short Text']['Read'] | null;
12
- is_scheduled_to_execute_on__time: Types['Date Time']['Read'] | null;
13
- status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
14
- started_on__time: Types['Date Time']['Read'] | null;
15
- ended_on__time: Types['Date Time']['Read'] | null;
16
- error_message: Types['Short Text']['Read'] | null;
17
- attempt_count: Types['Integer']['Read'];
18
- attempt_limit: Types['Integer']['Read'];
19
- };
20
- Write: {
21
- created_at: Types['Date Time']['Write'];
22
- modified_at: Types['Date Time']['Write'];
23
- id: Types['Big Serial']['Write'];
24
- key: Types['Short Text']['Write'] | null;
25
- is_created_by__actor: Types['Integer']['Write'];
26
- is_executed_by__handler: Types['Short Text']['Write'];
27
- is_executed_with__parameter_set: Types['JSON']['Write'] | null;
28
- is_scheduled_with__cron_expression: Types['Short Text']['Write'] | null;
29
- is_scheduled_to_execute_on__time: Types['Date Time']['Write'] | null;
30
- status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
31
- started_on__time: Types['Date Time']['Write'] | null;
32
- ended_on__time: Types['Date Time']['Write'] | null;
33
- error_message: Types['Short Text']['Write'] | null;
34
- attempt_count: Types['Integer']['Write'];
35
- attempt_limit: Types['Integer']['Write'];
36
- };
37
- }
38
- export default interface $Model {
39
- task: Task;
40
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=tasks.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tasks.js","sourceRoot":"","sources":["../../src/tasks/tasks.ts"],"names":[],"mappings":""}
@@ -1,55 +0,0 @@
1
- Vocabulary: tasks
2
-
3
- Term: id
4
- Concept Type: Big Serial (Type)
5
- Term: actor
6
- Concept Type: Integer (Type)
7
- Term: attempt count
8
- Concept Type: Integer (Type)
9
- Term: attempt limit
10
- Concept Type: Integer (Type)
11
- Term: cron expression
12
- Concept Type: Short Text (Type)
13
- Term: error message
14
- Concept Type: Short Text (Type)
15
- Term: handler
16
- Concept Type: Short Text (Type)
17
- Term: key
18
- Concept Type: Short Text (Type)
19
- Term: parameter set
20
- Concept Type: JSON (Type)
21
- Term: status
22
- Concept Type: Short Text (Type)
23
- Term: time
24
- Concept Type: Date Time (Type)
25
-
26
- Term: task
27
- Fact type: task has id
28
- Necessity: each task has exactly one id
29
- Fact type: task has key
30
- Necessity: each task has at most one key
31
- Fact type: task is created by actor
32
- Necessity: each task is created by exactly one actor
33
- Fact type: task is executed by handler
34
- Necessity: each task is executed by exactly one handler
35
- Fact type: task is executed with parameter set
36
- Necessity: each task is executed with at most one parameter set
37
- Fact type: task is scheduled with cron expression
38
- Necessity: each task is scheduled with at most one cron expression
39
- Fact type: task is scheduled to execute on time
40
- Necessity: each task is scheduled to execute on at most one time
41
- Fact type: task has status
42
- Necessity: each task has exactly one status
43
- Definition: "queued" or "cancelled" or "succeeded" or "failed"
44
- Fact type: task started on time
45
- Necessity: each task started on at most one time
46
- Fact type: task ended on time
47
- Necessity: each task ended on at most one time
48
- Fact type: task has error message
49
- Necessity: each task has at most one error message
50
- Fact type: task has attempt count
51
- Necessity: each task has exactly one attempt count
52
- Fact type: task has attempt limit
53
- Necessity: each task has exactly one attempt limit
54
- Necessity: each task has an attempt limit that is greater than or equal to 1
55
-
@@ -1,32 +0,0 @@
1
- import type { ValidateFunction } from 'ajv';
2
- import type { AnyObject } from 'pinejs-client-core';
3
- import { PinejsClient } from '../sbvr-api/sbvr-utils';
4
- import type { Task } from './tasks';
5
- interface TaskArgs {
6
- api: PinejsClient;
7
- params: AnyObject;
8
- }
9
- type TaskResponse = Promise<{
10
- status: Task['Read']['status'];
11
- error?: string;
12
- }>;
13
- export interface TaskHandler {
14
- name: string;
15
- fn: (options: TaskArgs) => TaskResponse;
16
- validate?: ValidateFunction;
17
- }
18
- export declare class Worker {
19
- private readonly client;
20
- handlers: Record<string, TaskHandler>;
21
- private readonly concurrency;
22
- private readonly interval;
23
- private executing;
24
- constructor(client: PinejsClient);
25
- private canExecute;
26
- private execute;
27
- private update;
28
- private getNextAttemptTime;
29
- private poll;
30
- start(): Promise<void>;
31
- }
32
- export {};
@@ -1,224 +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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.Worker = void 0;
27
- const promises_1 = require("node:timers/promises");
28
- const env_1 = require("../config-loader/env");
29
- const permissions = __importStar(require("../sbvr-api/permissions"));
30
- const sbvr_utils_1 = require("../sbvr-api/sbvr-utils");
31
- const module_1 = require("../server-glue/module");
32
- const common_1 = require("./common");
33
- const selectColumns = Object.entries({
34
- id: 'id',
35
- 'is executed by-handler': 'is_executed_by__handler',
36
- 'is executed with-parameter set': 'is_executed_with__parameter_set',
37
- 'is scheduled with-cron expression': 'is_scheduled_with__cron_expression',
38
- 'attempt count': 'attempt_count',
39
- 'attempt limit': 'attempt_limit',
40
- 'is created by-actor': 'is_created_by__actor',
41
- })
42
- .map(([key, value]) => `t."${key}" AS "${value}"`)
43
- .join(', ');
44
- class Worker {
45
- client;
46
- handlers = {};
47
- concurrency;
48
- interval;
49
- executing = 0;
50
- constructor(client) {
51
- this.client = client;
52
- this.concurrency = env_1.tasks.queueConcurrency;
53
- this.interval = env_1.tasks.queueIntervalMS;
54
- }
55
- canExecute() {
56
- return (this.executing < this.concurrency && Object.keys(this.handlers).length > 0);
57
- }
58
- async execute(task, tx) {
59
- this.executing++;
60
- try {
61
- const handler = this.handlers[task.is_executed_by__handler];
62
- const startedOnTime = new Date();
63
- if (handler == null) {
64
- await this.update(tx, task, startedOnTime, 'failed', 'Matching task handler not found, this should never happen!');
65
- return;
66
- }
67
- if (handler.validate != null &&
68
- !handler.validate(task.is_executed_with__parameter_set)) {
69
- await this.update(tx, task, startedOnTime, 'failed', `Invalid parameter set: ${common_1.ajv.errorsText(handler.validate.errors)}`);
70
- return;
71
- }
72
- let status = 'queued';
73
- let error;
74
- try {
75
- const results = await handler.fn({
76
- api: new sbvr_utils_1.PinejsClient({}),
77
- params: task.is_executed_with__parameter_set ?? {},
78
- });
79
- status = results.status;
80
- error = results.error;
81
- }
82
- finally {
83
- await this.update(tx, task, startedOnTime, status, error);
84
- }
85
- }
86
- catch (err) {
87
- console.error(`Failed to execute task ${task.id} with handler ${task.is_executed_by__handler}:`, err);
88
- process.exit(1);
89
- }
90
- finally {
91
- this.executing--;
92
- }
93
- }
94
- async update(tx, task, startedOnTime, status, errorMessage) {
95
- const attemptCount = task.attempt_count + 1;
96
- const body = {
97
- started_on__time: startedOnTime,
98
- ended_on__time: new Date(),
99
- status,
100
- attempt_count: attemptCount,
101
- ...(errorMessage != null && { error_message: errorMessage }),
102
- };
103
- if (status === 'failed' && attemptCount < task.attempt_limit) {
104
- body.status = 'queued';
105
- body.is_scheduled_to_execute_on__time =
106
- this.getNextAttemptTime(attemptCount);
107
- }
108
- await this.client.patch({
109
- resource: 'task',
110
- passthrough: {
111
- tx,
112
- req: permissions.root,
113
- },
114
- id: task.id,
115
- body,
116
- });
117
- if (body.status != null &&
118
- ['failed', 'succeeded'].includes(body.status) &&
119
- task.is_scheduled_with__cron_expression != null) {
120
- await this.client.post({
121
- resource: 'task',
122
- passthrough: {
123
- tx,
124
- req: permissions.root,
125
- },
126
- options: {
127
- returnResource: false,
128
- },
129
- body: {
130
- attempt_limit: task.attempt_limit,
131
- is_created_by__actor: task.is_created_by__actor,
132
- is_executed_by__handler: task.is_executed_by__handler,
133
- is_executed_with__parameter_set: task.is_executed_with__parameter_set,
134
- is_scheduled_with__cron_expression: task.is_scheduled_with__cron_expression,
135
- },
136
- });
137
- }
138
- }
139
- getNextAttemptTime(attempt) {
140
- const delay = Math.ceil(Math.exp(Math.min(10, attempt)));
141
- return new Date(Date.now() + delay);
142
- }
143
- poll() {
144
- let executed = false;
145
- void (async () => {
146
- try {
147
- if (!this.canExecute()) {
148
- return;
149
- }
150
- const handlerNames = Object.keys(this.handlers);
151
- await module_1.sbvrUtils.db.transaction(async (tx) => {
152
- const result = await module_1.sbvrUtils.db.executeSql(`SELECT ${selectColumns}
153
- FROM task AS t
154
- WHERE
155
- t."is executed by-handler" IN (${handlerNames.map((_, index) => `$${index + 1}`).join(', ')}) AND
156
- t."status" = 'queued' AND
157
- t."attempt count" <= t."attempt limit" AND
158
- (
159
- t."is scheduled to execute on-time" IS NULL OR
160
- t."is scheduled to execute on-time" <= CURRENT_TIMESTAMP + $${handlerNames.length + 1} * INTERVAL '1 SECOND'
161
- )
162
- ORDER BY
163
- t."is scheduled to execute on-time" ASC,
164
- t."id" ASC
165
- LIMIT 1 FOR UPDATE SKIP LOCKED`, [...handlerNames, Math.ceil(this.interval / 1000)]);
166
- if (result.rows.length > 0) {
167
- await this.execute(result.rows[0], tx);
168
- executed = true;
169
- }
170
- });
171
- }
172
- catch (err) {
173
- console.error('Failed polling for tasks:', err);
174
- }
175
- finally {
176
- if (!executed) {
177
- await (0, promises_1.setTimeout)(this.interval);
178
- }
179
- this.poll();
180
- }
181
- })();
182
- }
183
- async start() {
184
- if (module_1.sbvrUtils.db.engine !== 'postgres' || module_1.sbvrUtils.db.on == null) {
185
- throw new Error('Database does not support tasks, giving up on starting worker');
186
- }
187
- const tasksWithUnknownHandlers = await this.client.get({
188
- resource: 'task',
189
- passthrough: {
190
- req: permissions.root,
191
- },
192
- options: {
193
- $filter: {
194
- status: 'queued',
195
- $not: {
196
- is_executed_by__handler: { $in: Object.keys(this.handlers) },
197
- },
198
- },
199
- },
200
- });
201
- if (tasksWithUnknownHandlers.length > 0) {
202
- throw new Error(`Found tasks with unknown handlers: ${tasksWithUnknownHandlers
203
- .map((task) => `${task.id}(${task.is_executed_by__handler})`)
204
- .join(', ')}`);
205
- }
206
- module_1.sbvrUtils.db.on('notification', async (msg) => {
207
- if (this.canExecute()) {
208
- await module_1.sbvrUtils.db.transaction(async (tx) => {
209
- const result = await module_1.sbvrUtils.db.executeSql(`SELECT ${selectColumns} FROM task AS t WHERE id = $1 FOR UPDATE SKIP LOCKED`, [msg.payload]);
210
- if (result.rows.length > 0) {
211
- await this.execute(result.rows[0], tx);
212
- }
213
- });
214
- }
215
- }, {
216
- channel: common_1.channel,
217
- });
218
- for (let i = 0; i < this.concurrency; i++) {
219
- this.poll();
220
- }
221
- }
222
- }
223
- exports.Worker = Worker;
224
- //# sourceMappingURL=worker.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"worker.js","sourceRoot":"","sources":["../../src/tasks/worker.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,mDAAkD;AAElD,8CAAyD;AAEzD,qEAAuD;AACvD,uDAAsD;AACtD,kDAAkD;AAClD,qCAAwC;AA+BxC,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC;IACpC,EAAE,EAAE,IAAI;IACR,wBAAwB,EAAE,yBAAyB;IACnD,gCAAgC,EAAE,iCAAiC;IACnE,mCAAmC,EAAE,oCAAoC;IACzE,eAAe,EAAE,eAAe;IAChC,eAAe,EAAE,eAAe;IAChC,qBAAqB,EAAE,sBAAsB;CACA,CAAC;KAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,SAAS,KAAK,GAAG,CAAC;KACjD,IAAI,CAAC,IAAI,CAAC,CAAC;AAKb,MAAa,MAAM;IAMW;IALtB,QAAQ,GAAgC,EAAE,CAAC;IACjC,WAAW,CAAS;IACpB,QAAQ,CAAS;IAC1B,SAAS,GAAG,CAAC,CAAC;IAEtB,YAA6B,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;QAChD,IAAI,CAAC,WAAW,GAAG,WAAQ,CAAC,gBAAgB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,WAAQ,CAAC,eAAe,CAAC;IAC1C,CAAC;IAGO,UAAU;QACjB,OAAO,CACN,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAC1E,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,IAAiB,EAAE,EAAS;QACjD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,IAAI,CAAC;YAEJ,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,IAAI,IAAI,EAAE,CAAC;YAGjC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,IAAI,CAAC,MAAM,CAChB,EAAE,EACF,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,4DAA4D,CAC5D,CAAC;gBACF,OAAO;YACR,CAAC;YAKD,IACC,OAAO,CAAC,QAAQ,IAAI,IAAI;gBACxB,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,+BAA+B,CAAC,EACtD,CAAC;gBACF,MAAM,IAAI,CAAC,MAAM,CAChB,EAAE,EACF,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,0BAA0B,YAAG,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CACnE,CAAC;gBACF,OAAO;YACR,CAAC;YAGD,IAAI,MAAM,GAA2B,QAAQ,CAAC;YAC9C,IAAI,KAAyB,CAAC;YAC9B,IAAI,CAAC;gBACJ,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,EAAE,CAAC;oBAChC,GAAG,EAAE,IAAI,yBAAY,CAAC,EAAE,CAAC;oBACzB,MAAM,EAAE,IAAI,CAAC,+BAA+B,IAAI,EAAE;iBAClD,CAAC,CAAC;gBACH,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBACxB,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;YACvB,CAAC;oBAAS,CAAC;gBACV,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAC3D,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YAEd,OAAO,CAAC,KAAK,CACZ,0BAA0B,IAAI,CAAC,EAAE,iBAAiB,IAAI,CAAC,uBAAuB,GAAG,EACjF,GAAG,CACH,CAAC;YACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;gBAAS,CAAC;YACV,IAAI,CAAC,SAAS,EAAE,CAAC;QAClB,CAAC;IACF,CAAC;IAGO,KAAK,CAAC,MAAM,CACnB,EAAS,EACT,IAAiB,EACjB,aAAmB,EACnB,MAA8B,EAC9B,YAAqB;QAErB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QAC5C,MAAM,IAAI,GAA2B;YACpC,gBAAgB,EAAE,aAAa;YAC/B,cAAc,EAAE,IAAI,IAAI,EAAE;YAC1B,MAAM;YACN,aAAa,EAAE,YAAY;YAC3B,GAAG,CAAC,YAAY,IAAI,IAAI,IAAI,EAAE,aAAa,EAAE,YAAY,EAAE,CAAC;SAC5D,CAAC;QAIF,IAAI,MAAM,KAAK,QAAQ,IAAI,YAAY,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9D,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;YAGvB,IAAI,CAAC,gCAAgC;gBACpC,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACxC,CAAC;QAGD,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;YACvB,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE;gBACZ,EAAE;gBACF,GAAG,EAAE,WAAW,CAAC,IAAI;aACrB;YACD,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI;SACJ,CAAC,CAAC;QAIH,IACC,IAAI,CAAC,MAAM,IAAI,IAAI;YACnB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;YAC7C,IAAI,CAAC,kCAAkC,IAAI,IAAI,EAC9C,CAAC;YACF,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACtB,QAAQ,EAAE,MAAM;gBAChB,WAAW,EAAE;oBACZ,EAAE;oBACF,GAAG,EAAE,WAAW,CAAC,IAAI;iBACrB;gBACD,OAAO,EAAE;oBACR,cAAc,EAAE,KAAK;iBACrB;gBACD,IAAI,EAAE;oBACL,aAAa,EAAE,IAAI,CAAC,aAAa;oBACjC,oBAAoB,EAAE,IAAI,CAAC,oBAAoB;oBAC/C,uBAAuB,EAAE,IAAI,CAAC,uBAAuB;oBACrD,+BAA+B,EAAE,IAAI,CAAC,+BAA+B;oBACrE,kCAAkC,EACjC,IAAI,CAAC,kCAAkC;iBACxC;aACD,CAAC,CAAC;QACJ,CAAC;IACF,CAAC;IAGO,kBAAkB,CAAC,OAAe;QACzC,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;QACzD,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;IACrC,CAAC;IAIO,IAAI;QACX,IAAI,QAAQ,GAAG,KAAK,CAAC;QACrB,KAAK,CAAC,KAAK,IAAI,EAAE;YAChB,IAAI,CAAC;gBACJ,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;oBACxB,OAAO;gBACR,CAAC;gBACD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAChD,MAAM,kBAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;oBAC3C,MAAM,MAAM,GAAG,MAAM,kBAAS,CAAC,EAAE,CAAC,UAAU,CAC3C,UAAU,aAAa;;;wCAGW,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;sEAK5B,YAAY,CAAC,MAAM,GAAG,CAAC;;;;;qCAKxD,EAC/B,CAAC,GAAG,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAClD,CAAC;oBAGF,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAgB,EAAE,EAAE,CAAC,CAAC;wBACtD,QAAQ,GAAG,IAAI,CAAC;oBACjB,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACd,OAAO,CAAC,KAAK,CAAC,2BAA2B,EAAE,GAAG,CAAC,CAAC;YACjD,CAAC;oBAAS,CAAC;gBACV,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACf,MAAM,IAAA,qBAAU,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACjC,CAAC;gBACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACb,CAAC;QACF,CAAC,CAAC,EAAE,CAAC;IACN,CAAC;IAGM,KAAK,CAAC,KAAK;QAEjB,IAAI,kBAAS,CAAC,EAAE,CAAC,MAAM,KAAK,UAAU,IAAI,kBAAS,CAAC,EAAE,CAAC,EAAE,IAAI,IAAI,EAAE,CAAC;YACnE,MAAM,IAAI,KAAK,CACd,+DAA+D,CAC/D,CAAC;QACH,CAAC;QAGD,MAAM,wBAAwB,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;YACtD,QAAQ,EAAE,MAAM;YAChB,WAAW,EAAE;gBACZ,GAAG,EAAE,WAAW,CAAC,IAAI;aACrB;YACD,OAAO,EAAE;gBACR,OAAO,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,IAAI,EAAE;wBACL,uBAAuB,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;qBAC5D;iBACD;aACD;SACD,CAAC,CAAC;QACH,IAAI,wBAAwB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACd,sCAAsC,wBAAwB;iBAC5D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,uBAAuB,GAAG,CAAC;iBAC5D,IAAI,CAAC,IAAI,CAAC,EAAE,CACd,CAAC;QACH,CAAC;QAED,kBAAS,CAAC,EAAE,CAAC,EAAE,CACd,cAAc,EACd,KAAK,EAAE,GAAG,EAAE,EAAE;YACb,IAAI,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC;gBACvB,MAAM,kBAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE;oBAC3C,MAAM,MAAM,GAAG,MAAM,kBAAS,CAAC,EAAE,CAAC,UAAU,CAC3C,UAAU,aAAa,sDAAsD,EAC7E,CAAC,GAAG,CAAC,OAAO,CAAC,CACb,CAAC;oBACF,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC5B,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAgB,EAAE,EAAE,CAAC,CAAC;oBACvD,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC;QACF,CAAC,EACD;YACC,OAAO,EAAP,gBAAO;SACP,CACD,CAAC;QAGF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,IAAI,CAAC,IAAI,EAAE,CAAC;QACb,CAAC;IACF,CAAC;CACD;AA9PD,wBA8PC"}
@@ -1,9 +0,0 @@
1
- import Ajv from 'ajv';
2
-
3
- // Root path for the tasks API
4
- export const apiRoot = 'tasks';
5
-
6
- // Channel name for triggering task executions
7
- export const channel = 'pinejs$execute_task';
8
-
9
- export const ajv = new Ajv();
@@ -1,152 +0,0 @@
1
- import type { Schema } from 'ajv';
2
- import * as cronParser from 'cron-parser';
3
- import { tasks as tasksEnv } from '../config-loader/env';
4
- import { addPureHook } from '../sbvr-api/hooks';
5
- import * as sbvrUtils from '../sbvr-api/sbvr-utils';
6
- import type { ConfigLoader } from '../server-glue/module';
7
- import { ajv, apiRoot, channel } from './common';
8
- import type { TaskHandler } from './worker';
9
- import { Worker } from './worker';
10
-
11
- export type * from './tasks';
12
-
13
- // eslint-disable-next-line @typescript-eslint/no-var-requires
14
- const modelText: string = require('./tasks.sbvr');
15
-
16
- // Create trigger for handling new tasks
17
- // Create index for polling tasks table
18
- const initSql = `
19
- CREATE OR REPLACE FUNCTION notify_execute_task()
20
- RETURNS TRIGGER AS $$
21
- BEGIN
22
- PERFORM pg_notify('${channel}', NEW.id::text);
23
- RETURN NEW;
24
- END;
25
- $$ LANGUAGE plpgsql;
26
-
27
- CREATE OR REPLACE TRIGGER execute_task_trigger
28
- AFTER INSERT ON task
29
- FOR EACH ROW WHEN (NEW.status = 'queued' AND NEW."is scheduled to execute on-time" IS NULL)
30
- EXECUTE FUNCTION notify_execute_task();
31
-
32
- CREATE INDEX IF NOT EXISTS idx_task_poll ON task USING btree (
33
- "is executed by-handler",
34
- "is scheduled to execute on-time" ASC,
35
- "id" ASC
36
- ) WHERE status = 'queued';
37
- `;
38
-
39
- export const config: ConfigLoader.Config = {
40
- models: [
41
- {
42
- modelName: apiRoot,
43
- apiRoot,
44
- modelText,
45
- customServerCode: exports,
46
- initSql,
47
- },
48
- ],
49
- };
50
-
51
- export let worker: Worker | null = null;
52
- export async function setup(): Promise<void> {
53
- // Async task functionality is only supported on Postgres
54
- if (sbvrUtils.db.engine !== 'postgres') {
55
- console.warn('Skipping task setup as database not supported');
56
- return;
57
- }
58
-
59
- const client = sbvrUtils.api[apiRoot];
60
- worker = new Worker(client);
61
-
62
- // Add resource hooks
63
- addPureHook('POST', apiRoot, 'task', {
64
- POSTPARSE: async ({ req, request }) => {
65
- // Set the actor
66
- request.values.is_created_by__actor =
67
- req.user?.actor ?? req.apiKey?.actor;
68
- if (request.values.is_created_by__actor == null) {
69
- throw new Error(
70
- 'Creating tasks with missing actor on req is not allowed',
71
- );
72
- }
73
-
74
- // Set defaults
75
- request.values.status = 'queued';
76
- request.values.attempt_count = 0;
77
- request.values.attempt_limit ??= 1;
78
-
79
- // Set scheduled start time using cron expression if provided
80
- if (
81
- request.values.is_scheduled_with__cron_expression != null &&
82
- request.values.is_scheduled_to_execute_on__time == null
83
- ) {
84
- try {
85
- request.values.is_scheduled_to_execute_on__time = cronParser
86
- .parseExpression(request.values.is_scheduled_with__cron_expression)
87
- .next()
88
- .toDate()
89
- .toISOString();
90
- } catch {
91
- throw new Error(
92
- `Invalid cron expression: ${request.values.is_scheduled_with__cron_expression}`,
93
- );
94
- }
95
- }
96
-
97
- // Assert that the provided start time is far enough in the future
98
- if (request.values.is_scheduled_to_execute_on__time != null) {
99
- const now = new Date(Date.now() + tasksEnv.queueIntervalMS);
100
- const startTime = new Date(
101
- request.values.is_scheduled_to_execute_on__time,
102
- );
103
- if (startTime < now) {
104
- throw new Error(
105
- `Task scheduled start time must be greater than ${tasksEnv.queueIntervalMS} milliseconds in the future`,
106
- );
107
- }
108
- }
109
-
110
- // Assert that the requested handler exists
111
- const handlerName = request.values.is_executed_by__handler;
112
- if (handlerName == null) {
113
- throw new Error(`Must specify a task handler to execute`);
114
- }
115
- const handler = worker?.handlers[handlerName];
116
- if (handler == null) {
117
- throw new Error(
118
- `No task handler with name '${handlerName}' registered`,
119
- );
120
- }
121
-
122
- // Assert that the provided parameter set is valid
123
- if (handler.validate != null) {
124
- if (!handler.validate(request.values.is_executed_with__parameter_set)) {
125
- throw new Error(
126
- `Invalid parameter set: ${ajv.errorsText(handler.validate.errors)}`,
127
- );
128
- }
129
- }
130
- },
131
- });
132
- }
133
-
134
- // Register a task handler
135
- export function addTaskHandler(
136
- name: string,
137
- fn: TaskHandler['fn'],
138
- schema?: Schema,
139
- ): void {
140
- if (worker == null) {
141
- throw new Error('Database does not support tasks');
142
- }
143
-
144
- if (worker.handlers[name] != null) {
145
- throw new Error(`Task handler with name '${name}' already registered`);
146
- }
147
- worker.handlers[name] = {
148
- name,
149
- fn,
150
- validate: schema != null ? ajv.compile(schema) : undefined,
151
- };
152
- }
@@ -1,55 +0,0 @@
1
- Vocabulary: tasks
2
-
3
- Term: id
4
- Concept Type: Big Serial (Type)
5
- Term: actor
6
- Concept Type: Integer (Type)
7
- Term: attempt count
8
- Concept Type: Integer (Type)
9
- Term: attempt limit
10
- Concept Type: Integer (Type)
11
- Term: cron expression
12
- Concept Type: Short Text (Type)
13
- Term: error message
14
- Concept Type: Short Text (Type)
15
- Term: handler
16
- Concept Type: Short Text (Type)
17
- Term: key
18
- Concept Type: Short Text (Type)
19
- Term: parameter set
20
- Concept Type: JSON (Type)
21
- Term: status
22
- Concept Type: Short Text (Type)
23
- Term: time
24
- Concept Type: Date Time (Type)
25
-
26
- Term: task
27
- Fact type: task has id
28
- Necessity: each task has exactly one id
29
- Fact type: task has key
30
- Necessity: each task has at most one key
31
- Fact type: task is created by actor
32
- Necessity: each task is created by exactly one actor
33
- Fact type: task is executed by handler
34
- Necessity: each task is executed by exactly one handler
35
- Fact type: task is executed with parameter set
36
- Necessity: each task is executed with at most one parameter set
37
- Fact type: task is scheduled with cron expression
38
- Necessity: each task is scheduled with at most one cron expression
39
- Fact type: task is scheduled to execute on time
40
- Necessity: each task is scheduled to execute on at most one time
41
- Fact type: task has status
42
- Necessity: each task has exactly one status
43
- Definition: "queued" or "cancelled" or "succeeded" or "failed"
44
- Fact type: task started on time
45
- Necessity: each task started on at most one time
46
- Fact type: task ended on time
47
- Necessity: each task ended on at most one time
48
- Fact type: task has error message
49
- Necessity: each task has at most one error message
50
- Fact type: task has attempt count
51
- Necessity: each task has exactly one attempt count
52
- Fact type: task has attempt limit
53
- Necessity: each task has exactly one attempt limit
54
- Necessity: each task has an attempt limit that is greater than or equal to 1
55
-
@@ -1,46 +0,0 @@
1
- // These types were generated by @balena/abstract-sql-to-typescript v4.0.0
2
-
3
- import type { Types } from '@balena/abstract-sql-to-typescript';
4
-
5
- export interface Task {
6
- Read: {
7
- created_at: Types['Date Time']['Read'];
8
- modified_at: Types['Date Time']['Read'];
9
- id: Types['Big Serial']['Read'];
10
- key: Types['Short Text']['Read'] | null;
11
- is_created_by__actor: Types['Integer']['Read'];
12
- is_executed_by__handler: Types['Short Text']['Read'];
13
- is_executed_with__parameter_set: Types['JSON']['Read'] | null;
14
- is_scheduled_with__cron_expression: Types['Short Text']['Read'] | null;
15
- is_scheduled_to_execute_on__time: Types['Date Time']['Read'] | null;
16
- status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
17
- started_on__time: Types['Date Time']['Read'] | null;
18
- ended_on__time: Types['Date Time']['Read'] | null;
19
- error_message: Types['Short Text']['Read'] | null;
20
- attempt_count: Types['Integer']['Read'];
21
- attempt_limit: Types['Integer']['Read'];
22
- };
23
- Write: {
24
- created_at: Types['Date Time']['Write'];
25
- modified_at: Types['Date Time']['Write'];
26
- id: Types['Big Serial']['Write'];
27
- key: Types['Short Text']['Write'] | null;
28
- is_created_by__actor: Types['Integer']['Write'];
29
- is_executed_by__handler: Types['Short Text']['Write'];
30
- is_executed_with__parameter_set: Types['JSON']['Write'] | null;
31
- is_scheduled_with__cron_expression: Types['Short Text']['Write'] | null;
32
- is_scheduled_to_execute_on__time: Types['Date Time']['Write'] | null;
33
- status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
34
- started_on__time: Types['Date Time']['Write'] | null;
35
- ended_on__time: Types['Date Time']['Write'] | null;
36
- error_message: Types['Short Text']['Write'] | null;
37
- attempt_count: Types['Integer']['Write'];
38
- attempt_limit: Types['Integer']['Write'];
39
- };
40
- }
41
-
42
- export default interface $Model {
43
- task: Task;
44
-
45
-
46
- }