Playwright test

.github/workflows/playwright.yml

@@ -0,0 +1,32 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    container:
+      image: mcr.microsoft.com/playwright:v1.52.0-noble
+      options: --user 1001
+    steps:
+    - uses: actions/checkout@v4
+    - name: Insert auth font awesome auth token
+      run: echo "@fortawesome:registry=https://npm.fontawesome.com/" > .npmrc && echo "//npm.fontawesome.com/:_authToken=${{ secrets.FONT_AWESOME_AUTH_TOKEN }}" >> .npmrc
+    - uses: actions/setup-node@v4
+      with:
+        node-version: lts/*
+    - name: Install dependencies
+      run: npm install -g yarn && yarn
+    - name: Install Playwright Browsers
+      run: yarn playwright install
+    - name: Run Playwright tests
+      run: yarn playwright test
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() }}
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30

.gitignore

@@ -8,3 +8,9 @@ yarn-error.log
 public
 .env*
 **/*.swp
+
+# Playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

Dockerfile

@@ -0,0 +1,15 @@
+FROM mcr.microsoft.com/playwright:v1.52.0-noble
+
+WORKDIR /app
+
+COPY .npmrc ./.npmrc
+COPY package.json .
+COPY yarn.lock .
+COPY tsconfig.json .
+COPY vite.config.ts .
+COPY playwright.config.ts .
+
+RUN yarn install
+
+EXPOSE 9323
+

docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+  playwright:
+    build: .
+    volumes:
+      - ./lib:/app/lib
+      - ./e2e:/app/e2e
+      - ./tools:/app/tools
+      - ./playwright-report:/app/playwright-report
+      - ./.npmrc:/app/.npmrc
+      - ./package.json:/app/package.json
+      - ./yarn.lock:/app/yarn.lock
+      - ./tsconfig.json:/app/tsconfig.json
+      - ./playwright.config.ts:/app/playwright.config.ts
+      - ./vite.config.ts:/app/vite.config.ts
+      - ./.storybook:/app/.storybook
+    ports:
+      - '9323:9323'

e2e/example.spec.ts

@@ -0,0 +1,37 @@
+import { test, expect, Page } from '@playwright/test';
+
+function waitForImages(page: Page) {
+	return page.evaluate(() => {
+		return Promise.all(
+			Array.from(document.images)
+				.filter((img) => !img.complete)
+				.map(
+					(img) =>
+						new Promise<void>((resolve) => {
+							img.onload = img.onerror = () => resolve();
+						}),
+				),
+		);
+	});
+}
+
+test.describe('Visual Regression Tests for Components', async () => {
+	const data = JSON.parse(process.env.STORIES_DATA);
+	console.log({ data });
+
+	const stories = Object.entries(data.entries)
+		.filter(([storyId]) => storyId.startsWith('components'))
+		.slice(0, 5);
+
+	for (const [storyId, story] of stories) {
+		test(`component ${story.title}: ${story.name}`, async ({ page }) => {
+			await page.goto(`http://localhost:6006/iframe.html?viewMode=story&id=${storyId}`);
+
+			await page.waitForSelector('[data-v-app]');
+
+			await waitForImages(page);
+
+			await expect(page).toHaveScreenshot(`${storyId}.png`);
+		});
+	}
+});

e2e/global-setup.ts

@@ -0,0 +1,7 @@
+async function globalSetup() {
+	process.env.STORIES_DATA = await fetch('http://localhost:6006/index.json').then((r) =>
+		r.text(),
+	);
+}
+
+export default globalSetup;

lib/js/components/Avatar/Avatar.stories.ts

