@balena/pinejs 17.2.0-build-add-large-file-uploads-interfaces-971bf14a0a43ac87997af442136f384f224ba6d7-1 → 17.2.0-build-joshbwlng-tasks-b246a5244eeb1c020c533c54d6fb2f112a0ed972-1

package/out/tasks/index.js

@@ -0,0 +1,160 @@
+"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;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = void 0;
+exports.setup = setup;
+exports.addTaskHandler = addTaskHandler;
+const cronParser = __importStar(require("cron-parser"));
+const env_1 = require("../config-loader/env");
+const errors_1 = require("../sbvr-api/errors");
+const hooks_1 = require("../sbvr-api/hooks");
+const sbvrUtils = __importStar(require("../sbvr-api/sbvr-utils"));
+const common_1 = require("./common");
+const worker_1 = require("./worker");
+__exportStar(require("./types"), exports);
+const modelText = require('./tasks.sbvr');
+const initSql = `
+CREATE OR REPLACE FUNCTION notify_task_insert()
+RETURNS TRIGGER AS $$
+BEGIN
+	PERFORM pg_notify('${common_1.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';
+`;
+exports.config = {
+    models: [
+        {
+            modelName: common_1.apiRoot,
+            apiRoot: common_1.apiRoot,
+            modelText,
+            customServerCode: exports,
+            initSql,
+        },
+    ],
+};
+let worker = null;
+async function setup() {
+    if (sbvrUtils.db.engine !== 'postgres') {
+        console.warn('Skipping task setup as database not supported');
+        return;
+    }
+    const client = sbvrUtils.api[common_1.apiRoot];
+    worker = new worker_1.Worker(client);
+    (0, hooks_1.addPureHook)('POST', common_1.apiRoot, 'task', {
+        POSTPARSE: async ({ req, request }) => {
+            request.values.is_created_by__actor =
+                req.user?.actor ?? req.apiKey?.actor;
+            if (request.values.is_created_by__actor == null) {
+                throw new errors_1.BadRequestError('Creating tasks with missing actor on req is not allowed');
+            }
+            request.values.status = 'queued';
+            request.values.attempt_count = 0;
+            request.values.attempt_limit ??= 1;
+            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 errors_1.BadRequestError(`Invalid cron expression: ${request.values.is_scheduled_with__cron_expression}`);
+                }
+            }
+            if (request.values.is_scheduled_to_execute_on__time != null) {
+                const now = new Date(Date.now() + env_1.tasks.queueIntervalMS);
+                const startTime = new Date(request.values.is_scheduled_to_execute_on__time);
+                if (startTime < now) {
+                    throw new errors_1.BadRequestError(`Task scheduled start time must be greater than ${env_1.tasks.queueIntervalMS} milliseconds in the future`);
+                }
+            }
+            const handlerName = request.values.is_executed_by__handler;
+            if (handlerName == null) {
+                throw new errors_1.BadRequestError(`Must specify a task handler to execute`);
+            }
+            const handler = worker?.handlers[handlerName];
+            if (handler == null) {
+                throw new errors_1.BadRequestError(`No task handler with name '${handlerName}' registered`);
+            }
+            if (handler.validate != null) {
+                if (!handler.validate(request.values.is_executed_with__parameter_set)) {
+                    throw new errors_1.BadRequestError(`Invalid parameter set: ${common_1.ajv.errorsText(handler.validate.errors)}`);
+                }
+            }
+        },
+    });
+    (0, hooks_1.addPureHook)('all', common_1.apiRoot, 'task', {
+        PRERESPOND: async ({ response }) => {
+            if (typeof response.body === 'object') {
+                convertBigIntsToStrings(response.body);
+            }
+        },
+    });
+    worker.start();
+}
+function convertBigIntsToStrings(obj) {
+    for (const [key, value] of Object.entries(obj)) {
+        if (value != null) {
+            const typeOfValue = typeof value;
+            if (typeOfValue === 'bigint') {
+                obj[key] = value.toString();
+            }
+            else if (typeOfValue === 'object') {
+                convertBigIntsToStrings(value);
+            }
+        }
+    }
+}
+function addTaskHandler(name, fn, schema) {
+    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 ? common_1.ajv.compile(schema) : undefined,
+    };
+}
+//# sourceMappingURL=index.js.map

