@balena/pinejs 17.1.0-build-joshbwlng-tasks-9f3f42ef1bf62714507bacc7842e99841b116d94-1 → 17.1.0-build-model-based-typings-c276ef4fb8482a246c25940d617d76b76847eff8-1

package/out/tasks/tasks.sbvr

@@ -1,55 +0,0 @@
-Vocabulary: tasks
-
-Term: id
-    Concept Type: Big Serial (Type)
-Term: actor
-	Concept Type: Integer (Type)
-Term: attempt count
-	Concept Type: Integer (Type)
-Term: attempt limit
-	Concept Type: Integer (Type)
-Term: cron expression
-	Concept Type: Short Text (Type)
-Term: error message
-	Concept Type: Short Text (Type)
-Term: handler
-	Concept Type: Short Text (Type)
-Term: key
-	Concept Type: Short Text (Type)
-Term: parameter set
-	Concept Type: JSON (Type)
-Term: status
-	Concept Type: Short Text (Type)
-Term: time
-	Concept Type: Date Time (Type)
-
-Term: task
-Fact type: task has id
-	Necessity: each task has exactly one id
-Fact type: task has key
-	Necessity: each task has at most one key
-Fact type: task is created by actor
-	Necessity: each task is created by exactly one actor
-Fact type: task is executed by handler
-	Necessity: each task is executed by exactly one handler
-Fact type: task is executed with parameter set
-	Necessity: each task is executed with at most one parameter set
-Fact type: task is scheduled with cron expression
-	Necessity: each task is scheduled with at most one cron expression
-Fact type: task is scheduled to execute on time
-	Necessity: each task is scheduled to execute on at most one time
-Fact type: task has status
-	Necessity: each task has exactly one status
-	Definition: "queued" or "cancelled" or "succeeded" or "failed"
-Fact type: task started on time
-	Necessity: each task started on at most one time
-Fact type: task ended on time
-	Necessity: each task ended on at most one time
-Fact type: task has error message
-	Necessity: each task has at most one error message
-Fact type: task has attempt count
-	Necessity: each task has exactly one attempt count
-Fact type: task has attempt limit
-	Necessity: each task has exactly one attempt limit
-	Necessity: each task has an attempt limit that is greater than or equal to 1
-

package/out/tasks/types.d.ts

@@ -1,37 +0,0 @@
-import type { ValidateFunction } from 'ajv';
-import type { AnyObject } from 'pinejs-client-core';
-import type * as Db from '../database-layer/db';
-import type { PinejsClient } from '../sbvr-api/sbvr-utils';
-export declare const taskStatuses: readonly ["queued", "cancelled", "succeeded", "failed"];
-export type TaskStatus = (typeof taskStatuses)[number];
-export interface Task {
-    id: number;
-    created_at: Date;
-    modified_at: Date;
-    is_created_by__actor: number;
-    is_executed_by__handler: string;
-    is_executed_with__parameter_set: object | null;
-    is_scheduled_with__cron_expression: string | null;
-    is_scheduled_to_execute_on__time: Date | null;
-    status: TaskStatus;
-    started_on__time: Date | null;
-    ended_on__time: Date | null;
-    error_message: string | null;
-    attempt_count: number;
-    attempt_limit: number;
-}
-export type PartialTask = Pick<Task, 'id' | 'is_created_by__actor' | 'is_executed_by__handler' | 'is_executed_with__parameter_set' | 'is_scheduled_with__cron_expression' | 'attempt_count' | 'attempt_limit'>;
-export interface TaskArgs {
-    api: PinejsClient;
-    params: AnyObject;
-    tx: Db.Tx;
-}
-export type TaskResponse = Promise<{
-    status: TaskStatus;
-    error?: string;
-}>;
-export interface TaskHandler {
-    name: string;
-    fn: (options: TaskArgs) => TaskResponse;
-    validate?: ValidateFunction;
-}

package/out/tasks/types.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.taskStatuses = void 0;
-exports.taskStatuses = [
-    'queued',
-    'cancelled',
-    'succeeded',
-    'failed',
-];
-//# sourceMappingURL=types.js.map

