@sentinelqa/playwright-reporter 0.1.30 → 0.1.32

package/README.md

@@ -1,15 +1,21 @@
 # Playwright Reporter
 
+After every failed run, Sentinel prints a shareable debugging link:
+
+👉 https://sentinelqa.com/run/abc123
+
+Open it to inspect failures instantly or share it in Slack, PRs, or GitHub issues.
+
 [![npm](https://img.shields.io/npm/v/@sentinelqa/playwright-reporter)](https://www.npmjs.com/package/@sentinelqa/playwright-reporter)
 [![downloads](https://img.shields.io/npm/dm/@sentinelqa/playwright-reporter)](https://www.npmjs.com/package/@sentinelqa/playwright-reporter)
 [![license](https://img.shields.io/npm/l/@sentinelqa/playwright-reporter)](./LICENSE)
 
-A Playwright reporter that aggregates traces, screenshots, videos, and logs
-into a single debugging report for failed tests.
+From failed CI run → root cause in seconds.
+Get a shareable Playwright debugging link with traces, screenshots, and failure context — no setup required.
 
-Works locally out of the box with no account required.
+Works with no account or API key required.
 
-Optionally upload runs to Sentinel Cloud for CI history and AI failure analysis.
+Use it to get a shareable hosted run link from CI or local development, then upgrade to Sentinel Cloud for richer history and intelligence.
 
 ![Sentinel Report Example](./docs/screenshot.png)
 ![Run-to-Run Diff](./docs/run_diff.png)
@@ -17,24 +23,31 @@ Optionally upload runs to Sentinel Cloud for CI history and AI failure analysis.
 
 ## Features
 
-- Aggregates Playwright traces, screenshots, videos, and logs
-- Generates a local HTML debugging report
-- Prints a deterministic quick diagnosis in the terminal after failed runs
-- Adds a failure digest to the local HTML report
-- Groups similar failures so repeated symptoms are easy to spot
-- Lets you copy debug summaries for Slack, Jira, and GitHub issues
-- Compares the current run to the previous run on the same branch
+- Free hosted debugging links by default, with no account or API key required
+- Public run page that opens on unified failures across the run
+- Within-run failure grouping so repeated failures collapse into one issue
+- Public failure pages with screenshots, evidence, parsed errors and light summaries
+- Copyable share actions for Slack, PRs, and debugging handoff
+- Deterministic quick diagnosis in the terminal after failed runs
+- Playwright traces, screenshots, videos and logs uploaded automatically
+- 48-hour public share links on the free hosted flow
 - Works with existing Playwright reporter setup
-- Optional Sentinel Cloud integration
-- CI run history and AI debugging summaries in cloud mode
+- Optional live failure capture for richer Sentinel Cloud analysis
+- CI run history, retention, and deeper AI debugging in Sentinel Cloud
 
 ## Why this exists
 
-Debugging Playwright CI failures often means downloading traces,
-screenshots, and videos separately.
+Debugging Playwright failures usually means downloading traces, screenshots, and logs separately from CI.
+
+Reporter uploads those artifacts into a single hosted Sentinel run page so you can open one link, inspect failures fast, and share that link with the rest of the team.
 
-Reporter aggregates everything into one debugging report
-so you can quickly understand what failed.
+## Why teams use the free version
+
+- Drop one wrapper into `playwright.config.ts` and keep running `npx playwright test`
+- Get a hosted Sentinel debugging link automatically on failed runs
+- Share one public URL in Slack, PRs, or GitHub issues instead of passing around raw CI artifacts
+- See unified failures, grouped failure patterns, screenshots, and evidence in one place
+- Let teammates inspect the failure without needing your CI system or local machine
 
 ## Requirements
 
@@ -47,8 +60,8 @@ so you can quickly understand what failed.
 
 - best for free and local users
 - zero-friction setup
-- local HTML report works exactly as today
-- cloud upload works when configured
+- hosted Sentinel report link is generated automatically
+- no `SENTINEL_TOKEN` required
 - AI summaries use trace and reporter evidence, but are less precise than live page capture
 
 Install:
@@ -87,58 +100,59 @@ Run your Playwright tests:
 npx playwright test
 ```
 
-If tests fail and `SENTINEL_TOKEN` is not set, Sentinel generates:
+If tests fail, Sentinel uploads a hosted debugging report and prints the shareable link in the terminal.
+
+Open the hosted report to inspect:
 
-- `sentinel-report/index.html`
-- `sentinel-debug.html`
+- failed tests across jobs
+- within-run grouped failures
+- screenshots and videos
+- trace links
+- parsed failure details
+- light summaries
+- shareable public debugging page
 
-Open the report to inspect:
+The free hosted public flow is designed for distribution:
 
-- failure digest
-- similar failure groups
-- run-to-run diff
-- failed tests
-- screenshots
-- videos
-- trace files
-- logs
+- one shareable debugging link per run
+- public read-only pages
+- fast enough to use in CI comments and Slack threads
+- clear upgrade path into a full Sentinel workspace when teams want history, retention, and deeper analysis
 
 ## Modes
 
-### Local mode
+### Free hosted mode
 
-If `SENTINEL_TOKEN` is not set, the reporter generates a local HTML debugging report.
+If `SENTINEL_TOKEN` is not set, the reporter uploads the run to a hosted public Sentinel report and prints the shareable URL.
 
-### Cloud mode
+This free public flow includes:
 
-If `SENTINEL_TOKEN` is set in CI, the reporter uploads the run to Sentinel instead of generating the local HTML report.
+- hosted run page
+- hosted failure pages
+- grouped failures inside the run
+- light summaries
+- copy/share actions
+- 48-hour share links
 
-```bash
-SENTINEL_TOKEN=your_project_ingest_token npx playwright test
-```
-
-For intentional uploads outside CI, also set `SENTINEL_UPLOAD_LOCAL=1` and provide the usual commit and run metadata expected by the uploader.
+### Workspace mode
 
-Example:
+If `SENTINEL_TOKEN` is set, the reporter uploads into your Sentinel workspace instead of the free hosted public flow.
 
 ```bash
-SENTINEL_TOKEN=your_project_ingest_token \
-SENTINEL_UPLOAD_LOCAL=1 \
-GITHUB_SHA=abc123 \
-GITHUB_REF_NAME=main \
-GITHUB_RUN_ID=local-dev \
-npx playwright test
+SENTINEL_TOKEN=your_project_ingest_token npx playwright test
 ```
 
+For local runs outside CI, Sentinel will use your local git metadata automatically when available.
+
 ## What `withSentinel()` does
 
 - Preserves your existing reporter configuration
 - Injects a Playwright JSON reporter if one is missing
-- Reuses your existing Playwright HTML reporter path when configured
 - Sets sensible artifact defaults:
   - trace: `retain-on-failure`
   - screenshot: `only-on-failure`
   - video: `retain-on-failure`
+- Uploads the run to hosted Sentinel at the end of the test run
 
 ## Recommended Cloud Setup
 
@@ -175,7 +189,7 @@ Use this cloud setup when you want:
 - richer DOM-aware diagnosis
 - more reliable code patches grounded in real page state
 
-Free and local-only users do not need this. The standard `withSentinel()` setup remains the simplest path and continues to generate the local report the same way as before.
+Free and local-only users do not need this. The standard `withSentinel()` setup remains the simplest path and will upload a hosted Sentinel report automatically.
 
 ## Options
 
@@ -187,9 +201,6 @@ withSentinel(config, {
   testResultsDir: "test-results",
   artifactDirs: ["tmp/extra-artifacts"],
   verbose: true,
-  localReportDir: "sentinel-report",
-  localReportFileName: "index.html",
-  localRedirectFileName: "sentinel-debug.html",
 });
 ```
 
@@ -202,6 +213,10 @@ Sentinel Cloud adds:
 - AI-generated failure summaries
 - flaky test detection
 - shareable run links
+- longer retention
+- compare against previous runs
+- recurring failure history
+- richer fix suggestions and team workflows
 
 Free for up to 100 CI runs per month.
 Create an account at [sentinelqa.com](https://sentinelqa.com).

package/dist/index.d.ts

@@ -23,9 +23,6 @@ export type SentinelPlaywrightOptions = {
     testResultsDir?: string;
     artifactDirs?: string[];
     verbose?: boolean;
-    localReportDir?: string;
-    localReportFileName?: string;
-    localRedirectFileName?: string;
 };
 export declare function withSentinel(config: PlaywrightConfig, options?: SentinelPlaywrightOptions): PlaywrightConfig;
 export declare function resolveSentinelPaths(config: PlaywrightConfig, options?: SentinelPlaywrightOptions): SentinelResolvedPaths;

package/dist/index.js

@@ -105,10 +105,7 @@ function withSentinel(config, options = {}) {
         playwrightReportDir,
         testResultsDir,
         artifactDirs,
-        verbose: options.verbose ?? false,
-        localReportDir: options.localReportDir,
-        localReportFileName: options.localReportFileName,
-        localRedirectFileName: options.localRedirectFileName
+        verbose: options.verbose ?? false
     };
     const sentinelIndex = reporters.findIndex((entry) => getReporterName(entry) === sentinelReporterPath);
     if (sentinelIndex !== -1) {

package/dist/reporter.d.ts

@@ -5,9 +5,6 @@ type ReporterOptions = {
     testResultsDir: string;
     artifactDirs?: string[];
     verbose?: boolean;
-    localReportDir?: string;
-    localReportFileName?: string;
-    localRedirectFileName?: string;
 };
 declare class SentinelReporter {
     private failedCount;
@@ -16,7 +13,6 @@ declare class SentinelReporter {
     constructor(options: ReporterOptions);
     onBegin(config: any, suite: any): void;
     onTestEnd(test: any, result: any): Promise<void>;
-    private printLocalReport;
     onEnd(): Promise<void>;
 }
 export = SentinelReporter;

package/dist/reporter.js

@@ -1,33 +1,16 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const path_1 = __importDefault(require("path"));
-const url_1 = require("url");
 const node_1 = require("@sentinelqa/uploader/node");
 const env_1 = require("./env");
-const localReport_1 = require("./localReport");
 const quickDiagnosis_1 = require("./quickDiagnosis");
 const { sentinelCaptureFailureContextFromReporter } = require("@sentinelqa/uploader/playwright");
-const pluralize = (count, singular, plural) => {
-    return count === 1 ? singular : plural;
-};
-const formatTerminalLink = (label, target) => {
-    if (!process.stdout.isTTY)
-        return label;
-    return `\u001B]8;;${target}\u0007${label}\u001B]8;;\u0007`;
-};
 const colorize = (value, code) => {
     if (!process.stdout.isTTY)
         return value;
     return `\u001b[${code}m${value}\u001b[0m`;
 };
-const bold = (value) => colorize(value, "1");
 const green = (value) => colorize(value, "32");
-const cyan = (value) => colorize(value, "36");
 const yellow = (value) => colorize(value, "33");
 const dim = (value) => colorize(value, "2");
-const magenta = (value) => colorize(value, "35");
 class SentinelReporter {
     constructor(options) {
         this.failedCount = 0;
@@ -59,75 +42,21 @@ class SentinelReporter {
             this.failedCount += 1;
         }
     }
-    printLocalReport(localReport) {
-        const localReportPath = localReport.htmlPath;
-        const relativeReportPath = path_1.default
-            .relative(process.cwd(), localReportPath)
-            .replace(/\\/g, "/");
-        const displayPath = relativeReportPath.startsWith(".")
-            ? relativeReportPath
-            : `./${relativeReportPath}`;
-        const openCommand = `open ${displayPath}`;
+    async onEnd() {
         console.log("");
         console.log(green("✔ Artifacts collected"));
-        console.log(green("✔ Sentinel HTML debugging report created"));
-        console.log("");
-        console.log(bold("Report"));
-        console.log(`  ${cyan(formatTerminalLink(displayPath, (0, url_1.pathToFileURL)(localReportPath).href))}`);
-        console.log("");
-        console.log(bold("Open"));
-        console.log(`  ${cyan(openCommand)}`);
-        console.log("");
         const quickDiagnosis = (0, quickDiagnosis_1.buildQuickDiagnosis)(this.options.playwrightJsonPath);
         if (quickDiagnosis?.lines.length) {
+            console.log("");
             console.log(yellow("Quick diagnosis"));
             for (const line of quickDiagnosis.lines) {
                 console.log(`  ${dim(line)}`);
             }
-            console.log("");
-        }
-        if (localReport.runDiff) {
-            console.log(yellow("Run-to-run diff"));
-            console.log(`  ${dim(`New failures: ${localReport.runDiff.newFailures.length}`)}`);
-            console.log(`  ${dim(`Fixed since last run: ${localReport.runDiff.fixedTests.length}`)}`);
-            console.log(`  ${dim(`Still failing: ${localReport.runDiff.stillFailing.length}`)}`);
-            console.log("");
-        }
-        console.log(yellow("Tip"));
-        console.log(`  ${dim("Want full AI analysis, shareable run links, and CI history?")}`);
-        console.log(`  ${dim("Try Sentinel Cloud Beta free:")} ${cyan(formatTerminalLink("https://sentinelqa.com", "https://sentinelqa.com"))}`);
-        console.log("");
-        console.log(`  ${magenta("★ If this reporter helped you debug faster,")}`);
-        console.log(`  ${dim("consider starring the project:")}`);
-        console.log(`  ${cyan(formatTerminalLink("https://github.com/adnangradascevic/playwright-reporter", "https://github.com/adnangradascevic/playwright-reporter"))}`);
-    }
-    async onEnd() {
-        const hasSentinelToken = Boolean(process.env.SENTINEL_TOKEN);
-        const hasCiEnv = (0, node_1.hasSupportedCiEnv)(process.env);
-        const localUploadEnabled = (0, node_1.isLocalUploadEnabled)(process.env);
-        if (!hasSentinelToken || (!hasCiEnv && !localUploadEnabled)) {
-            const localReport = (0, localReport_1.generateLocalDebugReport)({
-                playwrightJsonPath: this.options.playwrightJsonPath,
-                playwrightReportDir: this.options.playwrightReportDir,
-                testResultsDir: this.options.testResultsDir,
-                artifactDirs: this.options.artifactDirs || [],
-                reportDir: this.options.localReportDir,
-                reportFileName: this.options.localReportFileName,
-                redirectFileName: this.options.localRedirectFileName
-            });
-            this.printLocalReport(localReport);
-            console.log("");
-            if (hasSentinelToken && !hasCiEnv && !localUploadEnabled) {
-                console.log("Sentinel upload skipped for this local run.");
-                console.log("To upload local runs, set SENTINEL_UPLOAD_LOCAL=1 and provide the required CI metadata.");
-                console.log("");
-            }
-            return;
         }
         console.log("");
-        console.log("Uploading failure artifacts to Sentinel...");
+        console.log("Uploading hosted debugging report to Sentinel...");
         console.log("");
-        const exitCode = await (0, node_1.runSentinelUpload)({
+        const upload = await (0, node_1.runSentinelUpload)({
             playwrightJsonPath: this.options.playwrightJsonPath,
             playwrightReportDir: this.options.playwrightReportDir,
             testResultsDir: this.options.testResultsDir,
@@ -137,11 +66,19 @@ class SentinelReporter {
                 SENTINEL_REPORTER_PROJECT: this.options.project || undefined
             }
         });
-        if (exitCode !== 0) {
-            throw new Error(`Sentinel upload failed with exit code ${exitCode}`);
+        if (upload.exitCode !== 0) {
+            throw new Error(`Sentinel upload failed with exit code ${upload.exitCode}`);
         }
         console.log("");
-        console.log("✔ Uploaded run to Sentinel");
+        console.log("✔ Hosted report uploaded to Sentinel");
+        if (upload.shareRunUrl || upload.internalRunUrl) {
+            console.log("");
+            console.log("Sentinel report");
+            console.log(`  ${upload.shareRunUrl || upload.internalRunUrl}`);
+            if (upload.shareLabel) {
+                console.log(`  ${dim(upload.shareLabel)}`);
+            }
+        }
     }
 }
 module.exports = SentinelReporter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sentinelqa/playwright-reporter",
-  "version": "0.1.30",
+  "version": "0.1.32",
   "private": false,
   "description": "Playwright reporter for CI debugging with optional Sentinel cloud dashboards",
   "license": "MIT",