@balena/pinejs 18.1.0-build-joshbwlng-listener-0b0f8758d06970eeb1cc188b8a5e3301897ba8ab-1 → 18.1.0

package/out/tasks/worker.js

@@ -0,0 +1,212 @@
+"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 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.update(tx, task, startedOnTime, 'failed', 'Matching task handler not found, this should never happen!');
+                return;
+            }
+            if (handler.validate != null &&
+                !handler.validate(task.is_executed_with__parameter_set)) {
+                await this.update(tx, task, startedOnTime, 'failed', `Invalid parameter set: ${common_1.ajv.errorsText(handler.validate.errors)}`);
+                return;
+            }
+            let status = 'queued';
+            let error;
+            try {
+                const results = await handler.fn({
+                    api: new sbvr_utils_1.PinejsClient({}),
+                    params: task.is_executed_with__parameter_set ?? {},
+                });
+                status = results.status;
+                error = results.error;
+            }
+            finally {
+                await this.update(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 update(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 (body.status != null &&
+            ['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 module_1.sbvrUtils.db.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 1 FOR UPDATE SKIP LOCKED`, [...handlerNames, Math.ceil(this.interval / 1000)]);
+                    if (result.rows.length > 0) {
+                        await this.execute(result.rows[0], tx);
+                        executed = true;
+                    }
+                });
+            }
+            catch (err) {
+                console.error('Failed polling for tasks:', err);
+            }
+            finally {
+                if (!executed) {
+                    await (0, promises_1.setTimeout)(this.interval);
+                }
+                this.poll();
+            }
+        })();
+    }
+    async start() {
+        if (module_1.sbvrUtils.db.engine !== 'postgres') {
+            throw new Error('Database does not support tasks, giving up on starting worker');
+        }
+        const tasksWithUnknownHandlers = await this.client.get({
+            resource: 'task',
+            passthrough: {
+                req: permissions.root,
+            },
+            options: {
+                $filter: {
+                    status: 'queued',
+                    $not: {
+                        is_executed_by__handler: { $in: Object.keys(this.handlers) },
+                    },
+                },
+            },
+        });
+        if (tasksWithUnknownHandlers.length > 0) {
+            throw new Error(`Found tasks with unknown handlers: ${tasksWithUnknownHandlers
+                .map((task) => `${task.id}(${task.is_executed_by__handler})`)
+                .join(', ')}`);
+        }
+        for (let i = 0; i < this.concurrency; i++) {
+            this.poll();
+        }
+    }
+}
+exports.Worker = Worker;
+//# sourceMappingURL=worker.js.map

package/out/tasks/worker.js.map

@@ -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,qCAA+B;AA+B/B,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,EAAE,CAAC;YACxC,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;QAGD,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;AA1OD,wBA0OC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@balena/pinejs",
-  "version": "18.1.0-build-joshbwlng-listener-0b0f8758d06970eeb1cc188b8a5e3301897ba8ab-1",
+  "version": "18.1.0",
   "main": "out/server-glue/module",
   "type": "commonjs",
   "repository": "git@github.com:balena-io/pinejs.git",
@@ -20,15 +20,15 @@
     "webpack-build": "npm run webpack-browser && npm run webpack-module && npm run webpack-server",
     "lint": "balena-lint -t tsconfig.dev.json -e js -e ts src build typings Gruntfile.ts && npx tsc --project tsconfig.dev.json --noEmit",
     "test": "npm run lint && npm run build && npm run webpack-build && npm run test:compose && npm run test:generated-types",
