@sentinelqa/playwright 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) SentinelQA
+
+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/README.md

@@ -0,0 +1,54 @@
+# @sentinelqa/playwright
+
+Playwright config wrapper and reporter for SentinelQA.
+
+## Install
+
+```bash
+npm i -D @sentinelqa/playwright
+```
+
+## Usage
+
+```ts
+import { defineConfig } from "@playwright/test";
+import { withSentinel } from "@sentinelqa/playwright";
+
+export default withSentinel(
+  defineConfig({
+    use: {
+      trace: "retain-on-failure",
+      screenshot: "only-on-failure",
+      video: "retain-on-failure"
+    }
+  }),
+  {
+    project: "my-app"
+  }
+);
+```
+
+Set your ingest token in CI:
+
+```bash
+SENTINEL_TOKEN=your_project_ingest_token
+```
+
+Then keep your existing Playwright command:
+
+```bash
+npx playwright test
+```
+
+## What it does
+
+- Ensures a Playwright JSON report is written
+- Ensures the Playwright HTML report is written
+- Uploads `playwright-report/` and `test-results/` to Sentinel after the run
+- Preserves the same Sentinel link output as the uploader CLI
+
+## Notes
+
+- Uploads run only when `SENTINEL_TOKEN` is set
+- Uploads currently require GitHub Actions, GitLab CI, or CircleCI metadata
+- Local runs keep working; upload is skipped outside supported CI providers

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+type ReporterEntry = string | [string] | [string, Record<string, unknown>];
+type PlaywrightUseOptions = {
+    trace?: string;
+    screenshot?: string;
+    video?: string;
+};
+type PlaywrightConfig = {
+    reporter?: ReporterEntry | ReporterEntry[];
+    outputDir?: string;
+    use?: PlaywrightUseOptions;
+    [key: string]: unknown;
+};
+export type SentinelPlaywrightOptions = {
+    project?: string;
+    playwrightJsonPath?: string;
+    playwrightReportDir?: string;
+    testResultsDir?: string;
+    artifactDirs?: string[];
+};
+export declare function withSentinel(config: PlaywrightConfig, options?: SentinelPlaywrightOptions): PlaywrightConfig;
+export {};

package/dist/index.js

@@ -0,0 +1,84 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withSentinel = withSentinel;
+const path_1 = __importDefault(require("path"));
+const DEFAULT_REPORT_DIR = "playwright-report";
+const DEFAULT_TEST_RESULTS_DIR = "test-results";
+const cloneEntry = (entry) => {
+    if (!Array.isArray(entry))
+        return entry;
+    const [name, options] = entry;
+    return options ? [name, { ...options }] : [name];
+};
+const normalizeReporter = (reporter) => {
+    if (!reporter)
+        return [];
+    if (!Array.isArray(reporter))
+        return [cloneEntry(reporter)];
+    if (reporter.length === 0)
+        return [];
+    const maybeTuple = typeof reporter[0] === "string" &&
+        (reporter.length === 1 ||
+            (reporter.length === 2 &&
+                !Array.isArray(reporter[1]) &&
+                typeof reporter[1] === "object"));
+    if (maybeTuple) {
+        return [cloneEntry(reporter)];
+    }
+    return reporter.map(cloneEntry);
+};
+const getReporterName = (entry) => {
+    return Array.isArray(entry) ? entry[0] : entry;
+};
+const setReporterOptions = (reporters, name, options) => {
+    const index = reporters.findIndex((entry) => getReporterName(entry) === name);
+    if (index === -1) {
+        reporters.push([name, options]);
+        return;
+    }
+    const existing = reporters[index];
+    if (Array.isArray(existing)) {
+        reporters[index] = [name, { ...(existing[1] || {}), ...options }];
+        return;
+    }
+    reporters[index] = [name, options];
+};
+function withSentinel(config, options = {}) {
+    const nextConfig = {
+        ...config,
+        use: {
+            ...config.use,
+            trace: config.use?.trace || "retain-on-failure",
+            screenshot: config.use?.screenshot || "only-on-failure",
+            video: config.use?.video || "retain-on-failure"
+        }
+    };
+    const testResultsDir = options.testResultsDir || config.outputDir || DEFAULT_TEST_RESULTS_DIR;
+    const playwrightReportDir = options.playwrightReportDir || DEFAULT_REPORT_DIR;
+    const playwrightJsonPath = options.playwrightJsonPath || path_1.default.join(playwrightReportDir, "report.json");
+    nextConfig.outputDir = testResultsDir;
+    const reporters = normalizeReporter(config.reporter);
+    setReporterOptions(reporters, "json", { outputFile: playwrightJsonPath });
+    setReporterOptions(reporters, "html", {
+        outputFolder: playwrightReportDir,
+        open: "never"
+    });
+    const sentinelReporterPath = require.resolve("./reporter");
+    const sentinelReporterOptions = {
+        project: options.project || null,
+        playwrightJsonPath,
+        playwrightReportDir,
+        testResultsDir,
+        artifactDirs: options.artifactDirs || []
+    };
+    const sentinelIndex = reporters.findIndex((entry) => getReporterName(entry) === sentinelReporterPath);
+    if (sentinelIndex !== -1) {
+        reporters.splice(sentinelIndex, 1);
+    }
+    reporters.push([sentinelReporterPath, sentinelReporterOptions]);
+    nextConfig.reporter = reporters;
+    return nextConfig;
+}

