@squiz/job-runner-lib 1.66.1

package/src/domains/job/manifest/JobManifestV1.ts

@@ -0,0 +1,60 @@
+import { JobManifestV1Model } from '../../../domains/manifest/ManifestModel';
+import { SchemaVersions } from '../../../domains/manifest/AbstractManifest';
+import { ResourceNotFoundError } from '@squiz/dx-common-lib';
+import { MANIFEST_MODELS } from '@squiz/dx-json-schema-lib';
+import path from 'path';
+
+export class JobManifestV1 {
+  constructor(protected manifest: JobManifestV1Model, protected manifestPath: string) {}
+
+  public static getJobSchemaVersionRegex(): RegExp {
+    return /\/schemas\/(?<schema>JobV\d+)\.json#?$/;
+  }
+
+  public getSchemaVersion(): SchemaVersions {
+    return 'JobV1';
+  }
+
+  public getModel(): JobManifestV1Model {
+    return this.manifest;
+  }
+
+  public getJobFunctionByName(fnName: string = ''): MANIFEST_MODELS.JobV1.JobFunction {
+    const manifestModel = this.getModel();
+    if (!fnName) {
+      if (manifestModel.mainFunction) {
+        fnName = manifestModel.mainFunction;
+      } else {
+        throw new ResourceNotFoundError('Job main function is not defined');
+      }
+    }
+    const functionDefinition = manifestModel.functions.find((a) => a.name === fnName);
+
+    if (!functionDefinition) {
+      throw new ResourceNotFoundError(
+        `"${fnName}" function for ${this.getName()} ${this.getVersion()} could not be found`,
+      );
+    }
+    return functionDefinition;
+  }
+
+  public async getJobFunctionEntryFilePath(jobFunction: MANIFEST_MODELS.JobV1.JobFunction): Promise<string> {
+    const jobDirectory = this.getJobDirectory();
+    const inputPath = path.resolve(path.join(jobDirectory, jobFunction.entry));
+    return inputPath;
+  }
+
+  public getJobDirectory() {
+    return path.resolve(path.join(this.manifestPath, '..'));
+  }
+
+  public getManifestPath() {
+    return this.manifestPath;
+  }
+  public getName(): string {
+    return this.manifest.name;
+  }
+  public getVersion(): string {
+    return this.manifest.version;
+  }
+}

package/src/domains/job/manifest/index.ts

@@ -0,0 +1,5 @@
+export * from './JobManifestTypes';
+export * from './mocks/JobManifest.mock';
+export * from './mocks/JobManifestDto.mock';
+export * from './mocks/JobManifestRecord.mock';
+export * from './mocks/JobManifestRequest.mock';

package/src/domains/job/manifest/mocks/JobManifest.mock.ts

@@ -0,0 +1,35 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../constants/Repository.constants';
+import { JobManifest } from '../JobManifestTypes';
+
+export const createMockJobManifest = (partialRecord: Partial<JobManifest> = {}): JobManifest => {
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+  const input = {};
+
+  return {
+    concurrency: faker.number.int(),
+    entryFile: faker.system.fileName(),
+    entryFunction: {
+      name: faker.lorem.word(),
+      entry: faker.system.filePath(),
+      input,
+    },
+    name: faker.lorem.word(),
+    version,
+    timeoutSeconds: faker.number.int({ max: 28800, min: 5 }),
+    type: PARTITION_KEYS.job,
+    ...partialRecord,
+  };
+};
+
+export const createMockJobManifests = (size?: number): Array<JobManifest> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobManifest());
+};

package/src/domains/job/manifest/mocks/JobManifestDto.mock.ts

@@ -0,0 +1,46 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../constants/Repository.constants';
+import { JobManifestDto, JobManifestRecord } from '../JobManifestTypes';
+
+export const createMockJobManifestDto = (partialRecord: Partial<JobManifestRecord> = {}): JobManifestDto => {
+  const name = faker.lorem.word();
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+  const input = {};
+
+  return {
+    concurrency: {
+      N: (partialRecord.concurrency ?? faker.number.int()).toString(),
+    },
+    entryFile: { S: partialRecord.entryFile ?? faker.system.fileName() },
+    entryFunction: {
+      S: JSON.stringify(partialRecord.entryFunction) ?? JSON.stringify(input),
+    },
+    pk: {
+      S: partialRecord.pk ?? PARTITION_KEYS.manifest,
+    },
+    sk: {
+      S: partialRecord.sk ?? `${name}-${version}`,
+    },
+    name: {
+      S: partialRecord.name ?? name,
+    },
+    version: {
+      S: partialRecord.version ?? version,
+    },
+    timeoutSeconds: {
+      N: (partialRecord.timeoutSeconds ?? faker.number.int({ max: 28800, min: 5 })).toString(),
+    },
+  };
+};
+
+export const createMockJobManifestDtos = (size?: number): Array<JobManifestDto> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobManifestDto());
+};

