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

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/tasks.ts

@@ -1,46 +0,0 @@
-// These types were generated by @balena/abstract-sql-to-typescript v4.0.0
-
-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/src/tasks/worker.ts

@@ -1,289 +0,0 @@
-import type { ValidateFunction } from 'ajv';
-import { setTimeout } from 'node:timers/promises';
-import type { AnyObject } from 'pinejs-client-core';
-import { tasks as tasksEnv } from '../config-loader/env';
-import type * as Db from '../database-layer/db';
-import * as permissions from '../sbvr-api/permissions';
-import { PinejsClient } from '../sbvr-api/sbvr-utils';
-import { sbvrUtils } from '../server-glue/module';
-import { ajv } from './common';
-import type { Task } from './tasks';
-
-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;
-}
-
-type PartialTask = Pick<
-	Task['Read'],
-	| 'id'
-	| 'is_created_by__actor'
-	| 'is_executed_by__handler'
-	| 'is_executed_with__parameter_set'
-	| 'is_scheduled_with__cron_expression'
-	| 'attempt_count'
-	| 'attempt_limit'
->;
-
-// Map of column names with SBVR names used in SELECT queries
-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',
-} satisfies Record<string, keyof Task['Read']>)
-	.map(([key, value]) => `t."${key}" AS "${value}"`)
-	.join(', ');
-
-// The worker is responsible for executing tasks in the queue.
-// It polls the database for tasks to execute. It will execute
-// tasks in parallel up to a certain concurrency limit.
-export class Worker {
-	public handlers: Record<string, TaskHandler> = {};
-	private readonly concurrency: number;
-	private readonly interval: number;
-	private executing = 0;
-
-	constructor(private readonly client: PinejsClient) {
-		this.concurrency = tasksEnv.queueConcurrency;
-		this.interval = tasksEnv.queueIntervalMS;
-	}
-
-	// Check if instance can execute more tasks
-	private canExecute(): boolean {
-		return (
-			this.executing < this.concurrency && Object.keys(this.handlers).length > 0
-		);
-	}
-
-	private async execute(task: PartialTask, tx: Db.Tx): Promise<void> {
-		this.executing++;
-		try {
-			// Get specified handler
-			const handler = this.handlers[task.is_executed_by__handler];
-			const startedOnTime = new Date();
-
-			// This should never actually happen
-			if (handler == null) {
-				await this.update(
-					tx,
-					task,
-					startedOnTime,
-					'failed',
-					'Matching task handler not found, this should never happen!',
-				);
-				return;
-			}
-
-			// Validate parameters before execution so we can fail early if
-			// the parameter set is invalid. This can happen if the handler
-			// definition changes after a task is added to the queue.
-			if (
-				handler.validate != null &&
-				!handler.validate(task.is_executed_with__parameter_set)
-			) {
-				await this.update(
-					tx,
-					task,
-					startedOnTime,
-					'failed',
-					`Invalid parameter set: ${ajv.errorsText(handler.validate.errors)}`,
-				);
-				return;
-			}
-
-			// Execute handler and update task with results
-			let status: Task['Read']['status'] = 'queued';
-			let error: string | undefined;
-			try {
-				const results = await handler.fn({
-					api: new 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) {
-			// This shouldn't happen, but if it does we want to log and kill the process
-			console.error(
-				`Failed to execute task ${task.id} with handler ${task.is_executed_by__handler}:`,
-				err,
-			);
-			process.exit(1);
-		} finally {
-			this.executing--;
-		}
-	}
-
-	// Update task and schedule next attempt if needed
-	private async update(
-		tx: Db.Tx,
-		task: PartialTask,
-		startedOnTime: Date,
-		status: Task['Read']['status'],
-		errorMessage?: string,
-	): Promise<void> {
-		const attemptCount = task.attempt_count + 1;
-		const body: Partial<Task['Write']> = {
-			started_on__time: startedOnTime,
-			ended_on__time: new Date(),
-			status,
-			attempt_count: attemptCount,
-			...(errorMessage != null && { error_message: errorMessage }),
-		};
-
-		// Re-enqueue if the task failed but has retries left, remember that
-		// attemptCount includes the initial attempt while attempt_limit does not
-		if (status === 'failed' && attemptCount < task.attempt_limit) {
-			body.status = 'queued';
-
-			// Schedule next attempt using exponential backoff
-			body.is_scheduled_to_execute_on__time =
-				this.getNextAttemptTime(attemptCount);
-		}
-
-		// Patch current task
-		await this.client.patch({
-			resource: 'task',
-			passthrough: {
-				tx,
-				req: permissions.root,
-			},
-			id: task.id,
-			body,
-		});
-
-		// Create new task with same configuration if previous
-		// iteration completed and has a cron expression
-		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,
-				},
-			});
-		}
-	}
-
-	// Calculate next attempt time using exponential backoff
-	private getNextAttemptTime(attempt: number): Date | null {
-		const delay = Math.ceil(Math.exp(Math.min(10, attempt)));
-		return new Date(Date.now() + delay);
-	}
-
-	// Poll for tasks and execute them
-	// This is recursive and is spawned once per concurrency limit
-	private poll(): void {
-		let executed = false;
-		void (async () => {
-			try {
-				if (!this.canExecute()) {
-					return;
-				}
-				const handlerNames = Object.keys(this.handlers);
-				await sbvrUtils.db.transaction(async (tx) => {
-					const result = await 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)],
-					);
-
-					// Execute task if one was found
-					if (result.rows.length > 0) {
-						await this.execute(result.rows[0] as PartialTask, tx);
-						executed = true;
-					}
-				});
-			} catch (err) {
-				console.error('Failed polling for tasks:', err);
-			} finally {
-				if (!executed) {
-					await setTimeout(this.interval);
-				}
-				this.poll();
-			}
-		})();
-	}
-
-	// Start polling for tasks
-	public async start(): Promise<void> {
-		// Tasks only support postgres for now
-		if (sbvrUtils.db.engine !== 'postgres') {
-			throw new Error(
-				'Database does not support tasks, giving up on starting worker',
-			);
-		}
-
-		// Check for any pending tasks with unknown handlers
-		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(', ')}`,
-			);
-		}
-
-		// Spawn children to poll for and execute tasks
-		for (let i = 0; i < this.concurrency; i++) {
-			this.poll();
-		}
-	}
-}