package/dist/reporter.d.ts

@@ -0,0 +1,17 @@
+type ReporterOptions = {
+    project?: string | null;
+    playwrightJsonPath: string;
+    playwrightReportDir: string;
+    testResultsDir: string;
+    artifactDirs?: string[];
+};
+declare class SentinelReporter {
+    private failedCount;
+    private totalCount;
+    private options;
+    constructor(options: ReporterOptions);
+    onBegin(config: any, suite: any): void;
+    onTestEnd(_test: any, result: any): void;
+    onEnd(): Promise<void>;
+}
+export = SentinelReporter;

package/dist/reporter.js

@@ -0,0 +1,56 @@
+"use strict";
+const node_1 = require("@sentinelqa/uploader/node");
+const pluralize = (count, singular, plural) => {
+    return count === 1 ? singular : plural;
+};
+class SentinelReporter {
+    constructor(options) {
+        this.failedCount = 0;
+        this.totalCount = 0;
+        this.options = options;
+    }
+    onBegin(config, suite) {
+        this.totalCount = typeof suite?.allTests === "function" ? suite.allTests().length : 0;
+        if (config?.projects?.length && !this.options.project) {
+            this.options.project = config.projects[0]?.name || null;
+        }
+    }
+    onTestEnd(_test, result) {
+        if (!result)
+            return;
+        if (["failed", "timedOut", "interrupted"].includes(result.status)) {
+            this.failedCount += 1;
+        }
+    }
+    async onEnd() {
+        console.log("Playwright run finished");
+        console.log(`${this.failedCount} ${pluralize(this.failedCount, "test", "tests")} failed`);
+        if (!process.env.SENTINEL_TOKEN) {
+            return;
+        }
+        if (!(0, node_1.hasSupportedCiEnv)(process.env)) {
+            console.log("");
+            console.log("Skipping Sentinel upload because no supported CI environment was detected.");
+            return;
+        }
+        console.log("");
+        console.log("Uploading failure artifacts to Sentinel...");
+        console.log("");
+        const exitCode = await (0, node_1.runSentinelUpload)({
+            playwrightJsonPath: this.options.playwrightJsonPath,
+            playwrightReportDir: this.options.playwrightReportDir,
+            testResultsDir: this.options.testResultsDir,
+            artifactDirs: this.options.artifactDirs || [],
+            suppressSummaryJson: true,
+            env: {
+                SENTINEL_REPORTER_PROJECT: this.options.project || undefined
+            }
+        });
+        if (exitCode !== 0) {
+            throw new Error(`Sentinel upload failed with exit code ${exitCode}`);
+        }
+        console.log("");
+        console.log("✔ Uploaded run to Sentinel");
+    }
+}
+module.exports = SentinelReporter;

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@sentinelqa/playwright",
+  "version": "0.1.0",
+  "private": false,
+  "description": "Playwright config wrapper and reporter for SentinelQA",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sentinelqa/sentinel"
+  },
+  "keywords": [
+    "sentinelqa",
+    "playwright",
+    "ci",
+    "debugging",
+    "reporter"
+  ],
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./reporter": "./dist/reporter.js"
+  },
+  "peerDependencies": {
+    "@playwright/test": ">=1.40.0"
+  },
+  "dependencies": {
+    "@sentinelqa/uploader": "^0.1.20"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "publish:dry": "npm run build && npm pack --dry-run"
+  }
+}