chore: migrate AWS SDK for JavaScript v2 APIs to v3

Author: trivikr

apps/firelens-stability/lib/cloud/ecs.ts

@@ -1,9 +1,9 @@
 import { getJsonFromFile, sleep } from "../utils/utils.js";
-import * as ECS from "@aws-sdk/client-ecs";
-import AWS from 'aws-sdk'; /* We really should be migrating to v3, but for now use v2 */
+import { ECS, RunTaskCommandOutput } from "@aws-sdk/client-ecs";
+import { ServiceException } from "@smithy/smithy-client";
+/* We really should be migrating to v3, but for now use v2 */
 import { getTestCaseTaskDefinition } from "../utils/config-utils.js";
 import { PromiseResult } from "aws-sdk/lib/request";
-process.env.AWS_SDK_JS_SUPPRESS_MAINTENANCE_MODE_MESSAGE = '1';
 import * as Constants from "../constants.js"
 
 let ecsTestCaseTaskQueue: Array<IEcsTestTask> = [];
@@ -61,22 +61,21 @@ async function processEcsTestTaskQueue() {
 async function startECSTask(task: IEcsTestTask) {
     const testCase = task.testCase;
 
-    // Set the region name
-    AWS.config.update({ region: testCase.config.region });
-
     // Create an ECS client
-    const ecs = new AWS.ECS();
+    const ecs = new ECS({
+        region: testCase.config.region,
+    });
 
     // Create fargate cluster if it doesn't already exist
-    const clusters = await ecs.listClusters().promise();
+    const clusters = await ecs.listClusters();
     if (!clusters.clusterArns.some(c => c.endsWith(`/${testCase.config.cluster}`))) {
         await ecs.createCluster({
             settings: [{
                 name: "containerInsights",
                 value: "enabled"
             }],
             clusterName: testCase.config.cluster
-        }).promise();
+        });
         console.log(`🍇 Created cluster: ${testCase.config.cluster}\n`)
         await sleep(2000); /* Wait for the container to be ready to accept new tasks */
     }
