Playwright setup.

Basic tests - visibility of custom scroll. position of scroll handle on scrolling

Author: rommguy

.github/workflows/playwright.yml

@@ -0,0 +1,27 @@
+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@v3
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - name: Install dependencies
+      run: npm install -g yarn && yarn
+    - name: Install Playwright Browsers
+      run: yarn playwright install --with-deps
+    - name: Run Playwright tests
+      run: yarn playwright test
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -22,3 +22,7 @@ dist-ssr
 *.njsproj
 *.sln
 *.sw?
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

package.json

@@ -23,7 +23,9 @@
     "build": "tsc && vite build",
     "prepare": "npm run build",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui --project firefox"
   },
   "dependencies": {
     "@types/lodash": "^4.14.202",
@@ -33,6 +35,7 @@
     "styled-components": "^6.1.8"
   },
   "devDependencies": {
+    "@playwright/test": "^1.41.1",
     "@types/node": "^20.11.10",
     "@types/react": "^18.2.43",
     "@types/react-dom": "^18.2.17",

playwright.config.ts

@@ -0,0 +1,84 @@
+import { defineConfig, devices } from "@playwright/test";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/**
+ * 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",
+  /* 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://127.0.0.1:3000',
+
+    /* 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' },
+    // },
+  ],
+
+  globalSetup: path.resolve(__dirname, "startServer.ts"),
+  globalTeardown: path.resolve(__dirname, "stopServer.ts"),
+
+  /* Run your local dev server before starting the tests */
+  // webServer: {
+  //   command: 'npm run start',
+  //   url: 'http://127.0.0.1:3000',
+  //   reuseExistingServer: !process.env.CI,
+  // },
+});

src/App.tsx

@@ -13,7 +13,7 @@ export const App = () => {
         it doesn't take up any space. This enables the same results regardless
         of browser or operating system.
       </div>
-      <div className="example-wrapper">
+      <div data-testid="first-example" className="example-wrapper">
         <DemoComp demoType="compare-with-native" />
       </div>
       <div id="with-crazy-design">

src/customScroll.tsx

@@ -541,6 +541,7 @@ export class CustomScroll extends Component<
         ref={this.customScrollRef}
       >
         <div
+          data-testid="outer-container"
           className="rcs-outer-container"
           style={this.getOuterContainerStyle()}
           onMouseDown={this.onMouseDown}
@@ -550,11 +551,13 @@ export class CustomScroll extends Component<
           {this.hasScroll ? (
             <div className="rcs-positioning">
               <CustomScrollbar
+                data-testid="custom-scrollbar"
                 ref={this.customScrollbarRef}
                 className={`rcs-custom-scrollbar ${this.props.rtl ? "rcs-custom-scrollbar-rtl" : ""}`}
                 key="scrollbar"
               >
                 <div
+                  data-testid="custom-scroll-handle"
                   ref={this.scrollHandleRef}
                   className="rcs-custom-scroll-handle"
                   style={scrollHandleStyle}
@@ -565,6 +568,7 @@ export class CustomScroll extends Component<
             </div>
           ) : null}
           <div
+            data-testid="inner-container"
             ref={this.innerContainerRef}
             className={this.getInnerContainerClasses()}
             style={scrollStyles.innerContainer}

startServer.ts

@@ -0,0 +1,9 @@
+import { exec } from "child_process";
+
+const startServer = async () => {
+  // @ts-expect-error not needed
+  global.__VITE_SERVER__ = exec("npm run dev"); // Replace 'npm run dev' with your Vite start script
+  await new Promise((resolve) => setTimeout(resolve, 4000)); // Wait for the server to start
+};
+
+export default startServer;

stopServer.ts

@@ -0,0 +1,6 @@
+const stopServer = async () => {
+  // @ts-expect-error not needed
+  global.__VITE_SERVER__.kill();
+};
+
+export default stopServer;

tests/customScroll.spec.ts

@@ -0,0 +1,48 @@
+import { test, expect } from "@playwright/test";
+import {
+  assertCustomScrollBarVisible,
+  getInnerContainer,
+  getScrollHandle,
+} from "./customScrollDriver";
+
+const APP_URL = "http://localhost:5174/";
+
+test.describe("basic functionality", () => {
+  test.beforeEach(async ({ page }) => {
+    await page.goto(APP_URL);
+  });
+
+  test("Custom scrollbar appears when hovering the container", async ({
+    page,
+  }) => {
+    const examplePanel = page.getByTestId("first-example");
+    await examplePanel.getByTestId("outer-container").hover();
+
+    await assertCustomScrollBarVisible(examplePanel);
+  });
+
+  test("Updates the position of the scroll handle when scrolling", async ({
+    page,
+  }) => {
+    const examplePanel = page.getByTestId("first-example");
+
+    await examplePanel.getByTestId("outer-container").hover();
+    await expect(getScrollHandle(examplePanel)).toHaveCSS("top", "0px");
+
+    await page.mouse.wheel(0, 100);
+
+    expect(
+      await getInnerContainer(examplePanel).evaluate(
+        // @ts-expect-error missing type
+        (node) => (node as HTMLElement).scrollTop,
+      ),
+    ).toBe(100);
+
+    expect(
+      await getScrollHandle(examplePanel).evaluate(
+        // @ts-expect-error missing type
+        (node) => (node as HTMLElement).offsetTop,
+      ),
+    ).toBe(28);
+  });
+});

tests/customScrollDriver.ts

@@ -0,0 +1,15 @@
+import { expect, Locator } from "@playwright/test";
+
+export const getCustomScrollbar = (container: Locator) =>
+  container.getByTestId("custom-scrollbar");
+
+export const assertCustomScrollBarVisible = async (container: Locator) => {
+  await expect(getCustomScrollbar(container)).toBeVisible();
+  await expect(getCustomScrollbar(container)).toHaveCSS("opacity", "1");
+};
+
+export const getInnerContainer = (container: Locator) =>
+  container.getByTestId("inner-container");
+
+export const getScrollHandle = (container: Locator) =>
+  container.getByTestId("custom-scroll-handle");

vite.config.ts

@@ -24,4 +24,7 @@ export default defineConfig({
     emptyOutDir: true,
   },
   plugins: [react(), dts()],
+  server: {
+    port: 5174,
+  },
 });

