Transform clients imported from aws-sdk/clients/all (#845)

trivikr · web-flow · commit 81d863f969ce · 2024-04-11T11:10:15.000-07:00
diff --git a/.changeset/poor-badgers-battle.md b/.changeset/poor-badgers-battle.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Transform clients imported from aws-sdk/clients/all
diff --git a/scripts/generateNewClientTests/getServiceImportDeepAllInput.ts b/scripts/generateNewClientTests/getServiceImportDeepAllInput.ts
@@ -0,0 +1,3 @@
+import { getServiceImportInput } from "./getServiceImportInput";
+
+export const getServiceImportDeepAllInput = () => getServiceImportInput("aws-sdk/clients/all");
diff --git a/scripts/generateNewClientTests/getServiceImportInput.ts b/scripts/generateNewClientTests/getServiceImportInput.ts
@@ -1,10 +1,10 @@
 import { CLIENTS_TO_TEST } from "./config";
 import { getV2ClientsNewExpressionCode } from "./getV2ClientsNewExpressionCode";
 
-export const getServiceImportInput = () => {
+export const getServiceImportInput = (path?: string) => {
   let content = ``;
 
-  content += `import { ${CLIENTS_TO_TEST.join(", ")} } from "aws-sdk";\n`;
+  content += `import { ${CLIENTS_TO_TEST.join(", ")} } from "${path ? path : "aws-sdk"}";\n`;
   content += `\n`;
   content += getV2ClientsNewExpressionCode(CLIENTS_TO_TEST);
 
diff --git a/scripts/generateNewClientTests/getServiceRequireDeepAllInput.ts b/scripts/generateNewClientTests/getServiceRequireDeepAllInput.ts
@@ -0,0 +1,3 @@
+import { getServiceRequireInput } from "./getServiceRequireInput";
+
+export const getServiceRequireDeepAllInput = () => getServiceRequireInput("aws-sdk/clients/all");
diff --git a/scripts/generateNewClientTests/getServiceRequireInput.ts b/scripts/generateNewClientTests/getServiceRequireInput.ts
@@ -1,10 +1,10 @@
 import { CLIENTS_TO_TEST } from "./config";
 import { getV2ClientsNewExpressionCode } from "./getV2ClientsNewExpressionCode";
 
-export const getServiceRequireInput = () => {
+export const getServiceRequireInput = (path?: string) => {
   let content = ``;
 
-  content += `const { ${CLIENTS_TO_TEST.join(", ")} } = require("aws-sdk");\n`;
+  content += `const { ${CLIENTS_TO_TEST.join(", ")} } = require("${path ? path : "aws-sdk"}");\n`;
   content += `\n`;
   content += getV2ClientsNewExpressionCode(CLIENTS_TO_TEST);
 
diff --git a/scripts/generateNewClientTests/index.ts b/scripts/generateNewClientTests/index.ts
@@ -15,6 +15,7 @@ import { getGlobalRequirePropertyInput } from "./getGlobalRequirePropertyInput";
 import { getGlobalRequirePropertyOutput } from "./getGlobalRequirePropertyOutput";
 import { getGlobalRequirePropertyWithNameInput } from "./getGlobalRequirePropertyWithNameInput";
 import { getGlobalRequirePropertyWithNameOutput } from "./getGlobalRequirePropertyWithNameOutput";
+import { getServiceImportDeepAllInput } from "./getServiceImportDeepAllInput";
 import { getServiceImportDeepInput } from "./getServiceImportDeepInput";
 import { getServiceImportDeepOutput } from "./getServiceImportDeepOutput";
 import { getServiceImportDeepStarInput } from "./getServiceImportDeepStarInput";
@@ -31,6 +32,7 @@ import { getServiceImportInput } from "./getServiceImportInput";
 import { getServiceImportOutput } from "./getServiceImportOutput";
 import { getServiceImportWithNameInput } from "./getServiceImportWithNameInput";
 import { getServiceImportWithNameOutput } from "./getServiceImportWithNameOutput";
+import { getServiceRequireDeepAllInput } from "./getServiceRequireDeepAllInput";
 import { getServiceRequireDeepInput } from "./getServiceRequireDeepInput";
 import { getServiceRequireDeepOutput } from "./getServiceRequireDeepOutput";
 import { getServiceRequireDeepWithNameInput } from "./getServiceRequireDeepWithNameInput";
@@ -68,6 +70,8 @@ const newClientTestsPath = join(__dirname, "..", "..", newClientsTestsFolder);
     ["service-import-equals-with-name.output.ts", getServiceImportEqualsWithNameOutput],
     ["service-import-deep.input.js", getServiceImportDeepInput],
     ["service-import-deep.output.js", getServiceImportDeepOutput],
+    ["service-import-deep-all.input.js", getServiceImportDeepAllInput],
+    ["service-import-deep-all.output.js", getServiceImportDeepOutput],
     ["service-import-deep-with-name.input.js", getServiceImportDeepWithNameInput],
     ["service-import-deep-with-name.output.js", getServiceImportDeepWithNameOutput],
     ["service-import-deep-star.input.js", getServiceImportDeepStarInput],
@@ -78,6 +82,8 @@ const newClientTestsPath = join(__dirname, "..", "..", newClientsTestsFolder);
     ["service-import-with-name.output.js", getServiceImportWithNameOutput],
     ["service-require.input.js", getServiceRequireInput],
     ["service-require.output.js", getServiceRequireOutput],
+    ["service-require-deep-all.input.js", getServiceRequireDeepAllInput],
+    ["service-require-deep-all.output.js", getServiceRequireOutput],
     ["service-require-deep.input.js", getServiceRequireDeepInput],
     ["service-require-deep.output.js", getServiceRequireDeepOutput],
     ["service-require-deep-with-name.input.js", getServiceRequireDeepWithNameInput],
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/service-import-deep-all.input.js b/src/transforms/v2-to-v3/__fixtures__/new-client/service-import-deep-all.input.js
@@ -0,0 +1,7 @@
+// This file is generated by scripts/generateNewClientTests/index.ts
+// Do not edit this file directly. Instead, edit the script and run it to regenerate this file.
+import { AccessAnalyzer, Discovery, ACM } from "aws-sdk/clients/all";
+
+new AccessAnalyzer();
+new Discovery();
+new ACM();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/service-import-deep-all.output.js b/src/transforms/v2-to-v3/__fixtures__/new-client/service-import-deep-all.output.js
@@ -0,0 +1,11 @@
+// This file is generated by scripts/generateNewClientTests/index.ts
+// Do not edit this file directly. Instead, edit the script and run it to regenerate this file.
+
+
+import { AccessAnalyzer } from "@aws-sdk/client-accessanalyzer";
+import { ACM } from "@aws-sdk/client-acm";
+import { ApplicationDiscoveryService } from "@aws-sdk/client-application-discovery-service";
+
+new AccessAnalyzer();
+new ApplicationDiscoveryService();
+new ACM();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/service-require-deep-all.input.js b/src/transforms/v2-to-v3/__fixtures__/new-client/service-require-deep-all.input.js
@@ -0,0 +1,7 @@
+// This file is generated by scripts/generateNewClientTests/index.ts
+// Do not edit this file directly. Instead, edit the script and run it to regenerate this file.
+const { AccessAnalyzer, Discovery, ACM } = require("aws-sdk/clients/all");
+
+new AccessAnalyzer();
+new Discovery();
+new ACM();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/service-require-deep-all.output.js b/src/transforms/v2-to-v3/__fixtures__/new-client/service-require-deep-all.output.js
@@ -0,0 +1,11 @@
+// This file is generated by scripts/generateNewClientTests/index.ts
+// Do not edit this file directly. Instead, edit the script and run it to regenerate this file.
+
+
+const { AccessAnalyzer } = require("@aws-sdk/client-accessanalyzer");
+const { ACM } = require("@aws-sdk/client-acm");
+const { ApplicationDiscoveryService } = require("@aws-sdk/client-application-discovery-service");
+
+new AccessAnalyzer();
+new ApplicationDiscoveryService();
+new ACM();
diff --git a/src/transforms/v2-to-v3/modules/index.ts b/src/transforms/v2-to-v3/modules/index.ts
@@ -4,4 +4,5 @@ export * from "./getGlobalNameFromModule";
 export * from "./getImportType";
 export * from "./getRequireDeclaratorsWithProperty";
 export * from "./removeModules";
+export * from "./replaceDeepImport";
 export * from "./types";
diff --git a/src/transforms/v2-to-v3/modules/replaceDeepImport.ts b/src/transforms/v2-to-v3/modules/replaceDeepImport.ts
@@ -0,0 +1,15 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+export interface ReplaceDeepImportOptions {
+  fromPath: string;
+  toPath: string;
+}
+
+export const replaceDeepImport = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { fromPath, toPath }: ReplaceDeepImportOptions
+) => {
+  source.find(j.Literal, { value: fromPath }).replaceWith(j.literal(toPath));
+  source.find(j.StringLiteral, { value: fromPath }).replaceWith(j.stringLiteral(toPath));
+};
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts
@@ -25,8 +25,14 @@ import {
   getClientNamesFromGlobal,
   getClientNamesRecord,
 } from "./client-names";
-import { NOT_SUPPORTED_COMMENT, S3 } from "./config";
-import { addClientModules, getGlobalNameFromModule, getImportType, removeModules } from "./modules";
+import { NOT_SUPPORTED_COMMENT, PACKAGE_NAME, S3 } from "./config";
+import {
+  addClientModules,
+  getGlobalNameFromModule,
+  getImportType,
+  removeModules,
+  replaceDeepImport,
+} from "./modules";
 import { removeTypesFromTSQualifiedName, replaceTSTypeReference } from "./ts-type";
 import {
   IndentationType,
@@ -48,6 +54,8 @@ const transformer = async (file: FileInfo, api: API) => {
     return file.source;
   }
 
+  replaceDeepImport(j, source, { fromPath: "aws-sdk/clients/all", toPath: PACKAGE_NAME });
+
   const v2GlobalName = getGlobalNameFromModule(j, source);
   const v2ClientNamesRecord = getClientNamesRecord(j, source, importType);
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": patch
 +---
++
 +Transform clients imported from aws-sdk/clients/all
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { getServiceImportInput } from "./getServiceImportInput";`
	`2`	`+`
	`3`	`+export const getServiceImportDeepAllInput = () => getServiceImportInput("aws-sdk/clients/all");`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { getServiceRequireInput } from "./getServiceRequireInput";`
	`2`	`+`
	`3`	`+export const getServiceRequireDeepAllInput = () => getServiceRequireInput("aws-sdk/clients/all");`