package/out/tasks/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/tasks/types.ts"],"names":[],"mappings":";;;AAKa,QAAA,YAAY,GAAG;IAC3B,QAAQ;IACR,WAAW;IACX,WAAW;IACX,QAAQ;CACC,CAAC"}

package/out/tasks/worker.d.ts

@@ -1,16 +0,0 @@
-import { PinejsClient } from '../sbvr-api/sbvr-utils';
-import type { TaskHandler } from './types';
-export declare class Worker {
-    private readonly client;
-    handlers: Record<string, TaskHandler>;
-    private readonly concurrency;
-    private readonly interval;
-    private executing;
-    constructor(client: PinejsClient);
-    private canExecute;
-    private execute;
-    private finalize;
-    private getNextAttemptTime;
-    private poll;
-    start(): void;
-}

package/out/tasks/worker.js

@@ -1,226 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Worker = void 0;
-const promises_1 = require("node:timers/promises");
-const env_1 = require("../config-loader/env");
-const db_1 = require("../database-layer/db");
-const permissions = __importStar(require("../sbvr-api/permissions"));
-const sbvr_utils_1 = require("../sbvr-api/sbvr-utils");
-const module_1 = require("../server-glue/module");
-const common_1 = require("./common");
-const selectColumns = Object.entries({
-    id: 'id',
-    'is executed by-handler': 'is_executed_by__handler',
-    'is executed with-parameter set': 'is_executed_with__parameter_set',
-    'is scheduled with-cron expression': 'is_scheduled_with__cron_expression',
-    'attempt count': 'attempt_count',
-    'attempt limit': 'attempt_limit',
-    'is created by-actor': 'is_created_by__actor',
-})
-    .map(([key, value]) => `t."${key}" AS "${value}"`)
-    .join(', ');
-class Worker {
-    client;
-    handlers = {};
-    concurrency;
-    interval;
-    executing = 0;
-    constructor(client) {
-        this.client = client;
-        this.concurrency = env_1.tasks.queueConcurrency;
-        this.interval = env_1.tasks.queueIntervalMS;
-    }
-    canExecute() {
-        return (this.executing < this.concurrency && Object.keys(this.handlers).length > 0);
-    }
-    async execute(task, tx) {
-        this.executing++;
-        try {
-            const handler = this.handlers[task.is_executed_by__handler];
-            const startedOnTime = new Date();
-            if (handler == null) {
-                await this.finalize(tx, task, startedOnTime, 'failed', 'Matching task handler not found');
-                return;
-            }
-            if (handler.validate != null &&
-                !handler.validate(task.is_executed_with__parameter_set)) {
-                await this.finalize(tx, task, startedOnTime, 'failed', `Invalid parameter set: ${common_1.ajv.errorsText(handler.validate.errors)}`);
-                return;
-            }
-            let status = 'queued';
-            let error;
-            try {
-                await module_1.sbvrUtils.db.transaction(async (handlerTx) => {
-                    const results = await handler.fn({
-                        api: new sbvr_utils_1.PinejsClient({
-                            passthrough: {
-                                tx: handlerTx,
-                            },
-                        }),
-                        params: task.is_executed_with__parameter_set ?? {},
-                        tx: handlerTx,
-                    });
-                    status = results.status;
-                    error = results.error;
-                    if (results.status !== 'succeeded' && !handlerTx.isClosed()) {
-                        await handlerTx.rollback();
-                    }
-                });
-            }
-            catch (err) {
-                if (!(err instanceof db_1.TransactionClosedError)) {
-                    throw err;
-                }
-            }
-            finally {
-                await this.finalize(tx, task, startedOnTime, status, error);
-            }
-        }
-        catch (err) {
-            console.error(`Failed to execute task ${task.id} with handler ${task.is_executed_by__handler}:`, err);
-            process.exit(1);
-        }
-        finally {
-            this.executing--;
-        }
-    }
-    async finalize(tx, task, startedOnTime, status, errorMessage) {
-        const attemptCount = task.attempt_count + 1;
-        const body = {
-            started_on__time: startedOnTime,
-            ended_on__time: new Date(),
-            status,
-            attempt_count: attemptCount,
-            ...(errorMessage != null && { error_message: errorMessage }),
-        };
-        if (status === 'failed' && attemptCount < task.attempt_limit) {
-            body.status = 'queued';
-            body.is_scheduled_to_execute_on__time =
-                this.getNextAttemptTime(attemptCount);
-        }
-        await this.client.patch({
-            resource: 'task',
-            passthrough: {
-                tx,
-                req: permissions.root,
-            },
-            id: task.id,
-            body,
-        });
-        if (['failed', 'succeeded'].includes(body.status) &&
-            task.is_scheduled_with__cron_expression != null) {
-            await this.client.post({
-                resource: 'task',
-                passthrough: {
-                    tx,
-                    req: permissions.root,
-                },
-                options: {
-                    returnResource: false,
-                },
-                body: {
-                    attempt_limit: task.attempt_limit,
-                    is_created_by__actor: task.is_created_by__actor,
-                    is_executed_by__handler: task.is_executed_by__handler,
-                    is_executed_with__parameter_set: task.is_executed_with__parameter_set,
-                    is_scheduled_with__cron_expression: task.is_scheduled_with__cron_expression,
-                },
-            });
-        }
-    }
-    getNextAttemptTime(attempt) {
-        const delay = Math.ceil(Math.exp(Math.min(10, attempt)));
-        return new Date(Date.now() + delay);
-    }
-    poll() {
-        let executed = false;
-        void (async () => {
-            try {
-                if (!this.canExecute()) {
-                    return;
-                }
-                const handlerNames = Object.keys(this.handlers);
-                await module_1.sbvrUtils.db.transaction(async (tx) => {
-                    const result = await tx.executeSql(`SELECT ${selectColumns}
-						FROM task AS t
-						WHERE
-							t."is executed by-handler" IN (${handlerNames.map((_, index) => `$${index + 1}`).join(', ')}) AND
-							t."status" = 'queued' AND
-							t."attempt count" <= t."attempt limit" AND
-							(
-								t."is scheduled to execute on-time" IS NULL OR
-								t."is scheduled to execute on-time" <= CURRENT_TIMESTAMP + $${handlerNames.length + 1} * INTERVAL '1 SECOND'
-							)
-						ORDER BY
-							t."is scheduled to execute on-time" ASC,
-							t."id" ASC
-						LIMIT $${handlerNames.length + 2}
-						FOR UPDATE SKIP LOCKED`, [
-                        ...handlerNames,
-                        Math.ceil(this.interval / 1000),
-                        Math.max(this.concurrency - this.executing, 0),
-                    ]);
-                    if (result.rows.length === 0) {
-                        return;
-                    }
-                    await Promise.all(result.rows.map(async (row) => {
-                        await this.execute(row, tx);
-                    }));
-                    executed = true;
-                });
-            }
-            catch (err) {
-                console.error('Failed polling for tasks:', err);
-            }
-            finally {
-                if (!executed) {
-                    await (0, promises_1.setTimeout)(this.interval);
-                }
-                this.poll();
-            }
-        })();
-    }
-    start() {
-        if (module_1.sbvrUtils.db.engine !== 'postgres' || module_1.sbvrUtils.db.on == null) {
-            throw new Error('Database does not support tasks, giving up on starting worker');
-        }
-        module_1.sbvrUtils.db.on('notification', async (msg) => {
-            if (this.canExecute()) {
-                await module_1.sbvrUtils.db.transaction(async (tx) => {
-                    const result = await tx.executeSql(`SELECT ${selectColumns} FROM task AS t WHERE id = $1 FOR UPDATE SKIP LOCKED`, [msg.payload]);
-                    if (result.rows.length > 0) {
-                        await this.execute(result.rows[0], tx);
-                    }
-                });
-            }
-        }, {
-            channel: common_1.channel,
-        });
-        this.poll();
-    }
-}
-exports.Worker = Worker;
-//# sourceMappingURL=worker.js.map