-    "test:compose": "trap 'docker compose -f docker-compose.npm-test.yml down ; echo Stopped ; exit 0' INT; docker compose -f docker-compose.npm-test.yml up -d && sleep 2 && DATABASE_URL=postgres://docker:docker@localhost:5431/postgres PINEJS_WEBRESOURCE_MAXFILESIZE=1000000000 S3_ENDPOINT=http://localhost:43680 S3_ACCESS_KEY=USERNAME S3_SECRET_KEY=PASSWORD S3_STORAGE_ADAPTER_BUCKET=balena-pine-web-resources S3_REGION=us-east-1 npm run mocha",
+    "test:compose": "trap 'docker compose -f docker-compose.npm-test.yml down ; echo Stopped ; exit 0' INT; docker compose -f docker-compose.npm-test.yml up -d && sleep 2 && DATABASE_URL=postgres://docker:docker@localhost:5431/postgres PINEJS_WEBRESOURCE_MAXFILESIZE=1000000000 S3_ENDPOINT=http://localhost:43680 S3_ACCESS_KEY=USERNAME S3_SECRET_KEY=PASSWORD S3_STORAGE_ADAPTER_BUCKET=balena-pine-web-resources S3_REGION=us-east-1 PINEJS_QUEUE_CONCURRENCY=1 npm run mocha",
     "test:generated-types": "npm run generate-types && git diff --exit-code ./src/sbvr-api/user.ts ./src/migrator/migrations.ts ./src/sbvr-api/dev.ts",
     "mocha": "TS_NODE_FILES=true mocha",
     "lint-fix": "balena-lint -t tsconfig.dev.json -e js -e ts --fix src test build typings Gruntfile.ts",
-    "generate-types": "node ./bin/sbvr-compiler.js generate-types ./src/sbvr-api/user.sbvr ./src/sbvr-api/user.ts && node ./bin/sbvr-compiler.js generate-types ./src/migrator/migrations.sbvr ./src/migrator/migrations.ts && node ./bin/sbvr-compiler.js generate-types ./src/sbvr-api/dev.sbvr ./src/sbvr-api/dev.ts && balena-lint -t tsconfig.dev.json --fix ./src/sbvr-api/user.ts ./src/migrator/migrations.ts ./src/sbvr-api/dev.ts"
+    "generate-types": "node ./bin/sbvr-compiler.js generate-types ./src/sbvr-api/user.sbvr ./src/sbvr-api/user.ts && node ./bin/sbvr-compiler.js generate-types ./src/migrator/migrations.sbvr ./src/migrator/migrations.ts && node ./bin/sbvr-compiler.js generate-types ./src/sbvr-api/dev.sbvr ./src/sbvr-api/dev.ts && node ./bin/sbvr-compiler.js generate-types ./src/tasks/tasks.sbvr ./src/tasks/tasks.ts && balena-lint -t tsconfig.dev.json --fix ./src/sbvr-api/user.ts ./src/migrator/migrations.ts ./src/sbvr-api/dev.ts"
   },
   "dependencies": {
     "@balena/abstract-sql-compiler": "^9.2.0",
-    "@balena/abstract-sql-to-typescript": "^3.3.1",
+    "@balena/abstract-sql-to-typescript": "^4.0.0",
     "@balena/env-parsing": "^1.1.12",
     "@balena/lf-to-abstract-sql": "^5.0.2",
     "@balena/odata-parser": "^3.0.8",
@@ -53,14 +53,16 @@
     "@types/pg": "^8.11.6",
     "@types/randomstring": "^1.3.0",
     "@types/websql": "^0.0.30",
+    "ajv": "^8.12.0",
     "busboy": "^1.6.0",
     "commander": "^11.1.0",
+    "cron-parser": "^4.9.0",
     "deep-freeze": "^0.0.1",
     "eventemitter3": "^5.0.1",
     "express-session": "^1.18.0",
     "lodash": "^4.17.21",
     "memoizee": "^0.4.17",
-    "pinejs-client-core": "^6.15.10",
+    "pinejs-client-core": "^7.0.0",
     "randomstring": "^1.3.0",
     "typed-error": "^3.2.2"
   },
@@ -91,6 +93,7 @@
     "grunt-ts": "^6.0.0-beta.22",
     "grunt-webpack": "^6.0.0",
     "husky": "^9.1.4",
+    "json-schema-to-ts": "^3.1.0",
     "lint-staged": "^15.2.7",
     "load-grunt-tasks": "^5.1.0",
     "mocha": "^10.7.0",