package/out/tasks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/tasks/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoDA,sBAyFC;AAiBD,wCAiBC;AA9KD,wDAA0C;AAC1C,8CAAyD;AACzD,+CAAqD;AACrD,6CAAgD;AAChD,kEAAoD;AAEpD,qCAAiD;AAEjD,qCAAkC;AAElC,0CAAwB;AAGxB,MAAM,SAAS,GAAW,OAAO,CAAC,cAAc,CAAC,CAAC;AAIlD,MAAM,OAAO,GAAG;;;;sBAIM,gBAAO;;;;;;;;;;;;;;;CAe5B,CAAC;AAEW,QAAA,MAAM,GAAwB;IAC1C,MAAM,EAAE;QACP;YACC,SAAS,EAAE,gBAAO;YAClB,OAAO,EAAP,gBAAO;YACP,SAAS;YACT,gBAAgB,EAAE,OAAO;YACzB,OAAO;SACP;KACD;CACD,CAAC;AAEF,IAAI,MAAM,GAAkB,IAAI,CAAC;AAC1B,KAAK,UAAU,KAAK;IAE1B,IAAI,SAAS,CAAC,EAAE,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAC;QAC9D,OAAO;IACR,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAAC,gBAAO,CAAC,CAAC;IACtC,MAAM,GAAG,IAAI,eAAM,CAAC,MAAM,CAAC,CAAC;IAG5B,IAAA,mBAAW,EAAC,MAAM,EAAE,gBAAO,EAAE,MAAM,EAAE;QACpC,SAAS,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE;YAErC,OAAO,CAAC,MAAM,CAAC,oBAAoB;gBAClC,GAAG,CAAC,IAAI,EAAE,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC;YACtC,IAAI,OAAO,CAAC,MAAM,CAAC,oBAAoB,IAAI,IAAI,EAAE,CAAC;gBACjD,MAAM,IAAI,wBAAe,CACxB,yDAAyD,CACzD,CAAC;YACH,CAAC;YAGD,OAAO,CAAC,MAAM,CAAC,MAAM,GAAG,QAAQ,CAAC;YACjC,OAAO,CAAC,MAAM,CAAC,aAAa,GAAG,CAAC,CAAC;YACjC,OAAO,CAAC,MAAM,CAAC,aAAa,KAAK,CAAC,CAAC;YAGnC,IACC,OAAO,CAAC,MAAM,CAAC,kCAAkC,IAAI,IAAI;gBACzD,OAAO,CAAC,MAAM,CAAC,gCAAgC,IAAI,IAAI,EACtD,CAAC;gBACF,IAAI,CAAC;oBACJ,OAAO,CAAC,MAAM,CAAC,gCAAgC,GAAG,UAAU;yBAC1D,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,CAAC;yBAClE,IAAI,EAAE;yBACN,MAAM,EAAE;yBACR,WAAW,EAAE,CAAC;gBACjB,CAAC;gBAAC,MAAM,CAAC;oBACR,MAAM,IAAI,wBAAe,CACxB,4BAA4B,OAAO,CAAC,MAAM,CAAC,kCAAkC,EAAE,CAC/E,CAAC;gBACH,CAAC;YACF,CAAC;YAGD,IAAI,OAAO,CAAC,MAAM,CAAC,gCAAgC,IAAI,IAAI,EAAE,CAAC;gBAC7D,MAAM,GAAG,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,WAAQ,CAAC,eAAe,CAAC,CAAC;gBAC5D,MAAM,SAAS,GAAG,IAAI,IAAI,CACzB,OAAO,CAAC,MAAM,CAAC,gCAAgC,CAC/C,CAAC;gBACF,IAAI,SAAS,GAAG,GAAG,EAAE,CAAC;oBACrB,MAAM,IAAI,wBAAe,CACxB,kDAAkD,WAAQ,CAAC,eAAe,6BAA6B,CACvG,CAAC;gBACH,CAAC;YACF,CAAC;YAGD,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,uBAAuB,CAAC;YAC3D,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,wBAAe,CAAC,wCAAwC,CAAC,CAAC;YACrE,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;YAC9C,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,IAAI,wBAAe,CACxB,8BAA8B,WAAW,cAAc,CACvD,CAAC;YACH,CAAC;YAGD,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;gBAC9B,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,+BAA+B,CAAC,EAAE,CAAC;oBACvE,MAAM,IAAI,wBAAe,CACxB,0BAA0B,YAAG,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CACnE,CAAC;gBACH,CAAC;YACF,CAAC;QACF,CAAC;KACD,CAAC,CAAC;IACH,IAAA,mBAAW,EAAC,KAAK,EAAE,gBAAO,EAAE,MAAM,EAAE;QAEnC,UAAU,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YAClC,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBACvC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACxC,CAAC;QACF,CAAC;KACD,CAAC,CAAC;IACH,MAAM,CAAC,KAAK,EAAE,CAAC;AAChB,CAAC;AAGD,SAAS,uBAAuB,CAAC,GAAQ;IACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YACnB,MAAM,WAAW,GAAG,OAAO,KAAK,CAAC;YACjC,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAC9B,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;YAC7B,CAAC;iBAAM,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;gBACrC,uBAAuB,CAAC,KAAK,CAAC,CAAC;YAChC,CAAC;QACF,CAAC;IACF,CAAC;AACF,CAAC;AAGD,SAAgB,cAAc,CAC7B,IAAY,EACZ,EAAqB,EACrB,MAAe;IAEf,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,2BAA2B,IAAI,sBAAsB,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG;QACvB,IAAI;QACJ,EAAE;QACF,QAAQ,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,YAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS;KAC1D,CAAC;AACH,CAAC"}

