Merge pull request #1785 from balena-io/enable-disable-scheduled-jobs

Add the ability to enable/disable scheduled jobs

src/infra/scheduler/index.ts

@@ -23,6 +23,7 @@ import Redlock from 'redlock';
 import type { ScheduledJobRun } from '../../balena-model.js';
 import { captureException } from '../error-handling/index.js';
 import { redis, redisRO } from '../redis/index.js';
+import { DISABLED_SCHEDULED_JOBS } from '../../lib/config.js';
 
 export type { Job } from 'node-schedule';
 
@@ -88,6 +89,7 @@ const updateJobInfoExecute = async (jobInfoKey: string, job: schedule.Job) => {
 	await redis.set(jobInfoKey, serializedJobInfo);
 };
 
+export const jobIds: string[] = [];
 export const scheduleJob = (
 	jobId: string,
 	rule:
@@ -99,6 +101,7 @@ export const scheduleJob = (
 	jobFunction: JobFunction,
 	lockOptions?: LockSettings,
 ): schedule.Job => {
+	jobIds.push(jobId);
 	const ttl = lockOptions?.ttl ? lockOptions.ttl : JOB_DEFAULT_TTL;
 	const jobLockKey = JOB_LOCK_PREFIX + jobId;
 	const jobInfoKey = JOB_INFO_PREFIX + jobId;
@@ -107,6 +110,11 @@ export const scheduleJob = (
 		rule,
 		async (fireDate: Date) => {
 			try {
+				if (DISABLED_SCHEDULED_JOBS.has(jobId)) {
+					// If jobs are not enabled then we immediately return without taking a lock.
+					// This allows dynamically enabling/disabling jobs without needing to restart the API.
+					return;
+				}
 				const lock: Redlock.Lock = await locker.lock(jobLockKey, ttl);
 				const rootApi = api.resin.clone({
 					passthrough: { req: permissions.root },

src/lib/config.ts

@@ -9,6 +9,7 @@ import {
 	SECONDS,
 	hostPortsVar,
 	trustProxyVar,
+	arrayVar,
 } from '@balena/env-parsing';
 
 // Even though we only use these when TRUST_PROXY we do not conditionally
@@ -486,6 +487,16 @@ export const WEBRESOURCES_CLOUDFRONT_HOST = optionalVar(
 	'WEBRESOURCES_CLOUDFRONT_HOST',
 );
 
+export const DISABLED_SCHEDULED_JOBS = new Set(
+	arrayVar('DISABLED_SCHEDULED_JOBS') ?? [],
+);
+export const disableScheduledJob = (jobName: string) => {
+	DISABLED_SCHEDULED_JOBS.add(jobName);
+};
+export const enableScheduledJob = (jobName: string) => {
+	DISABLED_SCHEDULED_JOBS.delete(jobName);
+};
+
 /**
  * Splits an env var in the format of `${username}:${password}`
  * into a RedisAuth object. Auth is optional, so this can return