@@ -146,6 +149,6 @@
     "recursive": true
   },
   "versionist": {
-    "publishedAt": "2024-08-20T13:12:17.350Z"
+    "publishedAt": "2024-08-20T13:18:33.683Z"
   }
 }

package/src/config-loader/env.ts

@@ -49,7 +49,7 @@ export const cache = {
 	apiKeyActorId: false as CacheOpts,
 };
 
-import { boolVar } from '@balena/env-parsing';
+import { boolVar, intVar } from '@balena/env-parsing';
 import memoize from 'memoizee';
 import memoizeWeak = require('memoizee/weak');
 export const createCache = <T extends (...args: any[]) => any>(
@@ -146,3 +146,8 @@ export const migrator = {
 	 */
 	asyncMigrationIsEnabled: boolVar('PINEJS_ASYNC_MIGRATION_ENABLED', true),
 };
+
+export const tasks = {
+	queueConcurrency: intVar('PINEJS_QUEUE_CONCURRENCY', 0),
+	queueIntervalMS: intVar('PINEJS_QUEUE_INTERVAL_MS', 1000),
+};

package/src/database-layer/db.ts

@@ -106,13 +106,6 @@ export interface Database extends BaseDatabase {
 	) => Promise<Result>;
 	transaction: TransactionFn;
 	readTransaction: TransactionFn;
-	on?: (
-		name: 'notification',
-		fn: (...args: any[]) => Promise<void>,
-		options?: {
-			channel?: string;
-		},
-	) => void;
 }
 
 interface EngineParams {
@@ -714,61 +707,9 @@ if (maybePg != null) {
 				`);
 			}
 		}
-
-		// Connect and listen for notifications
-		async function listen(
-			channel: string,
-			fn: (...args: any[]) => Promise<void>,
-		) {
-			let listenerClient: Pg.PoolClient | null = null;
-
-			// Clean up and reconnect listener
-			const reconnect = () => {
-				try {
-					listenerClient?.release();
-				} catch (err) {
-					// Ignore listener client release errors
-				}
-				setTimeout(() => {
-					void listen(channel, fn);
-				}, 1000);
-			};
-
-			try {
-				listenerClient = await pool.connect();
-				listenerClient.on('end', reconnect);
-				listenerClient.on('notification', (msg) => {
-					if (msg.channel === channel) {
-						void fn(msg).catch((err) => {
-							console.error(`Error handling message for '${channel}':`, err);
-						});
-					}
-				});
-				await listenerClient.query(`LISTEN "${channel}"`);
-			} catch (err) {
-				console.error(
-					`Error setting up listener client for '${channel}':`,
-					err,
-				);
-				reconnect();
-			}
-		}
-
 		return {
 			engine: Engines.postgres,
 			executeSql: atomicExecuteSql,
-			on: async (name, fn, options) => {
-				if (name !== 'notification') {
-					throw new Error(`Unsupported listener type: ${name}`);
-				} else if (options?.channel == null) {
-					throw new Error('Missing channel option for notification listener');
-				} else if (options.channel.includes('"')) {
-					throw new Error(
-						`Invalid channel name for task LISTEN: ${options.channel}`,
-					);
-				}
-				await listen(options.channel, fn);
-			},
 			transaction: createTransaction(async (stackTraceErr, timeoutMS) => {
 				const client = await pool.connect();
 				const tx = new PostgresTx(client, false, stackTraceErr, timeoutMS);

package/src/migrator/migrations.ts

@@ -1,4 +1,4 @@
-// These types were generated by @balena/abstract-sql-to-typescript v3.3.1
+// These types were generated by @balena/abstract-sql-to-typescript v4.0.0
 
 import type { Types } from '@balena/abstract-sql-to-typescript';
 

package/src/sbvr-api/dev.ts

@@ -1,4 +1,4 @@
-// These types were generated by @balena/abstract-sql-to-typescript v3.3.1
+// These types were generated by @balena/abstract-sql-to-typescript v4.0.0
 
 import type { Types } from '@balena/abstract-sql-to-typescript';
 

package/src/sbvr-api/sbvr-utils.ts

@@ -777,7 +777,7 @@ export const postExecuteModels = async (tx: Db.Tx): Promise<void> => {
 	// Hence, skipped migrations from earlier models are not set as executed as the `migration` table is missing
 	// Here the skipped migrations that haven't been set properly are covered
 	// This is mostly an edge case when running on an empty database schema and migrations model hasn't been executed, yet.
-	// One specifc case are tests to run tests against migrated and unmigrated database states
+	// One specific case are tests to run tests against migrated and unmigrated database states
 
 	for (const modelKey of Object.keys(models)) {
 		const pendingToSetExecutedMigrations =

package/src/sbvr-api/user.ts

@@ -1,4 +1,4 @@
-// These types were generated by @balena/abstract-sql-to-typescript v3.3.1
+// These types were generated by @balena/abstract-sql-to-typescript v4.0.0
 
 import type { Types } from '@balena/abstract-sql-to-typescript';
 

package/src/server-glue/module.ts

@@ -6,6 +6,7 @@ import * as dbModule from '../database-layer/db';
 import * as configLoader from '../config-loader/config-loader';
 import * as migrator from '../migrator/sync';
 import type * as migratorUtils from '../migrator/utils';
+import * as tasks from '../tasks';
 
 import * as sbvrUtils from '../sbvr-api/sbvr-utils';
 import { PINEJS_ADVISORY_LOCK } from '../config-loader/env';
@@ -19,6 +20,7 @@ export * as errors from '../sbvr-api/errors';
 export * as env from '../config-loader/env';
 export * as types from '../sbvr-api/common-types';
 export * as hooks from '../sbvr-api/hooks';
+export * as tasks from '../tasks';
 export * as webResourceHandler from '../webresource-handler';
 export type { configLoader as ConfigLoader };
 export type { migratorUtils as Migrator };
@@ -63,6 +65,7 @@ export const init = async <T extends string>(
 		await sbvrUtils.setup(app, db);
 		const cfgLoader = configLoader.setup(app);
 		await cfgLoader.loadConfig(migrator.config);
+		await cfgLoader.loadConfig(tasks.config);
 
 		const promises: Array<Promise<void>> = [];
 		if (process.env.SBVR_SERVER_ENABLED) {

package/src/tasks/common.ts

@@ -0,0 +1,6 @@
+import Ajv from 'ajv';
+
+// Root path for the tasks API
+export const apiRoot = 'tasks';
+
+export const ajv = new Ajv();

package/src/tasks/index.ts

@@ -0,0 +1,138 @@
+import type { Schema } from 'ajv';
+import * as cronParser from 'cron-parser';
+import { tasks as tasksEnv } from '../config-loader/env';
+import { addPureHook } from '../sbvr-api/hooks';
+import * as sbvrUtils from '../sbvr-api/sbvr-utils';
+import type { ConfigLoader } from '../server-glue/module';
+import { ajv, apiRoot } from './common';
+import type { TaskHandler } from './worker';
+import { Worker } from './worker';
+
+export type * from './tasks';
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const modelText: string = require('./tasks.sbvr');
+
+// Create index for polling tasks table
+const initSql = `
+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,
+		},
+	],
+};
+
+export let worker: Worker | null = null;
+export async function setup(): Promise<void> {
+	// Async task functionality is only supported on Postgres
+	if (sbvrUtils.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 Error(
+					'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 Error(
+						`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 Error(
+						`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 Error(`Must specify a task handler to execute`);
+			}
+			const handler = worker?.handlers[handlerName];
+			if (handler == null) {
+				throw new Error(
+					`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 Error(
+						`Invalid parameter set: ${ajv.errorsText(handler.validate.errors)}`,
+					);
+				}
+			}
+		},
+	});
+}
+
+// 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

@@ -0,0 +1,55 @@
+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
+