@public-ui/visual-tests 3.0.0-rc.6 → 3.0.0-rc.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@public-ui/visual-tests",
-  "version": "3.0.0-rc.6",
+  "version": "3.0.0-rc.8",
   "license": "EUPL-1.2",
   "homepage": "https://public-ui.github.io",
   "repository": {
@@ -15,6 +15,9 @@
     "name": "Informationstechnikzentrum Bund",
     "email": "kolibri@itzbund.de"
   },
+  "engines": {
+    "pnpm": "^10"
+  },
   "type": "module",
   "sideEffects": false,
   "description": "Provides utility to run visual regression tests for themes.",
@@ -23,18 +26,18 @@
   },
   "dependencies": {
     "@playwright/test": "1.49.1",
-    "axe-playwright": "2.0.3",
-    "portfinder": "1.0.32",
+    "axe-playwright": "2.1.0",
+    "portfinder": "1.0.35",
     "serve": "14.2.4",
-    "@public-ui/sample-react": "3.0.0-rc.6"
+    "@public-ui/sample-react": "3.0.0-rc.8"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "7.25.9",
+    "@babel/eslint-parser": "7.26.10",
     "@babel/plugin-syntax-import-attributes": "7.26.0",
-    "@babel/preset-env": "7.26.7",
+    "@babel/preset-env": "7.26.9",
     "eslint": "8.57.1",
-    "knip": "5.40.0",
-    "prettier": "3.4.2"
+    "knip": "5.46.0",
+    "prettier": "3.5.3"
   },
   "files": [
     "playwright.config.js",
@@ -43,7 +46,8 @@
   ],
   "scripts": {
     "format": "prettier --check src",
-    "lint": "eslint src",
+    "lint": "pnpm lint:eslint",
+    "lint:eslint": "eslint src",
     "unused": "knip",
     "postinstall": "pnpm exec playwright install"
   }

package/playwright.config.js

@@ -2,19 +2,24 @@ import { defineConfig, devices } from '@playwright/test';
 import * as path from 'path';
 import * as process from 'process';
 
-const PORT = Number(process.env.KOLIBRI_VISUAL_TEST_PORT);
-const URL = `http://localhost:${PORT}`;
+// Validate and set ENVs
+const PORT = parseInt(process.env.KOLIBRI_VISUAL_TEST_PORT || '', 10);
+const BASE_URL = `http://localhost:${PORT}`;
 
