Add e2e tests (#20)

* feat: add multiple tab support

* feat: add search history

* feat: add keyboard support to the search

* chore: unused import

* chore: remove unusued hook

* chore: rename the custom scroll component argument

* chore: update playground for easier debugging

* feat: add hideTabs option and fix styles

* feat: add a credentials form to playground

* fix: use cloudflare version of redis to avoid direct process access

* feat: add persistance support

* fix: prevent useEffect from working when tab is not active

* fix: automatically rescan until a result shows up

* fix: only fetch when the tab is active

* fix: skeleton and empty styles

* fix: refactor tabs and improve next tab selection logic when current tab is removed

* feat: add useOverflow utility hook

* fix: make the tooltip use portals

* fix: search recomendations overflowing

* feat: show tooltip only when tabs is overflowing

* fix: adding new key sometimes throwing error

* fix: not being able to click anywhere after closing delete key modal

* feat: add "copy key" to dropdown menu

* feat: make the "delete key" item red

* fix: add zustand migration

* feat: add e2e tests

* test: improve key delete tests

Author: ytkimirti

.github/workflows/playwright.yml

@@ -0,0 +1,30 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm install -g pnpm && pnpm install
+    - name: Install Playwright Browsers
+      run: pnpm exec playwright install --with-deps
+    - name: Run Playwright tests
+      run: pnpm exec playwright test
+      env:
+        UPSTASH_REDIS_REST_URL: ${{ secrets.UPSTASH_REDIS_REST_URL }}
+        UPSTASH_REDIS_REST_TOKEN: ${{ secrets.UPSTASH_REDIS_REST_TOKEN }}
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -39,3 +39,10 @@ next-env.d.ts
 
 .turbo
 dist
+
+# Playwright
+node_modules/
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package.json

@@ -53,7 +53,7 @@
     "zustand": "5.0.0"
   },
   "devDependencies": {
-    "postcss-prefix-selector": "^2.1.0",
+    "@playwright/test": "^1.53.1",
     "@types/node": "^22.8.4",
     "@types/react": "^18.3.12",
     "@types/react-dom": "^18.3.1",
@@ -63,9 +63,11 @@
     "autoprefixer": "^10.4.14",
     "class-variance-authority": "^0.7.0",
     "clsx": "^2.0.0",
+    "dotenv": "^16.5.0",
     "eslint": "9.10.0",
     "eslint-plugin-unicorn": "55.0.0",
     "postcss": "^8.4.31",
+    "postcss-prefix-selector": "^2.1.0",
     "prettier": "^3.0.3",
     "prettier-plugin-tailwindcss": "^0.5.5",
     "react": "^18.3.1",
@@ -82,4 +84,4 @@
     "react": "^18.2.0 || ^19",
     "react-dom": "^18.2.0 || ^19"
   }
-}
+}

playwright.config.ts

@@ -0,0 +1,71 @@
+import path from "path"
+import { defineConfig, devices } from "@playwright/test"
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+import dotenv from "dotenv"
+
+dotenv.config({ path: path.resolve(__dirname, ".env") })
+process.env.PLAYWRIGHT = "true"
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+  testDir: "./tests",
+  /* 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: "http://localhost:5173",
+
+    /* 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: "pnpm run dev",
+    url: "http://localhost:5173",
+    reuseExistingServer: !process.env.CI,
+  },
+})