@flakiness/playwright 0.150.0 → 0.152.0

package/lib/playwright-test.js

@@ -4,7 +4,8 @@ import {
   GitWorktree,
   ReportUtils,
   showReport,
-  SystemUtilizationSampler,
+  CPUUtilization,
+  RAMUtilization,
   uploadReport,
   writeReport
 } from "@flakiness/sdk";
@@ -27,16 +28,25 @@ var FlakinessReporter = class {
   constructor(_options = {}) {
     this._options = _options;
     this._outputFolder = path.join(process.cwd(), this._options.outputFolder ?? process.env.FLAKINESS_OUTPUT_DIR ?? "flakiness-report");
+    this._sampleSystem = this._sampleSystem.bind(this);
+    this._sampleSystem();
   }
   _config;
   _rootSuite;
   _results = /* @__PURE__ */ new Map();
   _unattributedErrors = [];
-  _systemUtilizationSampler = new SystemUtilizationSampler();
+  _cpuUtilization = new CPUUtilization({ precision: 10 });
+  _ramUtilization = new RAMUtilization({ precision: 10 });
   _report;
   _attachments = [];
   _outputFolder;
   _result;
+  _telemetryTimer;
+  _sampleSystem() {
+    this._cpuUtilization.sample();
+    this._ramUtilization.sample();
+    this._telemetryTimer = setTimeout(this._sampleSystem, 1e3);
+  }
   printsToStdio() {
     return false;
   }
@@ -156,7 +166,9 @@ var FlakinessReporter = class {
     };
   }
   async onEnd(result) {
-    this._systemUtilizationSampler.dispose();
+    clearTimeout(this._telemetryTimer);
+    this._cpuUtilization.sample();
+    this._ramUtilization.sample();
     if (!this._config || !this._rootSuite)
       throw new Error("ERROR: failed to resolve config");
     let commitId;
@@ -212,20 +224,21 @@ var FlakinessReporter = class {
     for (let envIdx = 0; envIdx < environments.length; ++envIdx)
       context.project2environmentIdx.set(this._config.projects[envIdx], envIdx);
     const report = ReportUtils.normalizeReport({
+      version: 1,
       category: "playwright",
       commitId: worktree.headCommitId(),
       relatedCommitIds: [],
-      systemUtilization: this._systemUtilizationSampler.result,
       configPath,
       url: CIUtils.runUrl(),
       environments,
       suites: await this._toFKSuites(context, this._rootSuite),
-      opaqueData: this._config,
       unattributedErrors: this._unattributedErrors.map((e) => this._toFKTestError(context, e)),
       duration: parseDurationMS(result.duration),
       startTimestamp: +result.startTime
     });
-    ReportUtils.createTestStepSnippetsInplace(worktree, report);
+    ReportUtils.collectSources(worktree, report);
+    this._cpuUtilization.enrich(report);
+    this._ramUtilization.enrich(report);
     for (const unaccessibleAttachment of context.unaccessibleAttachmentPaths)
       warn(`cannot access attachment ${unaccessibleAttachment}`);
     this._report = report;
@@ -274,8 +287,7 @@ function createEnvironments(projects) {
     delete metadata.gitDiff;
     result.set(project, ReportUtils.createEnvironment({
       name,
-      userSuppliedData: metadata,
-      opaqueData: { project }
+      metadata
     }));
   }
   return result;

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@flakiness/playwright",
-  "version": "0.150.0",
+  "version": "0.152.0",
   "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flakiness/playwright.git"
+  },
   "exports": {
     ".": {
       "types": "./types/src/playwright-test.d.ts",
@@ -10,13 +14,21 @@
     }
   },
   "type": "module",
-  "description": "",
+  "description": "A custom Playwright test reporter that generates Flakiness Reports from your Playwright test runs",
   "types": "./types/index.d.ts",
   "scripts": {
     "minor": "./version.mjs minor",
     "patch": "./version.mjs patch"
   },
-  "keywords": [],
+  "keywords": [
+    "playwright",
+    "test",
+    "reporter",
+    "flakiness",
+    "testing",
+    "e2e",
+    "test-reporting"
+  ],
   "author": "Degu Labs, Inc",
   "license": "MIT",
   "devDependencies": {
@@ -27,7 +39,7 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@flakiness/sdk": "^0.150.2",
+    "@flakiness/sdk": "^0.152.0",
     "chalk": "^5.6.2"
   }
 }

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

@@ -6,11 +6,13 @@ export default class FlakinessReporter implements Reporter {
     private _rootSuite?;
     private _results;
     private _unattributedErrors;
-    private _systemUtilizationSampler;
+    private _cpuUtilization;
+    private _ramUtilization;
     private _report?;
     private _attachments;
     private _outputFolder;
     private _result?;
+    private _telemetryTimer?;
     constructor(_options?: {
         endpoint?: string;
         token?: string;
@@ -18,6 +20,7 @@ export default class FlakinessReporter implements Reporter {
         open?: OpenMode;
         collectBrowserVersions?: boolean;
     });
+    private _sampleSystem;
     printsToStdio(): boolean;
     onBegin(config: FullConfig, suite: Suite): void;
     onError(error: TestError): void;

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":"AAWA,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;IAa5C,OAAO,CAAC,QAAQ;IAZ5B,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,mBAAmB,CAAmB;IAE9C,OAAO,CAAC,yBAAyB,CAAkC;IACnE,OAAO,CAAC,OAAO,CAAC,CAAY;IAC5B,OAAO,CAAC,YAAY,CAAgC;IACpD,OAAO,CAAC,aAAa,CAAS;IAE9B,OAAO,CAAC,OAAO,CAAC,CAAa;gBAET,QAAQ,GAAE;QAC5B,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;IAIN,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;IAyFxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA0B9B"}
+{"version":3,"file":"playwright-test.d.ts","sourceRoot":"","sources":["../../src/playwright-test.ts"],"names":[],"mappings":"AAYA,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,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;IA4FxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA0B9B"}