@squiz/job-runner-lib 2.9.0 → 2.10.1

package/src/domains/job/services/JobExecutionTaskService/JobExecutionTaskService.spec.ts

@@ -31,7 +31,7 @@ describe('JobExecutionTaskService', () => {
     shortRegion: 'au',
     shortEnvironment: 'dev',
     clusterArn: `clusterArn`,
-    taskDefinitionArn: `legacyTaskDefinitionArn`,
+    taskDefinitionArn: `defaultTaskDefinitionArn`,
     taskDefinitionArnsByRuntimeImage: {
       'node:20': 'node20TaskDefinitionArn',
       'node:24': 'node24TaskDefinitionArn',
@@ -213,11 +213,11 @@ describe('JobExecutionTaskService', () => {
         defaultRunJobTaskParams.jobExecution,
       );
       expect(mockEcsClient).toHaveReceivedCommandWith(RunTaskCommand, {
-        taskDefinition: defaultRunJobTaskParams.taskDefinitionArnsByRuntimeImage['node:20'],
+        taskDefinition: defaultRunJobTaskParams.taskDefinitionArnsByRuntimeImage['node:24'],
       });
     });
 
-    it('should use the legacy task definition ARN when the node:20 map entry is missing', async () => {
+    it('should use the default task definition ARN when the node:24 map entry is missing', async () => {
       const mockArn = `mock-arn`;
 
       mockEcsClient.on(RunTaskCommand).resolves({ tasks: [{ taskArn: mockArn }] });
@@ -250,9 +250,8 @@ describe('JobExecutionTaskService', () => {
       await expect(
         jobExecutionTaskService.runJobExecutionTask({
           ...defaultRunJobTaskParams,
-          taskDefinitionArnsByRuntimeImage: {
-            'node:20': 'node20TaskDefinitionArn',
-          },
+          taskDefinitionArnsByRuntimeImage: {},
+          taskDefinitionArn: '',
         }),
       ).rejects.toThrow(RuntimeImageTaskDefinitionError);
       expect(mockEcsClient).not.toHaveReceivedCommand(RunTaskCommand);

package/src/domains/job/services/JobExecutionTaskService/JobExecutionTaskService.ts

@@ -61,7 +61,7 @@ export class JobExecutionTaskService {
     const taskDefinitionArn = resolveRuntimeImageTaskDefinitionArn({
       image: jobManifest?.image,
       taskDefinitionArnsByRuntimeImage: params.taskDefinitionArnsByRuntimeImage,
-      legacyTaskDefinitionArn: params.taskDefinitionArn,
+      defaultTaskDefinitionArn: params.taskDefinitionArn,
     });
     const jobDetailsFileUrl = await this.createJobDetailsFile(params.tenantId, params.jobExecution, jobManifest);
     const tags = getAwsTags({

package/src/domains/job/utils/ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn.spec.ts

@@ -0,0 +1,64 @@
+/*!
+ * @license
+ * Copyright Squiz Australia Pty Ltd. All Rights Reserved.
+ */
+
+import { RuntimeImageTaskDefinitionError } from '../../errors';
+import { resolveRuntimeImageTaskDefinitionArn } from './ResolveRuntimeImageTaskDefinitionArn';
+
+describe('resolveRuntimeImageTaskDefinitionArn', () => {
+  const taskDefinitionArnsByRuntimeImage = {
+    'node:24': 'node24TaskDefinitionArn',
+  };
+  const defaultTaskDefinitionArn = 'defaultTaskDefinitionArn';
+
+  it('resolves node:24 when the stored image is deprecated node:20', () => {
+    expect(
+      resolveRuntimeImageTaskDefinitionArn({
+        image: 'node:20',
+        taskDefinitionArnsByRuntimeImage,
+        defaultTaskDefinitionArn,
+      }),
+    ).toEqual('node24TaskDefinitionArn');
+  });
+
+  it('resolves node:24 when the stored image is missing', () => {
+    expect(
+      resolveRuntimeImageTaskDefinitionArn({
+        image: undefined,
+        taskDefinitionArnsByRuntimeImage,
+        defaultTaskDefinitionArn,
+      }),
+    ).toEqual('node24TaskDefinitionArn');
+  });
+
+  it('uses the default task definition ARN when the runtime map entry is missing', () => {
+    expect(
+      resolveRuntimeImageTaskDefinitionArn({
+        image: 'node:20',
+        taskDefinitionArnsByRuntimeImage: {},
+        defaultTaskDefinitionArn,
+      }),
+    ).toEqual(defaultTaskDefinitionArn);
+  });
+
+  it('throws when the runtime image is unsupported', () => {
+    expect(() =>
+      resolveRuntimeImageTaskDefinitionArn({
+        image: 'node:26',
+        taskDefinitionArnsByRuntimeImage,
+        defaultTaskDefinitionArn,
+      }),
+    ).toThrow(RuntimeImageTaskDefinitionError);
+  });
+
+  it('throws when no task definition ARN is configured for the runtime image', () => {
+    expect(() =>
+      resolveRuntimeImageTaskDefinitionArn({
+        image: 'node:24',
+        taskDefinitionArnsByRuntimeImage: {},
+        defaultTaskDefinitionArn: '',
+      }),
+    ).toThrow(RuntimeImageTaskDefinitionError);
+  });
+});

package/src/domains/job/utils/ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn.ts

@@ -4,7 +4,6 @@
  */
 
 import {
-  LEGACY_RUNTIME_IMAGE,
   SUPPORTED_RUNTIME_IMAGES,
   getRuntimeImageOrDefault,
   isSupportedRuntimeImage,
@@ -15,7 +14,7 @@ import { ResolveRuntimeImageTaskDefinitionArnParams } from './ResolveRuntimeImag
 export const resolveRuntimeImageTaskDefinitionArn = ({
   image,
   taskDefinitionArnsByRuntimeImage,
-  legacyTaskDefinitionArn,
+  defaultTaskDefinitionArn,
 }: ResolveRuntimeImageTaskDefinitionArnParams): string => {
   const runtimeImage = getRuntimeImageOrDefault(image);
 
@@ -25,9 +24,7 @@ export const resolveRuntimeImageTaskDefinitionArn = ({
     );
   }
 
-  const taskDefinitionArn =
-    taskDefinitionArnsByRuntimeImage[runtimeImage] ||
-    (runtimeImage === LEGACY_RUNTIME_IMAGE ? legacyTaskDefinitionArn : undefined);
+  const taskDefinitionArn = taskDefinitionArnsByRuntimeImage[runtimeImage] || defaultTaskDefinitionArn;
 
   if (!taskDefinitionArn) {
     throw new RuntimeImageTaskDefinitionError(

package/src/domains/job/utils/ResolveRuntimeImageTaskDefinitionArn/ResolveRuntimeImageTaskDefinitionArn.types.ts

@@ -6,5 +6,5 @@
 export interface ResolveRuntimeImageTaskDefinitionArnParams {
   image: string | null | undefined;
   taskDefinitionArnsByRuntimeImage: Record<string, string>;
-  legacyTaskDefinitionArn: string;
+  defaultTaskDefinitionArn: string;
 }

package/src/domains/manifest/utils/validateRuntimeImage.ts

@@ -16,16 +16,16 @@ export const validateAndDefaultRuntimeImage = (image: string | null | undefined)
     return RECOMMENDED_RUNTIME_IMAGE;
   }
 
-  if (!isSupportedRuntimeImage(image)) {
+  if (isDeprecatedRuntimeImage(image)) {
     throw new ManifestValidationError(
-      `Unsupported runtime image "${image}". Supported images are: ${SUPPORTED_RUNTIME_IMAGES.join(', ')}`,
+      `Runtime image "${image}" is deprecated and can no longer be used for new uploads. ` +
+        `Please use the recommended runtime image "${RECOMMENDED_RUNTIME_IMAGE}".`,
     );
   }
 
-  if (isDeprecatedRuntimeImage(image)) {
+  if (!isSupportedRuntimeImage(image)) {
     throw new ManifestValidationError(
-      `Runtime image "${image}" is deprecated and can no longer be used for new uploads. ` +
-        `Please use the recommended runtime image "${RECOMMENDED_RUNTIME_IMAGE}".`,
+      `Unsupported runtime image "${image}". Supported images are: ${SUPPORTED_RUNTIME_IMAGES.join(', ')}`,
     );
   }