@@ -87,7 +86,7 @@ async function startECSTask(task: IEcsTestTask) {
     // Register task definition
     let taskDefinitionArn;
     try {
-        taskDefinitionArn = (await ecs.registerTaskDefinition(taskDefinition).promise()).taskDefinition!.taskDefinitionArn;
+        taskDefinitionArn = (await ecs.registerTaskDefinition(taskDefinition)).taskDefinition!.taskDefinitionArn;
     }
     catch (err) {
         console.error(`Error registering task definition: ${err}`);
@@ -133,11 +132,10 @@ function ecsTaskReturn(ecsTestTask: IEcsTestTask) {
 async function validateAndRetryECSTask(ecsTestTask: IEcsTestTask) {
     const testCase = ecsTestTask.testCase;
 
-    // Set the region name
-    AWS.config.update({ region: ecsTestTask.testCase.config.region });
-    
     // Create an ECS client
-    const ecs = new AWS.ECS();
+    const ecs = new ECS({
+        region: testCase.config.region,
+    });
 
     const {
         currentTasks,
@@ -182,11 +180,10 @@ async function validateAndRetryECSTask(ecsTestTask: IEcsTestTask) {
 async function outOfRetriesECSTask(ecsTestTask: IEcsTestTask) {
     const testCase = ecsTestTask.testCase;
 
-    // Set the region name
-    AWS.config.update({ region: ecsTestTask.testCase.config.region });
-
     // Create an ECS client
-    const ecs = new AWS.ECS();
+    const ecs = new ECS({
+        region: testCase.config.region,
+    });
 
     const {
         runningTasksCount,
@@ -212,11 +209,11 @@ async function outOfRetriesECSTask(ecsTestTask: IEcsTestTask) {
 }
 
 
-async function launchECSTasks(testCase: ITestCase, taskCount: number, ecs: AWS.ECS, taskDefinitionArn: string): Promise<string[]> {
+async function launchECSTasks(testCase: ITestCase, taskCount: number, ecs: ECS, taskDefinitionArn: string): Promise<string[]> {
     let launchedTasks = [];
     while (launchedTasks.length < taskCount) {
         const launchCount = Math.min(10, taskCount - launchedTasks.length);
-        let result: PromiseResult<AWS.ECS.RunTaskResponse, AWS.AWSError>;
+        let result: PromiseResult<RunTaskCommandOutput, ServiceException>;
         try {
             result = await ecs.runTask({
             enableExecuteCommand: true,
@@ -231,7 +228,7 @@ async function launchECSTasks(testCase: ITestCase, taskCount: number, ecs: AWS.E
                     securityGroups: testCase.config.taskVpcSecurityGroups,
                 }
             }
-            }).promise();
+            });
         }
         catch (err) {
             console.error(`Error launching task: ${err}`);
@@ -254,8 +251,10 @@ async function launchECSTasks(testCase: ITestCase, taskCount: number, ecs: AWS.E
     return launchedTasks;
 }
 
-async function validateECSTestTask(ecs: AWS.ECS, ecsTestTask: IEcsTestTask) {     
-    const currentTasks = await ecs.describeTasks({cluster: ecsTestTask.testCase.config.cluster, tasks: ecsTestTask.executionRecord.taskArns}).promise();
+async function validateECSTestTask(ecs: ECS, ecsTestTask: IEcsTestTask) {     
+    const currentTasks = await ecs.describeTasks(
+        {cluster: ecsTestTask.testCase.config.cluster, tasks: ecsTestTask.executionRecord.taskArns},
+    );
     const startingTasks = currentTasks.tasks
         .filter(t => (t.taskDefinitionArn === ecsTestTask.taskDefinitionArn) &&
             (t.lastStatus === "PROVISIONING" || t.lastStatus === "PENDING" || t.lastStatus === "ACTIVATING"))

clients/s3-client.ts

@@ -1,12 +1,12 @@
-import AWS from 'aws-sdk';
+import { S3 } from "@aws-sdk/client-s3";
 import { IClient } from "../core/ext-types.js"
 import { IExecutionResult } from "../core/pipeline-types.js";
 
 const environmentClient: IClient = {
     name: "s3",
     makeCommandGenerator: (async function*() {
 
-        const s3 = new AWS.S3();
+        const s3 = new S3();
 
         const bucket = process.env.CLIENT_S3_BUCKET || 'firelens-datajet';
         const file = process.env.CLIENT_S3_FILE || 'firelens-datajet.json';
@@ -15,7 +15,7 @@ const environmentClient: IClient = {
             const s3Response = await s3.getObject({
                 Bucket: bucket,
                 Key: file
-            }).promise();
+            });
 
             const config = JSON.parse(s3Response.Body.toString());
 

generators/s3-generator.ts

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import AWS from 'aws-sdk';
+import { S3 } from "@aws-sdk/client-s3";
 import { IBatchGenerator, ILogData } from "../core/ext-types.js"
 import fs from 'fs';
 import readline from 'readline';
@@ -39,7 +39,7 @@ const s3Generator: IBatchGenerator = {
     defaultConfig: defaultConfig,
     createConfiguredGenerator: function (config: IGeneratorConfig) {
 
-        const s3 = new AWS.S3();
+        const s3 = new S3();
 
         const bucket = config.bucket
         const file = config.file;
@@ -56,7 +56,7 @@ const s3Generator: IBatchGenerator = {
                         const s3Response = await s3.getObject({
                             Bucket: bucket,
                             Key: file
-                        }).promise();
+                        });
 
                         s3Logs = (s3Response?.Body?.toString() ?? "").split("\n");
                     }
@@ -101,7 +101,7 @@ const s3Generator: IBatchGenerator = {
                     hasLooped = true;
                 }
             })()),
-        }
+        };
     }
 
 };