-console.log('Serving React Sample app:', URL);
+const CWD = process.env.KOLIBRI_CWD ?? '';
+const TIMEOUT = parseInt(process.env.KOLIBRI_VISUAL_TESTS_TIMEOUT || '15000', 10);
+const EXPECT_TIMEOUT = parseInt(process.env.KOLIBRI_VISUAL_TESTS_EXPECT_TIMEOUT || '5000', 10);
+const BUILD_PATH = process.env.KOLIBRI_VISUAL_TESTS_BUILD_PATH ?? '';
+const THEME = (process.env.THEME_EXPORT || 'default').toLocaleLowerCase();
 
 /**
  * See https://playwright.dev/docs/test-configuration.
  */
 export default defineConfig({
 	testDir: './tests',
-	snapshotDir: path.join(process.env.KOLIBRI_CWD ?? '', 'snapshots'),
+	snapshotDir: path.join(CWD, 'snapshots'),
 	// snapshotPathTemplate: '',
-	outputDir: path.join(process.env.KOLIBRI_CWD ?? '', 'test-results'),
+	outputDir: path.join(CWD, 'test-results'),
 	/* Run tests in files in parallel */
 	fullyParallel: true,
 	/* Fail the build on CI if you accidentally left test.only in the source code. */
@@ -24,20 +29,20 @@ export default defineConfig({
 	/* Opt out of parallel tests on CI. */
 	workers: process.env.CI ? 1 : undefined,
 	/* Allow to override the expectation timeout for slow environments */
-	timeout: process.env.KOLIBRI_VISUAL_TESTS_TIMEOUT ? Number(process.env.KOLIBRI_VISUAL_TESTS_TIMEOUT) : undefined,
+	timeout: TIMEOUT,
 	/* Reporter to use. See https://playwright.dev/docs/test-reporters */
 	reporter: 'line',
 	/* 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: URL,
+		baseURL: BASE_URL,
 
 		/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
 		trace: 'on-first-retry',
 	},
 
 	expect: {
-		timeout: process.env.KOLIBRI_VISUAL_TESTS_EXPECT_TIMEOUT ? Number(process.env.KOLIBRI_VISUAL_TESTS_EXPECT_TIMEOUT) : undefined,
+		timeout: EXPECT_TIMEOUT,
 	},
 
 	/* Configure projects for major browsers */
@@ -59,8 +64,9 @@ export default defineConfig({
 	/* Run your local dev server before starting the tests */
 	webServer: {
 		command: `npx serve -p ${PORT}`,
-		cwd: path.resolve(process.env.KOLIBRI_VISUAL_TESTS_BUILD_PATH),
-		url: URL,
+		cwd: path.resolve(BUILD_PATH),
+		url: BASE_URL,
 		reuseExistingServer: false,
 	},
+	snapshotPathTemplate: `{snapshotDir}/theme-${THEME}/{arg}-{projectName}-{platform}{ext}`,
 });

package/src/index.js

@@ -19,15 +19,8 @@ if (!tempDir) {
 process.env.THEME_MODULE = path.join(process.cwd(), process.env.THEME_MODULE); // Use current working directory (i.e. the theme folder) to complete module path
 const visualsTestModulePath = fileURLToPath(new URL('..', import.meta.url));
 const binaryPath = fileURLToPath(new URL('../node_modules/.bin', import.meta.url));
-
-let sampleReactPath = '../node_modules/@public-ui/sample-react';
-let backSteps = ``;
-let workingDir = null;
-do {
-	const url = new URL(backSteps + sampleReactPath, import.meta.url);
-	workingDir = fileURLToPath(url);
-	backSteps += `../`;
-} while (!fs.existsSync(workingDir) && path.resolve(process.cwd(), backSteps) !== '/');
+const sampleReactPackageJsonPath = import.meta.resolve('@public-ui/sample-react/package.json');
+const workingDir = fileURLToPath(path.dirname(sampleReactPackageJsonPath));
 
 if (!fs.existsSync(workingDir)) {
 	throw new Error('Could not find React Sample App package. Please install it with "npm install @public-ui/sample-react".');

package/tests/sample-app.routes.js

@@ -93,6 +93,11 @@ ROUTES.set('button/baselined', {
 		skipFailures: false,
 	},
 });
+ROUTES.set('button/short-key', {
+	axe: {
+		skipFailures: false,
+	},
+});
 ROUTES.set('card/basic', {
 	axe: {
 		skipFailures: false,

package/tests/theme-snapshots.spec.js

@@ -1,40 +1,6 @@
 import { test, expect } from '@playwright/test';
 import { ROUTES } from './sample-app.routes.js';
 
-// https://github.com/microsoft/playwright/issues/7575#issuecomment-1288164474
-export const configureSnapshotPath =
-	() =>
-	// eslint-disable-next-line no-empty-pattern
-	({}, testInfo) => {
-		const originalSnapshotPath = testInfo.snapshotPath;
-		testInfo.snapshotPath = (snapshotName) => {
-			const result = originalSnapshotPath
-				.apply(testInfo, [snapshotName])
-
-				// Remove browser name from snapshot name
-				// .replace('-chromium', '')
-				// .replace('-firefox', '')
-
-				// Remove os name from snapshot name
-				// .replace('-darwin', '')
-				// .replace('-linux', '')
-				// .replace('-windows', '')
-
-				// Remove test counter from snapshot name
-				.replace('-1-', '-')
-
-				// Identify 2. test as zoom snapshot
-				.replace('-2-', '-zoom-')
-
-				// Make different snapshot folder for different themes
-				.replace('theme-snapshots.spec.js', `theme-${(process.env.THEME_EXPORT || 'default').toLocaleLowerCase()}`)
-				.replace('-snapshots', '');
-			return result;
-		};
-	};
-
-test.beforeEach(configureSnapshotPath());
-
 // https://playwright.dev/docs/emulation
 test.use({
 	colorScheme: 'light',
@@ -47,27 +13,52 @@ test.use({
 	},
 });
 
+const DEFAULT_SNAPSHOT_OPTIONS = {
+	animations: 'disabled',
+	fullPage: true,
+	maxDiffPixelRatio: 0,
+	scale: 'css', // 'css' or 'device'
+	timeout: 10000,
+};
+
 ROUTES.forEach((options, route) => {
 	test(`snapshot for ${route}`, async ({ page }) => {
 		const hideMenusParam = `${route.includes('?') ? '&' : '?'}hideMenus`;
-		await page.goto(`/#${route}${hideMenusParam}`, { waitUntil: 'networkidle' });
+		await page.goto(`/#${route}${hideMenusParam}`);
+		await page.waitForLoadState('networkidle');
+		await page.addStyleTag({
+			content: `
+				* {
+					transition: none !important;
+					animation: none !important;
+				}
+			`,
+		});
 		if (options?.viewportSize) {
 			await page.setViewportSize(options.viewportSize);
 		}
 		if (options?.waitForTimeout) {
 			await page.waitForTimeout(options.waitForTimeout);
 		}
-		await expect(page).toHaveScreenshot({
-			fullPage: true,
-			maxDiffPixelRatio: 0.01,
+
+		/**
+		 * We would like to use a readable name for the snapshot file.
+		 */
+		const snapshotName = `snapshot-for-${route.replace(/(\/|\?|&|=)/g, '-')}`;
+
+		await expect(page).toHaveScreenshot(`${snapshotName}.png`, {
+			...DEFAULT_SNAPSHOT_OPTIONS,
 			...options,
 		});
 		await page.evaluate(() => {
+			// eslint-disable-next-line no-undef
 			document.body.style.zoom = '400%';
+			// document.body.style.transform = 'scale(4)';
+			// document.body.style.transformOrigin = 'top left';
+			// document.body.style.width = '25vw';
 		});
-		await expect(page).toHaveScreenshot({
-			fullPage: true,
-			maxDiffPixelRatio: 0.02,
+		await expect(page).toHaveScreenshot(`${snapshotName}-zoom.png`, {
+			...DEFAULT_SNAPSHOT_OPTIONS,
 			...options,
 		});
 	});