package/out/tasks/out.d.ts

@@ -0,0 +1,40 @@
+import type { Types } from '@balena/abstract-sql-to-typescript';
+export interface Task {
+    Read: {
+        created_at: Types['Date Time']['Read'];
+        modified_at: Types['Date Time']['Read'];
+        id: Types['Big Serial']['Read'];
+        key: Types['Short Text']['Read'] | null;
+        is_created_by__actor: Types['Integer']['Read'];
+        is_executed_by__handler: Types['Short Text']['Read'];
+        is_executed_with__parameter_set: Types['JSON']['Read'] | null;
+        is_scheduled_with__cron_expression: Types['Short Text']['Read'] | null;
+        is_scheduled_to_execute_on__time: Types['Date Time']['Read'] | null;
+        status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
+        started_on__time: Types['Date Time']['Read'] | null;
+        ended_on__time: Types['Date Time']['Read'] | null;
+        error_message: Types['Short Text']['Read'] | null;
+        attempt_count: Types['Integer']['Read'];
+        attempt_limit: Types['Integer']['Read'];
+    };
+    Write: {
+        created_at: Types['Date Time']['Write'];
+        modified_at: Types['Date Time']['Write'];
+        id: Types['Big Serial']['Write'];
+        key: Types['Short Text']['Write'] | null;
+        is_created_by__actor: Types['Integer']['Write'];
+        is_executed_by__handler: Types['Short Text']['Write'];
+        is_executed_with__parameter_set: Types['JSON']['Write'] | null;
+        is_scheduled_with__cron_expression: Types['Short Text']['Write'] | null;
+        is_scheduled_to_execute_on__time: Types['Date Time']['Write'] | null;
+        status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
+        started_on__time: Types['Date Time']['Write'] | null;
+        ended_on__time: Types['Date Time']['Write'] | null;
+        error_message: Types['Short Text']['Write'] | null;
+        attempt_count: Types['Integer']['Write'];
+        attempt_limit: Types['Integer']['Write'];
+    };
+}
+export default interface $Model {
+    task: Task;
+}

package/out/tasks/out.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=out.js.map

package/out/tasks/out.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"out.js","sourceRoot":"","sources":["../../src/tasks/out.ts"],"names":[],"mappings":""}

package/out/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
+

package/out/tasks/types.d.ts

@@ -0,0 +1,40 @@
+import type { Types } from '@balena/abstract-sql-to-typescript';
+export interface Task {
+    Read: {
+        created_at: Types['Date Time']['Read'];
+        modified_at: Types['Date Time']['Read'];
+        id: Types['Big Serial']['Read'];
+        key: Types['Short Text']['Read'] | null;
+        is_created_by__actor: Types['Integer']['Read'];
+        is_executed_by__handler: Types['Short Text']['Read'];
+        is_executed_with__parameter_set: Types['JSON']['Read'] | null;
+        is_scheduled_with__cron_expression: Types['Short Text']['Read'] | null;
+        is_scheduled_to_execute_on__time: Types['Date Time']['Read'] | null;
+        status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
+        started_on__time: Types['Date Time']['Read'] | null;
+        ended_on__time: Types['Date Time']['Read'] | null;
+        error_message: Types['Short Text']['Read'] | null;
+        attempt_count: Types['Integer']['Read'];
+        attempt_limit: Types['Integer']['Read'];
+    };
+    Write: {
+        created_at: Types['Date Time']['Write'];
+        modified_at: Types['Date Time']['Write'];
+        id: Types['Big Serial']['Write'];
+        key: Types['Short Text']['Write'] | null;
+        is_created_by__actor: Types['Integer']['Write'];
+        is_executed_by__handler: Types['Short Text']['Write'];
+        is_executed_with__parameter_set: Types['JSON']['Write'] | null;
+        is_scheduled_with__cron_expression: Types['Short Text']['Write'] | null;
+        is_scheduled_to_execute_on__time: Types['Date Time']['Write'] | null;
+        status: 'queued' | 'cancelled' | 'succeeded' | 'failed';
+        started_on__time: Types['Date Time']['Write'] | null;
+        ended_on__time: Types['Date Time']['Write'] | null;
+        error_message: Types['Short Text']['Write'] | null;
+        attempt_count: Types['Integer']['Write'];
+        attempt_limit: Types['Integer']['Write'];
+    };
+}
+export default interface $Model {
+    task: Task;
+}