package/out/tasks/worker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"worker.js","sourceRoot":"","sources":["../../src/tasks/worker.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAkD;AAElD,8CAAyD;AAEzD,6CAA8D;AAC9D,qEAAuD;AACvD,uDAAsD;AACtD,kDAAkD;AAClD,qCAAwC;AAIxC,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;CAC7C,CAAC;KACA,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;YACjC,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,IAAI,CAAC,QAAQ,CAClB,EAAE,EACF,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,iCAAiC,CACjC,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,QAAQ,CAClB,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,GAAe,QAAQ,CAAC;YAClC,IAAI,KAAyB,CAAC;YAC9B,IAAI,CAAC;gBACJ,MAAM,kBAAS,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;oBAClD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,EAAE,CAAC;wBAChC,GAAG,EAAE,IAAI,yBAAY,CAAC;4BACrB,WAAW,EAAE;gCACZ,EAAE,EAAE,SAAS;6BACb;yBACD,CAAC;wBACF,MAAM,EAAE,IAAI,CAAC,+BAA+B,IAAI,EAAE;wBAClD,EAAE,EAAE,SAAS;qBACb,CAAC,CAAC;oBACH,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;oBACxB,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;oBACtB,IAAI,OAAO,CAAC,MAAM,KAAK,WAAW,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC;wBAC7D,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAC;oBAC5B,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBAEd,IAAI,CAAC,CAAC,GAAG,YAAY,2BAAsB,CAAC,EAAE,CAAC;oBAC9C,MAAM,GAAG,CAAC;gBACX,CAAC;YACF,CAAC;oBAAS,CAAC;gBAEV,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAC7D,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,QAAQ,CACrB,EAAS,EACT,IAAiB,EACjB,aAAmB,EACnB,MAAkB,EAClB,YAAqB;QAErB,MAAM,YAAY,GAAG,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAc;YACvB,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,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;IAGO,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,EAAE,CAAC,UAAU,CACjC,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;;;;;eAK9E,YAAY,CAAC,MAAM,GAAG,CAAC;6BACT,EACvB;wBACC,GAAG,YAAY;wBACf,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;wBAC/B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;qBAC9C,CACD,CAAC;oBACF,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC9B,OAAO;oBACR,CAAC;oBAGD,MAAM,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;wBAC7B,MAAM,IAAI,CAAC,OAAO,CAAC,GAAkB,EAAE,EAAE,CAAC,CAAC;oBAC5C,CAAC,CAAC,CACF,CAAC;oBACF,QAAQ,GAAG,IAAI,CAAC;gBACjB,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;QAEX,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;QACD,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,EAAE,CAAC,UAAU,CACjC,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;QACF,IAAI,CAAC,IAAI,EAAE,CAAC;IACb,CAAC;CACD;AAxPD,wBAwPC"}

