@testivai/witness-playwright 1.8.0 → 2.0.0

package/dist/reporter.js

@@ -32,37 +32,20 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestivAIPlaywrightReporter = void 0;
 const fs = __importStar(require("fs-extra"));
 const path = __importStar(require("path"));
-const simple_git_1 = __importDefault(require("simple-git"));
-const axios_1 = __importDefault(require("axios"));
-const ci_1 = require("./ci");
-const common_1 = require("@testivai/common");
-const mode_1 = require("./mode");
+const witness_1 = require("@testivai/witness");
 class TestivAIPlaywrightReporter {
     constructor(options = {}) {
-        this.gitInfo = null;
-        this.browserInfo = null;
-        this.runId = null;
-        this.ciInfo = null;
         this.tempDir = path.join(process.cwd(), '.testivai', 'temp');
-        this.localMode = false;
         this.captureOnly = false;
         this.shard = null;
         this.options = {
-            apiUrl: options.apiUrl || process.env.TESTIVAI_API_URL || 'https://core-api.testiv.ai',
-            apiKey: options.apiKey || process.env.TESTIVAI_API_KEY,
-            compression: options.compression || {},
             debug: options.debug || process.env.TESTIVAI_DEBUG === 'true',
             captureOnly: options.captureOnly,
         };
-        // Initialize compression helper
-        this.compressionHelper = new common_1.CompressionHelper(this.options.compression);
     }
     /**
      * Capture-only resolution, most explicit wins:
@@ -70,65 +53,16 @@ class TestivAIPlaywrightReporter {
      *   2. TESTIVAI_CAPTURE_ONLY — for CI that can't edit playwright.config
      *   3. auto: Playwright says this is shard i/N with N > 1
      */
-    resolveCaptureOnly(config) {
-        if (typeof this.options.captureOnly === 'boolean')
-            return this.options.captureOnly;
-        const env = process.env.TESTIVAI_CAPTURE_ONLY;
-        if (env !== undefined && env !== '')
-            return env !== '0' && env.toLowerCase() !== 'false';
-        return !!(this.shard && this.shard.total > 1);
+    resolveCaptureOnly(_config) {
+        return (0, witness_1.resolveCaptureOnly)(this.options.captureOnly, this.shard);
     }
-    async onBegin(config, suite) {
-        this.shard = config.shard ?? null;
+    async onBegin(config, _suite) {
+        // Playwright's own --shard wins; TESTIVAI_SHARD covers CI that splits work
+        // some other way, and is the same contract the non-JS adapters honour.
+        this.shard = config.shard ?? (0, witness_1.parseShardEnv)(process.env.TESTIVAI_SHARD);
         this.captureOnly = this.resolveCaptureOnly(config);
-        // Resolve mode. Local-first is the default: with no API key we capture
-        // and report locally rather than disabling the reporter. Cloud mode
-        // activates only when a key is present (or config/env force it).
-        this.localMode = (0, mode_1.resolveLocalMode)({ apiKey: this.options.apiKey });
-        if (this.localMode) {
-            process.env.TESTIVAI_MODE = 'local';
-            // One quiet, friendly line — not a scary "disabling reporter" error.
-            if (!this.options.apiKey && !process.env.TESTIVAI_MODE_ANNOUNCED) {
-                console.log('TestivAI: no API key set — running in local mode (report → visual-report/index.html).');
-                process.env.TESTIVAI_MODE_ANNOUNCED = '1';
-            }
-        }
-        // 1. Clean temp directory
+        // Clean temp directory
         await fs.emptyDir(this.tempDir);
-        // 2. Capture Git metadata
-        try {
-            const git = (0, simple_git_1.default)();
-            const [branch, commit] = await Promise.all([
-                git.revparse(['--abbrev-ref', 'HEAD']),
-                git.revparse(['HEAD']),
-            ]);
-            this.gitInfo = { branch, commit };
-        }
-        catch (error) {
-            console.error('Testivai Reporter: Could not get Git information.', error);
-            this.gitInfo = { branch: 'unknown', commit: 'unknown' };
-        }
-        // 3. Capture Browser info from the first project
-        const project = suite.suites[0]?.project();
-        if (project) {
-            this.browserInfo = {
-                name: project.use.browserName || 'unknown',
-                version: 'unknown', // Playwright does not easily expose browser version
-                viewportWidth: project.use.viewport?.width || 0,
-                viewportHeight: project.use.viewport?.height || 0,
-                userAgent: project.use.userAgent || 'unknown',
-                os: 'unknown',
-            };
-        }
-        // 4. Get CI Run ID and CI info
-        this.runId = (0, ci_1.getCiRunId)();
-        this.ciInfo = (0, ci_1.getCiInfo)();
-        if (this.runId && this.options.debug) {
-            console.log(`Testivai Reporter: [DEBUG] Detected CI environment. Run ID: ${this.runId}`);
-            if (this.ciInfo) {
-                console.log(`Testivai Reporter: [DEBUG] CI Info: provider=${this.ciInfo.provider}, PR=#${this.ciInfo.prNumber || 'N/A'}`);
-            }
-        }
     }
     async onEnd(result) {
         // Wrap entire reporter logic in try-catch to prevent crashes
@@ -145,24 +79,10 @@ class TestivAIPlaywrightReporter {
                 // Without this a crashed shard silently reduces coverage whenever
                 // failOnMissing is off.
                 if (this.shard) {
-                    try {
-                        const tempRoot = path.join(process.cwd(), '.testivai', 'temp');
-                        fs.ensureDirSync(tempRoot);
-                        const captures = fs
-                            .readdirSync(tempRoot, { withFileTypes: true })
-                            .filter((e) => e.isDirectory())
-                            .map((e) => e.name);
-                        fs.writeJsonSync(path.join(tempRoot, 'testivai-shard.json'), {
-                            shard: { current: this.shard.current, total: this.shard.total },
-                            captures,
-                            status: result.status,
-                            timestamp: new Date().toISOString(),
-                        });
-                    }
-                    catch {
-                        // A manifest we cannot write must not fail the test run; the merge
-                        // step degrades to "no completeness check" and says so.
-                    }
+                    (0, witness_1.writeShardManifest)(path.join(process.cwd(), '.testivai', 'temp'), this.shard, {
+                        complete: true,
+                        status: result.status,
+                    });
                 }
                 const where = this.shard ? `shard ${this.shard.current}/${this.shard.total}` : 'capture-only mode';
                 console.log(`\n  TestivAI: ${where} — captured to .testivai/temp/, comparison skipped.`);
@@ -170,182 +90,49 @@ class TestivAIPlaywrightReporter {
                 console.log('    npx testivai merge-captures <dirs...> && npx testivai report --fail-on-diff');
                 return;
             }
-            // ── Local mode: generate HTML report instead of uploading ─────────────────
-            if (this.localMode) {
-                if (this.options.debug) {
-                    console.log('Testivai Reporter: [DEBUG] Local mode - generating visual report...');
-                }
-                // Dynamic import of @testivai/witness/report for local mode
-                const { generateReport } = await Promise.resolve().then(() => __importStar(require('@testivai/witness/report')));
-                // Load local config for report settings
-                const localConfigPath = path.join(process.cwd(), '.testivai', 'config.json');
-                const localConfig = fs.existsSync(localConfigPath)
-                    ? fs.readJsonSync(localConfigPath)
-                    : { threshold: 0.1, reportDir: 'visual-report', autoOpen: false };
-                const reportData = generateReport({
-                    projectRoot: process.cwd(),
-                    reportDir: localConfig.reportDir || 'visual-report',
-                    threshold: localConfig.threshold,
-                    autoOpen: localConfig.autoOpen,
-                });
-                // Print summary
-                const { summary } = reportData;
-                const missing = reportData.missingBaselines?.length ?? 0;
-                console.log(`\n  ═══ TestivAI Visual Report ═══`);
-                console.log(`  Total: ${summary.total}  |  Passed: ${summary.passed}  |  Changed: ${summary.changed}  |  New: ${summary.newSnapshots}`);
-                if (missing > 0) {
-                    console.log(`  Missing baselines (no capture this run): ${missing}`);
-                }
-                // A reporter cannot change the process exit code — Playwright owns it,
-                // and it reflects test results, not visual results. Saying nothing here
-                // meant a run could print "Changed: 3" and still exit 0, which reads
-                // like a check that passed. State it plainly and name the gate.
-                if (summary.changed > 0 || summary.newSnapshots > 0 || missing > 0) {
-                    console.log(`\n  ⚠  This did NOT fail the build — a reporter cannot set the exit code.`);
-                    console.log(`     Gate it in CI:  npx testivai report --fail-on-diff`);
-                    console.log(`     To approve:     npx testivai approve --all`);
-                }
-                if (this.options.debug) {
-                    console.log(`Testivai Reporter: [DEBUG] Report generated at ${path.join(process.cwd(), localConfig.reportDir || 'visual-report')}`);
-                }
-                return;
-            }
-            // ── Cloud mode: upload to TestivAI API ────────────────────────────────────
-            if (!this.options.apiUrl) {
-                return; // Reporter is disabled
-            }
+            // ── Generate the HTML report ──────────────────────────────────────────
             if (this.options.debug) {
-                console.log('Testivai Reporter: [DEBUG] Test run finished. Preparing to upload evidence...');
+                console.log('Testivai Reporter: [DEBUG] Generating visual report...');
             }
-            const snapshotFiles = await fs.readdir(this.tempDir);
-            // Filter out .css.json files - they're not metadata files
-            const jsonFiles = snapshotFiles.filter(f => f.endsWith('.json') && !f.endsWith('.css.json'));
-            if (jsonFiles.length === 0) {
-                if (this.options.debug) {
-                    console.log('Testivai Reporter: [DEBUG] No snapshots found to upload.');
-                }
-                return;
-            }
-            if (this.options.debug) {
-                console.log(`Testivai Reporter: [DEBUG] Found ${jsonFiles.length} snapshot(s) to process`);
-            }
-            // Build snapshots array matching Witness SDK format
-            const snapshots = [];
-            for (const jsonFile of jsonFiles) {
-                const metadataPath = path.join(this.tempDir, jsonFile);
-                const metadata = await fs.readJson(metadataPath);
-                // Null safety: ensure metadata has required structure
-                // @renamed: dom → structure, css → styles (IP protection)
-                const structurePath = metadata.files.structure;
-                const screenshotPath = metadata.files.screenshot;
-                const stylesPath = metadata.files.styles;
-                if (!metadata.files || !structurePath || !screenshotPath) {
-                    console.warn(`Testivai Reporter: Invalid metadata structure in ${jsonFile}, skipping...`);
-                    continue;
-                }
-                // Extract the first selector's layout data (usually 'body')
-                const layoutKeys = Object.keys(metadata.layout || {});
-                if (layoutKeys.length === 0) {
-                    console.warn(`Testivai Reporter: No layout data found for ${metadata.snapshotName}, skipping...`);
-                    continue;
-                }
-                const firstSelector = layoutKeys[0];
-                const layoutData = metadata.layout[firstSelector];
-                // Read screenshot and encode to base64
-                const screenshotBuffer = await fs.readFile(screenshotPath);
-                const screenshotBase64 = screenshotBuffer.toString('base64');
-                // Read computed styles if available
-                // @renamed: cssData → stylesData (IP protection)
-                let stylesData;
-                if (stylesPath && await fs.pathExists(stylesPath)) {
-                    try {
-                        const stylesJson = await fs.readJson(stylesPath);
-                        if (stylesJson.computed_styles && Object.keys(stylesJson.computed_styles).length > 0) {
-                            stylesData = { computed_styles: stylesJson.computed_styles };
-                        }
-                    }
-                    catch (err) {
-                        if (this.options.debug) {
-                            console.warn(`Testivai Reporter: [DEBUG] Failed to read styles file for ${metadata.snapshotName}:`, err);
-                        }
-                    }
-                }
-                // @renamed: dom → structure, css → styles (IP protection)
-                const snapshotPayload = {
-                    snapshotName: metadata.snapshotName,
-                    testName: metadata.testName,
-                    timestamp: metadata.timestamp,
-                    url: metadata.url,
-                    viewport: metadata.viewport,
-                    structure: { html: await fs.readFile(structurePath, 'utf-8') },
-                    styles: stylesData,
-                    layout: {
-                        x: layoutData.x,
-                        y: layoutData.y,
-                        width: layoutData.width,
-                        height: layoutData.height,
-                        top: layoutData.y,
-                        left: layoutData.x,
-                        right: layoutData.x + layoutData.width,
-                        bottom: layoutData.y + layoutData.height
-                    },
-                    testivaiConfig: metadata.testivaiConfig,
-                    screenshotData: screenshotBase64,
-                    performanceMetrics: metadata.performanceMetrics
-                };
-                snapshots.push(snapshotPayload);
-            }
-            // Build batch payload matching Witness SDK format
-            const batchPayload = {
-                git: this.gitInfo,
-                browser: this.browserInfo,
-                snapshots,
-                timestamp: Date.now(),
-                runId: this.runId,
-                ci: this.ciInfo,
-            };
-            // Compress and upload (same as Witness SDK)
-            const payloadJson = JSON.stringify(batchPayload);
-            const compressionResult = await this.compressionHelper.compress(payloadJson);
-            if (this.options.debug && compressionResult.compressionRatio > 0) {
-                this.compressionHelper.logCompressionResult(compressionResult);
-            }
-            const headers = {
-                'X-API-KEY': this.options.apiKey,
-                'Content-Type': 'application/json',
-                ...compressionResult.headers,
-            };
-            // Upload to same endpoint as Witness SDK
-            const startBatchResponse = await axios_1.default.post(`${this.options.apiUrl}/api/v1/ingest/start-batch`, compressionResult.data, { headers });
-            const batchId = startBatchResponse.data.batch_id || startBatchResponse.data.batchId;
-            // Show success message (brief in normal mode, detailed in debug mode)
-            if (this.options.debug) {
-                console.log(`Testivai Reporter: [DEBUG] ✓ Uploaded ${snapshots.length} snapshot(s) (Batch ID: ${batchId})`);
+            // Dynamic import of @testivai/witness/report
+            const { generateReport } = await Promise.resolve().then(() => __importStar(require('@testivai/witness/report')));
+            // Load local config for report settings
+            const localConfigPath = path.join(process.cwd(), '.testivai', 'config.json');
+            const localConfig = fs.existsSync(localConfigPath)
+                ? fs.readJsonSync(localConfigPath)
+                : { threshold: 0.1, reportDir: 'visual-report', autoOpen: false };
+            const reportData = generateReport({
+                projectRoot: process.cwd(),
+                reportDir: localConfig.reportDir || 'visual-report',
+                threshold: localConfig.threshold,
+                autoOpen: localConfig.autoOpen,
+            });
+            // Print summary
+            const { summary } = reportData;
+            const missing = reportData.missingBaselines?.length ?? 0;
+            console.log(`\n  === TestivAI Visual Report ===`);
+            console.log(`  Total: ${summary.total}  |  Passed: ${summary.passed}  |  Changed: ${summary.changed}  |  New: ${summary.newSnapshots}`);
+            if (missing > 0) {
+                console.log(`  Missing baselines (no capture this run): ${missing}`);
             }
-            else {
-                console.log(`Testivai Reporter: ✓ Uploaded ${snapshots.length} snapshot(s)`);
+            // A reporter cannot change the process exit code — Playwright owns it,
+            // and it reflects test results, not visual results. Saying nothing here
+            // meant a run could print "Changed: 3" and still exit 0, which reads
+            // like a check that passed. State it plainly and name the gate.
+            if (summary.changed > 0 || summary.newSnapshots > 0 || missing > 0) {
+                console.log(`\n  NOTE: this did NOT fail the build — a reporter cannot set the exit code.`);
+                console.log(`     Gate it in CI:  npx testivai report --fail-on-diff`);
+                console.log(`     To approve:     npx testivai approve --all`);
             }
-            // Clean up temp files (skip if DEBUG mode is enabled)
             if (this.options.debug) {
-                console.log(`Testivai Reporter: [DEBUG] Keeping temporary evidence files in: ${this.tempDir}`);
+                console.log(`Testivai Reporter: [DEBUG] Report generated at ${path.join(process.cwd(), localConfig.reportDir || 'visual-report')}`);
             }
-            else {
-                await fs.emptyDir(this.tempDir);
-            }
-            // Finalize batch
-            await axios_1.default.post(`${this.options.apiUrl}/api/v1/ingest/finish-batch/${batchId}`, {}, {
-                headers: { 'X-API-KEY': this.options.apiKey },
-            });
         }
         catch (error) {
             // Log error but don't throw - let tests complete normally
-            console.error('Testivai Reporter: ❌ Error:', error.message);
+            console.error('Testivai Reporter: Error:', error.message);
             if (this.options.debug) {
                 console.error('Error stack:', error.stack);
-                if (error.response) {
-                    console.error('Response status:', error.response.status);
-                    console.error('Response data:', JSON.stringify(error.response.data, null, 2));
-                }
             }
             // Don't throw - reporter errors should not crash the test run
         }

package/dist/snapshot.d.ts

@@ -1,5 +1,5 @@
-import { Page, TestInfo } from '@playwright/test';
-import { TestivAIConfig } from './types';
+import type { Page, TestInfo } from '@playwright/test';
+import type { TestivAIConfig } from './types';
 /**
  * Compute the effective snapshot name, folding in a project variant when the
  * Playwright config runs multiple projects. Without this, two projects (e.g.