nasa · kwartrosa · Dec 13, 2023 · Dec 18, 2023 · Dec 18, 2023 · Dec 19, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -64,6 +64,8 @@ instructions](https://nasa.github.io/cumulus/docs/upgrade-notes/upgrade-rds-clus
     migration from Aurora PostgreSQl v11 to v13.   See Migration Notes for more details.
 - **CUMULUS-3564**
   - Update webpack configuration to explicitly disable chunking
+- **CUMULUS-2891**
+  - Updated ECS code to aws sdk v3
 - **CUMULUS-2895**
   - Updated KMS code to aws sdk v3
 - **CUMULUS-2888**

diff --git a/example/package.json b/example/package.json
@@ -70,6 +70,7 @@
     "@cumulus/test-processing": "18.2.0"
   },
   "devDependencies": {
+    "@aws-sdk/client-ecs": "^3.447.0",
     "@cumulus/test-data": "18.2.0"
   }
 }
diff --git a/example/spec/helpers/ecsHelpers.js b/example/spec/helpers/ecsHelpers.js
@@ -13,7 +13,7 @@ async function findAsyncOperationTaskDefinitionForDeployment(stackName) {
       sort: 'ASC',
     };
     // eslint-disable-next-line no-await-in-loop
-    const response = await ecs().listTaskDefinitions(params).promise();
+    const response = await ecs().listTaskDefinitions(params);
     nextToken = response.nextToken;
     const taskDefinitionArns = response.taskDefinitionArns;
     taskDefinitionArn = taskDefinitionArns[taskDefinitionArns.length - 1];

