Remove require declarator from declaration (#626)

Author: trivikr

.changeset/wild-games-clap.md

@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Remove require declarator from declaration

src/transforms/v2-to-v3/__fixtures__/existing/identifier-require-property.input.js

@@ -0,0 +1,5 @@
+const DynDB = require("aws-sdk").DynamoDB;
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
+
+const client1 = new DynDB();
+const client2 = new DynamoDB();

src/transforms/v2-to-v3/__fixtures__/existing/identifier-require-property.output.js

@@ -0,0 +1,7 @@
+const {
+  DynamoDB,
+  DynamoDB: DynDB
+} = require("@aws-sdk/client-dynamodb");
+
+const client1 = new DynDB();
+const client2 = new DynamoDB();

src/transforms/v2-to-v3/modules/removeClientModule.ts

@@ -7,7 +7,7 @@ import { removeImportDefault } from "./removeImportDefault";
 import { removeImportEquals } from "./removeImportEquals";
 import { removeImportNamed } from "./removeImportNamed";
 import { removeRequireIdentifier } from "./removeRequireIdentifier";
-import { removeRequireObjectProperty } from "./removeRequireObjectProperty";
+import { removeRequireObjectPattern } from "./removeRequireObjectPattern";
 import { removeRequireProperty } from "./removeRequireProperty";
 import { ImportType } from "./types";
 
@@ -31,7 +31,7 @@ export const removeClientModule = (
 
   if (importType === ImportType.REQUIRE) {
     removeRequireIdentifier(j, source, defaultOptions);
-    removeRequireObjectProperty(j, source, namedOptions);
+    removeRequireObjectPattern(j, source, namedOptions);
     removeRequireProperty(j, source, { ...namedOptions, propertyName: v2ClientName });
   } else if (importType === ImportType.IMPORT_EQUALS) {
     removeImportEquals(j, source, defaultOptions);

src/transforms/v2-to-v3/modules/removeRequireIdentifier.ts

@@ -1,4 +1,4 @@
-import { Collection, JSCodeshift } from "jscodeshift";
+import { Collection, Identifier, JSCodeshift, VariableDeclarator } from "jscodeshift";
 
 import { getRequireDeclaratorsWithIdentifier } from "./getRequireDeclaratorsWithIdentifier";
 
@@ -18,15 +18,39 @@ export const removeRequireIdentifier = (
   });
 
   requireDeclarators.forEach((varDeclarator) => {
-    const varDeclarationCollection = j(varDeclarator).closest(j.VariableDeclaration);
+    const varDeclaration = varDeclarator.parentPath.parentPath;
 
-    // Remove VariableDeclarator as it contains the only identifier.
-    j(varDeclarator).remove();
+    // Removes variable declarator from the declarations.
+    varDeclaration.value.declarations = varDeclaration.value.declarations.filter(
+      (declaration: VariableDeclarator | Identifier) => {
+        if (declaration.type === "Identifier") return true;
+
+        const id = declaration.id;
+        if (id.type !== "Identifier") return true;
+        if (id.name !== localName) return true;
+
+        const init = declaration.init;
+        if (!init) return true;
+        if (init.type !== "CallExpression") return true;
+
+        const callee = init.callee;
+        if (!callee) return true;
+        if (callee.type !== "Identifier") return true;
+        if (callee.name !== "require") return true;
+
+        const args = init.arguments;
+        if (!args) return true;
+        if (args.length !== 1) return true;
+        if (args[0].type !== "Literal") return true;
+        if (args[0].value !== sourceValue) return true;
+
+        return false;
+      }
+    );
 
     // Remove VariableDeclaration if there are no declarations.
-    const varDeclaration = varDeclarationCollection.nodes()[0];
-    if (varDeclaration && varDeclaration.declarations?.length === 0) {
-      varDeclarationCollection.remove();
+    if (varDeclaration.value.declarations?.length === 0) {
+      j(varDeclaration).remove();
     }
   });
 };

src/transforms/v2-to-v3/modules/removeRequireObjectProperty.ts renamed to src/transforms/v2-to-v3/modules/removeRequireObjectPattern.ts

@@ -1,4 +1,12 @@
-import { Collection, JSCodeshift, ObjectPattern, ObjectProperty, Property } from "jscodeshift";
+import {
+  Collection,
+  Identifier,
+  JSCodeshift,
+  ObjectPattern,
+  ObjectProperty,
+  Property,
+  VariableDeclarator,
+} from "jscodeshift";
 
 import { OBJECT_PROPERTY_TYPE_LIST } from "../config";
 import { getRequireDeclaratorsWithObjectPattern } from "./getRequireDeclaratorsWithObjectPattern";
@@ -8,7 +16,7 @@ export interface RemoveRequireObjectPropertyOptions {
   sourceValue: string;
 }
 
-export const removeRequireObjectProperty = (
+export const removeRequireObjectPattern = (
   j: JSCodeshift,
   source: Collection<unknown>,
   { localName, sourceValue }: RemoveRequireObjectPropertyOptions
@@ -19,8 +27,6 @@ export const removeRequireObjectProperty = (
   });
 
   requireDeclarators.forEach((varDeclarator) => {
-    const varDeclarationCollection = j(varDeclarator).closest(j.VariableDeclaration);
-
     // Remove ObjectProperty from Variable Declarator.
     const varDeclaratorId = varDeclarator.value.id as ObjectPattern;
     varDeclaratorId.properties = varDeclaratorId.properties.filter((property) => {
@@ -31,12 +37,14 @@ export const removeRequireObjectProperty = (
 
     // Remove VariableDeclarator if there are no properties.
     if (varDeclaratorId.properties.length === 0) {
-      j(varDeclarator).remove();
+      const varDeclaration = varDeclarator.parentPath.parentPath;
+      varDeclaration.value.declarations = varDeclaration.value.declarations.filter(
+        (declaration: VariableDeclarator | Identifier) => declaration !== varDeclarator.value
+      );
 
       // Remove VariableDeclaration if there are no declarations.
-      const varDeclaration = varDeclarationCollection.nodes()[0];
-      if (varDeclaration && varDeclaration.declarations?.length === 0) {
-        varDeclarationCollection.remove();
+      if (varDeclaration.value.declarations?.length === 0) {
+        j(varDeclaration).remove();
       }
     }
   });

src/transforms/v2-to-v3/modules/removeRequireProperty.ts

@@ -1,4 +1,4 @@
-import { Collection, JSCodeshift } from "jscodeshift";
+import { Collection, Identifier, JSCodeshift, VariableDeclarator } from "jscodeshift";
 
 import { getRequireDeclaratorsWithProperty } from "./getRequireDeclaratorsWithProperty";
 
@@ -20,15 +20,44 @@ export const removeRequireProperty = (
   });
 
   requireDeclarators.forEach((varDeclarator) => {
-    const varDeclarationCollection = j(varDeclarator).closest(j.VariableDeclaration);
+    const varDeclaration = varDeclarator.parentPath.parentPath;
 
-    // Remove VariableDeclarator as it contains the only identifier.
-    j(varDeclarator).remove();
+    // Removes variable declarator from the declarations.
+    varDeclaration.value.declarations = varDeclaration.value.declarations.filter(
+      (declaration: VariableDeclarator | Identifier) => {
+        if (declaration.type === "Identifier") return true;
+
+        const id = declaration.id;
+        if (id.type !== "Identifier") return true;
+        if (id.name !== localName) return true;
+
+        const init = declaration.init;
+        if (!init) return true;
+        if (init.type !== "MemberExpression") return true;
+
+        const object = init.object;
+        if (object.type !== "CallExpression") return true;
+
+        const callee = object.callee;
+        if (callee.type !== "Identifier") return true;
+        if (callee.name !== "require") return true;
+
+        const args = object.arguments;
+        if (args.length !== 1) return true;
+        if (args[0].type !== "Literal") return true;
+        if (args[0].value !== sourceValue) return true;
+
+        const property = init.property;
+        if (property.type !== "Identifier") return true;
+        if (property.name !== propertyName) return true;
+
+        return false;
+      }
+    );
 
     // Remove VariableDeclaration if there are no declarations.
-    const varDeclaration = varDeclarationCollection.nodes()[0];
-    if (varDeclaration && varDeclaration.declarations?.length === 0) {
-      varDeclarationCollection.remove();
+    if (varDeclaration.value.declarations?.length === 0) {
+      j(varDeclaration).remove();
     }
   });
 };