package/src/tasks/common.ts

@@ -1,14 +0,0 @@
-import Ajv from 'ajv';
-
-// Root path for the tasks API
-export const apiRoot = 'tasks';
-
-// Channel name for task insert notifications
-export const channel = 'pinejs$task_insert';
-
-// Setting inlineRefs=false as without it we run into a
-// "Maximum call stack size exceeded" error apprarently caused
-// by String.prototype._uncountable_words being set in sbvr-parser?
-export const ajv = new Ajv({
-	inlineRefs: false,
-});

package/src/tasks/index.ts

@@ -1,155 +0,0 @@
-import type { Schema } from 'ajv';
-import * as cronParser from 'cron-parser';
-import { tasks as tasksEnv } from '../config-loader/env';
-import type * as Db from '../database-layer/db';
-import { BadRequestError } from '../sbvr-api/errors';
-import { addPureHook } from '../sbvr-api/hooks';
-import * as sbvrUtils from '../sbvr-api/sbvr-utils';
-import type { ConfigLoader } from '../server-glue/module';
-import { ajv, apiRoot, channel } from './common';
-import type { TaskHandler } from './types';
-import { Worker } from './worker';
-
-export * from './types';
-
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const modelText: string = require('./tasks.sbvr');
-
-// Create trigger for handling new tasks
-// Create index for polling tasks table
-const initSql = `
-CREATE OR REPLACE FUNCTION notify_task_insert()
-RETURNS TRIGGER AS $$
-BEGIN
-	PERFORM pg_notify('${channel}', NEW.id::text);
-	RETURN NEW;
-END;
-$$ LANGUAGE plpgsql;
-
-CREATE OR REPLACE TRIGGER task_insert_trigger
-AFTER INSERT ON task
-FOR EACH ROW WHEN (NEW.status = 'queued' AND NEW."is scheduled to execute on-time" IS NULL)
-EXECUTE FUNCTION notify_task_insert();
-
-CREATE INDEX IF NOT EXISTS idx_task_poll ON task USING btree (
-	"is executed by-handler",
-	"is scheduled to execute on-time" ASC,
-	"id" ASC
-) WHERE status = 'queued';
-`;
-
-export const config: ConfigLoader.Config = {
-	models: [
-		{
-			modelName: apiRoot,
-			apiRoot,
-			modelText,
-			customServerCode: exports,
-			initSql,
-		},
-	],
-};
-
-let worker: Worker | null = null;
-export async function setup(db: Db.Database): Promise<void> {
-	// Async task functionality is only supported on Postgres
-	if (db.engine !== 'postgres') {
-		console.warn('Skipping task setup as database not supported');
-		return;
-	}
-
-	const client = sbvrUtils.api[apiRoot];
-	worker = new Worker(client);
-
-	// Add resource hooks
-	addPureHook('POST', apiRoot, 'task', {
-		POSTPARSE: async ({ req, request }) => {
-			// Set the actor
-			request.values.is_created_by__actor =
-				req.user?.actor ?? req.apiKey?.actor;
-			if (request.values.is_created_by__actor == null) {
-				throw new BadRequestError(
-					'Creating tasks with missing actor on req is not allowed',
-				);
-			}
-
-			// Set defaults
-			request.values.status = 'queued';
-			request.values.attempt_count = 0;
-			request.values.attempt_limit ??= 1;
-
-			// Set scheduled start time using cron expression if provided
-			if (
-				request.values.is_scheduled_with__cron_expression != null &&
-				request.values.is_scheduled_to_execute_on__time == null
-			) {
-				try {
-					request.values.is_scheduled_to_execute_on__time = cronParser
-						.parseExpression(request.values.is_scheduled_with__cron_expression)
-						.next()
-						.toDate()
-						.toISOString();
-				} catch {
-					throw new BadRequestError(
-						`Invalid cron expression: ${request.values.is_scheduled_with__cron_expression}`,
-					);
-				}
-			}
-
-			// Assert that the provided start time is far enough in the future
-			if (request.values.is_scheduled_to_execute_on__time != null) {
-				const now = new Date(Date.now() + tasksEnv.queueIntervalMS);
-				const startTime = new Date(
-					request.values.is_scheduled_to_execute_on__time,
-				);
-				if (startTime < now) {
-					throw new BadRequestError(
-						`Task scheduled start time must be greater than ${tasksEnv.queueIntervalMS} milliseconds in the future`,
-					);
-				}
-			}
-
-			// Assert that the requested handler exists
-			const handlerName = request.values.is_executed_by__handler;
-			if (handlerName == null) {
-				throw new BadRequestError(`Must specify a task handler to execute`);
-			}
-			const handler = worker?.handlers[handlerName];
-			if (handler == null) {
-				throw new BadRequestError(
-					`No task handler with name '${handlerName}' registered`,
-				);
-			}
-
-			// Assert that the provided parameter set is valid
-			if (handler.validate != null) {
-				if (!handler.validate(request.values.is_executed_with__parameter_set)) {
-					throw new BadRequestError(
-						`Invalid parameter set: ${ajv.errorsText(handler.validate.errors)}`,
-					);
-				}
-			}
-		},
-	});
-	worker.start();
-}
-
-// Register a task handler
-export function addTaskHandler(
-	name: string,
-	fn: TaskHandler['fn'],
-	schema?: Schema,
-): void {
-	if (worker == null) {
-		throw new Error('Database does not support tasks');
-	}
-
-	if (worker.handlers[name] != null) {
-		throw new Error(`Task handler with name '${name}' already registered`);
-	}
-	worker.handlers[name] = {
-		name,
-		fn,
-		validate: schema != null ? ajv.compile(schema) : undefined,
-	};
-}

