@flakiness/sdk 2.5.0 → 2.7.0

package/README.md

@@ -34,7 +34,7 @@ const env = ReportUtils.createEnvironment({ name: 'CI' });
 const report: FlakinessReport.Report = {
   category: 'testreport',
   commitId: worktree.headCommitId(),
-  title: CIUtils.runTitle(),
+  title: process.env.FLAKINESS_TITLE,
   url: CIUtils.runUrl(),
   environments: [env],
   suites: [{

package/lib/browser.js

@@ -33,6 +33,7 @@ function normalizeReport(report) {
     return {
       ...step,
       duration: step.duration === 0 ? void 0 : step.duration,
+      attachments: step.attachments && step.attachments.length ? step.attachments : void 0,
       steps: step.steps && step.steps.length ? step.steps.map(cleanupTestStep) : void 0
     };
   }

package/lib/index.js

@@ -8,7 +8,7 @@ var __export = (target, all) => {
 var CIUtils;
 ((CIUtils2) => {
   function runTitle() {
-    return githubActionsTitle();
+    return void 0;
   }
   CIUtils2.runTitle = runTitle;
   function runUrl() {
@@ -16,10 +16,6 @@ var CIUtils;
   }
   CIUtils2.runUrl = runUrl;
 })(CIUtils || (CIUtils = {}));
-function githubActionsTitle() {
-  const title = process.env.GITHUB_WORKFLOW?.trim();
-  return title || void 0;
-}
 function githubActions() {
   const serverUrl = process.env.GITHUB_SERVER_URL || "https://github.com";
   const repo = process.env.GITHUB_REPOSITORY;
@@ -707,6 +703,7 @@ function normalizeReport(report) {
     return {
       ...step,
       duration: step.duration === 0 ? void 0 : step.duration,
+      attachments: step.attachments && step.attachments.length ? step.attachments : void 0,
       steps: step.steps && step.steps.length ? step.steps.map(cleanupTestStep) : void 0
     };
   }
@@ -1105,21 +1102,31 @@ async function readReport(reportFolder) {
   const filenameToPath = new Map(attachmentFiles.map((file) => [path.basename(file), file]));
   const attachmentIdToPath = /* @__PURE__ */ new Map();
   const missingAttachments = /* @__PURE__ */ new Map();
+  const visitAttachment = (attachment) => {
+    const attachmentPath = filenameToPath.get(attachment.id);
+    if (!attachmentPath) {
+      missingAttachments.set(attachment.id, attachment);
+    } else {
+      attachmentIdToPath.set(attachment.id, {
+        contentType: attachment.contentType,
+        id: attachment.id,
+        path: attachmentPath,
+        type: "file"
+      });
+    }
+  };
+  const visitStep = (step) => {
+    for (const attachment of step.attachments ?? [])
+      visitAttachment(attachment);
+    for (const childStep of step.steps ?? [])
+      visitStep(childStep);
+  };
   visitTests(report, (test) => {
     for (const attempt of test.attempts) {
-      for (const attachment of attempt.attachments ?? []) {
-        const attachmentPath = filenameToPath.get(attachment.id);
-        if (!attachmentPath) {
-          missingAttachments.set(attachment.id, attachment);
-        } else {
-          attachmentIdToPath.set(attachment.id, {
-            contentType: attachment.contentType,
-            id: attachment.id,
-            path: attachmentPath,
-            type: "file"
-          });
-        }
-      }
+      for (const attachment of attempt.attachments ?? [])
+        visitAttachment(attachment);
+      for (const step of attempt.steps ?? [])
+        visitStep(step);
     }
   });
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "2.5.0",
+  "version": "2.7.0",
   "private": false,
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "node": "^20.17.0 || >=22.9.0"
   },
   "devDependencies": {
-    "@flakiness/flakiness-report": "^0.28.0",
+    "@flakiness/flakiness-report": "^0.31.0",
     "@flakiness/playwright": "^1.3.3",
     "@playwright/test": "^1.58.2",
     "@types/debug": "^4.1.12",

package/types/src/ciUtils.d.ts

@@ -6,24 +6,10 @@
  */
 export declare namespace CIUtils {
     /**
-     * Automatically extracts a human-readable CI run title when available.
+     * @deprecated Use the `title` reporter option or `FLAKINESS_TITLE` environment variable instead.
+     * See https://docs.flakiness.io/report/customization/#title
      *
-     * This function attempts to detect the current CI environment and return a
-     * stable title that identifies the workflow or pipeline generating the report.
-     *
-     * Supported CI providers (checked in order):
-     * - GitHub Actions (via `GITHUB_WORKFLOW`)
-     *
-     * @returns {string | undefined} The CI run title, or `undefined` if no supported
-     *   CI environment exposes a stable human-readable title.
-     *
-     * @example
-     * ```typescript
-     * const report: FlakinessReport.Report = {
-     *   // ... other report properties
-     *   title: CIUtils.runTitle(),
-     * };
-     * ```
+     * @returns {undefined} Always returns `undefined`.
      */
     function runTitle(): string | undefined;
     /**

package/types/src/ciUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ciUtils.d.ts","sourceRoot":"","sources":["../../src/ciUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,SAAgB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAgB,MAAM,IAAI,MAAM,GAAG,SAAS,CAE3C;CACF"}
+{"version":3,"file":"ciUtils.d.ts","sourceRoot":"","sources":["../../src/ciUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,yBAAiB,OAAO,CAAC;IACvB;;;;;OAKG;IACH,SAAgB,QAAQ,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,SAAgB,MAAM,IAAI,MAAM,GAAG,SAAS,CAE3C;CACF"}

package/types/src/normalizeReport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeReport.d.ts","sourceRoot":"","sources":["../../src/normalizeReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAyB9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAmDtF"}
+{"version":3,"file":"normalizeReport.d.ts","sourceRoot":"","sources":["../../src/normalizeReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAyB9D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,eAAe,CAAC,MAAM,GAAG,eAAe,CAAC,MAAM,CAoDtF"}

package/types/src/readReport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"readReport.d.ts","sourceRoot":"","sources":["../../src/readReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAsB,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9D,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC;IAC/B,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,kBAAkB,EAAE,eAAe,CAAC,UAAU,EAAE,CAAC;CAClD,CAAC,CA0CD"}
+{"version":3,"file":"readReport.d.ts","sourceRoot":"","sources":["../../src/readReport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAG9D,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAGnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAsB,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC;IAC9D,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC;IAC/B,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,kBAAkB,EAAE,eAAe,CAAC,UAAU,EAAE,CAAC;CAClD,CAAC,CAoDD"}