package/src/domains/job/manifest/mocks/JobManifestRecord.mock.ts

@@ -0,0 +1,37 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../constants/Repository.constants';
+import { JobManifestRecord } from '../JobManifestTypes';
+
+export const createMockJobManifestRecord = (partialRecord: Partial<JobManifestRecord> = {}): JobManifestRecord => {
+  const name = faker.lorem.word();
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+  const input = {};
+
+  return {
+    concurrency: faker.number.int(),
+    entryFile: faker.system.fileName(),
+    entryFunction: {
+      name: faker.lorem.word(),
+      entry: faker.system.filePath(),
+      input,
+    },
+    pk: PARTITION_KEYS.job,
+    sk: `${name}-${version}`,
+    name,
+    version,
+    timeoutSeconds: faker.number.int({ max: 28800, min: 5 }),
+    ...partialRecord,
+  };
+};
+
+export const createMockJobManifestRecords = (size?: number): Array<JobManifestRecord> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobManifestRecord());
+};

package/src/domains/job/manifest/mocks/JobManifestRequest.mock.ts

@@ -0,0 +1,30 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { CreateJobManifestRequest } from '../JobManifestTypes';
+
+export const createMockCreateJobManifestRequest = (
+  partialRecord: Partial<CreateJobManifestRequest> = {},
+): CreateJobManifestRequest => {
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+  const input = {};
+
+  return {
+    concurrency: faker.number.int(),
+    entryFile: faker.system.fileName(),
+    entryFunction: {
+      name: faker.lorem.word(),
+      entry: faker.system.filePath(),
+      input,
+    },
+    name: faker.lorem.word(),
+    version,
+    timeoutSeconds: faker.number.int({ max: 28800, min: 5 }),
+    ...partialRecord,
+  };
+};

package/src/domains/job/model/Base/Base.ts

@@ -0,0 +1,44 @@
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+import { PartitionKey } from '../../constants/Repository.constants';
+
+/**
+ * The base interface for job runner entities.
+ * @export
+ * @interface BaseItem
+ */
+export interface BaseItem {
+  /**
+   * The property representing the corresponding record's partition key.
+   * @type {PartitionKey}
+   * @memberof BaseItem
+   */
+  type: PartitionKey;
+}
+
+/**
+ * The base interface representing the attributes of a DynamoDB record.
+ * @export
+ * @interface BaseRecord
+ */
+export interface BaseRecord {
+  /**
+   * The partition key.
+   * @type {PartitionKey}
+   * @memberof BaseRecord
+   */
+  pk: PartitionKey;
+
+  /**
+   * The sort key.
+   * @type {string}
+   * @memberof BaseRecord
+   */
+  sk: string;
+}
+
+/**
+ * The base dto interface.
+ * @export
+ * @interface BaseDto
+ */
+export type BaseDto = Record<keyof BaseRecord, AttributeValue>;

package/src/domains/job/model/Base/index.ts

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

package/src/domains/job/model/Job/Job.ts

@@ -0,0 +1,98 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+import { PartitionKey } from '../../constants/Repository.constants';
+
+/**
+ * Job interface.
+ * @export
+ * @interface Job
+ */
+export interface Job {
+  /**
+   * The name of the job.
+   * @type {string}
+   * @memberof Job
+   */
+  name: string;
+
+  /**
+   * The description of the job.
+   * @type {string}
+   * @memberof Job
+   */
+  description: string;
+
+  /**
+   * The version of the job.
+   * @type {string}
+   * @memberof Job
+   */
+  version: string;
+
+  /**
+   * The DynamoDB record type ('job').
+   * @type {PartitionKey}
+   * @memberof Job
+   */
+  type: PartitionKey;
+}
+
+/**
+ * The Job record attributes stored in DynamoDB.
+ * @export
+ * @interface JobRecord
+ */
+export interface JobRecord {
+  /**
+   * The partition key ('job').
+   * @type {PartitionKey}
+   * @memberof JobRecord
+   */
+  pk: PartitionKey;
+
+  /**
+   * The sort key ('name-version').
+   * @type {string}
+   * @memberof JobRecord
+   */
+  sk: string;
+
+  /**
+   * The name of the job.
+   * @type {string}
+   * @memberof JobRecord
+   */
+  name: string;
+
+  /**
+   * The description of the job.
+   * @type {string}
+   * @memberof JobRecord
+   */
+  description: string;
+
+  /**
+   * The version of the job.
+   * @type {string}
+   * @memberof JobRecord
+   */
+  version: string;
+}
+
+export type JobDto = Record<keyof JobRecord, AttributeValue>;
+
+/**
+ * The parameters for listing jobs.
+ * @export
+ */
+export type ListJobParameters = Partial<Pick<Job, 'name' | 'version'>>;
+
+/**
+ * The request body for creating a job (POST /job).
+ * @export
+ */
+export type CreateJobRequest = Omit<Job, 'type'>;