package/src/tasks/tasks.sbvr

@@ -1,55 +0,0 @@
-Vocabulary: tasks
-
-Term: id
-    Concept Type: Big Serial (Type)
-Term: actor
-	Concept Type: Integer (Type)
-Term: attempt count
-	Concept Type: Integer (Type)
-Term: attempt limit
-	Concept Type: Integer (Type)
-Term: cron expression
-	Concept Type: Short Text (Type)
-Term: error message
-	Concept Type: Short Text (Type)
-Term: handler
-	Concept Type: Short Text (Type)
-Term: key
-	Concept Type: Short Text (Type)
-Term: parameter set
-	Concept Type: JSON (Type)
-Term: status
-	Concept Type: Short Text (Type)
-Term: time
-	Concept Type: Date Time (Type)
-
-Term: task
-Fact type: task has id
-	Necessity: each task has exactly one id
-Fact type: task has key
-	Necessity: each task has at most one key
-Fact type: task is created by actor
-	Necessity: each task is created by exactly one actor
-Fact type: task is executed by handler
-	Necessity: each task is executed by exactly one handler
-Fact type: task is executed with parameter set
-	Necessity: each task is executed with at most one parameter set
-Fact type: task is scheduled with cron expression
-	Necessity: each task is scheduled with at most one cron expression
-Fact type: task is scheduled to execute on time
-	Necessity: each task is scheduled to execute on at most one time
-Fact type: task has status
-	Necessity: each task has exactly one status
-	Definition: "queued" or "cancelled" or "succeeded" or "failed"
-Fact type: task started on time
-	Necessity: each task started on at most one time
-Fact type: task ended on time
-	Necessity: each task ended on at most one time
-Fact type: task has error message
-	Necessity: each task has at most one error message
-Fact type: task has attempt count
-	Necessity: each task has exactly one attempt count
-Fact type: task has attempt limit
-	Necessity: each task has exactly one attempt limit
-	Necessity: each task has an attempt limit that is greater than or equal to 1
-

