Exclude FromJSONSchema from api checks due to its complexity (#2079)

Author: Kamil Sobol

scripts/check_api_changes.ts

@@ -47,6 +47,18 @@ console.log(
 
 const packagePaths = await glob(`${latestRepositoryPath}/packages/*`);
 
+const excludedTypesByPackageName: Record<string, Array<string>> = {
+  'ai-constructs': [
+    // FromJSONSchema is complex enough to trigger
+    // index.ts(113,9): error TS2589: Type instantiation is excessively deep and possibly infinite.
+    // index.ts(113,87): error TS2589: Type instantiation is excessively deep and possibly infinite.
+    // index.ts(113,87): error TS2590: Expression produces a union type that is too complex to represent.
+    // See https://github.com/ThomasAribart/json-schema-to-ts/blob/main/documentation/FAQs/i-get-a-type-instantiation-is-excessively-deep-and-potentially-infinite-error-what-should-i-do.md.
+    // Therefore, excluding this type from checks.
+    'FromJSONSchema',
+  ],
+};
+
 const validationResults = await Promise.allSettled(
   packagePaths.map(async (packagePath) => {
     const packageName = path.basename(packagePath);
@@ -70,7 +82,8 @@ const validationResults = await Promise.allSettled(
     await new ApiChangesValidator(
       packagePath,
       baselinePackageApiReportPath,
-      workingDirectory
+      workingDirectory,
+      excludedTypesByPackageName[packageName]
     ).validate();
     console.log(`Validation of ${packageName} completed successfully`);
   })

scripts/components/api-changes-validator/api_changes_validator.test.ts

@@ -61,6 +61,7 @@ void describe('Api changes validator', { concurrency: true }, () => {
         latestPackagePath,
         baselinePackageApiReportPath,
         workingDirectory,
+        [],
         'npmLocalLink'
       );
 
@@ -92,6 +93,7 @@ void describe('Api changes validator', { concurrency: true }, () => {
         latestPackagePath,
         baselinePackageApiReportPath,
         workingDirectory,
+        ['SampleIgnoredType'],
         'npmLocalLink'
       );
 

scripts/components/api-changes-validator/api_changes_validator.ts

@@ -30,6 +30,7 @@ export class ApiChangesValidator {
     private readonly latestPackagePath: string,
     private readonly baselinePackageApiReportPath: string,
     private readonly workingDirectory: string,
+    private readonly excludedTypes: Array<string> = [],
     private readonly latestPackageDependencyDeclarationStrategy:
       | 'npmRegistry'
       | 'npmLocalLink' = 'npmRegistry'
@@ -103,7 +104,8 @@ export class ApiChangesValidator {
     const apiReportAST = ApiReportParser.parse(apiReportContent);
     const usage = new ApiUsageGenerator(
       latestPackageJson.name,
-      apiReportAST
+      apiReportAST,
+      this.excludedTypes
     ).generate();
     await fsp.writeFile(path.join(this.testProjectPath, 'index.ts'), usage);
     await execa('npm', ['install'], { cwd: this.testProjectPath });

scripts/components/api-changes-validator/api_usage_generator.test.ts

@@ -337,6 +337,15 @@ const someTypeUnderSubNamespaceUsageFunction = (someTypeUnderSubNamespaceFunctio
 }
     `,
   },
+  {
+    description: 'Skips ignored type',
+    apiReportCode: `
+export type SampleIgnoredType = {
+  someProperty: string;
+}
+    `,
+    expectedApiUsage: '',
+  },
 ];
 
 const nestInMarkdownCodeBlock = (apiReportCode: string) => {
@@ -351,7 +360,8 @@ void describe('Api usage generator', () => {
       );
       const apiUsage = new ApiUsageGenerator(
         'samplePackageName',
-        apiReportAST
+        apiReportAST,
+        ['SampleIgnoredType']
       ).generate();
       assert.strictEqual(
         // .replace() removes EOL differences between Windows and other OS so output matches for all

scripts/components/api-changes-validator/api_usage_generator.ts

@@ -25,7 +25,8 @@ export class ApiUsageGenerator {
    */
   constructor(
     private readonly packageName: string,
-    private readonly apiReportAST: ts.SourceFile
+    private readonly apiReportAST: ts.SourceFile,
+    private readonly excludedTypes: Array<string>
   ) {
     this.namespaceDefinitions = this.getNamespaceDefinitions();
   }
@@ -65,7 +66,8 @@ export class ApiUsageGenerator {
       case ts.SyntaxKind.TypeAliasDeclaration:
         return new TypeUsageStatementsGenerator(
           node as ts.TypeAliasDeclaration,
-          this.packageName
+          this.packageName,
+          this.excludedTypes
         ).generate();
       case ts.SyntaxKind.EnumDeclaration:
         return new EnumUsageStatementsGenerator(

scripts/components/api-changes-validator/api_usage_statements_generators.ts

@@ -122,10 +122,14 @@ export class TypeUsageStatementsGenerator implements UsageStatementsGenerator {
    */
   constructor(
     private readonly typeAliasDeclaration: ts.TypeAliasDeclaration,
-    private readonly packageName: string
+    private readonly packageName: string,
+    private readonly excludedTypes: Array<string>
   ) {}
   generate = (): UsageStatementsGeneratorOutput => {
     const typeName = this.typeAliasDeclaration.name.getText();
+    if (this.excludedTypes.includes(typeName)) {
+      return {};
+    }
     const constName = toLowerCamelCase(typeName);
     const genericTypeParametersDeclaration =
       new GenericTypeParameterDeclarationUsageStatementsGenerator(

scripts/components/api-changes-validator/test-resources/test-projects/without-breaks/project-without-breaks/API.md

@@ -79,4 +79,9 @@ export type SampleTypeUsingClass = {
 export type SampleTypeThatReferencesFunction<T extends typeof someFunction1> = {
   sampleProperty: T;
 };
+
+// This type is intentionally different from what's in sources
+export type SampleIgnoredType = {
+  someProperty: string;
+};
 ```

scripts/components/api-changes-validator/test-resources/test-projects/without-breaks/project-without-breaks/src/index.ts

@@ -110,3 +110,8 @@ export type SampleTypeUsingClass = {
 export type SampleTypeThatReferencesFunction<T extends typeof someFunction1> = {
   sampleProperty: T;
 };
+
+// This type is intentionally different from what's in api report
+export type SampleIgnoredType = {
+  someProperty: number;
+};