Sort v3 named require/imports in transformed code (#383)

trivikr · web-flow · commit 77f08e856e59 · 2023-02-21T13:46:27.000-08:00
diff --git a/.changeset/few-ligers-thank.md b/.changeset/few-ligers-thank.md
@@ -0,0 +1,5 @@
+---
+"aws-sdk-js-codemod": patch
+---
+
+Sort v3 named require/imports
diff --git a/src/transforms/v2-to-v3/__fixtures__/existing/package-import.output.js b/src/transforms/v2-to-v3/__fixtures__/existing/package-import.output.js
@@ -1,4 +1,4 @@
-import { DynamoDBClient, DynamoDB } from "@aws-sdk/client-dynamodb";
+import { DynamoDB, DynamoDBClient } from "@aws-sdk/client-dynamodb";
 
 const client1 = new DynamoDB();
 const client2 = new DynamoDBClient();
diff --git a/src/transforms/v2-to-v3/__fixtures__/existing/package-require.output.js b/src/transforms/v2-to-v3/__fixtures__/existing/package-require.output.js
@@ -1,6 +1,6 @@
 const {
-  DynamoDBClient,
-  DynamoDB
+  DynamoDB,
+  DynamoDBClient
 } = require("@aws-sdk/client-dynamodb");
 
 const client1 = new DynamoDB();
diff --git a/src/transforms/v2-to-v3/__fixtures__/existing/package-service-import.output.js b/src/transforms/v2-to-v3/__fixtures__/existing/package-service-import.output.js
@@ -1,4 +1,4 @@
-import { DynamoDBClient, DynamoDB } from "@aws-sdk/client-dynamodb";
+import { DynamoDB, DynamoDBClient } from "@aws-sdk/client-dynamodb";
 
 const client1 = new DynamoDB();
 const client2 = new DynamoDBClient();
diff --git a/src/transforms/v2-to-v3/__fixtures__/existing/package-service-require.output.js b/src/transforms/v2-to-v3/__fixtures__/existing/package-service-require.output.js
@@ -1,6 +1,6 @@
 const {
-  DynamoDBClient,
-  DynamoDB
+  DynamoDB,
+  DynamoDBClient
 } = require("@aws-sdk/client-dynamodb");
 
 const client1 = new DynamoDB();
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/global-import-equals.output.ts b/src/transforms/v2-to-v3/__fixtures__/waiters/global-import-equals.output.ts
@@ -2,8 +2,8 @@ import AWS_S3 = require("@aws-sdk/client-s3");
 
 const {
   S3,
-  waitUntilBucketNotExists,
-  waitUntilBucketExists
+  waitUntilBucketExists,
+  waitUntilBucketNotExists
 } = AWS_S3;
 
 const Bucket = "BUCKET_NAME";
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/global-import.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/global-import.output.js
@@ -1,4 +1,4 @@
-import { S3, waitUntilBucketNotExists, waitUntilBucketExists } from "@aws-sdk/client-s3";
+import { S3, waitUntilBucketExists, waitUntilBucketNotExists } from "@aws-sdk/client-s3";
 
 const Bucket = "BUCKET_NAME";
 const client = new S3({ region: "REGION" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/global-require-property.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/global-require-property.output.js
@@ -1,7 +1,7 @@
 const {
   S3,
-  waitUntilBucketNotExists,
-  waitUntilBucketExists
+  waitUntilBucketExists,
+  waitUntilBucketNotExists
 } = require("@aws-sdk/client-s3");
 
 const Bucket = "BUCKET_NAME";
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/global-require.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/global-require.output.js
@@ -1,7 +1,7 @@
 const {
   S3,
-  waitUntilBucketNotExists,
-  waitUntilBucketExists
+  waitUntilBucketExists,
+  waitUntilBucketNotExists
 } = require("@aws-sdk/client-s3");
 
 const Bucket = "BUCKET_NAME";
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/service-import-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/service-import-deep.output.js
@@ -1,4 +1,4 @@
-import { S3, waitUntilBucketNotExists, waitUntilBucketExists } from "@aws-sdk/client-s3";
+import { S3, waitUntilBucketExists, waitUntilBucketNotExists } from "@aws-sdk/client-s3";
 
 const Bucket = "BUCKET_NAME";
 const client = new S3({ region: "REGION" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/service-import-equals.output.ts b/src/transforms/v2-to-v3/__fixtures__/waiters/service-import-equals.output.ts
@@ -2,8 +2,8 @@ import AWS_S3 = require("@aws-sdk/client-s3");
 
 const {
   S3,
-  waitUntilBucketNotExists,
-  waitUntilBucketExists
+  waitUntilBucketExists,
+  waitUntilBucketNotExists
 } = AWS_S3;
 
 const Bucket = "BUCKET_NAME";
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/service-import.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/service-import.output.js
@@ -1,4 +1,4 @@
-import { S3, waitUntilBucketNotExists, waitUntilBucketExists } from "@aws-sdk/client-s3";
+import { S3, waitUntilBucketExists, waitUntilBucketNotExists } from "@aws-sdk/client-s3";
 
 const Bucket = "BUCKET_NAME";
 const client = new S3({ region: "REGION" });
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/service-require-deep.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/service-require-deep.output.js
@@ -1,7 +1,7 @@
 const {
   S3,
-  waitUntilBucketNotExists,
-  waitUntilBucketExists
+  waitUntilBucketExists,
+  waitUntilBucketNotExists
 } = require("@aws-sdk/client-s3");
 
 const Bucket = "BUCKET_NAME";
diff --git a/src/transforms/v2-to-v3/__fixtures__/waiters/service-require.output.js b/src/transforms/v2-to-v3/__fixtures__/waiters/service-require.output.js
@@ -1,7 +1,7 @@
 const {
   S3,
-  waitUntilBucketNotExists,
-  waitUntilBucketExists
+  waitUntilBucketExists,
+  waitUntilBucketNotExists
 } = require("@aws-sdk/client-s3");
 
 const Bucket = "BUCKET_NAME";
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientNamedImport.ts b/src/transforms/v2-to-v3/modules/addV3ClientNamedImport.ts
@@ -3,6 +3,7 @@ import { Collection, ImportSpecifier, JSCodeshift } from "jscodeshift";
 import { getImportSpecifiers } from "./getImportSpecifiers";
 import { getV2ImportDeclaration } from "./getV2ImportDeclaration";
 import { getV3ClientImportSpecifier } from "./getV3ClientImportSpecifier";
+import { importSpecifierCompareFn } from "./importSpecifierCompareFn";
 import { V3ClientImportSpecifierOptions, V3ClientModulesOptions } from "./types";
 
 export const addV3ClientNamedImport = (
@@ -21,23 +22,25 @@ export const addV3ClientNamedImport = (
   });
 
   if (importDeclarations.size()) {
-    const importSpecifiers = getImportSpecifiers(j, source, v3ClientPackageName).filter(
+    const allImportSpecifiers = getImportSpecifiers(j, source, v3ClientPackageName).filter(
       (importSpecifier) => importSpecifier?.type === "ImportSpecifier"
     ) as ImportSpecifier[];
 
     if (
-      importSpecifiers.find(
+      allImportSpecifiers.find(
         (specifier) =>
           specifier?.imported?.name === importedName && specifier?.local?.name === localName
       )
     ) {
       return;
     }
 
-    importDeclarations
-      .nodes()[0]
-      .specifiers?.push(getV3ClientImportSpecifier(j, { importedName, localName }));
-    return;
+    const firstImportDeclSpecifiers = importDeclarations.nodes()[0].specifiers;
+    if (firstImportDeclSpecifiers) {
+      firstImportDeclSpecifiers.push(getV3ClientImportSpecifier(j, { importedName, localName }));
+      firstImportDeclSpecifiers.sort(importSpecifierCompareFn);
+      return;
+    }
   }
 
   // Insert after global import, or service import.
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientNamedImportEquals.ts b/src/transforms/v2-to-v3/modules/addV3ClientNamedImportEquals.ts
@@ -4,6 +4,7 @@ import { getV3ClientDefaultLocalName } from "../utils";
 import { addV3ClientDefaultImportEquals } from "./addV3ClientDefaultImportEquals";
 import { getImportEqualsDeclaration } from "./getImportEqualsDeclaration";
 import { getV3ClientRequireProperty } from "./getV3ClientRequireProperty";
+import { objectPatternPropertyCompareFn } from "./objectPatternPropertyCompareFn";
 import { V3ClientModulesOptions, V3ClientRequirePropertyOptions } from "./types";
 
 export const addV3ClientNamedImportEquals = (
@@ -23,7 +24,9 @@ export const addV3ClientNamedImportEquals = (
   });
 
   if (existingVarDeclarator.size()) {
-    existingVarDeclarator.get(0).node.id.properties.push(namedImportObjectProperty);
+    const firstDeclaratorProperties = existingVarDeclarator.get(0).node.id.properties;
+    firstDeclaratorProperties.push(namedImportObjectProperty);
+    firstDeclaratorProperties.sort(objectPatternPropertyCompareFn);
     return;
   }
 
diff --git a/src/transforms/v2-to-v3/modules/addV3ClientNamedRequire.ts b/src/transforms/v2-to-v3/modules/addV3ClientNamedRequire.ts
@@ -6,6 +6,7 @@ import { getRequireDeclarators } from "./getRequireDeclarators";
 import { getRequireDeclaratorsWithIdentifier } from "./getRequireDeclaratorsWithIdentifier";
 import { getV2RequireDeclarator } from "./getV2RequireDeclarator";
 import { getV3ClientRequireProperty } from "./getV3ClientRequireProperty";
+import { objectPatternPropertyCompareFn } from "./objectPatternPropertyCompareFn";
 import { V3ClientModulesOptions, V3ClientRequirePropertyOptions } from "./types";
 
 export const addV3ClientNamedRequire = (
@@ -64,7 +65,9 @@ export const addV3ClientNamedRequire = (
     }
 
     if (existingRequireProperties.length > 0) {
-      (existingRequireProperties[0].id as ObjectPattern).properties.push(v3ClientObjectProperty);
+      const firstRequireProperties = (existingRequireProperties[0].id as ObjectPattern).properties;
+      firstRequireProperties.push(v3ClientObjectProperty);
+      firstRequireProperties.sort(objectPatternPropertyCompareFn);
       return;
     }
   }
diff --git a/src/transforms/v2-to-v3/modules/importSpecifierCompareFn.ts b/src/transforms/v2-to-v3/modules/importSpecifierCompareFn.ts
@@ -0,0 +1,30 @@
+import { ImportDefaultSpecifier, ImportNamespaceSpecifier, ImportSpecifier } from "jscodeshift";
+
+export const importSpecifierCompareFn = (
+  specifier1: ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier,
+  specifier2: ImportSpecifier | ImportDefaultSpecifier | ImportNamespaceSpecifier
+) => {
+  if (specifier1.type === "ImportSpecifier" && specifier2.type === "ImportSpecifier") {
+    return specifier1.imported.name.localeCompare(specifier2.imported.name);
+  }
+
+  if (
+    specifier1.type === "ImportDefaultSpecifier" &&
+    specifier2.type === "ImportDefaultSpecifier"
+  ) {
+    if (specifier1.local && specifier2.local)
+      return specifier1.local.name.localeCompare(specifier2.local.name);
+    return 0;
+  }
+
+  if (
+    specifier1.type === "ImportNamespaceSpecifier" &&
+    specifier2.type === "ImportNamespaceSpecifier"
+  ) {
+    if (specifier1.local && specifier2.local)
+      return specifier1.local.name.localeCompare(specifier2.local.name);
+    return 0;
+  }
+
+  return 0;
+};
diff --git a/src/transforms/v2-to-v3/modules/objectPatternPropertyCompareFn.ts b/src/transforms/v2-to-v3/modules/objectPatternPropertyCompareFn.ts
@@ -0,0 +1,34 @@
+import {
+  ObjectProperty,
+  Property,
+  PropertyPattern,
+  RestProperty,
+  SpreadProperty,
+  SpreadPropertyPattern,
+} from "jscodeshift";
+
+import { OBJECT_PROPERTY_TYPE_LIST } from "../config";
+
+export type ObjectPatternProperty =
+  | Property
+  | PropertyPattern
+  | SpreadPropertyPattern
+  | SpreadProperty
+  | ObjectProperty
+  | RestProperty;
+
+export const objectPatternPropertyCompareFn = (
+  property1: ObjectPatternProperty,
+  property2: ObjectPatternProperty
+) => {
+  if (
+    OBJECT_PROPERTY_TYPE_LIST.includes(property1.type) &&
+    OBJECT_PROPERTY_TYPE_LIST.includes(property2.type)
+  ) {
+    const property1Key = (property1 as Property | ObjectProperty).key;
+    const property2Key = (property2 as Property | ObjectProperty).key;
+    if (property1Key.type === "Identifier" && property2Key.type === "Identifier")
+      return property1Key.name.localeCompare(property2Key.name);
+  }
+  return 0;
+};

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"aws-sdk-js-codemod": patch
 +---
++
 +Sort v3 named require/imports
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { S3, waitUntilBucketNotExists, waitUntilBucketExists } from "@aws-sdk/client-s3";`
	`1`	`+import { S3, waitUntilBucketExists, waitUntilBucketNotExists } from "@aws-sdk/client-s3";`
`2`	`2`
`3`	`3`	`const Bucket = "BUCKET_NAME";`
`4`	`4`	`const client = new S3({ region: "REGION" });`