@squiz/job-runner-lib 2.7.0 → 2.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## 2.9.0
+
+### Minor Changes
+
+- 89bb566: Mark node:20 runtime image as deprecated
+
+## 2.8.0
+
+### Minor Changes
+
+- ce08dad: Added autoRetry support to job runner
+
 ## 2.7.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/constants/RetryConfig.constants.d.ts

@@ -6,13 +6,18 @@
  * Retry configuration with exponential backoff delays in seconds.
  * Using SQS message timer limits (max 15 minutes = 900 seconds).
  *
- * Delays: 30s, 1min, 2min, 5min, 10min, 15min
+ * Delays: 30s, 1min, 2min, 5min, 10min, then 15min thereafter.
  */
 export declare const RETRY_DELAYS_SECONDS: ReadonlyArray<number>;
 /**
  * Maximum number of retry attempts for container start failures.
  */
 export declare const MAX_RETRY_ATTEMPTS: number;
+/**
+ * Maximum number of total attempts for opted-in job code failures.
+ * This allows the initial attempt plus 3 retries.
+ */
+export declare const MAX_JOB_CODE_RETRY_ATTEMPTS = 4;
 /**
  * After a job has attempted to be started this number of times alerts will start to be sent.
  */

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

@@ -9,3 +9,8 @@ export declare const DEPRECATED_RUNTIME_IMAGES: readonly string[];
 export declare const getRuntimeImageOrDefault: (image: string | null | undefined) => string;
 export declare const isSupportedRuntimeImage: (image: string) => boolean;
 export declare const isDeprecatedRuntimeImage: (image: string) => boolean;
+export declare const getRuntimeImagesMetadata: () => {
+    supportedRuntimeImages: ("node:20" | "node:24")[];
+    deprecatedRuntimeImages: string[];
+    recommendedRuntimeImage: string;
+};

package/lib/domains/job/errors/RuntimeImageTaskDefinitionError.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export declare class RuntimeImageTaskDefinitionError extends Error {
+    constructor(message: string);
+}

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

@@ -6,3 +6,4 @@ export * from './NotFoundError';
 export * from './NotImplementedError';
 export * from './UnprocessableContent';
 export * from './ExecutionStatusError';
+export * from './RuntimeImageTaskDefinitionError';

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/manifest/JobManifestTypes.d.ts

@@ -55,6 +55,12 @@ export interface JobManifest {
      * @memberof JobManifest
      */
     image: string;
+    /**
+     * Whether failed job code executions should be retried automatically.
+     * @type {boolean}
+     * @memberof JobManifest
+     */
+    autoRetry: boolean;
     /**
      * The DynamoDB record type ('job').
      * @type {EntityType}
@@ -124,13 +130,19 @@ export interface JobManifestRecord {
      * @memberof JobManifestRecord
      */
     image: string;
+    /**
+     * Whether failed job code executions should be retried automatically.
+     * @type {boolean}
+     * @memberof JobManifestRecord
+     */
+    autoRetry: boolean;
 }
 export type JobManifestDto = Record<keyof JobManifestRecord, AttributeValue>;
 /**
  * The request body for creating a job (POST /job-manifest).
  * @export
  */
-export type CreateJobManifestRequest = Omit<JobManifest, 'type'>;
+export type CreateJobManifestRequest = Omit<JobManifest, 'type' | 'autoRetry'> & Partial<Pick<JobManifest, 'autoRetry'>>;
 /**
  * The request body for updating a job (PUT /job-manifest).
  * @export

package/lib/domains/job/model/Job/Job.d.ts

@@ -29,6 +29,12 @@ export interface Job {
      * @memberof Job
      */
     version: string;
+    /**
+     * The runtime image the job should execute against (e.g. `node:20`, `node:24`).
+     * @type {string}
+     * @memberof Job
+     */
+    image: string;
     /**
      * The DynamoDB record type ('job').
      * @type {EntityType}
@@ -72,6 +78,12 @@ export interface JobRecord {
      * @memberof JobRecord
      */
     version: string;
