@flakiness/playwright 1.6.0 → 1.8.0

package/lib/playwright-test.js

@@ -1,11 +1,14 @@
+import {
+  FlakinessReport as FK
+} from "@flakiness/flakiness-report";
 import {
   CIUtils,
+  CPUUtilization,
   GitWorktree,
+  RAMUtilization,
   ReportUtils,
   showReport,
   showReportCommand,
-  CPUUtilization,
-  RAMUtilization,
   uploadReport,
   writeReport
 } from "@flakiness/sdk";
@@ -36,6 +39,7 @@ class FlakinessReporter {
   _config;
   _rootSuite;
   _results = /* @__PURE__ */ new Map();
+  _stdioEntries = /* @__PURE__ */ new Map();
   _unattributedErrors = [];
   _cpuUtilization = new CPUUtilization({ precision: 10 });
   _ramUtilization = new RAMUtilization({ precision: 10 });
@@ -61,6 +65,25 @@ class FlakinessReporter {
   }
   onTestBegin(test) {
   }
+  onStdOut(chunk, test, result) {
+    this._onStdio(chunk, "stdout", result);
+  }
+  onStdErr(chunk, test, result) {
+    this._onStdio(chunk, "stderr", result);
+  }
+  _onStdio(chunk, stream, result) {
+    if (!result) return;
+    let entries = this._stdioEntries.get(result);
+    if (!entries) {
+      entries = [];
+      this._stdioEntries.set(result, entries);
+    }
+    entries.push({
+      data: chunk,
+      stream: stream === "stderr" ? FK.STREAM_STDERR : FK.STREAM_STDOUT,
+      time: Date.now()
+    });
+  }
   onTestEnd(test, result) {
     const results = this._results.get(test) ?? /* @__PURE__ */ new Set();
     results.add(result);
@@ -94,7 +117,6 @@ class FlakinessReporter {
     };
   }
   async _toFKRunAttempt(context, pwTest, result) {
-    const attachments = [];
     const attempt = {
       timeout: parseDurationMS(pwTest.timeout),
       annotations: pwTest.annotations.map((annotation) => ({
@@ -107,48 +129,74 @@ class FlakinessReporter {
       parallelIndex: result.parallelIndex,
       status: result.status,
       errors: result.errors && result.errors.length ? result.errors.map((error) => this._toFKTestError(context, error)) : void 0,
-      stdout: result.stdout ? result.stdout.map(toSTDIOEntry) : void 0,
-      stderr: result.stderr ? result.stderr.map(toSTDIOEntry) : void 0,
-      steps: result.steps ? result.steps.map((jsonTestStep) => this._toFKTestStep(context, jsonTestStep)) : void 0,
+      stdio: this._buildStdio(result),
+      steps: result.steps ? await Promise.all(result.steps.map((jsonTestStep) => this._toFKTestStep(context, jsonTestStep))) : void 0,
       startTimestamp: +result.startTime,
       duration: +result.duration,
-      attachments
+      attachments: await this._toFKAttachments(context, result.attachments)
     };
-    await Promise.all((result.attachments ?? []).map(async (jsonAttachment) => {
-      if (jsonAttachment.path && !await existsAsync(jsonAttachment.path)) {
-        context.unaccessibleAttachmentPaths.push(jsonAttachment.path);
-        return;
-      }
-      let attachment;
-      if (jsonAttachment.path)
-        attachment = await ReportUtils.createFileAttachment(jsonAttachment.contentType, jsonAttachment.path);
-      else if (jsonAttachment.body)
-        attachment = await ReportUtils.createDataAttachment(jsonAttachment.contentType, jsonAttachment.body);
-      else
-        return;
-      context.attachments.set(attachment.id, attachment);
-      attachments.push({
-        id: attachment.id,
-        name: jsonAttachment.name,
-        contentType: jsonAttachment.contentType
-      });
-    }));
     return attempt;
   }
-  _toFKTestStep(context, pwStep) {
+  _buildStdio(result) {
+    const rawEntries = this._stdioEntries.get(result);
+    if (!rawEntries?.length)
+      return void 0;
+    const stdio = [];
+    let ts = +result.startTime;
+    for (const entry of rawEntries) {
+      const dts = Math.max(0, entry.time - ts);
+      ts = entry.time;
+      if (Buffer.isBuffer(entry.data))
+        stdio.push({ buffer: entry.data.toString("base64"), dts, stream: entry.stream });
+      else
+        stdio.push({ text: entry.data, dts, stream: entry.stream });
+    }
+    this._stdioEntries.delete(result);
+    return stdio;
+  }
+  async _toFKAttachments(context, pwAttachments) {
+    const all = await Promise.all(pwAttachments.map((psAttachment) => this._toFKAttachment(context, psAttachment)));
+    const filtered = all.filter((attachment) => attachment !== void 0);
+    return filtered.length ? filtered : void 0;
+  }
+  async _toFKAttachment(context, pwAttachment) {
+    let result = context.attachmentsCache.get(pwAttachment);
+    if (!result) {
+      result = (async () => {
+        if (pwAttachment.path && !await existsAsync(pwAttachment.path)) {
+          context.unaccessibleAttachmentPaths.push(pwAttachment.path);
+          return;
+        }
+        let attachment;
+        if (pwAttachment.path)
+          attachment = await ReportUtils.createFileAttachment(pwAttachment.contentType, pwAttachment.path);
+        else if (pwAttachment.body)
+          attachment = await ReportUtils.createDataAttachment(pwAttachment.contentType, pwAttachment.body);
+        else
+          return;
+        context.attachments.set(attachment.id, attachment);
+        return {
+          id: attachment.id,
+          name: pwAttachment.name,
+          contentType: pwAttachment.contentType
+        };
+      })();
+      context.attachmentsCache.set(pwAttachment, result);
+    }
+    return await result;
+  }
+  async _toFKTestStep(context, pwStep) {
     const step = {
       // NOTE: jsonStep.duration was -1 in some playwright versions
       duration: parseDurationMS(Math.max(pwStep.duration, 0)),
       title: pwStep.title,
-      location: pwStep.location ? this._createLocation(context, pwStep.location) : void 0
+      location: pwStep.location ? this._createLocation(context, pwStep.location) : void 0,
+      attachments: await this._toFKAttachments(context, pwStep.attachments)
     };
-    if (pwStep.location) {
-      const resolvedPath = path.resolve(pwStep.location.file);
-    }
     if (pwStep.error)
       step.error = this._toFKTestError(context, pwStep.error);
     if (pwStep.steps)
-      step.steps = pwStep.steps.map((childJSONStep) => this._toFKTestStep(context, childJSONStep));
+      step.steps = await Promise.all(pwStep.steps.map((childJSONStep) => this._toFKTestStep(context, childJSONStep)));
     return step;
   }
   _createLocation(context, pwLocation) {
@@ -173,28 +221,23 @@ class FlakinessReporter {
     this._ramUtilization.sample();
     if (!this._config || !this._rootSuite)
       throw new Error("ERROR: failed to resolve config");
-    let commitId;
-    let worktree;
-    try {
-      worktree = GitWorktree.create(this._config.rootDir);
-      commitId = worktree.headCommitId();
-    } catch (e) {
-      warn(`Failed to fetch commit info - is this a git repo?`);
+    const worktreeResult = GitWorktree.initialize(this._config.rootDir);
+    if (!worktreeResult.ok) {
+      warn(`Failed to fetch commit info - is this a git repo? (${worktreeResult.error})`);
       err(`Report is NOT generated.`);
       return;
     }
+    const { commitId, worktree } = worktreeResult;
     const configPath = this._config.configFile ? worktree.gitPath(this._config.configFile) : void 0;
     const context = {
       project2environmentIdx: /* @__PURE__ */ new Map(),
       worktree,
       attachments: /* @__PURE__ */ new Map(),
+      attachmentsCache: /* @__PURE__ */ new Map(),
       unaccessibleAttachmentPaths: []
     };
-    const environmentsMap = createEnvironments(this._config.projects);
-    if (!environmentsMap.size) {
-      warn("Report is NOT generated since no Playwright project was executed.");
-      return;
-    }
+    const projects = this._rootSuite.suites.map((s) => s.project()).filter((p) => !!p);
+    const environmentsMap = createEnvironments(projects);
     if (this._options.collectBrowserVersions) {
       try {
         let playwrightPath = fs.realpathSync(process.argv[1]);
@@ -220,16 +263,17 @@ class FlakinessReporter {
           const browser = await browserType.launch({ channel, headless });
           const version = browser.version();
           await browser.close();
-          env.userSuppliedData ??= {};
-          env.userSuppliedData["browser"] = (channel ?? browserName).toLowerCase().trim() + " " + version;
+          env.metadata ??= {};
+          env.metadata["browser"] = (channel ?? browserName).toLowerCase().trim() + " " + version;
         }
       } catch (e) {
         err(`Failed to resolve browser version: ${e}`);
       }
     }
     const environments = [...environmentsMap.values()];
-    for (let envIdx = 0; envIdx < environments.length; ++envIdx)
-      context.project2environmentIdx.set(this._config.projects[envIdx], envIdx);
+    Array.from(environmentsMap.keys()).forEach((project, envIdx) => {
+      context.project2environmentIdx.set(project, envIdx);
+    });
     const report = ReportUtils.normalizeReport({
       flakinessProject: this._options.flakinessProject,
       title: this._options.title ?? process.env.FLAKINESS_TITLE,
@@ -280,11 +324,6 @@ To open last Flakiness report, run:
 function envBool(name) {
   return ["1", "true"].includes(process.env[name]?.toLowerCase() ?? "");
 }
-function toSTDIOEntry(data) {
-  if (Buffer.isBuffer(data))
-    return { buffer: data.toString("base64") };
-  return { text: data };
-}
 function createEnvironments(projects) {
   let uniqueNames = /* @__PURE__ */ new Set();
   const result = /* @__PURE__ */ new Map();
@@ -296,12 +335,7 @@ function createEnvironments(projects) {
     for (let i = 2; uniqueNames.has(name); ++i)
       name = `${defaultName}-${i}`;
     uniqueNames.add(defaultName);
-    const metadata = structuredClone(project.metadata);
-    delete metadata.gitDiff;
-    result.set(project, ReportUtils.createEnvironment({
-      name,
-      metadata
-    }));
+    result.set(project, ReportUtils.createEnvironment({ name }));
   }
   return result;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/playwright",
-  "version": "1.6.0",
+  "version": "1.8.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
   "author": "Degu Labs, Inc",
   "license": "MIT",
   "devDependencies": {
-    "@flakiness/playwright": "^1.5.0",
+    "@flakiness/playwright": "^1.6.0",
     "@playwright/test": "^1.57.0",
     "@types/node": "^25.0.3",
     "esbuild": "^0.27.2",
@@ -37,8 +37,8 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.29.0",
-    "@flakiness/sdk": "^2.6.0"
+    "@flakiness/flakiness-report": "^0.31.0",
+    "@flakiness/sdk": "^3.1.0"
   },
   "scripts": {
     "build": "kubik build.mts",

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

@@ -5,6 +5,7 @@ export default class FlakinessReporter implements Reporter {
     private _config?;
     private _rootSuite?;
     private _results;
+    private _stdioEntries;
     private _unattributedErrors;
     private _cpuUtilization;
     private _ramUtilization;
@@ -28,10 +29,16 @@ export default class FlakinessReporter implements Reporter {
     onBegin(config: FullConfig, suite: Suite): void;
     onError(error: TestError): void;
     onTestBegin(test: TestCase): void;
+    onStdOut(chunk: string | Buffer, test: TestCase | void, result: TestResult | void): void;
+    onStdErr(chunk: string | Buffer, test: TestCase | void, result: TestResult | void): void;
+    private _onStdio;
     onTestEnd(test: TestCase, result: TestResult): void;
     private _toFKSuites;
     private _toFKTest;
     private _toFKRunAttempt;
+    private _buildStdio;
+    private _toFKAttachments;
+    private _toFKAttachment;
     private _toFKTestStep;
     private _createLocation;
     private _toFKTestError;

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":"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,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,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;IAmGxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA4B9B"}
+{"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;AAwCnC,KAAK,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;AAQlD,MAAM,CAAC,OAAO,OAAO,iBAAkB,YAAW,QAAQ;IAiB5C,OAAO,CAAC,QAAQ;IAhB5B,OAAO,CAAC,OAAO,CAAC,CAAa;IAC7B,OAAO,CAAC,UAAU,CAAC,CAAQ;IAC3B,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,aAAa,CAAuC;IAC5D,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,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,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,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI;IAIjF,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI;IAIjF,OAAO,CAAC,QAAQ;IAchB,SAAS,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU;YAM9B,WAAW;YAsBX,SAAS;YAWT,eAAe;IA0B7B,OAAO,CAAC,WAAW;YAkBL,gBAAgB;YAMhB,eAAe;YA4Bf,aAAa;IAgB3B,OAAO,CAAC,eAAe;IAWvB,OAAO,CAAC,cAAc;IAUhB,KAAK,CAAC,MAAM,EAAE,UAAU;IAgGxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA4B9B"}