@squiz/job-runner-lib 1.66.1

package/src/domains/content/services/DynamicContentItemService.ts

@@ -0,0 +1,30 @@
+import { ContentApiService } from '@squiz/component-web-api-lib';
+import { AxiosError } from 'axios';
+import { UriResource } from '../../component';
+
+export class DynamicContentItemService {
+  constructor(private api: ContentApiService<UriResource>['dynamicContent']) {}
+
+  public async getDynamicContentItem(contentUri: string, apiKey: string): Promise<UriResource | undefined> {
+    try {
+      const headers: Record<string, string | number> = {
+        'x-api-key': apiKey,
+      };
+
+      const response = await this.api.getDynamicContentItem({ _contentUri: contentUri }, { headers });
+
+      return response.data;
+    } catch (e) {
+      const axiosError = e as AxiosError;
+      throw this.handleAxiosError(axiosError);
+    }
+  }
+
+  private handleAxiosError(error: AxiosError): Error {
+    const { response } = error;
+    if (!response || (typeof error == 'object' && !error.isAxiosError)) {
+      return error;
+    }
+    throw new Error(`Error occurred when resolving content from uri: ${(response.data as any)?.message}`);
+  }
+}

package/src/domains/content/utils/getContentSchemaName.spec.ts

@@ -0,0 +1,7 @@
+import { getContentSchemaName } from './getContentSchemaName';
+
+describe('getContentSchemaName', () => {
+  it('should join the component name, version and function by "/"', () => {
+    expect(getContentSchemaName('ns/foo', '1.1.1', 'main')).toEqual('ns/foo/1.1.1/main');
+  });
+});

package/src/domains/content/utils/getContentSchemaName.ts

@@ -0,0 +1,7 @@
+export function getContentSchemaName(
+  componentName: string,
+  componentVersion: string,
+  componentFunction: string,
+): string {
+  return [componentName, componentVersion, componentFunction].join('/');
+}

package/src/domains/db/ComponentConnectionManager.ts

@@ -0,0 +1,4 @@
+import { ConnectionManager } from '@squiz/db-lib';
+import { ComponentRepositories } from './ComponentRepositories';
+
+export type ComponentConnectionManager = ConnectionManager<ComponentRepositories>;

package/src/domains/db/ComponentRepositories.ts

@@ -0,0 +1,31 @@
+import { Repositories } from '@squiz/db-lib';
+import { ComponentSetComponentVersionRepository } from '../component-set/repositories/ComponentSetComponentVersionRepository';
+import { ComponentSetComponentVersionExcludedRepository } from '../component-set/repositories/ComponentSetComponentVersionExcludedRepository';
+import { ComponentSetComponentVersionEditableRepository } from '../component-set/repositories/ComponentSetComponentVersionEditableRepository';
+import { ComponentSetRepository } from '../component-set/repositories/ComponentSetRepository';
+import { ComponentSetRuleRepository } from '../component-set/repositories/ComponentSetRuleRepository';
+import { ComponentRepository } from '../component/repositories/ComponentRepository';
+import { ComponentVersionRepository } from '../component/repositories/ComponentVersionRepository';
+import { ComponentConnectionManager } from './ComponentConnectionManager';
+
+export interface ComponentRepositories extends Repositories {
+  component: ComponentRepository;
+  componentVersion: ComponentVersionRepository;
+  componentSet: ComponentSetRepository;
+  componentSetComponentVersion: ComponentSetComponentVersionRepository;
+  componentSetComponentVersionExcluded: ComponentSetComponentVersionExcludedRepository;
+  componentSetComponentVersionEditable: ComponentSetComponentVersionEditableRepository;
+  componentSetRule: ComponentSetRuleRepository;
+}
+
+export function createComponentRepositories(dbManager: ComponentConnectionManager): ComponentRepositories {
+  return {
+    component: new ComponentRepository(dbManager),
+    componentVersion: new ComponentVersionRepository(dbManager),
+    componentSet: new ComponentSetRepository(dbManager),
+    componentSetComponentVersion: new ComponentSetComponentVersionRepository(dbManager),
+    componentSetComponentVersionExcluded: new ComponentSetComponentVersionExcludedRepository(dbManager),
+    componentSetComponentVersionEditable: new ComponentSetComponentVersionEditableRepository(dbManager),
+    componentSetRule: new ComponentSetRuleRepository(dbManager),
+  };
+}