package/src/tasks/types.ts

@@ -1,56 +0,0 @@
-import type { ValidateFunction } from 'ajv';
-import type { AnyObject } from 'pinejs-client-core';
-import type * as Db from '../database-layer/db';
-import type { PinejsClient } from '../sbvr-api/sbvr-utils';
-
-export const taskStatuses = [
-	'queued',
-	'cancelled',
-	'succeeded',
-	'failed',
-] as const;
-export type TaskStatus = (typeof taskStatuses)[number];
-export interface Task {
-	id: number;
-	created_at: Date;
-	modified_at: Date;
-	is_created_by__actor: number;
-	is_executed_by__handler: string;
-	is_executed_with__parameter_set: object | null;
-	is_scheduled_with__cron_expression: string | null;
-	is_scheduled_to_execute_on__time: Date | null;
-	status: TaskStatus;
-	started_on__time: Date | null;
-	ended_on__time: Date | null;
-	error_message: string | null;
-	attempt_count: number;
-	attempt_limit: number;
-}
-
-export type PartialTask = Pick<
-	Task,
-	| 'id'
-	| 'is_created_by__actor'
-	| 'is_executed_by__handler'
-	| 'is_executed_with__parameter_set'
-	| 'is_scheduled_with__cron_expression'
-	| 'attempt_count'
-	| 'attempt_limit'
->;
-
-export interface TaskArgs {
-	api: PinejsClient;
-	params: AnyObject;
-	tx: Db.Tx;
-}
-
-export type TaskResponse = Promise<{
-	status: TaskStatus;
-	error?: string;
-}>;
-
-export interface TaskHandler {
-	name: string;
-	fn: (options: TaskArgs) => TaskResponse;
-	validate?: ValidateFunction;
-}