package/src/domains/job/model/Job/index.ts

@@ -0,0 +1,5 @@
+export * from './Job';
+export * from './mocks/Job.mock';
+export * from './mocks/JobDto.mock';
+export * from './mocks/JobRecord.mock';
+export * from './mocks/JobRequest.mock';

package/src/domains/job/model/Job/mocks/Job.mock.ts

@@ -0,0 +1,26 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../../constants/Repository.constants';
+import { Job } from '../Job';
+
+export const createMockJob = (partialRecord: Partial<Job> = {}): Job => {
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+  return {
+    name: faker.lorem.word(),
+    description: faker.lorem.sentence(),
+    type: PARTITION_KEYS.job,
+    version: version,
+    ...partialRecord,
+  };
+};
+
+export const createMockJobs = (size?: number): Array<Job> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJob());
+};

package/src/domains/job/model/Job/mocks/JobDto.mock.ts

@@ -0,0 +1,37 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../../constants/Repository.constants';
+import { JobDto, JobRecord } from '../Job';
+
+export const createMockJobDto = (partialRecord: Partial<JobRecord> = {}): JobDto => {
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+
+  return {
+    pk: {
+      S: partialRecord.pk ?? PARTITION_KEYS.job,
+    },
+    sk: {
+      S: partialRecord.sk ?? `${faker.lorem.word()}-${faker.lorem.word()}`,
+    },
+    name: {
+      S: partialRecord.name ?? faker.lorem.word(),
+    },
+    description: {
+      S: partialRecord.description ?? faker.lorem.word(),
+    },
+    version: {
+      S: partialRecord.version ?? version,
+    },
+  };
+};
+
+export const createMockJobDtos = (size?: number): Array<JobDto> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobDto());
+};

package/src/domains/job/model/Job/mocks/JobRecord.mock.ts

@@ -0,0 +1,28 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../../constants/Repository.constants';
+import { JobRecord } from '../Job';
+
+export const createMockJobRecord = (partialRecord: Partial<JobRecord> = {}): JobRecord => {
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+
+  return {
+    pk: PARTITION_KEYS.job,
+    sk: `${faker.lorem.word()}-${faker.lorem.word()}`,
+    name: faker.lorem.word(),
+    description: faker.lorem.sentence(),
+    version,
+    ...partialRecord,
+  };
+};
+
+export const createMockJobRecords = (size?: number): Array<JobRecord> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobRecord());
+};

package/src/domains/job/model/Job/mocks/JobRequest.mock.ts

@@ -0,0 +1,20 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { CreateJobRequest } from '../Job';
+
+export const createMockCreateJobRequest = (partialRecord: Partial<CreateJobRequest> = {}): CreateJobRequest => {
+  const version = Array.from({ length: 3 })
+    .map(() => faker.number.int())
+    .join('.');
+
+  return {
+    name: faker.lorem.word(),
+    description: faker.lorem.sentence(),
+    version,
+    ...partialRecord,
+  };
+};

package/src/domains/job/model/JobContext/JobContext.ts