package/src/domains/db/createConnectionManager.ts

@@ -0,0 +1,24 @@
+import { ConnectionManager, getConnectionInfo } from '@squiz/db-lib';
+import { ComponentConnectionManager } from './ComponentConnectionManager';
+import { ComponentRepositories, createComponentRepositories } from './ComponentRepositories';
+import migrationList from './migration-list';
+
+type DbConfig = Parameters<typeof getConnectionInfo>[0];
+
+export async function createConnectionManager(
+  applicationName: string,
+  connectionInfo: DbConfig,
+  migrationDirectory: string,
+): Promise<ComponentConnectionManager> {
+  const connection = await getConnectionInfo(connectionInfo);
+
+  const manager = new ConnectionManager<ComponentRepositories>(
+    applicationName,
+    connection,
+    migrationDirectory,
+    migrationList,
+    createComponentRepositories,
+  );
+
+  return manager;
+}

package/src/domains/db/index.ts

@@ -0,0 +1,3 @@
+export * from './ComponentConnectionManager';
+export * from './ComponentRepositories';
+export * from './createConnectionManager';

package/src/domains/db/migration-list.ts

@@ -0,0 +1,16 @@
+export default [
+  '20220704054051_initial.sql',
+  '20220718172237_adding_component_sets.sql',
+  '20220728113941_add_env_vars_field.sql',
+  '20220817113300_removing_null_props_from_jsonb.sql',
+  '20223525103556_component_set_rule.sql',
+  '20221027151225_dummy.sql',
+  '20221117151200_add_detail_columns_to_component_version.js',
+  '20221220151200_add_required_to_manifests.js',
+  '20221222151200_add_required_to_manifests.js',
+  '20230111095522_update_environment_property.js',
+  '20230203084900_ensure_static_root_exists.js',
+  '20230210143300_lowercase_all_uri_names.js',
+  '20230217151212_component_set_component_version_updates.sql',
+  '20230218121212_add_component_set_rules.js',
+];

package/src/domains/job/ParsePartitionKey/ParsePartitionKey.spec.ts

@@ -0,0 +1,27 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { parsePartitionKey } from './ParsePartitionKey';
+import { InternalServerError } from '../errors';
+
+describe('parsePartitionKey', () => {
+  it('should parse "job"', () => {
+    expect(parsePartitionKey('job')).toBe('job');
+  });
+
+  it('should parse "manifest"', () => {
+    expect(parsePartitionKey('manifest')).toBe('manifest');
+  });
+
+  it('should parse "context"', () => {
+    expect(parsePartitionKey('context')).toBe('context');
+  });
+  it('should throw an error for an invalid status', () => {
+    const invalidType = 'invalid';
+    expect(() => parsePartitionKey(invalidType)).toThrow(
+      new InternalServerError(`'${invalidType}' is an invalid type`),
+    );
+  });
+});

package/src/domains/job/ParsePartitionKey/ParsePartitionKey.ts

@@ -0,0 +1,19 @@
+import { JobExecutionPk, PARTITION_KEYS, PartitionKey } from '../constants/Repository.constants';
+import { InternalServerError } from '../errors/InternalServerError';
+
+export function parsePartitionKey(type: string): PartitionKey | JobExecutionPk {
+  if (type.startsWith('jobExecution')) {
+    return type;
+  } else {
+    switch (type) {
+      case 'job':
+        return PARTITION_KEYS.job;
+      case 'manifest':
+        return PARTITION_KEYS.manifest;
+      case 'context':
+        return PARTITION_KEYS.context;
+      default:
+        throw new InternalServerError(`'${type}' is an invalid type`);
+    }
+  }
+}

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

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

package/src/domains/job/constants/JobExecutionStatus.constants.ts

@@ -0,0 +1,9 @@
+export type JobExecutionStatus = JOB_EXECUTION_STATUS;
+
+export enum JOB_EXECUTION_STATUS {
+  queued = 'queued',
+  terminated = 'terminated',
+  successfullyCompleted = 'successfully-completed',
+  running = 'running',
+  errored = 'errored',
+}

package/src/domains/job/constants/QueryParams.ts

