AG-1435: lint e2e tests as described in playwright best practices

Sage-Bionetworks · Apr 30, 2024 · 49839b8 · 49839b8
1 parent ad5ddfa
commit 49839b8
Show file tree

Hide file tree

Showing 15 changed files with 77 additions and 38 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -11,7 +11,8 @@
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": "latest",
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": ["./tsconfig.base.json"]
   },
   "plugins": ["@typescript-eslint"],
   "rules": {
@@ -23,6 +24,7 @@
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/no-empty-interface": "off",
     "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-this-alias": "off"
+    "@typescript-eslint/no-this-alias": "off",
+    "@typescript-eslint/no-floating-promises": "warn"
   }
 }
diff --git a/src/app/core/components/footer/footer.component.spec.ts b/src/app/core/components/footer/footer.component.spec.ts
@@ -72,6 +72,8 @@ describe('Component: Footer', () => {
     const link = element.querySelector('.footer-logo a') as HTMLElement;
     expect(link).toBeTruthy();
 
+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     router.navigate(['/about']);
     tick();
     expect(location.path()).toBe('/about');

diff --git a/src/app/core/components/header/header.component.spec.ts b/src/app/core/components/header/header.component.spec.ts
@@ -69,6 +69,8 @@ describe('Component: Header', () => {
     const link = element.querySelector('.header-logo a') as HTMLElement;
     expect(link).toBeTruthy();
 
+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     router.navigate(['/nominated-targets']);
     tick();
     expect(location.path()).toBe('/nominated-targets');

diff --git a/src/app/features/charts/components/median-barchart/median-barchart.component.spec.ts b/src/app/features/charts/components/median-barchart/median-barchart.component.spec.ts
@@ -55,6 +55,7 @@ describe('Component: BarChart - Median', () => {
   let element: HTMLElement;
 
   beforeEach(waitForAsync(() => {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     TestBed.configureTestingModule({
       declarations: [MedianBarChartComponent],
       imports: [RouterTestingModule],

diff --git a/...app/features/genes/components/gene-comparison-tool/gene-comparison-tool.component.spec.ts b/...app/features/genes/components/gene-comparison-tool/gene-comparison-tool.component.spec.ts
@@ -49,6 +49,7 @@ describe('Component: GeneComparisonToolComponent', () => {
   let route: ActivatedRoute;
 
   beforeEach(fakeAsync(() => {
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     TestBed.configureTestingModule({
       declarations: [
         GeneComparisonToolComponent,
@@ -430,6 +431,7 @@ describe('Component: GeneComparisonToolComponent', () => {
       ) as HTMLElement;
       filterClearButton.click();
 
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       fixture.whenStable().then(() => {
         fixture.detectChanges();
         expectSignificanceThresholdIsNotApplied();
@@ -448,6 +450,7 @@ describe('Component: GeneComparisonToolComponent', () => {
       ) as HTMLElement;
       clearAllButton.click();
 
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       fixture.whenStable().then(() => {
         fixture.detectChanges();
         expectSignificanceThresholdIsNotApplied();
@@ -459,13 +462,15 @@ describe('Component: GeneComparisonToolComponent', () => {
       component.initData([comparisonGeneMock1, comparisonGeneMock2]);
       route.queryParams = of({});
 
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       fixture.whenStable().then(() => {
         fixture.detectChanges();
         expectSignificanceThresholdIsNotApplied();
 
         const toggle = element.querySelector(TOGGLE_CLASS) as HTMLElement;
         toggle.click();
 
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
         fixture.whenStable().then(() => {
           fixture.detectChanges();
           expectSignificanceThresholdIsApplied();

diff --git a/src/app/features/genes/components/gene-details/gene-details.component.ts b/src/app/features/genes/components/gene-details/gene-details.component.ts
@@ -138,6 +138,8 @@ export class GeneDetailsComponent implements OnInit, AfterViewInit {
           .subscribe((gene) => {
             if (!gene) {
               this.helperService.setLoading(false);
+              // https://github.com/angular/angular/issues/45202
+              // eslint-disable-next-line @typescript-eslint/no-floating-promises
               this.router.navigateByUrl('/404-not-found', { skipLocationChange: true });
             } else {
               this.gene = gene;

diff --git a/src/app/features/genes/components/gene-network/gene-network.component.ts b/src/app/features/genes/components/gene-network/gene-network.component.ts
@@ -91,6 +91,8 @@ export class GeneNetworkComponent implements OnInit {
   }
 
   navigateToSimilarGenes() {
+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     this.router.navigate([
       '/genes/' + this._gene?.ensembl_gene_id + '/similar',
     ]);

diff --git a/src/app/features/genes/components/gene-search/gene-search.component.ts b/src/app/features/genes/components/gene-search/gene-search.component.ts
@@ -157,6 +157,8 @@ export class GeneSearchComponent extends Unsub implements AfterViewInit {
     this.results = [];
     this.showGeneResults = false;
     this.searchNavigated.emit();
+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     this.router.navigate(['/genes/' + id]);
   }
 

diff --git a/src/app/features/genes/components/gene-similar/gene-similar.component.ts b/src/app/features/genes/components/gene-similar/gene-similar.component.ts
@@ -72,6 +72,8 @@ export class GeneSimilarComponent implements OnInit {
           .subscribe((gene: Gene | null) => {
             if (!gene) {
               this.helperService.setLoading(false);
+              // https://github.com/angular/angular/issues/45202
+              // eslint-disable-next-line @typescript-eslint/no-floating-promises
               this.router.navigateByUrl('/404-not-found', { skipLocationChange: true });
             } else {
               this.gene = gene;
@@ -144,6 +146,8 @@ export class GeneSimilarComponent implements OnInit {
   navigateToGeneComparisonTool() {
     const ids: string[] = this.genes.map((g: Gene) => g.ensembl_gene_id);
     this.helperService.setGCTSelection(ids);
+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     this.router.navigate(['/genes/comparison']);
   }
 }
diff --git a/src/app/features/genes/components/gene-table/gene-table.component.ts b/src/app/features/genes/components/gene-table/gene-table.component.ts
@@ -139,6 +139,8 @@ export class GeneTableComponent implements OnInit {
   }
 
   navigateToGene(gene: any) {
+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
     this.router.navigate(['/genes/' + gene.ensembl_gene_id]);
   }
 
@@ -174,12 +176,16 @@ export class GeneTableComponent implements OnInit {
 
   navigateToGeneComparisonTool() {
     if (typeof this.gctLink === 'object') {
+      // https://github.com/angular/angular/issues/45202
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       this.router.navigate(['/genes/comparison'], {
         queryParams: this.gctLink,
       });
     } else {
       const ids: string[] = this._genes.map((g: Gene) => g.ensembl_gene_id);
       this.helperService.setGCTSelection(ids);
+      // https://github.com/angular/angular/issues/45202
+      // eslint-disable-next-line @typescript-eslint/no-floating-promises
       this.router.navigate(['/genes/comparison']);
     }
   }

diff --git a/tests/gene-details.spec.ts b/tests/gene-details.spec.ts
@@ -12,6 +12,6 @@ test.describe('specific viewport block', () => {
     await expect(page).toHaveTitle('Agora');
 
     // expect div for page not found content to be visible
-    expect(page.locator('.page-not-found')).toBeVisible();
+    await expect(page.locator('.page-not-found')).toBeVisible();
   });
-});
+});
diff --git a/tests/gene-similar.spec.ts b/tests/gene-similar.spec.ts
@@ -12,6 +12,6 @@ test.describe('specific viewport block', () => {
     await expect(page).toHaveTitle('Agora');
 
     // expect div for page not found content to be visible
-    expect(page.locator('.page-not-found')).toBeVisible();
+    await expect(page.locator('.page-not-found')).toBeVisible();
   });
-});
+});
diff --git a/tests/homepage.spec.ts b/tests/homepage.spec.ts
@@ -35,15 +35,15 @@ test.describe('specific viewport block', () => {
     await page.goto('/');
 
     // Hamburger menu should be hidden for the desktop viewport
-    expect(page.locator('button.header-nav-toggle')).toBeHidden();
-    
+    await expect(page.locator('button.header-nav-toggle')).toBeHidden();
+
     // look for news link and click it
-    const newsLink = await page.getByRole('link', { name: 'News'});
+    const newsLink = page.getByRole('link', { name: 'News' });
 
     // news link should be visible on the home page
-    expect(newsLink).toBeVisible();
+    await expect(newsLink).toBeVisible();
 
     await newsLink.click();
     await expect(page).toHaveTitle('News | Agora Releases');
   });
-});
+});
diff --git a/tsconfig.base.json b/tsconfig.base.json
@@ -0,0 +1,37 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "baseUrl": "./src",
+    "outDir": "./dist/out-tsc",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "sourceMap": true,
+    "declaration": false,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "importHelpers": true,
+    "target": "es2017",
+    "module": "es2020",
+    "lib": ["es2020", "dom"],
+    "allowSyntheticDefaultImports": true
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  },
+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.html",
+    "./src/**/*.scss",
+    "./tests/**.ts",
+    "./tests/**/**.ts",
+    "playwright.config.ts"
+  ]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,31 +1,5 @@
 {
-  "compileOnSave": false,
-  "compilerOptions": {
-    "baseUrl": "./src",
-    "outDir": "./dist/out-tsc",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": false,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "sourceMap": true,
-    "declaration": false,
-    "downlevelIteration": true,
-    "experimentalDecorators": true,
-    "moduleResolution": "node",
-    "importHelpers": true,
-    "target": "es2017",
-    "module": "es2020",
-    "lib": ["es2020", "dom"],
-    "allowSyntheticDefaultImports": true
-  },
-  "angularCompilerOptions": {
-    "enableI18nLegacyMessageIdFormat": false,
-    "strictInjectionParameters": true,
-    "strictInputAccessModifiers": true,
-    "strictTemplates": true
-  },
+  "extends": "./tsconfig.base.json",
   "exclude": [
     "./node_modules",
     "./dist",