@@ -0,0 +1,101 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+import { PartitionKey } from '../../constants/Repository.constants';
+
+/**
+ * Environment interface.
+ * @interface Environment
+ */
+export interface Environment {
+  [key: string]: string;
+}
+
+export type RuntimeJobContext = Omit<JobContext, 'type'>;
+
+/**
+ * JobContext interface.
+ * @export
+ * @interface JobContext
+ */
+export interface JobContext {
+  /**
+   * The name of the job context.
+   * @type {string}
+   * @memberof JobContext
+   */
+  contextName: string;
+
+  /**
+   * The description of the job context.
+   * @type {string}
+   * @memberof JobContext
+   */
+  description: string;
+
+  /**
+   * The environment of the job context.
+   * @type {Environment}
+   * @memberof JobContext
+   */
+  environment: Environment;
+
+  /**
+   * The DynamoDB record type ('context').
+   * @type {PartitionKey}
+   * @memberof JobContext
+   */
+  type: PartitionKey;
+}
+
+/**
+ * The Job Context record attributes stored in DynamoDB.
+ * @export
+ * @interface JobContextRecord
+ */
+export interface JobContextRecord {
+  /**
+   * The partition key ('context').
+   * @type {PartitionKey}
+   * @memberof JobContextRecord
+   */
+  pk: PartitionKey;
+
+  /**
+   * The description of the job context.
+   * @type {string}
+   * @memberof JobContextRecord
+   */
+  description: string;
+
+  /**
+   * The sort key ('contextName').
+   * @type {string}
+   * @memberof JobContextRecord
+   */
+  sk: string;
+
+  /**
+   * The environment of the job context.
+   * @type {Environment}
+   * @memberof JobContextRecord
+   */
+  environment: Environment;
+}
+
+export type JobContextDto = Record<keyof JobContextRecord, AttributeValue>;
+
+/**
+ * The request body for creating a job context (POST /job-context).
+ * @export
+ */
+export type CreateJobContextRequest = Omit<JobContext, 'type'>;
+
+/**
+ * The request body for updating a job context (PATCH /job-context).
+ * @export
+ */
+export type UpdateJobContextRequest = Partial<Omit<JobContext, 'contextName' | 'type'>>;

package/src/domains/job/model/JobContext/index.ts

@@ -0,0 +1,5 @@
+export * from './JobContext';
+export * from './mocks/JobContext.mock';
+export * from './mocks/JobContextDto.mock';
+export * from './mocks/JobContextRecord.mock';
+export * from './mocks/JobContextRequest.mock';

package/src/domains/job/model/JobContext/mocks/JobContext.mock.ts

@@ -0,0 +1,34 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../../constants/Repository.constants';
+import { JobContext } from '../JobContext';
+
+export const createMockJobContext = (partialRecord: Partial<JobContext> = {}): JobContext => {
+  const environment: Record<string, string> = partialRecord.environment ?? {};
+
+  if (!partialRecord.environment) {
+    const numOfEnvVars = faker.number.int({ max: 5, min: 1 });
+    for (let i = 0; i < numOfEnvVars; i++) {
+      const key = faker.lorem.word(); // Generate a random key
+      const value = faker.lorem.word(); // Generate a random value
+      environment[key] = value;
+    }
+  }
+
+  return {
+    contextName: faker.lorem.word(),
+    description: faker.lorem.words(),
+    environment,
+    type: PARTITION_KEYS.context,
+    ...partialRecord,
+  };
+};
+
+export const createMockJobContexts = (size?: number): Array<JobContext> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobContext());
+};

package/src/domains/job/model/JobContext/mocks/JobContextDto.mock.ts

@@ -0,0 +1,46 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { faker } from '@faker-js/faker/locale/en';
+import { PARTITION_KEYS } from '../../../constants/Repository.constants';
+import { JobContextDto, JobContextRecord } from '../JobContext';
+
+export const createMockJobContextDto = (partialRecord: Partial<JobContextRecord> = {}): JobContextDto => {
+  const environment: Record<string, string> = partialRecord.environment ?? {};
+
+  if (!partialRecord.environment) {
+    const numOfEnvVars = faker.number.int({ max: 5, min: 1 });
+    for (let i = 0; i < numOfEnvVars; i++) {
+      const key = faker.lorem.word(); // Generate a random key
+      const value = faker.lorem.word(); // Generate a random value
+      environment[key] = value;
+    }
+  }
+
+  const environmentMap: Record<string, any> = {};
+  for (const key of Object.keys(environment)) {
+    environmentMap[key] = { S: environment[key] };
+  }
+
+  return {
+    environment: {
+      M: environmentMap,
+    },
+    description: {
+      S: partialRecord.description ?? faker.lorem.words(),
+    },
+    pk: {
+      S: partialRecord.pk ?? PARTITION_KEYS.context,
+    },
+    sk: {
+      S: partialRecord.sk ?? faker.lorem.word(),
+    },
+  };
+};
+
+export const createMockJobContextDtos = (size?: number): Array<JobContextDto> => {
+  const randomSize = size ?? faker.number.int({ max: 3, min: 1 });
+  return Array.from({ length: randomSize }).map(() => createMockJobContextDto());
+};