+    /**
+     * The runtime image the job should execute against (e.g. `node:20`, `node:24`).
+     * @type {string}
+     * @memberof JobRecord
+     */
+    image: string;
 }
 export type JobDto = Record<keyof JobRecord, AttributeValue>;
 /**

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

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

@@ -3,8 +3,8 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { Repository } from '../AbstractRepository';
 import { CreateJobManifestRequest, JobManifest, JobManifestDto, JobManifestSk, UpdateJobManifestRequest } from '../../manifest';
+import { Repository } from '../AbstractRepository';
 export declare class JobManifestRepository extends Repository<JobManifest, JobManifestDto, JobManifestSk> {
     constructor(dynamoDbClient: DynamoDBClient, tableName: string, tenant: string);
     create(input: CreateJobManifestRequest): Promise<JobManifest>;

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

@@ -3,9 +3,9 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { Repository } from '../AbstractRepository';
-import { CreateJobRequest, Job, JobDto, JobSk, ListJobParameters } from '../../model/Job';
 import { PaginationInfo, PaginationQueryResponse } from '../../core/pagination';
+import { CreateJobRequest, Job, JobDto, JobSk, ListJobParameters } from '../../model/Job';
+import { Repository } from '../AbstractRepository';
 export declare class JobRepository extends Repository<Job, JobDto, JobSk> {
     constructor(dynamoDbClient: DynamoDBClient, tableName: string, tenant: string);
     create(input: CreateJobRequest): Promise<Job>;

package/lib/domains/job/services/JobExecutionTaskService/JobExecutionTaskService.d.ts

@@ -22,4 +22,5 @@ export declare class JobExecutionTaskService {
     runJobExecutionTask(params: RunJobTaskParams): Promise<string | undefined>;
     private computeJobExecutionClientToken;
     private createJobDetailsFile;
+    private findJobManifest;
 }

package/lib/domains/job/services/JobExecutionTaskService/JobExecutionTaskService.defs.d.ts

@@ -15,5 +15,6 @@ export interface RunJobTaskParams {
     shortEnvironment: string;
     clusterArn: string;
     taskDefinitionArn: string;
+    taskDefinitionArnsByRuntimeImage: Record<string, string>;
     tenantId: string;
 }

package/lib/domains/job/utils/ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { ResolveRuntimeImageTaskDefinitionArnParams } from './ResolveRuntimeImageTaskDefinitionArn.types';
+export declare const resolveRuntimeImageTaskDefinitionArn: ({ image, taskDefinitionArnsByRuntimeImage, legacyTaskDefinitionArn, }: ResolveRuntimeImageTaskDefinitionArnParams) => string;

package/lib/domains/job/utils/ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn.types.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export interface ResolveRuntimeImageTaskDefinitionArnParams {
+    image: string | null | undefined;
+    taskDefinitionArnsByRuntimeImage: Record<string, string>;
+    legacyTaskDefinitionArn: string;
+}

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

@@ -3,3 +3,5 @@ export * from './GetAwsTags/GetAwsTags.types';
 export * from './SlackClient/SlackClient';
 export * from './SlackClient/types/SlackClient.types';
 export * from './SortByTimeQueued/SortByTimeQueued';
+export * from './ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn';
+export * from './ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn.types';

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

@@ -1,8 +1,9 @@
-export * from './services/ManifestServiceForDev';
 export * from './services/JobFunctionService';
+export * from './services/ManifestServiceForDev';
+export * from './utils/defaultAutoRetry';
 export * from './utils/getAndAssertJobManifestVersion';
 export * from './utils/isValidManifestVersion';
 export * from './utils/validateRuntimeImage';
-export * from './ManifestModel';
 export * from '../job/manifest/JobManifestV1';
 export * from './errors/ManifestValidationError';
+export * from './ManifestModel';

package/lib/domains/manifest/utils/defaultAutoRetry.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export declare const defaultAutoRetry: (autoRetry: boolean | null | undefined) => boolean;

package/lib/domains/manifest/utils/defaultAutoRetry.spec.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+export {};