@@ -54,8 +54,7 @@ export const Interactive: Story = {
 	args: {
 		size: AVATAR_SIZES.X_SMALL,
 		username: 'Dariusz Chrapek',
-		avatarUrl:
-			'https://wiecejnizlek.pl/wp-content/uploads/2021/08/Dariusz_Chrapek-uai-2996x2996-1-scaled.jpeg',
+		avatarUrl: 'https://cms.landing.bethink.tech/assets/team/dariuszireneusz_chrapek.png',
 		teamMemberImageUrl: 'https://lek.wiecejnizlek.pl/images/lek/logo-badge.svg',
 		activityStatusTooltip: 'Active now',
 	},

package.json

@@ -13,7 +13,7 @@
   "license": "UNLICENSED",
   "engines": {
     "yarn": "^1.22.1",
-    "node": "^16.13.0 || ^18.17.0 || ^20.9.0"
+    "node": "^16.13.0 || ^18.17.0 || ^20.9.0 || ^22.0.0"
   },
   "scripts": {
     "build": "vite build",
@@ -41,6 +41,7 @@
     "@fortawesome/pro-regular-svg-icons": "6.4.2",
     "@fortawesome/pro-solid-svg-icons": "6.4.2",
     "@fortawesome/vue-fontawesome": "3.0.3",
+    "@playwright/test": "^1.52.0",
     "@storybook/addon-actions": "^8.3.4",
     "@storybook/addon-controls": "^8.3.4",
     "@storybook/addon-designs": "^8.0.3",

playwright.config.ts

@@ -0,0 +1,80 @@
+import { defineConfig, devices } from '@playwright/test';
+
+/**
+ * Read environment variables from file.
+ * https://github.com/motdotla/dotenv
+ */
+// import dotenv from 'dotenv';
+// import path from 'path';
+// dotenv.config({ path: path.resolve(__dirname, '.env') });
+
+/**
+ * See https://playwright.dev/docs/test-configuration.
+ */
+export default defineConfig({
+	testDir: './e2e',
+	/* 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:3000',
+
+		/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
+		trace: 'on-first-retry',
+	},
+	globalSetup: './e2e/global-setup.ts',
+
+	/* 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: 'yarn dev --no-open -h 0.0.0.0',
+		url: 'http://localhost:6006',
+		reuseExistingServer: !process.env.CI,
+	},
+});

yarn.lock

@@ -1005,6 +1005,13 @@
     "@nodelib/fs.scandir" "2.1.5"
     fastq "^1.6.0"
 
+"@playwright/test@^1.52.0":
+  version "1.52.0"
+  resolved "https://registry.yarnpkg.com/@playwright/test/-/test-1.52.0.tgz#267ec595b43a8f4fa5e444ea503689629e91a5b8"
+  integrity sha512-uh6W7sb55hl7D6vsAeA+V2p5JnlAqzhqFyF0VcJkKZXkgnFcVG9PziERRHQfPLfNGx1C292a4JqbWzhR8L4R1g==
+  dependencies:
+    playwright "1.52.0"
+
 "@primeuix/styled@^0.0.5":
   version "0.0.5"
   resolved "https://registry.yarnpkg.com/@primeuix/styled/-/styled-0.0.5.tgz#430d06554470fddc28814059d76e63c9c21535b9"
@@ -3830,6 +3837,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.2, fsevents@~2.3.3:
   version "2.3.3"
   resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.3.tgz#cac6407785d03675a2a5e1a5305c697b347d90d6"
@@ -5698,6 +5710,20 @@ pkg-dir@^4.1.0, pkg-dir@^4.2.0:
   dependencies:
     find-up "^4.0.0"
 
+playwright-core@1.52.0:
+  version "1.52.0"
+  resolved "https://registry.yarnpkg.com/playwright-core/-/playwright-core-1.52.0.tgz#238f1f0c3edd4ebba0434ce3f4401900319a3dca"
+  integrity sha512-l2osTgLXSMeuLZOML9qYODUQoPPnUsKsb5/P6LJ2e6uPKXUdPK5WYhN4z03G+YNbWmGDY4YENauNu4ZKczreHg==
+
+playwright@1.52.0:
+  version "1.52.0"
+  resolved "https://registry.yarnpkg.com/playwright/-/playwright-1.52.0.tgz#26cb9a63346651e1c54c8805acfd85683173d4bd"
+  integrity sha512-JAwMNMBlxJ2oD1kce4KPtMkDeKGHQstdpFPcPH3maElAXon/QZeTvtsfXmTMRyO9TslfoYOXkSsvao2nE1ilTw==
+  dependencies:
+    playwright-core "1.52.0"
+  optionalDependencies:
+    fsevents "2.3.2"
+
 polished@^4.2.2:
   version "4.3.1"
   resolved "https://registry.yarnpkg.com/polished/-/polished-4.3.1.tgz#5a00ae32715609f83d89f6f31d0f0261c6170548"