@squiz/job-runner-lib 2.8.0 → 2.9.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 2.9.0
+
+### Minor Changes
+
+- 89bb566: Mark node:20 runtime image as deprecated
+
 ## 2.8.0
 
 ### Minor Changes

package/lib/domains/job/constants/QueueBacklog.constants.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+/**
+ * Backlog guard defaults. A job's `begin` is rejected with 422 once it has more than
+ * DEFAULT_MAX_QUEUED_EXECUTIONS queued AND its oldest queued execution is older than
+ * DEFAULT_MAX_QUEUED_AGE_HOURS. Both conditions are required (large AND stale).
+ */
+export declare const DEFAULT_MAX_QUEUED_EXECUTIONS = 500;
+export declare const DEFAULT_MAX_QUEUED_AGE_HOURS = 2;

package/lib/domains/job/index.d.ts

@@ -2,6 +2,7 @@ export * from './core/dynamoClient.mock';
 export * from './core/pagination';
 export * from './constants/InjectTokens';
 export * from './constants/JobExecutionStatus.constants';
+export * from './constants/QueueBacklog.constants';
 export * from './constants/Repository.constants';
 export * from './constants/RetryConfig.constants';
 export * from './constants/RuntimeImage.constants';

package/lib/domains/job/repository/JobExecutionRepository/JobExecutionRepository.d.ts

@@ -16,6 +16,21 @@ export declare class JobExecutionRepository extends Repository<JobExecution, Job
      * @memberof JobExecutionRepository
      */
     list(parameters?: ListJobExecutionParameters): Promise<Array<JobExecution>>;
+    /**
+     * Returns the single oldest queued execution for a job, or null if there are none.
+     *
+     * Queries the `lsi1` index (`lsi1sk = "<status>~<jobName>"`). All queued executions of one
+     * job share the same `lsi1sk`, so DynamoDB breaks ties by the base-table `sk`
+     * (`"<jobName>~<id>"`); `id` is prefixed with the ISO `timeQueued`, which sorts
+     * lexicographically, so ascending order is chronological and the first item is the oldest.
+     */
+    getOldestQueuedExecution(jobName: string): Promise<JobExecution | null>;
+    /**
+     * Counts queued executions for a job, evaluating at most `limit` items (`Select: COUNT` so no
+     * item data is returned). Pass a `limit` just above the threshold you care about — queued
+     * items are small, so a single page covers the bounded count.
+     */
+    countQueuedExecutions(jobName: string, limit?: number): Promise<number>;
     /**
      * Get list of records from database.
      * @abstract