@lvce-editor/test-with-playwright-worker 22.41.0 → 22.43.0

package/dist/svgScreenshot.js

@@ -7108,9 +7108,9 @@ var SvgScreenshot = (function (exports) {
   }`;
 	  document.head.append(freezeStyle);
 	  try {
-	    const target = selector ? document.querySelector(selector) : document.body;
+	    const target = typeof selector === 'string' ? document.querySelector(selector) : selector || document.body;
 	    if (!target) {
-	      throw new Error(`SVG screenshot selector did not match an element: ${selector}`);
+	      throw new Error(`SVG screenshot selector did not match an element: ${typeof selector === 'string' ? selector : '(detached target)'}`);
 	    }
 	    const root = document.documentElement;
 	    const captureArea = selector ? target.getBoundingClientRect() : new DOMRect(0, 0, root.clientWidth, root.clientHeight);

package/dist/workerMain.js

@@ -1,5 +1,5 @@
-import { join, dirname, basename, extname } from 'node:path';
-import { readFile, writeFile, readdir, rm, mkdir, access, mkdtemp } from 'node:fs/promises';
+import { join, dirname, basename, extname, resolve as resolve$1, isAbsolute } from 'node:path';
+import { readFile, writeFile, readdir, rm, mkdir, access, lstat, mkdtemp } from 'node:fs/promises';
 import { fileURLToPath, pathToFileURL } from 'node:url';
 import net from 'node:net';
 import os, { tmpdir } from 'node:os';
@@ -1219,7 +1219,7 @@ const get = id => {
 };
 
 // This function is serialized by Playwright and must not close over module bindings.
-const install = () => {
+const install$1 = () => {
   const limit = 5000;
   const payloadLimit = 8192;
   const entries = [];
@@ -1528,12 +1528,13 @@ const captureSvgScreenshot = async ({
   });
 };
 const compareSvgScreenshot = async ({
+  fixturePath,
   options,
   svg,
   test
 }) => {
   const formattedSvg = formatSvg(svg);
-  const snapshotPath = join(options.directory, getSnapshotName(test, options.name));
+  const snapshotPath = fixturePath || join(options.directory, getSnapshotName(test, options.name));
   const actualPath = `${snapshotPath}.actual`;
   if (options.update) {
     await mkdir(options.directory, {
@@ -1799,6 +1800,122 @@ const getTestState = (testOverlayState, text) => {
   }
 };
 
+const compare = async (path, actual, update) => {
+  const actualPath = `${path}.actual.png`;
+  if (update) {
+    await mkdir(dirname(path), {
+      recursive: true
+    });
+    await writeFile(path, actual);
+    await rm(actualPath, {
+      force: true
+    });
+    return;
+  }
+  let expected;
+  try {
+    expected = await readFile(path);
+  } catch (error) {
+    if (isEnoentError(error)) {
+      await mkdir(dirname(path), {
+        recursive: true
+      });
+      await writeFile(actualPath, actual);
+      throw new Error(`[SCREENSHOT_MISSING] PNG screenshot is missing: ${path}. Actual output: ${actualPath}. Run with --update-screenshots to create it.`);
+    }
+    throw error;
+  }
+  if (!actual.equals(expected)) {
+    await writeFile(actualPath, actual);
+    throw new Error(`[SCREENSHOT_MISMATCH] PNG screenshot differs: ${path}. Actual output: ${actualPath}`);
+  }
+  await rm(actualPath, {
+    force: true
+  });
+};
+
+const installed = new WeakSet();
+const resolveFixture = async (directory, uri) => {
+  if (typeof uri !== 'string' || !uri.endsWith('.svg') && !uri.endsWith('.png') || isAbsolute(uri) || uri.includes('\\') || uri.includes(':') || uri.includes('\0') || uri.split('/').some(part => !part || part === '.' || part === '..')) {
+    throw new Error(`[SCREENSHOT_INVALID_URI] Expected a relative .svg or .png path inside e2e/fixtures: ${String(uri)}`);
+  }
+  let current = resolve$1(directory);
+  for (const part of ['', ...uri.split('/')]) {
+    current = join(current, part);
+    try {
+      const stat = await lstat(current);
+      if (stat.isSymbolicLink()) {
+        throw new Error(`[SCREENSHOT_INVALID_URI] Symbolic links are not supported: ${uri}`);
+      }
+    } catch (error) {
+      if (!isEnoentError(error)) {
+        throw error;
+      }
+    }
+  }
+  return current;
+};
+const install = async (page, testPath, update) => {
+  if (installed.has(page)) {
+    return;
+  }
+  const directory = resolve$1(testPath, 'fixtures');
+  let previous = Promise.resolve();
+  await page.exposeBinding('lvceMatchScreenshot', async ({
+    frame
+  }, uri, token) => {
+    const run = async () => {
+      const fixturePath = await resolveFixture(directory, uri);
+      const element = await frame.evaluateHandle(token => {
+        const host = globalThis;
+        return host.lvceScreenshotTargets?.get(token) || null;
+      }, token);
+      try {
+        if (!element.asElement()) {
+          throw new Error(`[SCREENSHOT_ELEMENT_NOT_FOUND] ${String(uri)}`);
+        }
+        if (fixturePath.endsWith('.png')) {
+          await resolveFixture(directory, `${String(uri)}.actual.png`);
+          const png = await element.asElement().screenshot({
+            animations: 'disabled',
+            caret: 'hide'
+          });
+          await compare(fixturePath, png, update);
+        } else {
+          const svg = await capture(frame, element.asElement());
+          await compareSvgScreenshot({
+            fixturePath,
+            options: {
+              directory: dirname(fixturePath),
+              name: '',
+              update
+            },
+            svg,
+            test: ''
+          });
+        }
+      } finally {
+        await element.dispose();
+      }
+    };
+    // Capture changes document styles temporarily; serialize concurrent assertions on this page.
+    const prior = previous;
+    const result = (async () => {
+      await prior;
+      await run();
+    })();
+    previous = (async () => {
+      try {
+        await result;
+      } catch {
+        // A failed assertion must not prevent later requests from being handled.
+      }
+    })();
+    return result;
+  });
+  installed.add(page);
+};
+
 // Keep the server bind address and browser URLs on the same address family.
 // Chromium can fall back to IPv4 even when Node resolved localhost to ::1.
 const testServerHost = '127.0.0.1';
@@ -1835,12 +1952,14 @@ const runTest = async ({
   testSrc,
   timeout,
   traceFocus,
-  traceRendererWorker
+  traceRendererWorker,
+  updateSvgScreenshots = false
 }) => {
   const start = performance.now();
   const pageMessages = failOnConsoleMessages ? createPageMessages(page) : undefined;
   let result;
   try {
+    await install(page, dirname(testSrc), updateSvgScreenshots);
     const url = getUrlFromTestFile(test, port, traceFocus ?? false, traceRendererWorker ?? false);
     await navigateToTest(page, url, browser);
     const testOverlay = page.locator('#TestOverlay');
@@ -1940,7 +2059,8 @@ const runTests = async ({
   tests,
   testSrc,
   timeout,
-  traceFocus
+  traceFocus,
+  updateSvgScreenshots = false
 }) => {
   let failed = 0;
   let skipped = 0;
@@ -1962,6 +2082,7 @@ const runTests = async ({
         timeout,
         traceFocus: traceFocus ?? false,
         traceRendererWorker: rendererWorkerTraceDirectory !== undefined,
+        updateSvgScreenshots,
         ...(svgScreenshotOptions && {
           svgScreenshotOptions
         })
@@ -2125,13 +2246,16 @@ const runTestsWithReusedPage = async ({
   page,
   port,
   rendererWorkerTraceDirectory,
+  testPath,
   timeout,
-  traceFocus
+  traceFocus,
+  updateSvgScreenshots = false
 }) => {
   const start = performance.now();
   const pageMessages = failOnConsoleMessages ? createPageMessages(page) : undefined;
   let results;
   try {
+    await install(page, testPath, updateSvgScreenshots);
     const url = getAllTestsUrl(port, filter, traceFocus ?? false, rendererWorkerTraceDirectory !== undefined);
     await page.goto(url, {
       timeout,
@@ -3014,7 +3138,7 @@ const assertCoverageOptions = (coverageTarget, coverageInclude, coverageThreshol
  * @param {boolean} coverage
  * @param {boolean} traceRendererWorker
  */
-const runAllTests = async (extensionPath, testPath, cwd, browser, headless, timeout, runtimeOptions, traceFocus, filter, reusePage, svgScreenshotOptions, coverage, coverageInclude, coverageTarget, coverageThreshold, traceRendererWorker, failOnConsoleMessages) => {
+const runAllTests = async (extensionPath, testPath, cwd, browser, headless, timeout, runtimeOptions, traceFocus, filter, reusePage, svgScreenshotOptions, coverage, coverageInclude, coverageTarget, coverageThreshold, traceRendererWorker, failOnConsoleMessages, updateSvgScreenshots = false) => {
   string(extensionPath);
   string(testPath);
   string(cwd);
@@ -3107,7 +3231,7 @@ const runAllTests = async (extensionPath, testPath, cwd, browser, headless, time
   });
   try {
     if (traceRendererWorker) {
-      await page.addInitScript(install);
+      await page.addInitScript(install$1);
     }
     if (reusePage) {
       await runWithJavascriptCoverage({
@@ -3126,6 +3250,8 @@ const runAllTests = async (extensionPath, testPath, cwd, browser, headless, time
         run: async () => {
           await runTestsWithReusedPage({
             browser,
+            testPath,
+            updateSvgScreenshots,
             ...filterOption,
             failOnConsoleMessages,
             onFinalResult,
@@ -3160,7 +3286,7 @@ const runAllTests = async (extensionPath, testPath, cwd, browser, headless, time
       });
       try {
         if (traceRendererWorker) {
-          await nextBrowser.page.addInitScript(install);
+          await nextBrowser.page.addInitScript(install$1);
         }
         return nextBrowser;
       } catch (error) {
@@ -3176,6 +3302,7 @@ const runAllTests = async (extensionPath, testPath, cwd, browser, headless, time
         await runTests({
           browser,
           failOnConsoleMessages,
+          updateSvgScreenshots,
           ...(createPage && {
             createPage
           }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/test-with-playwright-worker",
-  "version": "22.41.0",
+  "version": "22.43.0",
   "description": "Worker package for test-with-playwright",
   "repository": {
     "type": "git",