Add initial transformation for s3.upload API (#394)

trivikr · web-flow · commit 5aeb73efb4e1 · 2023-02-22T19:15:47.000-08:00
diff --git a/.changeset/small-foxes-hug.md b/.changeset/small-foxes-hug.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": minor
+---
+
+Add initial transformation for s3.upload API
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import-equals.input.ts b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import-equals.input.ts
@@ -0,0 +1,9 @@
+import AWS = require("aws-sdk");
+
+const client = new AWS.S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import-equals.output.ts b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import-equals.output.ts
@@ -0,0 +1,23 @@
+import AWS_lib_storage = require("@aws-sdk/lib-storage");
+
+const {
+  Upload
+} = AWS_lib_storage;
+
+import AWS_S3 = require("@aws-sdk/client-s3");
+
+const {
+  S3
+} = AWS_S3;
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import.input.js
@@ -0,0 +1,9 @@
+import AWS from "aws-sdk";
+
+const client = new AWS.S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-import.output.js
@@ -0,0 +1,14 @@
+import { Upload } from "@aws-sdk/lib-storage";
+import { S3 } from "@aws-sdk/client-s3";
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require-property.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require-property.input.js
@@ -0,0 +1,9 @@
+const S3 = require("aws-sdk").S3;
+
+const client = new S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require-property.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require-property.output.js
@@ -0,0 +1,18 @@
+const {
+        Upload
+      } = require("@aws-sdk/lib-storage"),
+      {
+        S3
+      } = require("@aws-sdk/client-s3");
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require.input.js
@@ -0,0 +1,9 @@
+const AWS = require("aws-sdk");
+
+const client = new AWS.S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/global-require.output.js
@@ -0,0 +1,18 @@
+const {
+        Upload
+      } = require("@aws-sdk/lib-storage"),
+      {
+        S3
+      } = require("@aws-sdk/client-s3");
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-deep.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-deep.input.js
@@ -0,0 +1,9 @@
+import S3 from "aws-sdk/clients/s3";
+
+const client = new S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-deep.output.js
@@ -0,0 +1,14 @@
+import { Upload } from "@aws-sdk/lib-storage";
+import { S3 } from "@aws-sdk/client-s3";
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-equals.input.ts b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-equals.input.ts
@@ -0,0 +1,9 @@
+import S3 = require("aws-sdk/clients/s3");
+
+const client = new S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-equals.output.ts b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import-equals.output.ts
@@ -0,0 +1,23 @@
+import AWS_lib_storage = require("@aws-sdk/lib-storage");
+
+const {
+  Upload
+} = AWS_lib_storage;
+
+import AWS_S3 = require("@aws-sdk/client-s3");
+
+const {
+  S3
+} = AWS_S3;
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import.input.js
@@ -0,0 +1,9 @@
+import { S3 } from "aws-sdk";
+
+const client = new S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-import.output.js
@@ -0,0 +1,14 @@
+import { Upload } from "@aws-sdk/lib-storage";
+import { S3 } from "@aws-sdk/client-s3";
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require-deep.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require-deep.input.js
@@ -0,0 +1,9 @@
+const S3 = require("aws-sdk/clients/s3");
+
+const client = new S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require-deep.output.js
@@ -0,0 +1,18 @@
+const {
+        Upload
+      } = require("@aws-sdk/lib-storage"),
+      {
+        S3
+      } = require("@aws-sdk/client-s3");
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require.input.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require.input.js
@@ -0,0 +1,9 @@
+const { S3 } = require("aws-sdk");
+
+const client = new S3({ region: "REGION" });
+await client.upload({
+  Body: "BODY",
+  Bucket: "Bucket",
+  ContentType: "ContentType",
+  Key: "Key",
+}).promise();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-upload/service-require.output.js
@@ -0,0 +1,18 @@
+const {
+        Upload
+      } = require("@aws-sdk/lib-storage"),
+      {
+        S3
+      } = require("@aws-sdk/client-s3");
+
+const client = new S3({ region: "REGION" });
+await new Upload({
+  client,
+
+  params: {
+    Body: "BODY",
+    Bucket: "Bucket",
+    ContentType: "ContentType",
+    Key: "Key",
+  }
+}).done();
diff --git a/src/transforms/v2-to-v3/apis/index.ts b/src/transforms/v2-to-v3/apis/index.ts
@@ -1,4 +1,5 @@
 export * from "./getClientWaiterStates";
 export * from "./getV3ClientWaiterApiName";
+export * from "./isS3UploadApiUsed";
 export * from "./removePromiseCalls";
 export * from "./replaceWaiterApi";
diff --git a/src/transforms/v2-to-v3/apis/isS3UploadApiUsed.ts b/src/transforms/v2-to-v3/apis/isS3UploadApiUsed.ts
@@ -0,0 +1,33 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+import { getV2ClientIdentifiers } from "./getV2ClientIdentifiers";
+
+export interface IsS3UploadApiUsedOptions {
+  v2ClientName: string;
+  v2ClientLocalName: string;
+  v2GlobalName?: string;
+}
+
+export const isS3UploadApiUsed = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  options: IsS3UploadApiUsedOptions
+) => {
+  if (options.v2ClientName !== "S3") return false;
+
+  const v2ClientIdentifiers = getV2ClientIdentifiers(j, source, options);
+
+  for (const v2ClientId of v2ClientIdentifiers) {
+    const s3UploadCallExpressions = source.find(j.CallExpression, {
+      callee: {
+        type: "MemberExpression",
+        object: v2ClientId,
+        property: { type: "Identifier", name: "upload" },
+      },
+    });
+
+    if (s3UploadCallExpressions.length) return true;
+  }
+
+  return false;
+};
diff --git a/src/transforms/v2-to-v3/apis/replaceS3UploadApi.ts b/src/transforms/v2-to-v3/apis/replaceS3UploadApi.ts
@@ -0,0 +1,69 @@
+import { Collection, Identifier, JSCodeshift } from "jscodeshift";
+
+import { getV2ClientIdentifiers } from "./getV2ClientIdentifiers";
+
+export interface ReplaceS3UploadApiOptions {
+  v2ClientName: string;
+  v2ClientLocalName: string;
+  v2GlobalName?: string;
+}
+
+// Updates `s3.upload()` API with `new Upload()` API.
+export const replaceS3UploadApi = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  options: ReplaceS3UploadApiOptions
+): void => {
+  const v2ClientIdentifiers = getV2ClientIdentifiers(j, source, options);
+
+  for (const v2ClientId of v2ClientIdentifiers) {
+    source
+      .find(j.CallExpression, {
+        type: "CallExpression",
+        callee: {
+          type: "MemberExpression",
+          object: v2ClientId,
+          property: { type: "Identifier", name: "upload" },
+        },
+      })
+      .replaceWith((callExpression) => {
+        const params = callExpression.node.arguments[0];
+
+        const properties = [];
+        properties.push(
+          j.objectProperty.from({
+            key: j.identifier("client"),
+            value: v2ClientId,
+            shorthand: true,
+          })
+        );
+
+        if (params) {
+          properties.push(
+            j.objectProperty.from({
+              key: j.identifier("params"),
+              // @ts-expect-error Type 'SpreadElement | ExpressionKind' is not assignable
+              value: params,
+              shorthand: true,
+            })
+          );
+        }
+
+        return j.newExpression(j.identifier("Upload"), [j.objectExpression(properties)]);
+      });
+
+    // Replace `.promise()` call with `.done()` if present.
+    source
+      .find(j.MemberExpression, {
+        type: "MemberExpression",
+        object: {
+          type: "NewExpression",
+          callee: { type: "Identifier", name: "Upload" },
+        },
+        property: { type: "Identifier", name: "promise" },
+      })
+      .forEach((memberExpression) => {
+        (memberExpression.value.property as Identifier).name = "done";
+      });
+  }
+};
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientDefaultImportEquals.ts b/src/transforms/v2-to-v3/modules/addV3ClientDefaultImportEquals.ts
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientImportEquals.ts b/src/transforms/v2-to-v3/modules/addV3ClientImportEquals.ts
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientImports.ts b/src/transforms/v2-to-v3/modules/addV3ClientImports.ts
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientNamedImportEquals.ts b/src/transforms/v2-to-v3/modules/addV3ClientNamedImportEquals.ts
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientRequires.ts b/src/transforms/v2-to-v3/modules/addV3ClientRequires.ts
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": minor
 +---
++
 +Add initial transformation for s3.upload API