diff --git a/example/spec/parallel/testAPI/bulkDeleteFailureSpec.js b/example/spec/parallel/testAPI/bulkDeleteFailureSpec.js
@@ -3,6 +3,7 @@
 const { fakeGranuleFactoryV2, fakeExecutionFactoryV2 } = require('@cumulus/api/lib/testUtils');
 const { deleteAsyncOperation, getAsyncOperation } = require('@cumulus/api-client/asyncOperations');
 const { ecs } = require('@cumulus/aws-client/services');
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
 const {
   getClusterArn,
   loadCollection,
@@ -140,21 +141,18 @@ describe('POST /granules/bulkDelete with a failed bulk delete operation', () =>
     const describeTasksResponse = await ecs().describeTasks({
       cluster: clusterArn,
       tasks: [taskArn],
-    }).promise();
+    });
 
     expect(describeTasksResponse.tasks.length).toEqual(1);
   });
 
   it('eventually generates the correct output', async () => {
     expect(beforeAllSucceeded).toBeTrue();
 
-    await ecs().waitFor(
-      'tasksStopped',
-      {
-        cluster: clusterArn,
-        tasks: [taskArn],
-      }
-    ).promise();
+    await waitUntilTasksStopped(
+      { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+      { cluster: clusterArn, tasks: [taskArn] }
+    );
 
     const asyncOperation = await getAsyncOperation({
       prefix: config.stackName,

diff --git a/example/spec/parallel/testAPI/bulkDeleteSuccessSpec.js b/example/spec/parallel/testAPI/bulkDeleteSuccessSpec.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
 const get = require('lodash/get');
 const pAll = require('p-all');
 
@@ -254,21 +255,18 @@ describe('POST /granules/bulkDelete', () => {
       const describeTasksResponse = await ecs().describeTasks({
         cluster: clusterArn,
         tasks: [taskArn],
-      }).promise();
+      });
 
       expect(describeTasksResponse.tasks.length).toEqual(1);
     });
 
     it('eventually generates the correct output', async () => {
       expect(beforeAllSucceeded).toBeTrue();
 
-      await ecs().waitFor(
-        'tasksStopped',
-        {
-          cluster: clusterArn,
-          tasks: [taskArn],
-        }
-      ).promise();
+      await waitUntilTasksStopped(
+        { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+        { cluster: clusterArn, tasks: [taskArn] }
+      );
 
       const asyncOperation = await getAsyncOperation({
         prefix,

diff --git a/example/spec/parallel/testAPI/bulkOperationsSuccessSpec.js b/example/spec/parallel/testAPI/bulkOperationsSuccessSpec.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
+
 const get = require('lodash/get');
 const pAll = require('p-all');
 
@@ -258,7 +260,7 @@ describe('POST /granules/bulk', () => {
         const describeTasksResponse = await ecs().describeTasks({
           cluster: clusterArn,
           tasks: [taskArn],
-        }).promise();
+        });
 
         expect(describeTasksResponse.tasks.length).toEqual(1);
       }
@@ -267,13 +269,10 @@ describe('POST /granules/bulk', () => {
     it('eventually generates the correct output', async () => {
       if (beforeAllFailed) fail('beforeAll() failed');
       else {
-        await ecs().waitFor(
-          'tasksStopped',
-          {
-            cluster: clusterArn,
-            tasks: [taskArn],
-          }
-        ).promise();
+        await waitUntilTasksStopped(
+          { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+          { cluster: clusterArn, tasks: [taskArn] }
+        );
 
         const asyncOperation = await getAsyncOperation({
           prefix,

diff --git a/example/spec/serial/AsyncOperationRunnerFailingLambdaSpec.js b/example/spec/serial/AsyncOperationRunnerFailingLambdaSpec.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
+
 const get = require('lodash/get');
 const { v4: uuidv4 } = require('uuid');
 const { createAsyncOperation, deleteAsyncOperation } = require('@cumulus/api-client/asyncOperations');
@@ -70,13 +72,10 @@ describe('The AsyncOperation task runner executing a failing lambda function', (
 
       taskArn = runTaskResponse.tasks[0].taskArn;
 
-      await ecs().waitFor(
-        'tasksStopped',
-        {
-          cluster,
-          tasks: [taskArn],
-        }
-      ).promise();
+      await waitUntilTasksStopped(
+        { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+        { cluster: cluster, tasks: [taskArn] }
+      );
 
       asyncOperation = await waitForAsyncOperationStatus({
         id: asyncOperationId,

diff --git a/example/spec/serial/AsyncOperationRunnerNonExistentLambdaSpec.js b/example/spec/serial/AsyncOperationRunnerNonExistentLambdaSpec.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
+
 const { v4: uuidv4 } = require('uuid');
 
 const { createAsyncOperation, deleteAsyncOperation } = require('@cumulus/api-client/asyncOperations');
@@ -59,13 +61,10 @@ describe('The AsyncOperation task runner running a non-existent lambda function'
 
       const taskArn = runTaskResponse.tasks[0].taskArn;
 
-      await ecs().waitFor(
-        'tasksStopped',
-        {
-          cluster,
-          tasks: [taskArn],
-        }
-      ).promise();
+      await waitUntilTasksStopped(
+        { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+        { cluster: cluster, tasks: [taskArn] }
+      );
 
       asyncOperation = await waitForAsyncOperationStatus({
         id: asyncOperationId,

diff --git a/example/spec/serial/AsyncOperationRunnerNonExistentPayloadSpec.js b/example/spec/serial/AsyncOperationRunnerNonExistentPayloadSpec.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
 const get = require('lodash/get');
 const { v4: uuidv4 } = require('uuid');
 const { startECSTask } = require('@cumulus/async-operations');
@@ -67,13 +68,10 @@ describe('The AsyncOperation task runner with a non-existent payload', () => {
 
       taskArn = runTaskResponse.tasks[0].taskArn;
 
-      await ecs().waitFor(
-        'tasksStopped',
-        {
-          cluster,
-          tasks: [taskArn],
-        }
-      ).promise();
+      await waitUntilTasksStopped(
+        { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+        { cluster: cluster, tasks: [taskArn] }
+      );
 
       asyncOperation = await waitForAsyncOperationStatus({
         id: asyncOperationId,

diff --git a/example/spec/serial/AsyncOperationRunnerNonJsonPayloadSpec.js b/example/spec/serial/AsyncOperationRunnerNonJsonPayloadSpec.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
 const get = require('lodash/get');
 const { v4: uuidv4 } = require('uuid');
 
@@ -74,13 +75,10 @@ describe('The AsyncOperation task runner with a non-JSON payload', () => {
 
       taskArn = runTaskResponse.tasks[0].taskArn;
 
-      await ecs().waitFor(
-        'tasksStopped',
-        {
-          cluster,
-          tasks: [taskArn],
-        }
-      ).promise();
+      await waitUntilTasksStopped(
+        { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+        { cluster: cluster, tasks: [taskArn] }
+      );
 
       asyncOperation = await waitForAsyncOperationStatus({
         id: asyncOperationId,

diff --git a/example/spec/serial/AsyncOperationRunnerSuccessfulLambdaSpec.js b/example/spec/serial/AsyncOperationRunnerSuccessfulLambdaSpec.js
@@ -1,5 +1,7 @@
 'use strict';
 
+const { waitUntilTasksStopped } = require('@aws-sdk/client-ecs');
+
 const get = require('lodash/get');
 const { v4: uuidv4 } = require('uuid');
 const { createAsyncOperation, deleteAsyncOperation, listAsyncOperations } = require('@cumulus/api-client/asyncOperations');
@@ -74,13 +76,10 @@ describe('The AsyncOperation task runner executing a successful lambda function'
 
       taskArn = runTaskResponse.tasks[0].taskArn;
 
-      await ecs().waitFor(
-        'tasksStopped',
-        {
-          cluster,
-          tasks: [taskArn],
-        }
-      ).promise();
+      await waitUntilTasksStopped(
+        { client: ecs(), maxWaitTime: 600, maxDelay: 1, minDelay: 1 },
+        { cluster: cluster, tasks: [taskArn] }
+      );
 
       asyncOperation = await waitForAsyncOperationStatus({
         id: asyncOperationId,

diff --git a/packages/async-operations/package.json b/packages/async-operations/package.json
@@ -29,6 +29,7 @@
   "author": "Cumulus Authors",
   "license": "Apache-2.0",
   "dependencies": {
+    "@aws-sdk/client-ecs": "^3.477.0",
     "@aws-sdk/client-lambda": "^3.447.0",
     "@cumulus/aws-client": "18.2.0",
     "@cumulus/db": "18.2.0",

diff --git a/packages/async-operations/src/async_operations.ts b/packages/async-operations/src/async_operations.ts
@@ -1,4 +1,4 @@
-import { ECS } from 'aws-sdk';
+import { RunTaskCommandOutput } from '@aws-sdk/client-ecs';
 import { Knex } from 'knex';
 import { FunctionConfiguration } from '@aws-sdk/client-lambda';
 import { ecs, s3, lambda } from '@cumulus/aws-client/services';
@@ -13,8 +13,6 @@ import {
 import Logger from '@cumulus/logger';
 import { ApiAsyncOperation, AsyncOperationType } from '@cumulus/types/api/async_operations';
 import { v4 as uuidv4 } from 'uuid';
-import type { AWSError } from 'aws-sdk/lib/error';
-import type { PromiseResult } from 'aws-sdk/lib/request';
 
 import type {
   AsyncOperationPgModelObject,
@@ -30,7 +28,7 @@ const {
 
 const logger = new Logger({ sender: '@cumulus/async-operation' });
 
-type StartEcsTaskReturnType = Promise<PromiseResult<ECS.RunTaskResponse, AWSError>>;
+type StartEcsTaskReturnType = Promise<RunTaskCommandOutput>;
 
 export const getLambdaConfiguration = async (
   functionName: string
@@ -120,7 +118,7 @@ export const startECSTask = async ({
         },
       ],
     },
-  }).promise();
+  });
 };
 
 export const createAsyncOperation = async (

diff --git a/packages/async-operations/tests/test-async_operations.js b/packages/async-operations/tests/test-async_operations.js
@@ -65,12 +65,8 @@ test.before(async (t) => {
   ecsClient = ecs();
   ecsClient.runTask = (params) => {
     stubbedEcsRunTaskParams = params;
-    return {
-      promise: () => {
-        if (!stubbedEcsRunTaskResult) return Promise.reject(new Error('stubbedEcsRunTaskResult has not yet been set'));
-        return Promise.resolve(stubbedEcsRunTaskResult);
-      },
-    };
+    if (!stubbedEcsRunTaskResult) return Promise.reject(new Error('stubbedEcsRunTaskResult has not yet been set'));
+    return Promise.resolve(stubbedEcsRunTaskResult);
   };
 
   t.context.functionConfig = {

diff --git a/packages/aws-client/package.json b/packages/aws-client/package.json
@@ -55,6 +55,7 @@
     "@aws-sdk/client-s3": "^3.447.0",
     "@aws-sdk/client-sns": "^3.447.0",
     "@aws-sdk/client-sqs": "^3.447.0",
+    "@aws-sdk/client-ecs": "^3.447.0",
     "@aws-sdk/lib-dynamodb": "^3.447.0",
     "@aws-sdk/lib-storage": "^3.447.0",
     "@aws-sdk/s3-request-presigner": "^3.447.0",

diff --git a/packages/aws-client/src/services.ts b/packages/aws-client/src/services.ts
@@ -10,12 +10,13 @@ import { S3 } from '@aws-sdk/client-s3';
 import { SQS } from '@aws-sdk/client-sqs';
 import { DynamoDBDocument, TranslateConfig } from '@aws-sdk/lib-dynamodb';
 import { SNS } from '@aws-sdk/client-sns';
+import { ECS } from '@aws-sdk/client-ecs';
 import * as AWS from 'aws-sdk';
 
 import awsClient from './client';
 
 export const apigateway = awsClient(APIGatewayClient, '2015-07-09');
-export const ecs = awsClient(AWS.ECS, '2014-11-13');
+export const ecs = awsClient(ECS, '2014-11-13');
 export const ec2 = awsClient(AWS.EC2, '2016-11-15');
 export const s3 = awsClient(S3, '2006-03-01');
 export const kinesis = awsClient(Kinesis, '2013-12-02');

diff --git a/packages/aws-client/src/test-utils.ts b/packages/aws-client/src/test-utils.ts
@@ -16,7 +16,7 @@ const localStackPorts = {
   DynamoDBClient: 4566,
   DynamoDBStreamsClient: 4566,
   ec2: 4566,
-  ecs: 4566,
+  ECS: 4566,
   es: 4566,
   firehose: 4566,
   iam: 4566,

diff --git a/packages/aws-client/src/types.ts b/packages/aws-client/src/types.ts
@@ -9,9 +9,23 @@ import { Kinesis } from '@aws-sdk/client-kinesis';
 import { KMS } from '@aws-sdk/client-kms';
 import { Lambda } from '@aws-sdk/client-lambda';
 import { S3 } from '@aws-sdk/client-s3';
+import { ECS } from '@aws-sdk/client-ecs';
 import { SNS } from '@aws-sdk/client-sns';
 import { SQS } from '@aws-sdk/client-sqs';
 
-export type AWSClientTypes = APIGatewayClient | CloudFormation | CloudWatchEvents | DynamoDB
-| DynamoDBClient | DynamoDBStreamsClient | KMS | Kinesis | Lambda | S3 | SNS | SQS
-| AWS.Service | AWS.DynamoDB.DocumentClient;
+export type AWSClientTypes =
+    APIGatewayClient |
+    DynamoDB |
+    DynamoDBClient |
+    DynamoDBStreamsClient |
+    Lambda |
+    ECS |
+    S3 |
+    SNS |
+    SQS |
+    CloudWatchEvents |
+    CloudFormation |
+    Kinesis |
+    KMS |
+    AWS.Service |
+    AWS.DynamoDB.DocumentClient;