@@ -0,0 +1,16 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+/**
+ * All supported query parameters.
+ */
+export const QUERY = {
+  // FILTER: {},
+  PAGE: {
+    AFTER: 'page[after]',
+    BEFORE: 'page[before]',
+    SIZE: 'page[size]',
+  },
+};

package/src/domains/job/constants/Repository.constants.ts

@@ -0,0 +1,18 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+export type PartitionKey = PARTITION_KEYS | JobExecutionPk;
+
+// this needs to be dynamic as it changes based on the jobName,
+// and tsoa can't parse a template literal type
+// so we need to use a string type here
+export type JobExecutionPk = string;
+
+export enum PARTITION_KEYS {
+  job = 'job',
+  manifest = 'manifest',
+  jobExecution = 'jobExecution',
+  context = 'context',
+}

package/src/domains/job/core/dynamoClient.mock.ts

@@ -0,0 +1,34 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { GetItemCommandOutput, PutItemCommandOutput, ScanCommandOutput } from '@aws-sdk/client-dynamodb';
+
+export const createMockClientPutResponse = (
+  partialRecord: Partial<PutItemCommandOutput> = {},
+): PutItemCommandOutput => {
+  return {
+    $metadata: {},
+    Attributes: {},
+    ...partialRecord,
+  };
+};
+
+export const createMockClientScanResponse = (partialRecord: Partial<ScanCommandOutput> = {}): ScanCommandOutput => {
+  return {
+    $metadata: {},
+    Items: [],
+    LastEvaluatedKey: undefined,
+    ...partialRecord,
+  };
+};
+
+export const createMockClientGetResponse = (
+  partialRecord: Partial<GetItemCommandOutput> = {},
+): GetItemCommandOutput => {
+  return {
+    $metadata: {},
+    ...partialRecord,
+  };
+};

package/src/domains/job/core/pagination/index.ts

@@ -0,0 +1,3 @@
+export * from './model';
+export * from './services';
+export * from './utils';

package/src/domains/job/core/pagination/model/PageQuery.ts

@@ -0,0 +1,31 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+/**
+ * The page query object.
+ * @interface PageQuery
+ */
+export interface PageQuery {
+  /**
+   * The encoded token string for the next page.
+   * @type {string}
+   * @memberof PageQuery
+   */
+  after?: string;
+
+  /**
+   * The encoded token string for the previous page.
+   * @type {string}
+   * @memberof PageQuery
+   */
+  before?: string;
+
+  /**
+   * The page size.
+   * @type {number}
+   * @memberof PageQuery
+   */
+  size?: number;
+}

package/src/domains/job/core/pagination/model/PaginationInfo.ts

@@ -0,0 +1,40 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { PaginationDirectionType, PaginationPageLimit } from './PaginationTypes';
+
+/**
+ * The pagination info for a request.
+ * @interface PaginationInfo
+ */
+export interface PaginationInfo {
+  /**
+   * The pagination direction.
+   * @type {PaginationDirectionType}
+   * @memberof PaginationInfo
+   */
+  direction: PaginationDirectionType;
+
+  /**
+   * The pagination limit.
+   * @type {PaginationPageLimit}
+   * @memberof PaginationInfo
+   */
+  limit: PaginationPageLimit;
+
+  /**
+   * The request URL.
+   * @type {string}
+   * @memberof PaginationInfo
+   */
+  requestUrl: string;
+
+  /**
+   * The encoded token string.
+   * @type {string | null}
+   * @memberof PaginationInfo
+   */
+  token: string | null;
+}

package/src/domains/job/core/pagination/model/PaginationKey.ts

@@ -0,0 +1,4 @@
+import { BaseDto } from '../../../model/Base/Base';
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export type PaginationKey<T extends BaseDto> = Pick<T, 'pk' | 'sk'>;

package/src/domains/job/core/pagination/model/PaginationLinks.ts

@@ -0,0 +1,30 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+/**
+ * The pagination links object.
+ * @interface PaginationLinks
+ */
+export interface PaginationLinks {
+  /**
+   * The URL for the next link.
+   * @type {string | null}
+   * @memberof PaginationLinks
+   */
+  next: string | null;
+
+  /**
+   * The URL for the previous link.
+   * @type {string | null}
+   * @memberof PaginationLinks
+   */
+  prev: string | null;
+}
+
+/**
+ * The pagination tokens object.
+ * @interface PaginationTokens
+ */
+export type PaginationTokens = PaginationLinks;

