@pixeyedev/playwright 0.4.5 → 0.4.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pixeye (pixeye.dev)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/fixture.js

@@ -23,7 +23,8 @@ export const test = base.extend({
         setContext({
             outputDir,
             testFile,
-            testName: testInfo.title
+            testName: testInfo.title,
+            testId: testInfo.testId
         });
         const pixeyeApi = {
             screenshot: (target, name, options) => screenshot(target, name, options)

package/dist/reporter.d.ts

@@ -16,13 +16,21 @@ declare const detectShard: (config: FullConfig) => {
     index: number;
     total: number;
 };
+/** The tests that failed after their retries, by the id the sidecar carries
+ *  (`testInfo.testId` = `TestCase.id`, unique across files, describes and
+ *  projects); a flaky test's last files are from the attempt that passed. */
+export declare const failedTestIds: (suite: Suite | null) => Set<string>;
+/** The server reads `testStatus` and keeps such a shot out of the review
+ *  and out of the baselines (`failed` diff status). */
+export declare const markFailedTests: (metadata: Record<string, unknown> | undefined, failed: Set<string>) => Record<string, unknown> | undefined;
 declare class PixeyeReporter implements Reporter {
     private options;
     private shard;
     private skipUpload;
     private failOnError;
+    private suite;
     constructor(options?: ReporterOptions);
-    onBegin(config: FullConfig, _suite: Suite): void;
+    onBegin(config: FullConfig, suite: Suite): void;
     onTestEnd(_test: TestCase, _result: TestResult): void;
     onEnd(_result: FullResult): Promise<{
         status: FullResult['status'];

package/dist/reporter.js

@@ -1,6 +1,7 @@
 import { readFile } from 'node:fs/promises';
 import { join } from 'node:path';
-import { detectCIEnvironment, discoverScreenshots, isUploadMisconfig, PixeyeClient, renderUploadFailureBanner, resolveFailOnError, runParallel, uploadErrorSummary } from '@pixeyedev/core';
+import { detectCIEnvironment, discoverScreenshots, isUploadMisconfig, PixeyeClient, renderUploadFailureBanner, resolveFailOnError, runParallel, swapImageExtension, uploadErrorSummary } from '@pixeyedev/core';
+import { CONTENT_TYPE_BY_FORMAT } from '@pixeyedev/shared';
 import { getContext } from './screenshot.js';
 const DEFAULT_UPLOAD_CONCURRENCY = 32;
 const detectShard = (config) => {
@@ -23,16 +24,29 @@ const detectShard = (config) => {
 const detectRunner = () => {
     return 'playwright';
 };
+/** The tests that failed after their retries, by the id the sidecar carries
+ *  (`testInfo.testId` = `TestCase.id`, unique across files, describes and
+ *  projects); a flaky test's last files are from the attempt that passed. */
+export const failedTestIds = (suite) => new Set((suite ? suite.allTests() : [])
+    .filter(test => test.outcome() === 'unexpected')
+    .map(test => test.id));
+/** The server reads `testStatus` and keeps such a shot out of the review
+ *  and out of the baselines (`failed` diff status). */
+export const markFailedTests = (metadata, failed) => metadata && typeof metadata.testId === 'string' && failed.has(metadata.testId)
+    ? { ...metadata, testStatus: 'failed' }
+    : metadata;
 class PixeyeReporter {
     options;
     shard = { index: 0, total: 1 };
     skipUpload = false;
     failOnError;
+    suite = null;
     constructor(options = {}) {
         this.options = options;
         this.failOnError = resolveFailOnError(options.failOnError, process.env.PIXEYE_FAIL_ON_ERROR);
     }
-    onBegin(config, _suite) {
+    onBegin(config, suite) {
+        this.suite = suite;
         const token = this.options.token ?? process.env.PIXEYE_TOKEN;
         if (!token) {
             console.warn('[pixeye] No PIXEYE_TOKEN found. Skipping upload. Screenshots will still be captured.');
@@ -61,8 +75,11 @@ class PixeyeReporter {
         try {
             files = await discoverScreenshots(outputDir);
         }
-        catch {
-            console.log('[pixeye] No screenshots found. Nothing to upload.');
+        catch (err) {
+            // A missing directory yields an empty list, so a THROW here is always a
+            // file we could not read — say which, instead of "no screenshots".
+            console.error(`[pixeye] Could not read screenshots in ${outputDir}.`);
+            console.error(`[pixeye] ${err.message}`);
             return;
         }
         if (files.length === 0) {
@@ -81,7 +98,9 @@ class PixeyeReporter {
         const concurrency = this.options.uploadConcurrency ?? DEFAULT_UPLOAD_CONCURRENCY;
         try {
             const client = new PixeyeClient({ serverUrl: server, token });
-            // 1. Create build
+            // 1. Create build. A run with a failed test is partial: the shots it
+            // never reached are not removed, and keep their baseline.
+            const failed = failedTestIds(this.suite);
             const prNumber = process.env.PIXEYE_PR ? parseInt(process.env.PIXEYE_PR, 10) : ci?.prNumber;
             const buildResponse = await client.createBuild({
                 projectToken: token,
@@ -89,13 +108,16 @@ class PixeyeReporter {
                 branch,
                 prNumber: prNumber && !isNaN(prNumber) ? prNumber : undefined,
                 shardCount: this.shard.total,
+                partial: failed.size > 0,
                 runner,
                 baseBranch: ci?.baseBranch
             });
             const buildId = buildResponse.build.id;
             // 2. Presign upload URLs
             const hashes = files.map(f => f.fileHash);
-            const formats = Object.fromEntries(files.filter(f => f.format === 'webp').map(f => [f.fileHash, 'webp']));
+            // Only non-PNG needs declaring: the server defaults to png. Filtering
+            // on 'webp' alone stored a sniffed jpeg under a .png key.
+            const formats = Object.fromEntries(files.filter(f => f.format !== 'png').map(f => [f.fileHash, f.format]));
             const presign = await client.presignUpload({
                 buildId,
                 hashes,
@@ -117,7 +139,7 @@ class PixeyeReporter {
                         return;
                     }
                     const buffer = await readFile(file.filePath);
-                    const contentType = file.format === 'webp' ? 'image/webp' : 'image/png';
+                    const contentType = CONTENT_TYPE_BY_FORMAT[file.format];
                     await client.uploadFile(url, buffer, contentType);
                     uploaded++;
                 });
@@ -125,7 +147,7 @@ class PixeyeReporter {
             // 4. Read metadata sidecars and build manifest
             const manifest = await Promise.all(files.map(async (f) => {
                 // Try to read companion .meta.json
-                const metaPath = f.filePath.replace(/\.(png|webp)$/, '.meta.json');
+                const metaPath = swapImageExtension(f.filePath, '.meta.json');
                 let metadata;
                 try {
                     const metaContent = await readFile(metaPath, 'utf-8');
@@ -140,7 +162,7 @@ class PixeyeReporter {
                     format: f.format,
                     width: f.width,
                     height: f.height,
-                    metadata
+                    metadata: markFailedTests(metadata, failed)
                 };
             }));
             // 5. Submit shard

package/dist/screenshot.d.ts

@@ -27,6 +27,7 @@ export interface ScreenshotContext {
     outputDir: string;
     testFile: string;
     testName: string;
+    testId?: string;
 }
 export declare const setContext: (ctx: ScreenshotContext) => void;
 export declare const getContext: () => ScreenshotContext | null;

package/dist/screenshot.js

@@ -200,6 +200,7 @@ export const screenshot = async (target, name, options = {}) => {
         colorScheme: options.colorScheme,
         testFile,
         testName,
+        testId: _context?.testId,
         threshold: options.threshold,
         regions: allRegions.length > 0 ? allRegions : undefined,
         componentBounds

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@pixeyedev/playwright",
-  "version": "0.4.5",
+  "version": "0.4.6",
+  "license": "MIT",
   "private": false,
   "type": "module",
   "files": [
@@ -27,6 +28,7 @@
   },
   "scripts": {
     "build": "tsc && cp ../browser/dist/browser.iife.js dist/browser.iife.js",
+    "prepack": "rm -rf dist && npm run build",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
     "lint": "echo 'ok'",