cover class inheritance in api check (#876)

* cover class inheritance in api check

* nit

* pr feedback

Author: Kamil Sobol

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

@@ -236,6 +236,43 @@ class SomeAbstractClass2DerivedUsageClass<T1 extends SomeClass1, T2, T3, T4, T5,
   constructor(param1: T1, param2?: T2) {
     super(param1, param2);
   }
+}
+    `,
+  },
+  {
+    description: 'generates class inheritance usage',
+    apiReportCode: `
+export type SomeType1 = {
+};
+export type SomeType2<T1, T2> = {
+};
+export abstract class SomeAbstractClass<T1, T2> {
+}
+export class SomeClass<T1, T2, T3, T4> extends SomeAbstractClass<T1, T2> implements SomeType1, SomeType2<T3, T4>{
+}
+    `,
+    expectedApiUsage: `
+import { SomeType1 } from 'samplePackageName';
+import { SomeType2 } from 'samplePackageName';
+import { SomeAbstractClass } from 'samplePackageName';
+import { SomeClass } from 'samplePackageName';
+
+type SomeType1Baseline = {
+}
+const someType1UsageFunction = (someType1FunctionParameter: SomeType1Baseline) => {
+  const someType1: SomeType1 = someType1FunctionParameter;
+}
+
+type SomeType2Baseline<T1, T2> = {
+}
+const someType2UsageFunction = <T1, T2>(someType2FunctionParameter: SomeType2Baseline<T1, T2>) => {
+  const someType2: SomeType2<T1, T2> = someType2FunctionParameter;
+}
+
+const someClassInheritanceUsageFunction = <T1, T2, T3, T4>(someClassInheritanceUsageFunctionParameter: SomeClass<T1, T2, T3, T4>) => {
+  const superTypeUsageConst0: SomeAbstractClass<T1, T2> = someClassInheritanceUsageFunctionParameter;
+  const superTypeUsageConst1: SomeType1 = someClassInheritanceUsageFunctionParameter;
+  const superTypeUsageConst2: SomeType2<T3, T4> = someClassInheritanceUsageFunctionParameter;
 }
     `,
   },

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

@@ -189,8 +189,6 @@ export class EnumUsageStatementsGenerator implements UsageStatementsGenerator {
  * if they have private members, see https://github.com/microsoft/TypeScript/issues/53558.
  * Therefore strategy for classes is different. Instead of testing assignability
  * like we do for types we generate usage of it's members.
- *
- * TODO This covers properties and methods now, we should cover constructor and inheritance
  */
 export class ClassUsageStatementsGenerator implements UsageStatementsGenerator {
   /**
@@ -230,6 +228,14 @@ export class ClassUsageStatementsGenerator implements UsageStatementsGenerator {
       }
     }
 
+    if (this.classDeclaration.heritageClauses) {
+      usageStatement +=
+        new ClassInheritanceUsageStatementsGenerator(
+          this.classDeclaration,
+          this.classDeclaration.heritageClauses
+        ).generate().usageStatement ?? '';
+    }
+
     if (usageStatement) {
       usageStatement += EOL;
     }
@@ -415,6 +421,53 @@ class ClassConstructorUsageStatementsGenerator
   };
 }
 
+/**
+ * Generates usage snippets for class inheritance.
+ * Generated snippets attempt to use a reference typed with class (provided via usage function parameter)
+ * and assign it to local constant that is typed with super type from extend or implement clauses.
+ */
+class ClassInheritanceUsageStatementsGenerator
+  implements UsageStatementsGenerator
+{
+  constructor(
+    private readonly classDeclaration: ts.ClassDeclaration,
+    private readonly heritageClauses: ts.NodeArray<ts.HeritageClause>
+  ) {}
+
+  generate = (): UsageStatements => {
+    const className = this.classDeclaration.name?.getText();
+    if (!className) {
+      throw new Error('Class name is missing');
+    }
+    const usageFunctionName = toLowerCamelCase(
+      `${className}InheritanceUsageFunction`
+    );
+    const usageFunctionParameterName = `${usageFunctionName}Parameter`;
+    const genericTypeParametersDeclaration =
+      new GenericTypeParameterDeclarationUsageStatementsGenerator(
+        this.classDeclaration.typeParameters
+      ).generate().usageStatement ?? '';
+    const genericTypeParameters =
+      new GenericTypeParameterUsageStatementsGenerator(
+        this.classDeclaration.typeParameters
+      ).generate().usageStatement ?? '';
+
+    const superTypeUsageStatements = this.heritageClauses
+      .flatMap((clause) => clause.types)
+      .map((superType, index) => {
+        return `const superTypeUsageConst${index}: ${superType.getText()} = ${usageFunctionParameterName};`;
+      });
+
+    let usageStatement = '';
+    usageStatement += `const ${usageFunctionName} = ${genericTypeParametersDeclaration}(${usageFunctionParameterName}: ${className}${genericTypeParameters}) => {${EOL}`;
+    for (const superTypeUsageStatement of superTypeUsageStatements) {
+      usageStatement += `${indent(superTypeUsageStatement)}${EOL}`;
+    }
+    usageStatement += `}${EOL}`;
+    return { usageStatement };
+  };
+}
+
 /**
  * Generates usage of a variable/const/arrow function declared as top level export
  * , i.e. 'const someConst = ...`;