package/out/tasks/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/out/tasks/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/tasks/types.ts"],"names":[],"mappings":""}

package/out/tasks/worker.d.ts

@@ -0,0 +1,32 @@
+import type { ValidateFunction } from 'ajv';
+import type { AnyObject } from 'pinejs-client-core';
+import { PinejsClient } from '../sbvr-api/sbvr-utils';
+import type { Task } from './types';
+interface TaskArgs {
+    api: PinejsClient;
+    params: AnyObject;
+}
+type TaskResponse = Promise<{
+    status: Task['Read']['status'];
+    error?: string;
+}>;
+export interface TaskHandler {
+    name: string;
+    fn: (options: TaskArgs) => TaskResponse;
+    validate?: ValidateFunction;
+}
+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 update;
+    private getNextAttemptTime;
+    private poll;
+    start(): void;
+}
+export {};

package/out/tasks/worker.js

@@ -0,0 +1,204 @@
+"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');
+                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 (['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();
+            }
+        })();
+    }
+    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 module_1.sbvrUtils.db.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,
+        });
+        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,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;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,MAAM,CAChB,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,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,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;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;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,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;AAnOD,wBAmOC"}

package/out/webresource-handler/index.d.ts

@@ -1,6 +1,5 @@
 import type * as Express from 'express';
 import type * as stream from 'node:stream';
-import type { AnyObject } from '../sbvr-api/common-types';
 import type { WebResourceType as WebResource } from '@balena/sbvr-types';
 import { TypedError } from 'typed-error';
 export * from './handlers';
@@ -15,34 +14,10 @@ export interface UploadResponse {
     size: number;
     filename: string;
 }
-export interface BeginMultipartUploadPayload {
-    filename: string;
-    content_type: string;
-    size: number;
-    chunk_size: number;
-}
-export interface UploadPart {
-    url: string;
-    chunkSize: number;
-    partNumber: number;
-}
-export interface BeginMultipartUploadHandlerResponse {
-    uploadParts: UploadPart[];
-    fileKey: string;
-    uploadId: string;
-}
-export interface CommitMultipartUploadPayload {
-    fileKey: string;
-    uploadId: string;
-    filename: string;
-    providerCommitData?: AnyObject;
-}
 export interface WebResourceHandler {
     handleFile: (resource: IncomingFile) => Promise<UploadResponse>;
     removeFile: (fileReference: string) => Promise<void>;
     onPreRespond: (webResource: WebResource) => Promise<WebResource>;
-    beginMultipartUpload?: (fieldName: string, payload: BeginMultipartUploadPayload) => Promise<BeginMultipartUploadHandlerResponse>;
-    commitMultipartUpload?: (commitInfo: CommitMultipartUploadPayload) => Promise<WebResource>;
 }
 export declare class WebResourceError extends TypedError {
 }

package/out/webresource-handler/index.js

@@ -211,10 +211,9 @@ const getCreateWebResourceHooks = (webResourceHandler) => {
         },
     };
 };
-const isDefined = (x) => x != null;
 const getWebResourcesHrefs = (webResources) => {
     const hrefs = (webResources ?? []).flatMap((resource) => Object.values(resource ?? {})
-        .filter(isDefined)
+        .filter((resourceKey) => resourceKey != null)
         .map((resourceKey) => (0, exports.normalizeHref)(resourceKey.href)));
     return hrefs;
 };
@@ -225,7 +224,7 @@ exports.normalizeHref = normalizeHref;
 const getWebResourcesKeysFromRequest = (webResourceFields, { values }) => {
     return webResourceFields
         .map((field) => values[field]?.href)
-        .filter(isDefined);
+        .filter((href) => href != null);
 };
 const getRemoveWebResourceHooks = (webResourceHandler) => {
     return {