Transform AWS.util.array functions (#587)

Author: trivikr

.changeset/silly-lamps-tell.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Transform AWS.util.array functions

src/transforms/v2-to-v3/__fixtures__/util/arrayEach.input.js

@@ -0,0 +1,5 @@
+import AWS from "aws-sdk";
+
+AWS.util.arrayEach(["one", "two", "three"], (item, index) => {
+  console.log({ index, item });
+});

src/transforms/v2-to-v3/__fixtures__/util/arrayEach.output.js

@@ -0,0 +1,3 @@
+["one", "two", "three"].forEach((item, index) => {
+  console.log({ index, item });
+});

src/transforms/v2-to-v3/__fixtures__/util/arraySliceFn.input.js

@@ -0,0 +1,4 @@
+import AWS from "aws-sdk";
+
+const data = ["one", "two", "three"];
+const sliceFn = AWS.util.arraySliceFn(data);

src/transforms/v2-to-v3/__fixtures__/util/arraySliceFn.output.js

@@ -0,0 +1,2 @@
+const data = ["one", "two", "three"];
+const sliceFn = data.slice;

src/transforms/v2-to-v3/aws-util/getAwsUtilCallExpression.ts

@@ -0,0 +1,26 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export interface GetAwsUtilCallExpressionOptions {
+  v2GlobalName: string;
+  functionName: string;
+}
+
+export const getAwsUtilCallExpression = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2GlobalName, functionName }: GetAwsUtilCallExpressionOptions
+) =>
+  source.find(j.CallExpression, {
+    callee: {
+      type: "MemberExpression",
+      object: {
+        type: "MemberExpression",
+        object: {
+          type: "Identifier",
+          name: v2GlobalName,
+        },
+        property: { name: "util" },
+      },
+      property: { name: functionName },
+    },
+  });

src/transforms/v2-to-v3/aws-util/index.ts

@@ -0,0 +1 @@
+export * from "./replaceAwsUtilFunctions";

src/transforms/v2-to-v3/aws-util/replaceAwsUtilArrayFunctions.ts

@@ -0,0 +1,24 @@
+import { Collection, FunctionExpression, Identifier, JSCodeshift } from "jscodeshift";
+import { getAwsUtilCallExpression } from "./getAwsUtilCallExpression";
+
+export const replaceAwsUtilArrayFunctions = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  v2GlobalName: string
+) => {
+  // replace arrayEach
+  getAwsUtilCallExpression(j, source, { v2GlobalName, functionName: "arrayEach" })
+    .filter(({ node }) => node.arguments.length === 2)
+    .replaceWith(({ node }) => {
+      const array = node.arguments[0] as Identifier;
+      const iteratee = node.arguments[1] as FunctionExpression;
+      return j.callExpression(j.memberExpression(array, j.identifier("forEach")), [iteratee]);
+    });
+
+  // replace arraySliceFn
+  getAwsUtilCallExpression(j, source, { v2GlobalName, functionName: "arraySliceFn" })
+    .filter(({ node }) => node.arguments.length === 1)
+    .replaceWith(({ node }) =>
+      j.memberExpression(node.arguments[0] as Identifier, j.identifier("slice"))
+    );
+};

src/transforms/v2-to-v3/aws-util/replaceAwsUtilFunctions.ts

@@ -0,0 +1,11 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+import { replaceAwsUtilArrayFunctions } from "./replaceAwsUtilArrayFunctions";
+
+export const replaceAwsUtilFunctions = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  v2GlobalName?: string
+) => {
+  if (!v2GlobalName) return;
+  replaceAwsUtilArrayFunctions(j, source, v2GlobalName);
+};

src/transforms/v2-to-v3/transformer.ts

@@ -9,6 +9,7 @@ import {
   replaceS3GetSignedUrlApi,
   getClientIdentifiersRecord,
 } from "./apis";
+import { replaceAwsUtilFunctions } from "./aws-util";
 import { replaceClientCreation, replaceDocClientCreation } from "./client-instances";
 import {
   getClientMetadataRecord,
@@ -88,6 +89,7 @@ const transformer = async (file: FileInfo, api: API) => {
     replaceClientCreation(j, source, v2Options);
     replaceDocClientCreation(j, source, v2Options);
   }
+  replaceAwsUtilFunctions(j, source, v2GlobalName);
   removeGlobalModule(j, source, v2GlobalName);
 
   return source.toSource();