yarn.lock

@@ -312,6 +312,13 @@
   resolved "https://registry.yarnpkg.com/@pkgjs/parseargs/-/parseargs-0.11.0.tgz#a77ea742fab25775145434eb1d2328cf5013ac33"
   integrity sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==
 
+"@playwright/test@^1.41.1":
+  version "1.41.1"
+  resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.41.1.tgz#6954139ed4a67999f1b17460aa3d184f4b334f18"
+  integrity sha512-9g8EWTjiQ9yFBXc6HjCWe41msLpxEX0KhmfmPl9RPLJdfzL4F0lg2BdJ91O9azFdl11y1pmpwdjBiSxvqc+btw==
+  dependencies:
+    playwright "1.41.1"
+
 "@rollup/pluginutils@^5.1.0":
   version "5.1.0"
   resolved "https://registry.yarnpkg.com/@rollup/pluginutils/-/pluginutils-5.1.0.tgz#7e53eddc8c7f483a4ad0b94afb1f7f5fd3c771e0"
@@ -1273,6 +1280,11 @@ fs.realpath@^1.0.0:
   resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==
 
+fsevents@2.3.2:
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.2.tgz#8a526f78b8fdf4623b709e0b975c52c24c02fd1a"
+  integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==
+
 fsevents@~2.3.2, fsevents@~2.3.3:
   version "2.3.3"
   resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6"
@@ -1766,6 +1778,20 @@ pirates@^4.0.1:
   resolved "https://registry.yarnpkg.com/pirates/-/pirates-4.0.6.tgz#3018ae32ecfcff6c29ba2267cbf21166ac1f36b9"
   integrity sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==
 
+playwright-core@1.41.1:
+  version "1.41.1"
+  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.41.1.tgz#9c152670010d9d6f970f34b68e3e935d3c487431"
+  integrity sha512-/KPO5DzXSMlxSX77wy+HihKGOunh3hqndhqeo/nMxfigiKzogn8kfL0ZBDu0L1RKgan5XHCPmn6zXd2NUJgjhg==
+
+playwright@1.41.1:
+  version "1.41.1"
+  resolved "https://registry.yarnpkg.com/playwright/-/playwright-1.41.1.tgz#83325f34165840d019355c2a78a50f21ed9b9c85"
+  integrity sha512-gdZAWG97oUnbBdRL3GuBvX3nDDmUOuqzV/D24dytqlKt+eI5KbwusluZRGljx1YoJKZ2NRPaeWiFTeGZO7SosQ==
+  dependencies:
+    playwright-core "1.41.1"
+  optionalDependencies:
+    fsevents "2.3.2"
+
 postcss-import@^15.1.0:
   version "15.1.0"
   resolved "https://registry.yarnpkg.com/postcss-import/-/postcss-import-15.1.0.tgz#41c64ed8cc0e23735a9698b3249ffdbf704adc70"