@squiz/job-runner-lib 2.2.0 → 2.4.0

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

@@ -3,13 +3,11 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { AttributeValue, DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { PaginationInfo } from '../../core/pagination/model/PaginationInfo';
-import { PaginationQueryResponse } from '../../core/pagination/model/PaginationQueryResponse';
-import { CreateJobExecutionRequest, JobExecution, JobExecutionDto, ListJobExecutionParameters, UpdateJobExecutionParameters } from '../../model/JobExecution/JobExecution';
+import { PaginationInfo, PaginationQueryResponse } from '../../core/pagination';
+import { CreateJobExecutionRequest, JobExecution, JobExecutionDto, JobExecutionSk, ListJobExecutionParameters, UpdateJobExecutionParameters } from '../../model/JobExecution';
 import { Repository } from '../AbstractRepository';
-export declare class JobExecutionRepository extends Repository<JobExecution, JobExecutionDto> {
-    protected dynamoDbClient: DynamoDBClient;
-    constructor(dynamoDbClient: DynamoDBClient);
+export declare class JobExecutionRepository extends Repository<JobExecution, JobExecutionDto, JobExecutionSk> {
+    constructor(dynamoDbClient: DynamoDBClient, tableName: string, tenant?: string);
     begin(createParams: CreateJobExecutionRequest): Promise<JobExecution>;
     /**
      * Get list of records from database.
@@ -25,28 +23,20 @@ export declare class JobExecutionRepository extends Repository<JobExecution, Job
      * @memberof Repository
      */
     getExecutions(paginationInfo: PaginationInfo, jobName: string): Promise<PaginationQueryResponse<JobExecution>>;
-    /**
-     * Get one record from database.
-     * @abstract
-     * @param {string} sk The sort key used to identify the record.
-     * @returns {Promise<JobExecution | null>} The retrieved record.
-     * @memberof Repository
-     */
-    findOne(sk: string, jobName?: string): Promise<JobExecution | null>;
     /**
      * Update record in database.
      * @param {string} sk The sort key used to identify the record.
      * @param {Partial<JobExecution>} input The (partial) record to update.
-     * @param {string} jobName The name of the job used to identify the record as part of the pk.
      * @param {UpdateItemCommandInput} options Additional options for the update command.
      * @returns {Promise<JobExecution | null>} The updated record.
      * @memberof JobExecutionRepository
      */
-    update(sk: string, input: UpdateJobExecutionParameters, jobName?: string, options?: {
+    update(sk: JobExecutionSk, input: UpdateJobExecutionParameters, options?: {
         ConditionExpression?: string;
         ExpressionAttributeValues?: Record<string, AttributeValue>;
         ExpressionAttributeNames?: Record<string, string>;
-    }): Promise<JobExecution | null>;
+    }): Promise<JobExecution>;
+    buildSk(sk: JobExecutionSk): string;
     convertToDynamoDbItem(item: JobExecution): JobExecutionDto;
     convertToItem(dbItem: JobExecutionDto): JobExecution;
 }

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

@@ -2,4 +2,4 @@
  * @license
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
-export {};
+import 'aws-sdk-client-mock-jest';

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

@@ -0,0 +1,2 @@
+import { JobExecution, JobExecutionDto } from '../../../../model/JobExecution';
+export declare const convertDynamoDbItemToJobExecution: (dbItem: JobExecutionDto) => JobExecution;

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

@@ -0,0 +1 @@
+export * from './convertDynamoDbItemToJobExecution/convertDynamoDbItemToJobExecution';

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

@@ -4,13 +4,12 @@
  */
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
 import { Repository } from '../AbstractRepository';
-import { JobManifest } from '../../manifest/JobManifestTypes';
-import { JobManifestDto, CreateJobManifestRequest } from '../../manifest';
-export declare class JobManifestRepository extends Repository<JobManifest, JobManifestDto> {
-    protected dynamoDbClient: DynamoDBClient;
-    constructor(dynamoDbClient: DynamoDBClient);
+import { CreateJobManifestRequest, JobManifest, JobManifestDto, JobManifestSk, UpdateJobManifestRequest } from '../../manifest';
+export declare class JobManifestRepository extends Repository<JobManifest, JobManifestDto, JobManifestSk> {
+    constructor(dynamoDbClient: DynamoDBClient, tableName: string, tenant: string);
     create(input: CreateJobManifestRequest): Promise<JobManifest>;
-    update(sk: string, input: Partial<JobManifest>): Promise<JobManifest | null>;
+    update(sk: JobManifestSk, input: UpdateJobManifestRequest): Promise<JobManifest>;
     convertToDynamoDbItem(item: JobManifest): JobManifestDto;
     convertToItem(dbItem: JobManifestDto): JobManifest;
+    protected buildSk(sk: JobManifestSk): string;
 }

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

@@ -3,13 +3,11 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { Repository } from '../../repository/AbstractRepository';
-import { CreateJobRequest, Job, JobDto, ListJobParameters } from '../../model/Job/Job';
-import { PaginationInfo } from '../../core/pagination/model/PaginationInfo';
-import { PaginationQueryResponse } from '../../core/pagination/model/PaginationQueryResponse';
-export declare class JobRepository extends Repository<Job, JobDto> {
-    protected dynamoDbClient: DynamoDBClient;
-    constructor(dynamoDbClient: DynamoDBClient);
+import { Repository } from '../AbstractRepository';
+import { CreateJobRequest, Job, JobDto, JobSk, ListJobParameters } from '../../model/Job';
+import { PaginationInfo, PaginationQueryResponse } from '../../core/pagination';
+export declare class JobRepository extends Repository<Job, JobDto, JobSk> {
+    constructor(dynamoDbClient: DynamoDBClient, tableName: string, tenant: string);
     create(input: CreateJobRequest): Promise<Job>;
     /**
      * Get list of records from database.
@@ -27,4 +25,5 @@ export declare class JobRepository extends Repository<Job, JobDto> {
     getJobs(paginationInfo: PaginationInfo): Promise<PaginationQueryResponse<Job>>;
     convertToDynamoDbItem(item: Job): JobDto;
     convertToItem(dbItem: JobDto): Job;
+    protected buildSk(sk: JobSk): string;
 }

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

@@ -0,0 +1,9 @@
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import { JobExecutionStatus } from '../../constants/JobExecutionStatus.constants';
+import { JobExecutionsByTenant } from '../../model/JobExecution';
+export declare class MultiTenantJobExecutionRepository {
+    private readonly dynamoDbClient;
+    private readonly tableName;
+    constructor(dynamoDbClient: DynamoDBClient, tableName: string);
+    findByStatus(status: JobExecutionStatus): Promise<JobExecutionsByTenant>;
+}

package/lib/domains/job/repository/MultiTenantJobExecutionRepository/MultiTenantJobExecutionRepository.spec.d.ts

@@ -0,0 +1 @@
+import 'aws-sdk-client-mock-jest';

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

@@ -2,4 +2,5 @@ export * from './JobContextRepository/JobContextRepository';
 export * from './JobExecutionRepository/JobExecutionRepository';
 export * from './JobManifestRepository/JobManifestRepository';
 export * from './JobRepository/JobRepository';
+export * from './MultiTenantJobExecutionRepository/MultiTenantJobExecutionRepository';
 export * from './AbstractRepository';

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

@@ -5,15 +5,18 @@
 import { JobContextRepository } from '../../repository';
 import { PaginationFormattedResponse, PaginationInfo, PaginationService } from '../../core/pagination';
 import { CreateJobContextRequest, JobContext, UpdateJobContextRequest } from '../../model/JobContext';
+import { Logger } from '@squiz/optimization-logger';
 export declare class JobContextService {
     protected jobContextRepository: JobContextRepository;
     protected paginationService: PaginationService<JobContext>;
-    constructor(jobContextRepository: JobContextRepository, paginationService: PaginationService<JobContext>);
+    protected logger: Logger;
+    constructor(jobContextRepository: JobContextRepository, paginationService: PaginationService<JobContext>, logger: Logger);
     createJobContext(input: CreateJobContextRequest): Promise<JobContext>;
-    updateJobContext(name: string, input: UpdateJobContextRequest): Promise<JobContext | null>;
+    updateJobContext(contextName: string, input: UpdateJobContextRequest): Promise<JobContext | null>;
     listAllJobContexts(): Promise<Array<JobContext>>;
     listJobContexts(paginationInfo: PaginationInfo): Promise<PaginationFormattedResponse<JobContext>>;
     private listContextsUpToLimit;
     findJobContext(contextName: string): Promise<JobContext | null>;
-    deleteJobContext(contextName: string): Promise<void>;
+    deleteJobContext(context: JobContext): Promise<void>;
+    private logContextAction;
 }

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

@@ -3,19 +3,23 @@
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
 import { ECSClient } from '@aws-sdk/client-ecs';
-import { ListRunningTasksParams, RunJobTaskParams } from './JobExecutionTaskService.defs';
-import { JobDetailsRepository, S3Repository } from '../../S3Repository';
-import { JobManifestService } from '../JobManifestService/JobManifestService';
+import { JobDetailsRepository, JobUploadsRepository } from '../../S3Repository';
+import { JobExecution } from '../../model/JobExecution';
+import { JobExecutionRepository } from '../../repository';
 import { JobContextService } from '../JobContextService/JobContextService';
+import { JobManifestService } from '../JobManifestService/JobManifestService';
+import { HasReachedMaxTenantConcurrencyParams, RunJobTaskParams } from './JobExecutionTaskService.defs';
 export declare class JobExecutionTaskService {
     private readonly ecsClient;
     private readonly jobManifestService;
     private readonly jobContextService;
+    private readonly jobExecutionRepository;
     private readonly jobDetailsRepository;
     private readonly jobUploadRepository;
-    constructor(ecsClient: ECSClient, jobManifestService: JobManifestService, jobContextService: JobContextService, jobDetailsRepository: JobDetailsRepository, jobUploadRepository: S3Repository);
-    protected getTenantRunningTasks(params: ListRunningTasksParams): Promise<number>;
-    hasReachedMaxTenantConcurrency(params: ListRunningTasksParams): Promise<boolean>;
+    constructor(ecsClient: ECSClient, jobManifestService: JobManifestService, jobContextService: JobContextService, jobExecutionRepository: JobExecutionRepository, jobDetailsRepository: JobDetailsRepository, jobUploadRepository: JobUploadsRepository);
+    hasReachedMaxTenantConcurrency(params: HasReachedMaxTenantConcurrencyParams): Promise<boolean>;
+    hasReachedMaxJobConcurrency(jobExecution: JobExecution): Promise<boolean>;
     runJobExecutionTask(params: RunJobTaskParams): Promise<string | undefined>;
+    private computeJobExecutionClientToken;
     private createJobDetailsFile;
 }

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

@@ -2,9 +2,7 @@ import { JobExecution } from '../../model/JobExecution';
 /**
  * The required parameters for retrieving the number of running ECS tasks
  */
-export interface ListRunningTasksParams {
-    clusterArn: string;
-    runtimeTaskFamily: string;
+export interface HasReachedMaxTenantConcurrencyParams {
     maxTenantConcurrentTasks: number;
 }
 /**

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

@@ -11,5 +11,4 @@ export declare class JobManifestService {
     updateJobManifest(name: string, version: string, input: UpdateJobManifestRequest): Promise<JobManifest | null>;
     listAllJobManifests(): Promise<Array<JobManifest>>;
     findJobManifest(name: string, version: string): Promise<JobManifest | null>;
-    deleteJobManifest(name: string): Promise<void>;
 }

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

@@ -0,0 +1,17 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+import { SQSClient } from '@aws-sdk/client-sqs';
+import { SendJobStartMessageParams } from './JobStartQueueService.defs';
+export declare class JobStartQueueService {
+    private readonly sqsClient;
+    private readonly queueUrl;
+    constructor(sqsClient: SQSClient, queueUrl: string);
+    /**
+     * Sends a job start message to the SQS queue.
+     * Uses a standard queue (not FIFO) to support DelaySeconds for retry backoff.
+     * Duplicate job starts are prevented by ECS RunTask clientToken.
+     */
+    sendJobStartMessage(params: SendJobStartMessageParams): Promise<void>;
+}

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

@@ -0,0 +1,25 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+/**
+ * Message body for the job start queue.
+ */
+export interface JobStartMessage {
+    /** The tenant ID */
+    tenantId: string;
+    /** The job execution ID to start */
+    executionId: string;
+    /** The job name */
+    jobName: string;
+}
+/**
+ * Parameters for sending a job start message.
+ */
+export interface SendJobStartMessageParams {
+    tenantId: string;
+    executionId: string;
+    jobName: string;
+    /** Delay in seconds before the message becomes visible (0-900, max 15 minutes) */
+    delaySeconds?: number;
+}

package/lib/domains/job/services/JobUploadService/utils/manifestValidator.d.ts

@@ -2,7 +2,6 @@
  * @license
  * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
  */
-import { Logger } from '@squiz/dx-logger-lib';
 import { AxiosInstance } from 'axios';
 import { JobManifestV1 } from '../../../../manifest';
 /**
@@ -12,4 +11,4 @@ import { JobManifestV1 } from '../../../../manifest';
  * @param logger - Logger instance
  * @returns The validated manifest
  */
-export declare function getAndValidateManifest(apiClient: AxiosInstance, folderPath: string, logger: Logger): Promise<JobManifestV1>;
+export declare function getAndValidateManifest(apiClient: AxiosInstance, folderPath: string): Promise<JobManifestV1>;

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

@@ -1,5 +1,6 @@
 export * from './JobContextService/JobContextService';
 export * from './JobExecutionTaskService/JobExecutionTaskService';
 export * from './JobManifestService/JobManifestService';
-export * from './JobQueueService/JobQueueService';
+export * from './JobStartQueueService/JobStartQueueService';
+export * from './JobStartQueueService/JobStartQueueService.defs';
 export * from './JobUploadService/JobUploadService';

package/lib/domains/manifest/services/ManifestServiceForDev.d.ts

@@ -1,11 +1,8 @@
 import { JobManifestModel } from '../ManifestModel';
 import { JobManifestV1 } from '../../job/manifest/JobManifestV1';
 import { JsonValidationService } from '@squiz/dx-json-schema-lib';
-import { Logger } from '@squiz/dx-logger-lib';
 export declare class ManifestServiceForDev {
-    protected logger: Logger;
     protected jobValidationService: JsonValidationService;
-    constructor(logger: Logger);
     protected getJobManifest(manifestModel: JobManifestModel, manifestPath: string): JobManifestV1;
     readJobManifest(manifestPath: string): Promise<JobManifestV1>;
     protected assertJobManifestMeetsSchemaVersion(manifest: JobManifestModel, schemaVersionRegex: RegExp): Promise<void>;

package/lib/index.d.ts

@@ -2,3 +2,4 @@ export * from './domains/manifest/ManifestModel';
 export * from './domains/component';
 export * from './domains/job';
 export * from './domains/manifest';
+export * from './utils';