Remove newlines from ObjectPattern requires (#715)

trivikr · web-flow · commit c18f8bef3731 · 2023-11-12T02:07:37.000-08:00
diff --git a/.changeset/dry-panthers-laugh.md b/.changeset/dry-panthers-laugh.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Remove newlines from ObjectPattern requires
diff --git a/scripts/generateNewClientTests/getV3PackageRequiresCode.ts b/scripts/generateNewClientTests/getV3PackageRequiresCode.ts
@@ -24,8 +24,10 @@ export const getV3PackageRequiresCode = (
       : v2ClientName;
 
     const v3RequireKeyValuePair =
-      v2ClientName === v2ClientLocalName ? v3ClientName : `${v3ClientName}: ${v2ClientLocalName}`;
-    content += `const {\n  ${v3RequireKeyValuePair}\n} = require("${v3ClientPackageName}");\n\n`;
+      v2ClientName === v2ClientLocalName
+        ? ` ${v3ClientName} `
+        : `\n  ${v3ClientName}: ${v2ClientLocalName}\n`;
+    content += `const {${v3RequireKeyValuePair}} = require("${v3ClientPackageName}");\n\n`;
   }
 
   return content;
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-promise/global-require-property.output.js b/src/transforms/v2-to-v3/__fixtures__/api-promise/global-require-property.output.js
@@ -1,6 +1,4 @@
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const client = new DynamoDB();
 const data = await client.listTables();
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-promise/global-require.output.js b/src/transforms/v2-to-v3/__fixtures__/api-promise/global-require.output.js
@@ -1,6 +1,4 @@
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const client = new DynamoDB();
 const data = await client.listTables();
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-promise/service-require-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/api-promise/service-require-deep.output.js
@@ -1,6 +1,4 @@
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const client = new DynamoDB();
 const data = await client.listTables();
diff --git a/src/transforms/v2-to-v3/__fixtures__/api-promise/service-require.output.js b/src/transforms/v2-to-v3/__fixtures__/api-promise/service-require.output.js
@@ -1,6 +1,4 @@
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const client = new DynamoDB();
 const data = await client.listTables();
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/global-require.output.js b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/global-require.output.js
@@ -1,10 +1,6 @@
-const {
-  DynamoDBDocument
-} = require("@aws-sdk/lib-dynamodb");
+const { DynamoDBDocument } = require("@aws-sdk/lib-dynamodb");
 
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const documentClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
 const response = await documentClient.scan({ TableName: "TABLE_NAME" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require-deep-with-name.output.js b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require-deep-with-name.output.js
@@ -1,6 +1,4 @@
-const {
-  DynamoDBDocument
-} = require("@aws-sdk/lib-dynamodb");
+const { DynamoDBDocument } = require("@aws-sdk/lib-dynamodb");
 
 const {
   DynamoDB: DynamoDBClient
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require-deep.output.js
@@ -1,10 +1,6 @@
-const {
-  DynamoDBDocument
-} = require("@aws-sdk/lib-dynamodb");
+const { DynamoDBDocument } = require("@aws-sdk/lib-dynamodb");
 
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const documentClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
 const response = await documentClient.scan({ TableName: "TABLE_NAME" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require-with-name.output.js b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require-with-name.output.js
@@ -1,6 +1,4 @@
-const {
-  DynamoDBDocument
-} = require("@aws-sdk/lib-dynamodb");
+const { DynamoDBDocument } = require("@aws-sdk/lib-dynamodb");
 
 const {
   DynamoDB: DynamoDBClient
diff --git a/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require.output.js b/src/transforms/v2-to-v3/__fixtures__/ddb-doc-client/service-require.output.js
@@ -1,10 +1,6 @@
-const {
-  DynamoDBDocument
-} = require("@aws-sdk/lib-dynamodb");
+const { DynamoDBDocument } = require("@aws-sdk/lib-dynamodb");
 
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const documentClient = DynamoDBDocument.from(new DynamoDB({ region: "us-west-2" }));
 const response = await documentClient.scan({ TableName: "TABLE_NAME" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/misc/multiple-declarators.output.js b/src/transforms/v2-to-v3/__fixtures__/misc/multiple-declarators.output.js
@@ -1,10 +1,6 @@
-const {
-  ApplicationDiscoveryService
-} = require("@aws-sdk/client-application-discovery-service");
+const { ApplicationDiscoveryService } = require("@aws-sdk/client-application-discovery-service");
 
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const ddbClient = new DynamoDB(),
   discoveryClient = new ApplicationDiscoveryService();
diff --git a/src/transforms/v2-to-v3/__fixtures__/misc/require.output.ts b/src/transforms/v2-to-v3/__fixtures__/misc/require.output.ts
@@ -1,5 +1,3 @@
-const {
-  DynamoDB
-} = require("@aws-sdk/client-dynamodb");
+const { DynamoDB } = require("@aws-sdk/client-dynamodb");
 
 const client = new DynamoDB();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/global-require-property.output.js b/src/transforms/v2-to-v3/__fixtures__/new-client/global-require-property.output.js
@@ -2,17 +2,11 @@
 // 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 { AccessAnalyzer } = require("@aws-sdk/client-accessanalyzer");
 
-const {
-  ACM
-} = require("@aws-sdk/client-acm");
+const { ACM } = require("@aws-sdk/client-acm");
 
-const {
-  ApplicationDiscoveryService
-} = require("@aws-sdk/client-application-discovery-service");
+const { ApplicationDiscoveryService } = require("@aws-sdk/client-application-discovery-service");
 
 new AccessAnalyzer();
 new ApplicationDiscoveryService();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/global-require.output.js b/src/transforms/v2-to-v3/__fixtures__/new-client/global-require.output.js
@@ -2,17 +2,11 @@
 // 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 { AccessAnalyzer } = require("@aws-sdk/client-accessanalyzer");
 
-const {
-  ACM
-} = require("@aws-sdk/client-acm");
+const { ACM } = require("@aws-sdk/client-acm");
 
-const {
-  ApplicationDiscoveryService
-} = require("@aws-sdk/client-application-discovery-service");
+const { ApplicationDiscoveryService } = require("@aws-sdk/client-application-discovery-service");
 
 new AccessAnalyzer();
 new ApplicationDiscoveryService();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/service-require-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/new-client/service-require-deep.output.js
@@ -2,17 +2,11 @@
 // 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 { AccessAnalyzer } = require("@aws-sdk/client-accessanalyzer");
 
-const {
-  ACM
-} = require("@aws-sdk/client-acm");
+const { ACM } = require("@aws-sdk/client-acm");
 
-const {
-  ApplicationDiscoveryService
-} = require("@aws-sdk/client-application-discovery-service");
+const { ApplicationDiscoveryService } = require("@aws-sdk/client-application-discovery-service");
 
 new AccessAnalyzer();
 new ApplicationDiscoveryService();
diff --git a/src/transforms/v2-to-v3/__fixtures__/new-client/service-require.output.js b/src/transforms/v2-to-v3/__fixtures__/new-client/service-require.output.js
@@ -2,17 +2,11 @@
 // 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 { AccessAnalyzer } = require("@aws-sdk/client-accessanalyzer");
 
-const {
-  ACM
-} = require("@aws-sdk/client-acm");
+const { ACM } = require("@aws-sdk/client-acm");
 
-const {
-  ApplicationDiscoveryService
-} = require("@aws-sdk/client-application-discovery-service");
+const { ApplicationDiscoveryService } = require("@aws-sdk/client-application-discovery-service");
 
 new AccessAnalyzer();
 new ApplicationDiscoveryService();
diff --git a/src/transforms/v2-to-v3/__fixtures__/s3-get-signed-url/getObject.require.output.js b/src/transforms/v2-to-v3/__fixtures__/s3-get-signed-url/getObject.require.output.js
@@ -1,6 +1,4 @@
-const {
-  getSignedUrl
-} = require("@aws-sdk/s3-request-presigner");
+const { getSignedUrl } = require("@aws-sdk/s3-request-presigner");
 
 const {
   GetObjectCommand,
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
@@ -1,10 +1,6 @@
-const {
-  Upload
-} = require("@aws-sdk/lib-storage");
+const { Upload } = require("@aws-sdk/lib-storage");
 
-const {
-  S3
-} = require("@aws-sdk/client-s3");
+const { S3 } = require("@aws-sdk/client-s3");
 
 const client = new S3();
 await new Upload({
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
@@ -1,10 +1,6 @@
-const {
-  Upload
-} = require("@aws-sdk/lib-storage");
+const { Upload } = require("@aws-sdk/lib-storage");
 
-const {
-  S3
-} = require("@aws-sdk/client-s3");
+const { S3 } = require("@aws-sdk/client-s3");
 
 const client = new S3();
 await new Upload({
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
@@ -1,10 +1,6 @@
-const {
-  Upload
-} = require("@aws-sdk/lib-storage");
+const { Upload } = require("@aws-sdk/lib-storage");
 
-const {
-  S3
-} = require("@aws-sdk/client-s3");
+const { S3 } = require("@aws-sdk/client-s3");
 
 const client = new S3();
 await new Upload({
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
@@ -1,10 +1,6 @@
-const {
-  Upload
-} = require("@aws-sdk/lib-storage");
+const { Upload } = require("@aws-sdk/lib-storage");
 
-const {
-  S3
-} = require("@aws-sdk/client-s3");
+const { S3 } = require("@aws-sdk/client-s3");
 
 const client = new S3();
 await new Upload({
diff --git a/src/transforms/v2-to-v3/transformer.ts b/src/transforms/v2-to-v3/transformer.ts
@@ -33,6 +33,7 @@ import {
 import { replaceTSTypeReference } from "./ts-type";
 import {
   IndentationType,
+  getFormattedSourceString,
   getMostUsedIndentationType,
   getMostUsedStringLiteralQuote,
   getValueIndentedWithTabs,
@@ -115,7 +116,7 @@ const transformer = async (file: FileInfo, api: API) => {
   replaceAwsUtilFunctions(j, source, v2GlobalName);
   removeGlobalModule(j, source, v2GlobalName);
 
-  const sourceString = source.toSource({ quote, useTabs, trailingComma });
+  const sourceString = getFormattedSourceString(source.toSource({ quote, useTabs, trailingComma }));
 
   if (useTabs) {
     // Refs: https://github.com/benjamn/recast/issues/315
diff --git a/src/transforms/v2-to-v3/utils/getFormattedSourceString.ts b/src/transforms/v2-to-v3/utils/getFormattedSourceString.ts
@@ -0,0 +1,10 @@
+/**
+ * Returns formatted source string for changes which can't be applied automatically.
+ */
+export const getFormattedSourceString = (source: string) =>
+  source
+    // Remove newlines from ObjectPattern requires.
+    .replace(
+      /\{\n {2}([\w]*)\n\} = require\((['"])@aws-sdk/g,
+      (_, identifier, quote) => `{ ${identifier} } = require(${quote}@aws-sdk`
+    );
diff --git a/src/transforms/v2-to-v3/utils/index.ts b/src/transforms/v2-to-v3/utils/index.ts
@@ -1,5 +1,6 @@
 export * from "./getClientDeepImportPath";
 export * from "./getClientNewExpression";
+export * from "./getFormattedSourceString";
 export * from "./getMostUsedStringLiteralQuote";
 export * from "./getMostUsedIndentationType";
 export * from "./getValueIndentedWithTabs";

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": patch
 +---
++
 +Remove newlines from ObjectPattern requires