package/src/domains/job/core/pagination/model/PaginationQueryParams.ts

@@ -0,0 +1,15 @@
+import { PageQuery } from './PageQuery';
+
+/**
+ * The query parameters for a request for paginated data.
+ * @export
+ * @type PaginationQueryParams
+ */
+export type PaginationQueryParams = {
+  /**
+   * The page query param(s).
+   * @type {PageQuery}
+   * @memberof PaginationQueryParams
+   */
+  page: PageQuery;
+};

package/src/domains/job/core/pagination/model/PaginationQueryResponse.ts

@@ -0,0 +1,27 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { AttributeValue } from '@aws-sdk/client-dynamodb';
+
+/**
+ * The response for a DynamoDB query for a paginated list of data.
+ * @export
+ * @interface PaginationQueryResponse
+ */
+export interface PaginationQueryResponse<T> {
+  /**
+   * The list of items that matched the query.
+   * @type {Array<T>}
+   * @memberof PaginationQueryResponse
+   */
+  items: Array<T>;
+
+  /**
+   * The last evaluated key of the query.
+   * @type {Record<string, AttributeValue>}
+   * @memberof PaginationQueryResponse
+   */
+  lastEvaluatedKey?: Record<string, AttributeValue>;
+}

package/src/domains/job/core/pagination/model/PaginationResponse.ts

@@ -0,0 +1,48 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { PaginationLinks } from './PaginationLinks';
+
+/**
+ * The response data list with associated pagination links.
+ * @export
+ * @interface PaginationResponse
+ */
+export interface PaginationResponse<T> {
+  /**
+   * The pagination links.
+   * @type {PaginationLinks}
+   * @memberof PaginationResponse
+   */
+  links: PaginationLinks;
+
+  /**
+   * The list of settings.
+   * @type {Array<T>}
+   * @memberof PaginationResponse
+   */
+  data: Array<T>;
+}
+
+/**
+ * The formatted response for a list of paginated items.
+ * @export
+ * @interface PaginationFormattedResponse
+ */
+export interface PaginationFormattedResponse<T> {
+  /**
+   * The list of items that matched the query.
+   * @type {Array<T>}
+   * @memberof PaginationFormattedResponse
+   */
+  data: Array<T>;
+
+  /**
+   * The pagination links for the response.
+   * @type {PaginationLinks}
+   * @memberof PaginationFormattedResponse
+   */
+  links?: PaginationLinks;
+}

package/src/domains/job/core/pagination/model/PaginationTypes.ts

@@ -0,0 +1,45 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+/**
+ * The possible pagination direction types.
+ * @export
+ */
+export type PaginationDirectionType = PaginationDirectionTypeAfter | PaginationDirectionTypeBefore;
+
+/**
+ * The after pagination direction type.
+ * @export
+ */
+export type PaginationDirectionTypeAfter = typeof PAGINATION_DIRECTION_TYPE_AFTER;
+
+/**
+ * The before pagination direction type.
+ * @export
+ */
+export type PaginationDirectionTypeBefore = typeof PAGINATION_DIRECTION_TYPE_BEFORE;
+
+/**
+ * The after pagination direction constant.
+ * @export
+ */
+export const PAGINATION_DIRECTION_TYPE_AFTER = `after`;
+
+/**
+ * The before pagination direction constant.
+ * @export
+ */
+export const PAGINATION_DIRECTION_TYPE_BEFORE = `before`;
+
+/**
+ * The pagination page limit options.
+ * @export
+ */
+export enum PaginationPageLimit {
+  tiny = 5,
+  small = 20,
+  medium = 50,
+  large = 100,
+}

package/src/domains/job/core/pagination/model/index.ts

@@ -0,0 +1,8 @@
+export * from './PageQuery';
+export * from './PaginationInfo';
+export * from './PaginationKey';
+export * from './PaginationLinks';
+export * from './PaginationQueryParams';
+export * from './PaginationQueryResponse';
+export * from './PaginationResponse';
+export * from './PaginationTypes';