@meith/tasks 0.33.3 → 0.34.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meith/tasks",
-  "version": "0.33.3",
+  "version": "0.34.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -11,7 +11,7 @@
   "main": "./src/index.ts",
   "types": "./src/index.ts",
   "dependencies": {
-    "@meith/core": "^0.33.3"
+    "@meith/core": "^0.34.0"
   },
   "files": [
     "src",

package/src/builtin.ts

@@ -1,4 +1,4 @@
-import type { TaskDefinition } from './types'
+import type { TaskContext, TaskDefinition } from './types'
 
 export interface TaskWorkers {
   relayOutbox(batchSize: number): Promise<number>
@@ -28,8 +28,21 @@ export interface TaskWorkers {
   sweepAttachments(batchSize: number): Promise<{ deleted: number; failed: number }>
   sweepAvatars(batchSize: number): Promise<number>
   rollUpStatistics(): Promise<{ memberCount: number; online: number; record: boolean }>
+  runBackups(context: TaskContext): Promise<BackupTaskOutcome>
 }
 
+export interface BackupTaskOutcome {
+  readonly ran: number
+  readonly trigger?: string
+  readonly bundle?: string
+  readonly status?: string
+  readonly skipped?: string
+}
+
+export const BACKUP_TASK_ID = 'backup.run'
+
+export const BACKUP_TASK_MAX_SECONDS = 6 * 60 * 60
+
 function allDefinitions(workers: TaskWorkers): TaskDefinition[] {
   return [
     {
@@ -424,6 +437,28 @@ function allDefinitions(workers: TaskWorkers): TaskDefinition[] {
       },
     },
 
+    {
+      id: BACKUP_TASK_ID,
+      title: 'Take due backups',
+      titleKey: 'adminSystem.task.backupRun.title',
+      description:
+        'Runs the backup an administrator asked for, or the one the schedule says ' +
+        'is due, one at a time: the database dump, the uploads when the settings ' +
+        'include them, a bundle in the backup directory, a copy at the off-site ' +
+        'destination, and the pruning of whatever the retention rules no longer ' +
+        'keep. Checks every minute and does nothing most of the time. The worker ' +
+        'runs it in a lane of its own, because a dump of a large board takes ' +
+        'minutes and the outbox should not wait for it.',
+      descriptionKey: 'adminSystem.task.backupRun.description',
+      intervalSeconds: 60,
+      maxDurationSeconds: BACKUP_TASK_MAX_SECONDS,
+      lane: 'long',
+      async run(context) {
+        const outcome = await workers.runBackups(context)
+        return { detail: { ...outcome } }
+      },
+    },
+
     {
       id: 'stats.rollup',
       title: 'Roll up board statistics',
@@ -471,6 +506,7 @@ const REQUIRED_WORKER: Readonly<Record<string, keyof TaskWorkers>> = {
   'attachments.sweep': 'sweepAttachments',
   'avatars.sweep': 'sweepAvatars',
   'stats.rollup': 'rollUpStatistics',
+  [BACKUP_TASK_ID]: 'runBackups',
 }
 
 export function builtinTasks(workers: Partial<TaskWorkers>): TaskDefinition[] {

package/src/health.ts

@@ -4,10 +4,18 @@ export interface TaskHealthInput {
   readonly enabled: boolean
   readonly lastRunAt: Date | null
   readonly nextRunAt: Date | null
+  readonly lockedUntil?: Date | null | undefined
   readonly consecutiveFailures: number
 }
 
-export type TaskHealthStatus = 'healthy' | 'late' | 'stale' | 'failing' | 'disabled' | 'never-run'
+export type TaskHealthStatus =
+  | 'healthy'
+  | 'running'
+  | 'late'
+  | 'stale'
+  | 'failing'
+  | 'disabled'
+  | 'never-run'
 
 export interface TaskHealth extends TaskHealthInput {
   readonly status: TaskHealthStatus
@@ -31,6 +39,7 @@ export function assessTask(task: TaskHealthInput, now: Date): TaskHealth {
   const status = ((): TaskHealthStatus => {
     if (!task.enabled) return 'disabled'
     if (task.consecutiveFailures >= FAILING_THRESHOLD) return 'failing'
+    if (task.lockedUntil != null && task.lockedUntil.getTime() > now.getTime()) return 'running'
     if (task.lastRunAt === null) return 'never-run'
     if (intervalsLate >= STALE_INTERVALS) return 'stale'
     if (intervalsLate >= 1) return 'late'

package/src/index.ts

@@ -1,4 +1,10 @@
-export { builtinTasks, type TaskWorkers } from './builtin'
+export {
+  BACKUP_TASK_ID,
+  BACKUP_TASK_MAX_SECONDS,
+  type BackupTaskOutcome,
+  builtinTasks,
+  type TaskWorkers,
+} from './builtin'
 export {
   assessScheduler,
   assessTask,

package/src/types.ts

@@ -17,6 +17,7 @@ export interface TaskDefinition {
   readonly descriptionKey?: string
   readonly intervalSeconds: number
   readonly schedule?: string
+  readonly lane?: 'long'
   readonly maxDurationSeconds: number
   run(context: TaskContext): Promise<TaskResult>
 }