Handle aliased symbols in namespaces in api check (#1926)

* handle aliased symbols in namespaces * handle aliased symbols in namespaces * Update scripts/components/api-changes-validator/api_usage_generator.ts Co-authored-by: Amplifiyer <[email protected]> --------- Co-authored-by: Amplifiyer <[email protected]>
aws-amplify · Aug 28, 2024 · 5d6eef2 · 5d6eef2
1 parent d4c10fe
commit 5d6eef2
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 9 deletions.
diff --git a/scripts/components/api-changes-validator/api_usage_generator.ts b/scripts/components/api-changes-validator/api_usage_generator.ts
@@ -99,6 +99,7 @@ export class ApiUsageGenerator {
       namespaceBySymbol: new Map<string, string>(),
       namespaceNames: new Set<string>(),
       topLevelNamespaces: new Set<string>(),
+      aliasedSymbols: new Map<string, string>(),
     };
     for (const statement of this.apiReportAST.statements) {
       if (statement.kind === ts.SyntaxKind.ModuleDeclaration) {
@@ -118,9 +119,22 @@ export class ApiUsageGenerator {
                 const namedExports =
                   exportDeclaration.exportClause as ts.NamedExports;
                 for (const namedExport of namedExports.elements) {
-                  const symbolName = namedExport.name.getText();
+                  let symbolNameInApiView: string;
+                  if (namedExport.propertyName) {
+                    // If property name is present this means that
+                    // API Extractor aliased type definition to avoid duplicate
+                    // and exported from namespace as 'SomeType_2 as SomeType'
+                    symbolNameInApiView = namedExport.propertyName.getText();
+                    const exportedSymbolName = namedExport.name.getText();
+                    namespaceDefinitions.aliasedSymbols.set(
+                      symbolNameInApiView,
+                      exportedSymbolName
+                    );
+                  } else {
+                    symbolNameInApiView = namedExport.name.getText();
+                  }
                   namespaceDefinitions.namespaceBySymbol.set(
-                    symbolName,
+                    symbolNameInApiView,
                     namespaceName
                   );
                 }

diff --git a/...dator/test-resources/test-projects/without-breaks/project-with-namespace/API.md b/...dator/test-resources/test-projects/without-breaks/project-with-namespace/API.md
@@ -4,6 +4,10 @@ export type SomeTypeUnderNamespace = {
   someProperty: string;
 }
 
+export type SomeTypeUnderNamespace_2 = {
+  someProperty: string;
+}
+
 type SomeTypeUnderSubNamespace = {
   someOtherProperty: string;
 }
@@ -26,6 +30,12 @@ declare namespace someNamespace {
   }
 }
 
+declare namespace someNamespaceWithSameType {
+  export {
+    SomeTypeUnderNamespace_2 as SomeTypeUnderNamespace,
+  }
+}
+
 type SomeTypeUnderOtherEntryPoint = {
   somePropertyUnderOtherEntryPoint: string;
 }

diff --git a/...validator/test-resources/test-projects/without-breaks/project-with-namespace/src/index.ts b/...validator/test-resources/test-projects/without-breaks/project-with-namespace/src/index.ts
@@ -1,3 +1,4 @@
 import * as someNamespace from './some_namespace.js';
+import * as someNamespaceWithSameType from './some_namespace_with_same_type.js';
 
-export { someNamespace };
+export { someNamespace, someNamespaceWithSameType };
diff --git a/.../test-resources/test-projects/without-breaks/project-with-namespace/src/some_namespace.ts b/.../test-resources/test-projects/without-breaks/project-with-namespace/src/some_namespace.ts
@@ -1,10 +1,7 @@
 import * as someSubNamespace from './some_sub_namespace.js';
+import { SomeTypeUnderNamespace } from './types.js';
 
-export type SomeTypeUnderNamespace = {
-  someProperty: string;
-};
-
-export { someSubNamespace };
+export { someSubNamespace, SomeTypeUnderNamespace };
 
 export const functionUsingTypes1 = (
   props: SomeTypeUnderNamespace

diff --git a/.../test-projects/without-breaks/project-with-namespace/src/some_namespace_with_same_type.ts b/.../test-projects/without-breaks/project-with-namespace/src/some_namespace_with_same_type.ts
@@ -0,0 +1,3 @@
+import { SomeTypeUnderNamespace } from './types.js';
+
+export { SomeTypeUnderNamespace };
diff --git a/...validator/test-resources/test-projects/without-breaks/project-with-namespace/src/types.ts b/...validator/test-resources/test-projects/without-breaks/project-with-namespace/src/types.ts
@@ -0,0 +1,3 @@
+export type SomeTypeUnderNamespace = {
+  someProperty: string;
+};
diff --git a/scripts/components/api-changes-validator/types.ts b/scripts/components/api-changes-validator/types.ts
@@ -25,4 +25,5 @@ export type NamespaceDefinitions = {
   topLevelNamespaces: Set<string>;
   namespaceNames: Set<string>;
   namespaceBySymbol: Map<string, string>;
+  aliasedSymbols: Map<string, string>;
 };
diff --git a/scripts/components/api-changes-validator/usage_statemets_renderer.ts b/scripts/components/api-changes-validator/usage_statemets_renderer.ts
@@ -57,9 +57,15 @@ export class UsageStatementsRenderer {
           namespaceHierarchy.unshift(currentSymbolName);
         }
       } while (currentSymbolName);
+      const symbolAlias =
+        this.namespaceDefinitions.aliasedSymbols.get(symbolName);
+      let actualSymbolName = symbolName;
+      if (symbolAlias) {
+        actualSymbolName = symbolAlias;
+      }
       const symbolWithNamespace = `${namespaceHierarchy.join(
         '.'
-      )}.${symbolName}`;
+      )}.${actualSymbolName}`;
 
       // characters that can be found before or after symbol
       // this is to prevent partial matches in case one symbol's characters are subset of longer one
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import { SomeTypeUnderNamespace } from './types.js';

		export { SomeTypeUnderNamespace };