test(app): add Playwright to project

Enable e2e testing using Playwright

.gitignore

@@ -29,3 +29,7 @@ hail-*.log
 
 # vscode settings
 **/.vscode/
+
+# Playright test dirs
+/tests/playwright/
+/playwright/.cache/

package.json

@@ -12,7 +12,8 @@
     "lint:js": "eslint .",
     "test:jest": "jest",
     "test:jest:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
-    "test:full": "pnpm test:jest",
+    "test:playwright": "playwright test --reporter=list --workers=1",
+    "test:full": "pnpm test:jest && pnpm test:playwright",
     "typecheck": "pnpm tsc --noEmit",
     "typecheck:watch": "pnpm tsc -w --noEmit"
   },
@@ -30,6 +31,7 @@
     "@babel/preset-react": "^7.10.4",
     "@babel/preset-typescript": "^7.18.6",
     "@jest/globals": "^29.0.0",
+    "@playwright/test": "^1.43.0",
     "@types/d3-array": "^3.0.3",
     "@types/d3-scale": "^4.0.2",
     "@types/d3-shape": "^3.1.0",

playwright.config.ts

@@ -0,0 +1,80 @@
+import { defineConfig, devices } from '@playwright/test'
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// require('dotenv').config();
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: './tests/e2e',
+  outputDir: './tests/playwright/',
+  /* Run tests in files in parallel */
+  fullyParallel: true,
+  /* Fail the build on CI if you accidentally left test.only in the source code. */
+  forbidOnly: !!process.env.CI,
+  /* Retry on CI only */
+  retries: process.env.CI ? 2 : 0,
+  /* Opt out of parallel tests on CI. */
+  workers: process.env.CI ? 1 : undefined,
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: 'html',
+  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  use: {
+    /* Base URL to use in actions like `await page.goto('/')`. */
+    baseURL: process.env.URL ? process.env.URL : 'http://127.0.0.1:8008',
+
+    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+    trace: 'on-first-retry',
+  },
+
+  /* Configure projects for major browsers */
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+
+    // {
+    //   name: 'firefox',
+    //   use: { ...devices['Desktop Firefox'] },
+    // },
+
+    // {
+    //   name: 'webkit',
+    //   use: { ...devices['Desktop Safari'] },
+    // },
+
+    /* Test against mobile viewports. */
+    // {
+    //   name: 'Mobile Chrome',
+    //   use: { ...devices['Pixel 5'] },
+    // },
+    // {
+    //   name: 'Mobile Safari',
+    //   use: { ...devices['iPhone 12'] },
+    // },
+
+    /* Test against branded browsers. */
+    // {
+    //   name: 'Microsoft Edge',
+    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
+    // },
+    // {
+    //   name: 'Google Chrome',
+    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
+    // },
+  ],
+
+  /* Run your local dev server before starting the tests */
+  webServer: {
+    command: process.env.GNOMAD_API_URL
+      ? `GNOMAD_API_URL=${process.env.GNOMAD_API_URL} pnpm start:browser`
+      : `pnpm start:browser`,
+    url: 'http://127.0.0.1:8008',
+    reuseExistingServer: !process.env.CI,
+  },
+})

tests/e2e/HomePage.playwright.spec.ts

@@ -0,0 +1,8 @@
+import { test, expect } from '@playwright/test'
+
+test('has title', async ({ page }) => {
+  await page.goto('/gene/ENSG00000169174?dataset=gnomad_r4')
+
+  // Expect a title "to contain" a substring.
+  await expect(page).toHaveTitle(/PCSK9 | gnomAD v4.0.0 | gnomAD/)
+})