Add utility getV3ClientTypeName* which returns string (#217)

trivikr · web-flow · commit 52d8543bb90a · 2022-12-26T14:13:34.000-08:00
diff --git a/src/transforms/v2-to-v3/utils/add/addV3ClientImports.ts b/src/transforms/v2-to-v3/utils/add/addV3ClientImports.ts
@@ -1,7 +1,7 @@
-import { Collection, Identifier, JSCodeshift } from "jscodeshift";
+import { Collection, JSCodeshift } from "jscodeshift";
 
 import { PACKAGE_NAME } from "../config";
-import { getV2ServiceModulePath, getV3ClientTypes } from "../get";
+import { getV2ServiceModulePath, getV3ClientTypeNames } from "../get";
 import { addV3ClientModuleImport } from "./addV3ClientModuleImport";
 import { AddV3ClientModulesOptions } from "./addV3ClientModules";
 
@@ -41,17 +41,14 @@ export const addV3ClientImports = (
   }
 
   // Add require for input/output types, if needed.
-  const v3ClientTypes = getV3ClientTypes(j, source, { v2ClientName, v2DefaultModuleName });
+  const v3ClientTypeNames = getV3ClientTypeNames(j, source, { v2ClientName, v2DefaultModuleName });
 
-  if (v3ClientTypes.length > 0) {
+  if (v3ClientTypeNames.length > 0) {
     const clientImports = source.find(j.ImportDeclaration, {
       source: { value: v3ClientPackageName },
     });
-    for (const v3ClientType of v3ClientTypes.sort()) {
-      const v3ClientTypeName = (v3ClientType.typeName as Identifier).name;
-      if (v3ClientTypeName.endsWith("CommandInput") || v3ClientTypeName.endsWith("CommandOutput")) {
-        addV3ClientModuleImport(j, clientImports, v3ClientTypeName);
-      }
+    for (const v3ClientTypeName of v3ClientTypeNames.sort()) {
+      addV3ClientModuleImport(j, clientImports, v3ClientTypeName);
     }
   }
 };
diff --git a/src/transforms/v2-to-v3/utils/add/addV3ClientRequires.ts b/src/transforms/v2-to-v3/utils/add/addV3ClientRequires.ts
@@ -1,10 +1,22 @@
 import { Collection, Identifier, JSCodeshift } from "jscodeshift";
 
 import { PACKAGE_NAME } from "../config";
-import { getRequireVariableDeclaration, getV2ServiceModulePath, getV3ClientTypes } from "../get";
+import {
+  getRequireVariableDeclaration,
+  getV2ServiceModulePath,
+  getV3ClientTypeNames,
+} from "../get";
 import { addV3ClientModuleRequire } from "./addV3ClientModuleRequire";
 import { AddV3ClientModulesOptions } from "./addV3ClientModules";
 
+const getClientProperty = (j: JSCodeshift, name: Identifier) =>
+  j.property.from({
+    kind: "init",
+    key: name,
+    shorthand: true,
+    value: name,
+  });
+
 export const addV3ClientRequires = (
   j: JSCodeshift,
   source: Collection<unknown>,
@@ -15,14 +27,7 @@ export const addV3ClientRequires = (
     v2DefaultModuleName,
   }: AddV3ClientModulesOptions
 ): void => {
-  const v3ClientNameIdentifier = j.identifier(v3ClientName);
-  const v3ClientNameProperty = j.property.from({
-    kind: "init",
-    key: v3ClientNameIdentifier,
-    shorthand: true,
-    value: v3ClientNameIdentifier,
-  });
-
+  const v3ClientNameProperty = getClientProperty(j, j.identifier(v3ClientName));
   const existingRequires = getRequireVariableDeclaration(j, source, v3ClientPackageName);
 
   // Require declaration already exists.
@@ -49,22 +54,13 @@ export const addV3ClientRequires = (
   }
 
   // Add require for input/output types, if needed.
-  const v3ClientTypes = getV3ClientTypes(j, source, { v2ClientName, v2DefaultModuleName });
+  const v3ClientTypeNames = getV3ClientTypeNames(j, source, { v2ClientName, v2DefaultModuleName });
 
-  if (v3ClientTypes.length > 0) {
+  if (v3ClientTypeNames.length > 0) {
     const clientRequires = getRequireVariableDeclaration(j, source, v3ClientPackageName);
-    for (const v3ClientType of v3ClientTypes.sort()) {
-      const v3ClientTypeName = (v3ClientType.typeName as Identifier).name;
-      if (v3ClientTypeName.endsWith("CommandInput") || v3ClientTypeName.endsWith("CommandOutput")) {
-        const v3ClientTypeNameIdentifier = j.identifier(v3ClientTypeName);
-        const v3ClientTypeNameProperty = j.property.from({
-          kind: "init",
-          key: v3ClientTypeNameIdentifier,
-          shorthand: true,
-          value: v3ClientTypeNameIdentifier,
-        });
-        addV3ClientModuleRequire(j, clientRequires, v3ClientTypeNameProperty);
-      }
+    for (const v3ClientTypeName of v3ClientTypeNames.sort()) {
+      const v3ClientTypeNameProperty = getClientProperty(j, j.identifier(v3ClientTypeName));
+      addV3ClientModuleRequire(j, clientRequires, v3ClientTypeNameProperty);
     }
   }
 };
diff --git a/src/transforms/v2-to-v3/utils/get/getV2ClientTypeNames.ts b/src/transforms/v2-to-v3/utils/get/getV2ClientTypeNames.ts
@@ -0,0 +1,41 @@
+import { Collection, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
+
+export interface GetV2ClientTypeNamesOptions {
+  v2ClientName: string;
+  v2DefaultModuleName: string;
+}
+
+const getRightIdentifierName = (node: TSTypeReference) =>
+  ((node.typeName as TSQualifiedName).right as Identifier).name;
+
+export const getV2ClientTypeNames = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  { v2ClientName, v2DefaultModuleName }: GetV2ClientTypeNamesOptions
+): string[] => {
+  const v2DefaultTypeName = {
+    typeName: {
+      left: {
+        left: { type: "Identifier", name: v2DefaultModuleName },
+        right: { type: "Identifier", name: v2ClientName },
+      },
+    },
+  } as TSTypeReference;
+
+  const v2ClientTypeName = {
+    typeName: {
+      left: { type: "Identifier", name: v2ClientName },
+    },
+  } as TSTypeReference;
+
+  return [
+    ...source
+      .find(j.TSTypeReference, v2DefaultTypeName)
+      .nodes()
+      .map((node) => getRightIdentifierName(node)),
+    ...source
+      .find(j.TSTypeReference, v2ClientTypeName)
+      .nodes()
+      .map((node) => getRightIdentifierName(node)),
+  ];
+};
diff --git a/src/transforms/v2-to-v3/utils/get/getV2ClientTypes.ts b/src/transforms/v2-to-v3/utils/get/getV2ClientTypes.ts
diff --git a/src/transforms/v2-to-v3/utils/get/getV3ClientInputOutputType.ts b/src/transforms/v2-to-v3/utils/get/getV3ClientInputOutputType.ts
diff --git a/src/transforms/v2-to-v3/utils/get/getV3ClientType.ts b/src/transforms/v2-to-v3/utils/get/getV3ClientType.ts
@@ -0,0 +1,13 @@
+import { ASTPath, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
+
+import { getV3ClientTypeName } from "./getV3ClientTypeName";
+
+export const getV3ClientType = (j: JSCodeshift, v2ClientType: ASTPath<TSTypeReference>) => {
+  const v3ClientType = getV3ClientTypeName(
+    ((v2ClientType.node.typeName as TSQualifiedName).right as Identifier).name
+  );
+  if (!v3ClientType) {
+    return v2ClientType.node;
+  }
+  return j.tsTypeReference(j.identifier(v3ClientType));
+};
diff --git a/src/transforms/v2-to-v3/utils/get/getV3ClientTypeName.ts b/src/transforms/v2-to-v3/utils/get/getV3ClientTypeName.ts
@@ -0,0 +1,11 @@
+export const getV3ClientTypeName = (v2ClientTypeName: string) => {
+  if (v2ClientTypeName.endsWith("Input")) {
+    return v2ClientTypeName.replace(/Input$/, "CommandInput");
+  }
+
+  if (v2ClientTypeName.endsWith("Output")) {
+    return v2ClientTypeName.replace(/Output$/, "CommandOutput");
+  }
+
+  return undefined;
+};
diff --git a/src/transforms/v2-to-v3/utils/get/getV3ClientTypeNames.ts b/src/transforms/v2-to-v3/utils/get/getV3ClientTypeNames.ts
@@ -0,0 +1,13 @@
+import { Collection, JSCodeshift } from "jscodeshift";
+
+import { getV2ClientTypeNames, GetV2ClientTypeNamesOptions } from "./getV2ClientTypeNames";
+import { getV3ClientTypeName } from "./getV3ClientTypeName";
+
+export const getV3ClientTypeNames = (
+  j: JSCodeshift,
+  source: Collection<unknown>,
+  options: GetV2ClientTypeNamesOptions
+) =>
+  getV2ClientTypeNames(j, source, options)
+    .map((v2ClientTypeName) => getV3ClientTypeName(v2ClientTypeName))
+    .filter((v3ClientTypeName) => v3ClientTypeName !== undefined) as string[];
diff --git a/src/transforms/v2-to-v3/utils/get/getV3ClientTypes.ts b/src/transforms/v2-to-v3/utils/get/getV3ClientTypes.ts
diff --git a/src/transforms/v2-to-v3/utils/get/index.ts b/src/transforms/v2-to-v3/utils/get/index.ts
@@ -6,5 +6,5 @@ export * from "./getV2ClientNames";
 export * from "./getV2DefaultModuleName";
 export * from "./getV2ServiceModuleNames";
 export * from "./getV2ServiceModulePath";
-export * from "./getV3ClientInputOutputType";
-export * from "./getV3ClientTypes";
+export * from "./getV3ClientType";
+export * from "./getV3ClientTypeNames";
diff --git a/src/transforms/v2-to-v3/utils/replace/replaceTSTypeReference.ts b/src/transforms/v2-to-v3/utils/replace/replaceTSTypeReference.ts
@@ -1,18 +1,13 @@
-import { Collection, Identifier, JSCodeshift, TSQualifiedName, TSTypeReference } from "jscodeshift";
+import { Collection, JSCodeshift } from "jscodeshift";
 
-import { getV3ClientInputOutputType } from "../get";
+import { getV3ClientType } from "../get";
 
 export interface ReplaceTypeReferenceOptions {
   v2ClientName: string;
   v3ClientName: string;
   v2DefaultModuleName: string;
 }
 
-const getTsTypeWithClientName = (j: JSCodeshift, node: TSTypeReference, v3ClientName: string) => {
-  node.typeName = j.identifier(v3ClientName);
-  return node;
-};
-
 // Replace v2 client type reference with v3 client type reference.
 export const replaceTSTypeReference = (
   j: JSCodeshift,
@@ -27,7 +22,11 @@ export const replaceTSTypeReference = (
         right: { type: "Identifier", name: v2ClientName },
       },
     })
-    .replaceWith((tsTypeRef) => getTsTypeWithClientName(j, tsTypeRef.node, v3ClientName));
+    .replaceWith((tsTypeRef) => {
+      const { node } = tsTypeRef;
+      node.typeName = j.identifier(v3ClientName);
+      return node;
+    });
 
   // Replace type reference to client input/output created with default module.
   source
@@ -41,18 +40,14 @@ export const replaceTSTypeReference = (
         right: { type: "Identifier" },
       },
     })
-    .replaceWith((tsTypeRef) =>
-      getV3ClientInputOutputType(
-        j,
-        tsTypeRef.node,
-        ((tsTypeRef.node.typeName as TSQualifiedName).right as Identifier).name
-      )
-    );
+    .replaceWith((v2ClientType) => getV3ClientType(j, v2ClientType));
 
   // Replace type reference to client created with client module.
   source
     .find(j.TSTypeReference, {
-      typeName: { type: "Identifier", name: v2ClientName },
+      typeName: {
+        left: { type: "Identifier", name: v2ClientName },
+      },
     })
-    .replaceWith((tsTypeRef) => getTsTypeWithClientName(j, tsTypeRef.node, v3ClientName));
+    .replaceWith((v2ClientType) => getV3ClientType(j, v2ClientType));
 };
