Basic transformation of AWS Credentials (#598)

trivikr · web-flow · commit 7abe8a223e2d · 2023-10-20T09:56:49.000-07:00
diff --git a/.changeset/hot-insects-protect.md b/.changeset/hot-insects-protect.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Basic transformation of AWS Credentials
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/chainable.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/chainable.input.js
@@ -0,0 +1,6 @@
+import AWS from "aws-sdk";
+
+new AWS.ChainableTemporaryCredentials({
+  params: { RoleArn: "RoleA" },
+  masterCredentials: existingCredentials,
+});
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/chainable.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/chainable.output.js
@@ -0,0 +1,9 @@
+import { fromTemporaryCredentials } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromTemporaryCredentials({
+  params: { RoleArn: "RoleA" },
+  masterCredentials: existingCredentials,
+});
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/cognito-identity.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/cognito-identity.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.CognitoIdentityCredentials();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/cognito-identity.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/cognito-identity.output.js
@@ -0,0 +1,6 @@
+import { fromCognitoIdentity } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromCognitoIdentity();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/ec2-metadata.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/ec2-metadata.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.EC2MetadataCredentials();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/ec2-metadata.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/ec2-metadata.output.js
@@ -0,0 +1,6 @@
+import { fromInstanceMetadata } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromInstanceMetadata();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/ecs.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/ecs.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.ECSCredentials();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/ecs.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/ecs.output.js
@@ -0,0 +1,6 @@
+import { fromContainerMetadata } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromContainerMetadata();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/env.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/env.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.EnvironmentCredentials("AWS");
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/env.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/env.output.js
@@ -0,0 +1,6 @@
+import { fromEnv } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromEnv("AWS");
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/ini.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/ini.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.SharedIniFileCredentials({ profile: "profile-name" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/ini.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/ini.output.js
@@ -0,0 +1,6 @@
+import { fromIni } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromIni({ profile: "profile-name" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/remote.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/remote.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.RemoteCredentials();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/remote.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/remote.output.js
@@ -0,0 +1,6 @@
+import { fromContainerMetadata } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromContainerMetadata();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/token-file.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/token-file.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.TokenFileWebIdentityCredentials();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/token-file.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/token-file.output.js
@@ -0,0 +1,6 @@
+import { fromTokenFile } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromTokenFile();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/token-web.input.js b/src/transforms/v2-to-v3/__fixtures__/credentials/token-web.input.js
@@ -0,0 +1,3 @@
+import AWS from "aws-sdk";
+
+new AWS.WebIdentityCredentials();
diff --git a/src/transforms/v2-to-v3/__fixtures__/credentials/token-web.output.js b/src/transforms/v2-to-v3/__fixtures__/credentials/token-web.output.js
@@ -0,0 +1,6 @@
+import { fromWebToken } from "@aws-sdk/credential-providers";
+
+// JS SDK v3 switched to credential providers to functions instead of objects.
+// This is the closest approximation from codemod of what your application needs.
+// Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers
+fromWebToken();
diff --git a/src/transforms/v2-to-v3/__fixtures__/misc/unsupported-feature.input.js b/src/transforms/v2-to-v3/__fixtures__/misc/unsupported-feature.input.js
diff --git a/src/transforms/v2-to-v3/__fixtures__/misc/unsupported-feature.output.js b/src/transforms/v2-to-v3/__fixtures__/misc/unsupported-feature.output.js
diff --git a/src/transforms/v2-to-v3/apis/getAwsCredentialsNewExpressions.ts b/src/transforms/v2-to-v3/apis/getAwsCredentialsNewExpressions.ts
@@ -0,0 +1,23 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export interface GetAwsCredentialsNewExpressionOptions {
+  v2GlobalName: string;
+  className: string;
+}
+
+export const getAwsCredentialsNewExpressions = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2GlobalName, className }: GetAwsCredentialsNewExpressionOptions
+) =>
+  source.find(j.NewExpression, {
+    type: "NewExpression",
+    callee: {
+      type: "MemberExpression",
+      object: {
+        type: "Identifier",
+        name: v2GlobalName,
+      },
+      property: { name: className },
+    },
+  });
diff --git a/src/transforms/v2-to-v3/apis/index.ts b/src/transforms/v2-to-v3/apis/index.ts
@@ -6,6 +6,7 @@ export * from "./getS3SignedUrlApiNames";
 export * from "./isS3GetSignedUrlApiUsed";
 export * from "./isS3UploadApiUsed";
 export * from "./removePromiseCalls";
+export * from "./replaceAwsCredentials";
 export * from "./replaceS3GetSignedUrlApi";
 export * from "./replaceS3UploadApi";
 export * from "./replaceWaiterApi";
diff --git a/src/transforms/v2-to-v3/apis/replaceAwsCredentials.ts b/src/transforms/v2-to-v3/apis/replaceAwsCredentials.ts
@@ -0,0 +1,50 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+import { AWS_CREDENTIALS_MAP } from "../config";
+import { ImportType, addNamedModule } from "../modules";
+import { getAwsCredentialsNewExpressions } from "./getAwsCredentialsNewExpressions";
+
+export interface ReplaceAwsCredentialsOptions {
+  v2GlobalName?: string;
+  importType: ImportType;
+}
+
+export const replaceAwsCredentials = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2GlobalName, importType }: ReplaceAwsCredentialsOptions
+) => {
+  if (!v2GlobalName) return;
+
+  for (const [v2CredentialsName, v3ProviderName] of Object.entries(AWS_CREDENTIALS_MAP)) {
+    const credsNewExpressions = getAwsCredentialsNewExpressions(j, source, {
+      v2GlobalName,
+      className: v2CredentialsName,
+    });
+    const credsNewExpressionCount = credsNewExpressions.size();
+
+    if (credsNewExpressionCount > 0) {
+      addNamedModule(j, source, {
+        importType,
+        importedName: v3ProviderName,
+        packageName: "@aws-sdk/credential-providers",
+      });
+      credsNewExpressions.replaceWith(({ node }) =>
+        j.callExpression.from({
+          callee: j.identifier(v3ProviderName),
+          comments: [
+            j.commentLine(
+              " JS SDK v3 switched to credential providers to functions instead of objects."
+            ),
+            j.commentLine(
+              " This is the closest approximation from codemod of what your application needs."
+            ),
+            j.commentLine(
+              " Reference: https://www.npmjs.com/package/@aws-sdk/credential-providers"
+            ),
+          ],
+          arguments: node.arguments,
+        })
+      );
+    }
+  }
+};
diff --git a/src/transforms/v2-to-v3/config/AWS_CREDENTIALS_MAP.ts b/src/transforms/v2-to-v3/config/AWS_CREDENTIALS_MAP.ts
@@ -0,0 +1,14 @@
+/**
+ * Maps the AWS credentials class name in v2 to the v3 equivalent provider.
+ */
+export const AWS_CREDENTIALS_MAP: Record<string, string> = {
+  ChainableTemporaryCredentials: "fromTemporaryCredentials",
+  CognitoIdentityCredentials: "fromCognitoIdentity",
+  EC2MetadataCredentials: "fromInstanceMetadata",
+  ECSCredentials: "fromContainerMetadata",
+  EnvironmentCredentials: "fromEnv",
+  RemoteCredentials: "fromContainerMetadata",
+  SharedIniFileCredentials: "fromIni",
+  TokenFileWebIdentityCredentials: "fromTokenFile",
+  WebIdentityCredentials: "fromWebToken",
+};
diff --git a/src/transforms/v2-to-v3/config/index.ts b/src/transforms/v2-to-v3/config/index.ts
@@ -1,3 +1,4 @@
+export * from "./AWS_CREDENTIALS_MAP";
 export * from "./CLIENT_NAMES";
 export * from "./CLIENT_NAMES_MAP";
 export * from "./CLIENT_PACKAGE_NAMES_MAP";
diff --git a/src/transforms/v2-to-v3/modules/index.ts b/src/transforms/v2-to-v3/modules/index.ts
@@ -1,4 +1,5 @@
 export * from "./addClientModules";
+export * from "./addNamedModule";
 export * from "./getGlobalNameFromModule";
 export * from "./getImportEqualsDeclarationType";
 export * from "./getImportSpecifiers";
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts
@@ -8,6 +8,7 @@ import {
   replaceS3UploadApi,
   replaceS3GetSignedUrlApi,
   getClientIdentifiersRecord,
+  replaceAwsCredentials,
 } from "./apis";
 import { replaceAwsUtilFunctions } from "./aws-util";
 import { replaceClientCreation, replaceDocClientCreation } from "./client-instances";
@@ -91,6 +92,7 @@ const transformer = async (file: FileInfo, api: API) => {
     replaceClientCreation(j, source, { ...v2Options, v3ClientName });
     replaceDocClientCreation(j, source, v2Options);
   }
+  replaceAwsCredentials(j, source, { v2GlobalName, importType });
   replaceAwsUtilFunctions(j, source, v2GlobalName);
   removeGlobalModule(j, source, { v2GlobalName, importType });
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": minor
 +---
++
 +Basic transformation of AWS Credentials
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS from "aws-sdk";`
	`2`	`+`
	`3`	`+new AWS.CognitoIdentityCredentials();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS from "aws-sdk";`
	`2`	`+`
	`3`	`+new AWS.EC2MetadataCredentials();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS from "aws-sdk";`
	`2`	`+`
	`3`	`+new AWS.ECSCredentials();`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import AWS from "aws-sdk";`
	`2`	`+`
	`3`	`+new AWS.EnvironmentCredentials("AWS");`