@public-ui/visual-tests 3.0.0-alpha.1 → 3.0.0-rc.1

package/README.md

@@ -1,5 +1,13 @@
 # KoliBri - Visual Tests
 
+[![npm](https://img.shields.io/npm/v/@public-ui/visual-tests)](https://www.npmjs.com/package/@public-ui/components)
+[![license](https://img.shields.io/npm/l/@public-ui/visual-tests)](https://github.com/public-ui/kolibri/blob/main/LICENSE)
+[![downloads](https://img.shields.io/npm/dt/@public-ui/visual-tests)](https://www.npmjs.com/package/@public-ui/visual-tests)
+[![issues](https://img.shields.io/github/issues/public-ui/kolibri)](https://github.com/public-ui/kolibri/issues)
+[![pull requests](https://img.shields.io/github/issues-pr/public-ui/kolibri)](https://github.com/public-ui/kolibri/pulls)
+[![size](https://img.shields.io/bundlephobia/min/@public-ui/visual-tests)](https://bundlephobia.com/result?p=@public-ui/visual-tests)
+![contributors](https://img.shields.io/github/contributors/public-ui/kolibri)
+
 ## Motivation
 
 The `KoliBri` Visual Tests provide a way to add visual regression testing to **theme** modules.  
@@ -7,11 +15,23 @@ It takes screenshots of every component defined in the [React Sample App](https:
 
 ## Installation
 
+It is recommended to configure NPM via `.npmrc`:
+
+```bash
+# - npm
+engine-strict=true
+save-exact=true
+
+# - pnpm
+shamefully-hoist=true # this is required for the visual tests to work
+workspace-concurrency=1
+```
+
 You can install the `KoliBri` Visual Tests with `npm`, `pnpm` or `yarn`:
 
 ```bash
 npm i -D @public-ui/visual-tests
-pnpm i -D @public-ui/visual-tests
+pnpm i -D @public-ui/visual-tests # recommended
 yarn add -D @public-ui/visual-tests
 ```
 
@@ -21,17 +41,17 @@ Add the following npm scripts to the theme's `package.json`:
 
 ```json
 {
-    "scripts": {
-        "test": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test",
-        "test-update": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test --update-snapshots",
-    }
+	"scripts": {
+		"test": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test",
+		"test-update": "THEME_MODULE=src/index THEME_EXPORT=THEME_NAME kolibri-visual-test --update-snapshots"
+	}
 }
 ```
 
-* `THEME_MODULE` defines the relative path to the TypeScript module containing the the theme definitions. Without file extension. 
-* `THEME_EXPERT` defines the name of the export within the the module. (e.g., `export const THEME_NAME = {/**/};`) Defaults to `default`.  
+- `THEME_MODULE` defines the relative path to the TypeScript module containing the the theme definitions. Without file extension.
+- `THEME_EXPERT` defines the name of the export within the the module. (e.g., `export const THEME_NAME = {/**/};`) Defaults to `default`.
 
 Run the tests with `npm test`. The first time, this will create a new folder `snapshots` which is supposed to be committed to the repository.
 In the following runs, new screenshots will be compared to this reference.
 
-To update the reference screenshots call `npm run test-update`.
+To update the reference screenshots call `npm run test-update`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@public-ui/visual-tests",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-rc.1",
   "license": "EUPL-1.2",
   "homepage": "https://public-ui.github.io",
   "repository": {
@@ -26,7 +26,7 @@
     "axe-playwright": "2.0.3",
     "portfinder": "1.0.32",
     "serve": "14.2.4",
-    "@public-ui/sample-react": "3.0.0-alpha.1"
+    "@public-ui/sample-react": "3.0.0-rc.1"
   },
   "devDependencies": {
     "@babel/eslint-parser": "7.25.9",

package/src/index.js

@@ -2,6 +2,7 @@ import child_process from 'node:child_process';
 import path from 'node:path';
 import { fileURLToPath, pathToFileURL } from 'url';
 import * as crypto from 'crypto';
+import { readFile } from 'fs/promises';
 import * as fs from 'fs';
 import portfinder from 'portfinder';
 import * as process from 'process';
@@ -35,12 +36,11 @@ if (!fs.existsSync(workingDir)) {
 const buildPath = path.join(tempDir, `kolibri-visual-testing-build-${crypto.randomUUID()}`);
 const rawPackageJsonPath = new URL(path.join(workingDir, 'package.json'), import.meta.url).href;
 const packageJsonPath = process.platform === 'win32' ? pathToFileURL(rawPackageJsonPath) : rawPackageJsonPath;
-const packageJson = await import(packageJsonPath, {
-	assert: { type: 'json' },
-});
+const packageJsonContent = await readFile(new URL(packageJsonPath, import.meta.url), 'utf8');
+const packageJson = JSON.parse(packageJsonContent);
 
 console.log(`
-Building React Sample App (v${packageJson?.default?.version ?? '#.#.#'}) …`);
+Building React Sample App (v${packageJson?.version ?? '#.#.#'}) …`);
 
 child_process.spawnSync('pnpm', ['run', 'build', '--', `--output-path="${buildPath}"`], {
 	cwd: workingDir,

package/tests/sample-app.routes.js

@@ -498,11 +498,6 @@ ROUTES.set('version/context', {
 		skipFailures: false,
 	},
 });
-ROUTES.set('scenarios/appointment-form', {
-	axe: {
-		skipFailures: false,
-	},
-});
 ROUTES.set('scenarios/static-form', {
 	axe: {
 		skipFailures: false,

package/tests/theme-snapshots.spec.js

@@ -23,6 +23,9 @@ export const configureSnapshotPath =
 				// 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', '');
@@ -44,12 +47,7 @@ test.use({
 	},
 });
 
-const blocklist = [];
-
 ROUTES.forEach((options, route) => {
-	if (blocklist.includes(route)) {
-		return;
-	}
 	test(`snapshot for ${route}`, async ({ page }) => {
 		const hideMenusParam = `${route.includes('?') ? '&' : '?'}hideMenus`;
 		await page.goto(`/#${route}${hideMenusParam}`, { waitUntil: 'networkidle' });
@@ -59,6 +57,14 @@ ROUTES.forEach((options, route) => {
 		if (options?.waitForTimeout) {
 			await page.waitForTimeout(options.waitForTimeout);
 		}
+		await expect(page).toHaveScreenshot({
+			fullPage: true,
+			maxDiffPixelRatio: 0.0,
+			...options,
+		});
+		await page.evaluate(() => {
+			document.body.style.zoom = '400%';
+		});
 		await expect(page).toHaveScreenshot({
 			fullPage: true,
 			maxDiffPixelRatio: 0.01,