@flakiness/playwright 1.3.2 → 1.4.0

package/README.md

@@ -1,3 +1,5 @@
+[![Tests](https://img.shields.io/endpoint?url=https%3A%2F%2Fflakiness.io%2Fapi%2Fbadge%3Finput%3D%257B%2522badgeToken%2522%253A%2522badge-5VBxhivD3vj6ItXSEL9heM%2522%257D)](https://flakiness.io/flakiness/playwright)
+
 # Flakiness.io Playwright Reporter
 
 A custom Playwright test reporter that generates Flakiness Reports from your Playwright test runs. The reporter automatically converts Playwright test results into the standardized [Flakiness JSON format](https://github.com/flakiness/flakiness-report), capturing test outcomes, attachments, system utilization, and environment information.
@@ -20,6 +22,7 @@ A custom Playwright test reporter that generates Flakiness Reports from your Pla
   - [`outputFolder?: string`](#outputfolder-string)
   - [`open?: 'always' | 'never' | 'on-failure'`](#open-always--never--on-failure)
   - [`collectBrowserVersions?: boolean`](#collectbrowserversions-boolean)
+  - [`disableUpload?: boolean`](#disableupload-boolean)
 - [Environment Variables](#environment-variables)
 - [Example Configuration](#example-configuration)
 
@@ -202,6 +205,16 @@ reporter: [
 ]
 ```
 
+### `disableUpload?: boolean`
+
+When set to `true`, the reporter will skip uploading the report to Flakiness.io. The report is still generated locally in the output folder. This is useful for local development or testing the reporter itself. Can also be enabled via the `FLAKINESS_DISABLE_UPLOAD` environment variable.
+
+```typescript
+reporter: [
+  ['@flakiness/playwright', { disableUpload: true }]
+]
+```
+
 ## Environment Variables
 
 The reporter respects the following environment variables:
@@ -209,6 +222,7 @@ The reporter respects the following environment variables:
 - **`FLAKINESS_ACCESS_TOKEN`**: Access token for Flakiness.io uploads (equivalent to `token` option)
 - **`FLAKINESS_ENDPOINT`**: Custom Flakiness.io endpoint URL (equivalent to `endpoint` option)
 - **`FLAKINESS_OUTPUT_DIR`**: Output directory for reports (equivalent to `outputFolder` option)
+- **`FLAKINESS_DISABLE_UPLOAD`**: When set, disables report upload (equivalent to `disableUpload` option)
 
 
 
@@ -228,9 +242,9 @@ export default defineConfig({
       outputFolder: './flakiness-report',
       open: 'on-failure',
       collectBrowserVersions: false,
+      disableUpload: false,
     }]
   ],
   // ... rest of your config
 });
 ```
-

package/lib/playwright-test.js

@@ -3,16 +3,18 @@ import {
   GitWorktree,
   ReportUtils,
   showReport,
+  showReportCommand,
   CPUUtilization,
   RAMUtilization,
   uploadReport,
   writeReport
 } from "@flakiness/sdk";
-import chalk from "chalk";
-import fs from "fs";
-import path from "path";
-const warn = (txt) => console.warn(chalk.yellow(`[flakiness.io] ${txt}`));
-const err = (txt) => console.error(chalk.red(`[flakiness.io] ${txt}`));
+import fs from "node:fs";
+import path from "node:path";
+import * as nodeUtil from "node:util";
+const styleText = (format, text) => nodeUtil.styleText?.(format, text) ?? text;
+const warn = (txt) => console.warn(styleText("yellow", `[flakiness.io] ${txt}`));
+const err = (txt) => console.error(styleText("red", `[flakiness.io] ${txt}`));
 const log = (txt) => console.log(`[flakiness.io] ${txt}`);
 function parseDurationMS(value) {
   if (isNaN(value))
@@ -27,7 +29,7 @@ async function existsAsync(aPath) {
 class FlakinessReporter {
   constructor(_options = {}) {
     this._options = _options;
-    this._outputFolder = path.join(process.cwd(), this._options.outputFolder ?? process.env.FLAKINESS_OUTPUT_DIR ?? "flakiness-report");
+    this._outputFolder = path.resolve(process.cwd(), this._options.outputFolder ?? process.env.FLAKINESS_OUTPUT_DIR ?? "flakiness-report");
     this._sampleSystem = this._sampleSystem.bind(this);
     this._sampleSystem();
   }
@@ -253,25 +255,30 @@ class FlakinessReporter {
   async onExit() {
     if (!this._report)
       return;
-    await uploadReport(this._report, this._attachments, {
-      flakinessAccessToken: this._options.token,
-      flakinessEndpoint: this._options.endpoint
-    });
+    const disableUpload = this._options.disableUpload ?? envBool("FLAKINESS_DISABLE_UPLOAD");
+    if (!disableUpload) {
+      await uploadReport(this._report, this._attachments, {
+        flakinessAccessToken: this._options.token,
+        flakinessEndpoint: this._options.endpoint
+      });
+    }
     const openMode = this._options.open ?? "on-failure";
     const shouldOpen = process.stdin.isTTY && !process.env.CI && (openMode === "always" || openMode === "on-failure" && this._result?.status === "failed");
     if (shouldOpen) {
       await showReport(this._outputFolder);
     } else {
-      const defaultOutputFolder = path.join(process.cwd(), "flakiness-report");
-      const folder = defaultOutputFolder === this._outputFolder ? "" : path.relative(process.cwd(), this._outputFolder);
+      const command = showReportCommand(this._outputFolder);
       console.log(`
 To open last Flakiness report, run:
 
-  ${chalk.cyan(`npx flakiness show ${folder}`)}
+  ${styleText("cyan", command)}
       `);
     }
   }
 }
+function envBool(name) {
+  return ["1", "true"].includes(process.env[name]?.toLowerCase() ?? "");
+}
 function toSTDIOEntry(data) {
   if (Buffer.isBuffer(data))
     return { buffer: data.toString("base64") };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/playwright",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -28,6 +28,7 @@
   "author": "Degu Labs, Inc",
   "license": "MIT",
   "devDependencies": {
+    "@flakiness/playwright": "^1.3.2",
     "@playwright/test": "^1.57.0",
     "@types/node": "^25.0.3",
     "esbuild": "^0.27.2",
@@ -36,12 +37,12 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.27.0",
-    "@flakiness/sdk": "2.2.1",
-    "chalk": "^5.6.2"
+    "@flakiness/flakiness-report": "^0.28.0",
+    "@flakiness/sdk": "2.4.0"
   },
   "scripts": {
     "build": "kubik build.mts",
-    "watch": "kubik build.mts -w"
+    "watch": "kubik build.mts -w",
+    "test": "playwright test"
   }
 }

package/types/src/playwright-test.d.ts

@@ -20,6 +20,7 @@ export default class FlakinessReporter implements Reporter {
         outputFolder?: string;
         open?: OpenMode;
         collectBrowserVersions?: boolean;
+        disableUpload?: boolean;
     });
     private _sampleSystem;
     printsToStdio(): boolean;

package/types/src/playwright-test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"playwright-test.d.ts","sourceRoot":"","sources":["../../src/playwright-test.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EACV,UAAU,EAEV,UAAU,EAEV,QAAQ,EACR,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAEvC,MAAM,2BAA2B,CAAC;AA6BnC,KAAK,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;AAElD,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,QAAQ;IAgB5C,OAAO,CAAC,QAAQ;IAf5B,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,mBAAmB,CAAmB;IAE9C,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,OAAO,CAAC,CAAY;IAC5B,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,OAAO,CAAC,CAAa;IAE7B,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAErB,QAAQ,GAAE;QAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,sBAAsB,CAAC,EAAE,OAAO,CAAC;KAC7B;IAON,OAAO,CAAC,aAAa;IAMrB,aAAa,IAAI,OAAO;IAIxB,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IAKxC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI/B,WAAW,CAAC,IAAI,EAAE,QAAQ;IAG1B,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;YAM9B,WAAW;YAsBX,SAAS;YAWT,eAAe;IAmD7B,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,cAAc;IAUhB,KAAK,CAAC,MAAM,EAAE,UAAU;IAkGxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA0B9B"}
+{"version":3,"file":"playwright-test.d.ts","sourceRoot":"","sources":["../../src/playwright-test.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EACV,UAAU,EAEV,UAAU,EAEV,QAAQ,EACR,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAEvC,MAAM,2BAA2B,CAAC;AAgCnC,KAAK,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;AAElD,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,QAAQ;IAgB5C,OAAO,CAAC,QAAQ;IAf5B,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,mBAAmB,CAAmB;IAE9C,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,eAAe,CAAyC;IAChE,OAAO,CAAC,OAAO,CAAC,CAAY;IAC5B,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,OAAO,CAAC,CAAa;IAE7B,OAAO,CAAC,eAAe,CAAC,CAAiB;gBAErB,QAAQ,GAAE;QAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,aAAa,CAAC,EAAE,OAAO,CAAC;KACpB;IAON,OAAO,CAAC,aAAa;IAMrB,aAAa,IAAI,OAAO;IAIxB,OAAO,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,KAAK;IAKxC,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI;IAI/B,WAAW,CAAC,IAAI,EAAE,QAAQ;IAG1B,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;YAM9B,WAAW;YAsBX,SAAS;YAWT,eAAe;IAmD7B,OAAO,CAAC,aAAa;IAmBrB,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,cAAc;IAUhB,KAAK,CAAC,MAAM,EAAE,UAAU;IAkGxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA4B9B"}