Insert credentials at the first occurrence of a security credential key (#701)

Author: trivikr

.changeset/red-fans-cheer.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Insert credentials at the first occurrence of a security credential key

src/transforms/v2-to-v3/__fixtures__/config/credentials.order.input.js

@@ -0,0 +1,36 @@
+import AWS from "aws-sdk";
+
+const credsAfter = new AWS.Config({
+  logger: console,
+  region: "us-east-1",
+  accessKeyId: "KEY",
+  secretAccessKey: "SECRET"
+});
+
+const credsBefore = new AWS.Config({
+  accessKeyId: "KEY",
+  secretAccessKey: "SECRET",
+  logger: console,
+  region: "us-east-1",
+});
+
+const credsInBetween = new AWS.Config({
+  logger: console,
+  accessKeyId: "KEY",
+  secretAccessKey: "SECRET",
+  region: "us-east-1",
+});
+
+const credsDispersedBefore = new AWS.Config({
+  accessKeyId: "KEY",
+  logger: console,
+  secretAccessKey: "SECRET",
+  region: "us-east-1"
+});
+
+const credsDispersedAfter = new AWS.Config({
+  logger: console,
+  accessKeyId: "KEY",
+  region: "us-east-1",
+  secretAccessKey: "SECRET",
+});

src/transforms/v2-to-v3/__fixtures__/config/credentials.order.output.js

@@ -0,0 +1,51 @@
+const credsAfter = {
+  logger: console,
+  region: "us-east-1",
+
+  credentials: {
+    accessKeyId: "KEY",
+    secretAccessKey: "SECRET"
+  }
+};
+
+const credsBefore = {
+  credentials: {
+    accessKeyId: "KEY",
+    secretAccessKey: "SECRET"
+  },
+
+  logger: console,
+  region: "us-east-1"
+};
+
+const credsInBetween = {
+  logger: console,
+
+  credentials: {
+    accessKeyId: "KEY",
+    secretAccessKey: "SECRET"
+  },
+
+  region: "us-east-1"
+};
+
+const credsDispersedBefore = {
+  credentials: {
+    accessKeyId: "KEY",
+    secretAccessKey: "SECRET"
+  },
+
+  logger: console,
+  region: "us-east-1"
+};
+
+const credsDispersedAfter = {
+  logger: console,
+
+  credentials: {
+    accessKeyId: "KEY",
+    secretAccessKey: "SECRET"
+  },
+
+  region: "us-east-1"
+};

src/transforms/v2-to-v3/client-instances/getObjectWithUpdatedAwsConfigKeys.ts

@@ -67,6 +67,12 @@ export const getObjectWithUpdatedAwsConfigKeys = (
 
       if (securityCredentialKeys.includes(propertyKey.name)) {
         credentials.properties.push(property);
+
+        // Push credentials key only once.
+        if (credentials.properties.length === 1) {
+          return j.objectProperty(j.identifier("credentials"), credentials);
+        }
+
         return undefined;
       }
 
@@ -107,10 +113,6 @@ export const getObjectWithUpdatedAwsConfigKeys = (
     })
     .filter((property) => property !== undefined);
 
-  if (credentials.properties.length > 0) {
-    updatedProperties.unshift(j.objectProperty(j.identifier("credentials"), credentials));
-  }
-
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore is Argument is not assignable to parameter
   return j.objectExpression(updatedProperties);