@sentinelqa/playwright-reporter 0.1.21 → 0.1.23

package/README.md

@@ -93,7 +93,7 @@ If `SENTINEL_TOKEN` is not set, the reporter generates a local HTML debugging re
 
 ### Cloud mode
 
-If `SENTINEL_TOKEN` is set, the reporter uploads the run to Sentinel instead of generating the local HTML report.
+If `SENTINEL_TOKEN` is set in CI, the reporter uploads the run to Sentinel instead of generating the local HTML report.
 
 ```bash
 SENTINEL_TOKEN=your_project_ingest_token npx playwright test
@@ -101,6 +101,17 @@ 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.
 
+Example:
+
+```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
+```
+
 ## What `withSentinel()` does
 
 - Preserves your existing reporter configuration

package/dist/localReport.js

@@ -927,13 +927,11 @@ const buildHtml = (tests, summary, extraArtifacts) => {
           var tracePath = button.getAttribute("data-trace-path");
           if (!tracePath) return;
           try {
-            if (window.location.protocol === "http:" || window.location.protocol === "https:") {
-              var traceUrl = new URL(tracePath, window.location.href).href;
-              button.setAttribute(
-                "href",
-                "https://trace.playwright.dev/?trace=" + encodeURIComponent(traceUrl)
-              );
-            }
+            var traceUrl = new URL(tracePath, window.location.href).href;
+            button.setAttribute(
+              "href",
+              "https://trace.playwright.dev/?trace=" + encodeURIComponent(traceUrl)
+            );
           } catch (_error) {
             // Keep the raw trace file link as fallback.
           }

package/dist/reportServer.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/reportServer.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const http_1 = __importDefault(require("http"));
+const path_1 = __importDefault(require("path"));
+const MIME_TYPES = {
+    ".css": "text/css; charset=utf-8",
+    ".gif": "image/gif",
+    ".html": "text/html; charset=utf-8",
+    ".jpeg": "image/jpeg",
+    ".jpg": "image/jpeg",
+    ".js": "text/javascript; charset=utf-8",
+    ".json": "application/json; charset=utf-8",
+    ".mjs": "text/javascript; charset=utf-8",
+    ".mp4": "video/mp4",
+    ".png": "image/png",
+    ".svg": "image/svg+xml",
+    ".txt": "text/plain; charset=utf-8",
+    ".webm": "video/webm",
+    ".xml": "application/xml; charset=utf-8",
+    ".zip": "application/zip"
+};
+const rootIndex = process.argv.indexOf("--root");
+const portIndex = process.argv.indexOf("--port");
+if (rootIndex === -1 || portIndex === -1) {
+    throw new Error("Expected --root and --port arguments");
+}
+const rootDir = path_1.default.resolve(process.argv[rootIndex + 1] || process.cwd());
+const port = Number(process.argv[portIndex + 1]);
+if (!Number.isInteger(port) || port <= 0) {
+    throw new Error("Expected a valid port");
+}
+const send = (res, statusCode, body) => {
+    res.writeHead(statusCode, { "Content-Type": "text/plain; charset=utf-8" });
+    res.end(body);
+};
+const server = http_1.default.createServer((req, res) => {
+    const requestPath = req.url ? req.url.split("?")[0] : "/";
+    const decodedPath = decodeURIComponent(requestPath || "/");
+    const safePath = path_1.default.normalize(decodedPath).replace(/^(\.\.[/\\])+/, "");
+    const relativePath = safePath === "/" ? "/sentinel-report/index.html" : safePath;
+    const filePath = path_1.default.resolve(rootDir, `.${relativePath}`);
+    if (!filePath.startsWith(rootDir)) {
+        send(res, 403, "Forbidden");
+        return;
+    }
+    let stat;
+    try {
+        stat = fs_1.default.statSync(filePath);
+    }
+    catch {
+        send(res, 404, "Not Found");
+        return;
+    }
+    if (stat.isDirectory()) {
+        send(res, 404, "Not Found");
+        return;
+    }
+    const extension = path_1.default.extname(filePath).toLowerCase();
+    res.writeHead(200, {
+        "Cache-Control": "no-store",
+        "Content-Length": stat.size,
+        "Content-Type": MIME_TYPES[extension] || "application/octet-stream"
+    });
+    fs_1.default.createReadStream(filePath).pipe(res);
+});
+server.listen(port, "127.0.0.1");

package/dist/reporter.js

@@ -2,6 +2,8 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+const child_process_1 = require("child_process");
+const net_1 = __importDefault(require("net"));
 const path_1 = __importDefault(require("path"));
 const url_1 = require("url");
 const node_1 = require("@sentinelqa/uploader/node");
@@ -26,6 +28,47 @@ const cyan = (value) => colorize(value, "36");
 const yellow = (value) => colorize(value, "33");
 const dim = (value) => colorize(value, "2");
 const magenta = (value) => colorize(value, "35");
+const getAvailablePort = () => {
+    return new Promise((resolve, reject) => {
+        const server = net_1.default.createServer();
+        server.unref();
+        server.on("error", reject);
+        server.listen(0, "127.0.0.1", () => {
+            const address = server.address();
+            if (!address || typeof address === "string") {
+                server.close(() => reject(new Error("Failed to acquire a local port")));
+                return;
+            }
+            const port = address.port;
+            server.close((error) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                resolve(port);
+            });
+        });
+    });
+};
+const startLocalReportServer = async (localReportPath) => {
+    const port = await getAvailablePort();
+    const reportServerPath = require.resolve("./reportServer");
+    const rootDir = process.cwd();
+    const relativeReportPath = path_1.default.relative(rootDir, localReportPath).replace(/\\/g, "/");
+    const reportUrlPath = relativeReportPath.startsWith("/")
+        ? relativeReportPath
+        : `/${relativeReportPath}`;
+    const child = (0, child_process_1.spawn)(process.execPath, [reportServerPath, "--root", rootDir, "--port", String(port)], {
+        detached: true,
+        stdio: "ignore"
+    });
+    child.unref();
+    return `http://127.0.0.1:${port}${reportUrlPath}`;
+};
+const updateRedirectPage = (redirectPath, targetUrl) => {
+    const escapedTarget = targetUrl.replace(/"/g, """);
+    require("fs").writeFileSync(redirectPath, `<!doctype html><html lang="en"><head><meta charset="utf-8" /><meta http-equiv="refresh" content="0; url=${escapedTarget}" /><title>Sentinel Playwright Reporter</title></head><body><p>Open <a href="${escapedTarget}">${escapedTarget}</a>.</p></body></html>`, "utf8");
+};
 class SentinelReporter {
     constructor(options) {
         this.failedCount = 0;
@@ -56,23 +99,29 @@ class SentinelReporter {
             this.failedCount += 1;
         }
     }
-    printLocalReport(localReportPath) {
+    printLocalReport(localReportPath, localReportUrl) {
         const relativeReportPath = path_1.default
             .relative(process.cwd(), localReportPath)
             .replace(/\\/g, "/");
         const displayPath = relativeReportPath.startsWith(".")
             ? relativeReportPath
             : `./${relativeReportPath}`;
-        const openCommand = `open ${displayPath}`;
+        const displayTarget = localReportUrl || displayPath;
+        const openCommand = `open ${displayTarget}`;
         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(`  ${cyan(formatTerminalLink(localReportUrl || displayPath, localReportUrl || (0, url_1.pathToFileURL)(localReportPath).href))}`);
         console.log("");
         console.log(bold("Open"));
         console.log(`  ${cyan(openCommand)}`);
+        if (localReportUrl) {
+            console.log("");
+            console.log(yellow("Trace Viewer"));
+            console.log(`  ${dim("Open the localhost report URL above so 'View Trace' works correctly.")}`);
+        }
         console.log("");
         console.log(yellow("Tip"));
         console.log(`  ${dim("Upload runs to Sentinel Cloud for CI history,")}`);
@@ -86,7 +135,9 @@ class SentinelReporter {
     }
     async onEnd() {
         const hasSentinelToken = Boolean(process.env.SENTINEL_TOKEN);
-        if (!hasSentinelToken) {
+        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,
@@ -96,27 +147,26 @@ class SentinelReporter {
                 reportFileName: this.options.localReportFileName,
                 redirectFileName: this.options.localRedirectFileName
             });
-            this.printLocalReport(localReport.htmlPath);
+            let localReportUrl;
+            try {
+                localReportUrl = await startLocalReportServer(localReport.htmlPath);
+                updateRedirectPage(localReport.redirectPath, localReportUrl);
+            }
+            catch {
+                localReportUrl = undefined;
+            }
+            this.printLocalReport(localReport.htmlPath, localReportUrl);
             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;
         }
-        const hasCiEnv = (0, node_1.hasSupportedCiEnv)(process.env);
-        const localUploadEnabled = (0, node_1.isLocalUploadEnabled)(process.env);
         console.log("");
         console.log("Uploading failure artifacts to Sentinel...");
         console.log("");
-        if (!hasCiEnv && !localUploadEnabled) {
-            console.log("Local upload mode detected.");
-            console.log("If this run is outside CI, set SENTINEL_UPLOAD_LOCAL=1 and provide the required CI metadata.");
-            console.log("");
-            console.log("Typical local upload environment variables:");
-            console.log("• SENTINEL_UPLOAD_LOCAL=1");
-            console.log("• CI_COMMIT_SHA or GITHUB_SHA");
-            console.log("• CI_COMMIT_REF_NAME or GITHUB_REF_NAME");
-            console.log("• CI_JOB_URL or a matching run URL");
-            console.log("• CI_PIPELINE_ID or GITHUB_RUN_ID");
-            console.log("");
-        }
         const exitCode = await (0, node_1.runSentinelUpload)({
             playwrightJsonPath: this.options.playwrightJsonPath,
             playwrightReportDir: this.options.playwrightReportDir,

package/package.json

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