scripts/components/api-changes-validator/test-resources/test-projects/with-breaks/class-break-inheritance/API.md

@@ -0,0 +1,23 @@
+```ts
+export type SomeType1 = {
+  someProperty1: string;
+};
+
+export type SomeType2 = {
+  someProperty2: string;
+  someProperty3: string;
+};
+
+export abstract class SomeAbstractClass {
+  someMethod1: (param1: string, param2?: string) => string;
+}
+
+export class SomeClass
+  extends SomeAbstractClass
+  implements SomeType1, SomeType2
+{
+  someProperty1: string;
+  someProperty2: string;
+  someProperty3: string;
+}
+```

scripts/components/api-changes-validator/test-resources/test-projects/with-breaks/class-break-inheritance/expected-error-message.txt

@@ -0,0 +1,6 @@
+index.ts(30,83): error TS2339: Property 'someProperty1' does not exist on type 'SomeClass'.
+index.ts(33,83): error TS2339: Property 'someProperty2' does not exist on type 'SomeClass'.
+index.ts(36,83): error TS2339: Property 'someProperty3' does not exist on type 'SomeClass'.
+index.ts(39,9): error TS2741: Property 'someMethod1' is missing in type 'SomeClass' but required in type 'SomeAbstractClass'.
+index.ts(40,9): error TS2741: Property 'someProperty1' is missing in type 'SomeClass' but required in type 'SomeType1'.
+index.ts(41,9): error TS2739: Type 'SomeClass' is missing the following properties from type 'SomeType2': someProperty2, someProperty3

scripts/components/api-changes-validator/test-resources/test-projects/with-breaks/class-break-inheritance/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@aws-amplify/class-break-inheritance",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./lib/index.js",
+      "require": "./lib/index.js",
+      "types": "./lib/index.d.ts"
+    }
+  },
+  "types": "lib/index.d.ts"
+}

scripts/components/api-changes-validator/test-resources/test-projects/with-breaks/class-break-inheritance/src/index.ts

@@ -0,0 +1,15 @@
+export type SomeType1 = {
+  someProperty1: string;
+};
+
+export type SomeType2 = {
+  someProperty2: string;
+  someProperty3: string;
+};
+
+export abstract class SomeAbstractClass {
+  someMethod1: (param1: string, param2?: string) => string;
+}
+
+// remove all inheritance here
+export class SomeClass {}

scripts/components/api-changes-validator/test-resources/test-projects/with-breaks/class-break-inheritance/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../../../../../tsconfig.base.json",
+  "compilerOptions": { "rootDir": "src", "outDir": "lib" }
+}

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

@@ -47,6 +47,18 @@ export abstract class SomeAbstractClass2<T1, T2, T3, T4, T5, T6> {
   constructor(param1: T1, param2?: T2);
 }
 
+export class SomeDerivedClass1
+  extends SomeAbstractClass1
+  implements SampleType {}
+
+export class SomeDerivedClass2<T1, T2 extends SampleType, T3, T4, T5, T6>
+  extends SomeAbstractClass2<T1, T2, T3, T4, T5, T6>
+  implements SampleTypeWithTypeParam<T1, T2>
+{
+  anotherProperty: T2;
+  someProperty: T1;
+}
+
 export const someFunction1: () => void;
 export const someFunction2: (param1: string, param2?: number) => string;
 export const someFunction3: (param1: string, param2: number = 1) => string;

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

@@ -64,6 +64,18 @@ export abstract class SomeAbstractClass2<T1, T2, T3, T4, T5, T6> {
   }
 }
 
+export class SomeDerivedClass1
+  extends SomeAbstractClass1
+  implements SampleType {}
+
+export class SomeDerivedClass2<T1, T2 extends SampleType, T3, T4, T5, T6>
+  extends SomeAbstractClass2<T1, T2, T3, T4, T5, T6>
+  implements SampleTypeWithTypeParam<T1, T2>
+{
+  anotherProperty: T2;
+  someProperty: T1;
+}
+
 export const someFunction1 = (): void => {
   throw new Error();
 };