AG-1435 #1304

hallieswan · 2024-05-02T19:40:55Z

bump playwright version
add linting rule recommended in playwright best practices
add e2e tests for GCT gene pinning

hallieswan · 2024-05-02T19:42:04Z

.eslintrc.json

@@ -11,7 +11,8 @@
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": "latest",
-    "sourceType": "module"
+    "sourceType": "module",
+    "project": ["./tsconfig.base.json"]


Setting the @typescript-eslint/no-floating-promises rule causes this error: You have used a rule which requires parserServices to be generated. You must therefore provide a value for the "parserOptions.project" property for @typescript-eslint/parser., so specify a project.

hallieswan · 2024-05-02T19:42:20Z

package-lock.json

@@ -54,7 +54,7 @@
        "@angularclass/hmr": "^3.0.0",
        "@babel/plugin-proposal-decorators": "^7.18.10",
        "@ngtools/webpack": "^13.3.9",
-        "@playwright/test": "^1.39.0",
+        "@playwright/test": "^1.43.1",


Bump playwright version

hallieswan · 2024-05-02T19:46:12Z

src/app/core/components/footer/footer.component.spec.ts

+    // https://github.com/angular/angular/issues/45202
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
    router.navigate(['/about']);


router.navigate returns a Promise, but is not awaited in Agora or in the Angular docs. Per the referenced link, it's common practice to ignore the Promise, so disable the lint rule for these cases.

src/app/features/genes/components/gene-comparison-tool/gene-comparison-tool.component.html

hallieswan · 2024-05-02T21:02:17Z

src/app/features/charts/components/median-barchart/median-barchart.component.spec.ts

+  beforeEach(waitForAsync(async () => {
+    await TestBed.configureTestingModule({


Await promise, so there is not a warning from newly enabled @typescript-eslint/no-floating-promises rule

hallieswan · 2024-05-02T21:03:05Z

tsconfig.base.json

+  "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
+  },


Moved from tsconfig.json

hallieswan · 2024-05-02T21:03:33Z

tsconfig.base.json

+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.html",
+    "./src/**/*.scss",
+    "./tests/**.ts",
+    "./tests/**/**.ts",
+    "playwright.config.ts"
+  ]


Specifies which files should be linted

hallieswan · 2024-05-02T21:04:22Z

tsconfig.json

-    "strictInputAccessModifiers": true,
-    "strictTemplates": true
-  },
+  "extends": "./tsconfig.base.json",


Extend the base tsconfig, so that an exclude block can still be used when bundling via webpack

hallieswan · 2024-05-02T21:05:51Z

tests/gene-details.spec.ts

@@ -7,11 +8,12 @@ test.describe('specific viewport block', () => {
  test('invalid gene results in a 404 redirect', async ({ page }) => {
    // go to invalid ENSG page
    await page.goto('/genes/ENSG00000000000');
+    await waitForSpinnerNotVisible(page);


Waiting for loader to be removed reduces flakiness when page takes a long time to load

hallieswan · 2024-05-02T21:07:02Z

tests/gene-details.spec.ts


    // expect a title "to contain" a substring.
    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();


Fix warning from @typescript-eslint/no-floating-promises -- toBeVisible is an auto-retrying assertion, so should be awaited

tests/gene-comparison-tool-pinning-cache.spec.ts

hallieswan · 2024-05-13T17:51:00Z

src/app/features/genes/components/gene-comparison-tool/gene-comparison-tool.component.html

@@ -403,6 +403,7 @@ <h1 class="gct-heading h2">Gene Comparison Tool</h1>
                <div *ngIf="genesTable.filteredValue?.length">
                  <button
                    class="pin-all-button"
+                    [disabled]="getPinDisabledStatus()"


Set the disabled property, rather than just a 'disabled' class, so that Playwright can confirm that the pin gene button is disabled when pinned gene limit has been reached.

hallieswan · 2024-05-13T17:53:12Z

tests/gene-comparison-tool-pinning-url.spec.ts

+  test.fail('when RNA url includes proteins, the related gene is pinned', {
+    annotation: {
+      type: 'fail', 
+      description: 'Since AG-1425, only genes will be pinned from RNA url'
+    }
+  },


Expect this test to fail -- since AG-1425, only genes will be pinned from an RNA url. ensembl id + uniprot id will be dropped.

sagely1

Looks great!

…d, add wait for spinner to stabilize tests

hallieswan commented May 2, 2024

View reviewed changes

src/app/features/genes/components/gene-comparison-tool/gene-comparison-tool.component.html Outdated Show resolved Hide resolved

hallieswan commented May 2, 2024

View reviewed changes

tests/gene-comparison-tool-pinning-cache.spec.ts Outdated Show resolved Hide resolved

hallieswan marked this pull request as ready for review May 2, 2024 21:30

hallieswan requested a review from sagely1 May 2, 2024 21:30

hallieswan force-pushed the AG-1435 branch from c9f37fc to bbb8905 Compare May 13, 2024 17:50

hallieswan commented May 13, 2024

View reviewed changes

sagely1 approved these changes May 13, 2024

View reviewed changes

hallieswan added 6 commits May 14, 2024 08:47

AG-1435: bump playwright version

1a74c6b

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

cc9c078

AG-1435: add e2e tests for gct pinning

1e5ade8

AG-1435: keep warnings for floating promises that may need to be fixe…

feb334c

…d, add wait for spinner to stabilize tests

AG-1435: improve test naming

2293d4a

AG-1435: updates based on AG-1425

694d9de

hallieswan force-pushed the AG-1435 branch from bbb8905 to 694d9de Compare May 14, 2024 16:17

hallieswan merged commit aea77e0 into Sage-Bionetworks:develop May 14, 2024
3 checks passed

hallieswan deleted the AG-1435 branch May 14, 2024 16:40

hallieswan mentioned this pull request May 14, 2024

AG-1409 reset default sort bug #1306

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AG-1435 #1304

AG-1435 #1304

hallieswan commented May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024

hallieswan May 2, 2024 •

edited

hallieswan May 13, 2024

hallieswan May 13, 2024

sagely1 left a comment

		beforeEach(waitForAsync(async () => {
		await TestBed.configureTestingModule({

AG-1435 #1304

AG-1435 #1304

Conversation

hallieswan commented May 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hallieswan May 2, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sagely1 left a comment

Choose a reason for hiding this comment

hallieswan May 2, 2024 •

edited