@flakiness/sdk 3.4.0 → 3.5.0

package/README.md

@@ -105,6 +105,7 @@ Use this entry point when you need to process or manipulate reports in browser-b
 - **`fetchTestDurations()`** - Fetch historical test durations from Flakiness.io and return a report enriched with timings
 - **`showReport()`** - Start a local server and open the report in your browser
 - **`showReportCommand()`** - Build a shell command for opening the report later with the Flakiness CLI
+- **`showReportMessage()`** - Build the message a runner prints after writing a report (CI-aware: a one-liner with the report path on CI, open-in-CLI instructions otherwise)
 - **`uploadReport()`** - Upload reports and attachments to Flakiness.io
 - **`writeReport()`** - Write reports to disk in the standard Flakiness report format
 

package/lib/index.js

@@ -218,6 +218,10 @@ function sha1File(filePath) {
     });
   });
 }
+function isCI() {
+  const ci = (process.env.CI ?? "").toLowerCase();
+  return ci !== "" && ci !== "false" && ci !== "0";
+}
 function randomUUIDBase62() {
   const BASE62_CHARSET = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
   let num = BigInt("0x" + crypto.randomUUID().replace(/-/g, ""));
@@ -924,7 +928,7 @@ async function uploadReport(report, attachments, options) {
   if (!flakinessAccessToken && githubOIDC) {
     if (!report.flakinessProject) {
       const reason = "`flakinessProject` is not configured to upload using Github OIDC.";
-      if (process.env.CI)
+      if (isCI())
         logger.warn(`[flakiness.io] \u26A0 Skipping upload: ${reason}`);
       return { status: "skipped", reason };
     }
@@ -942,7 +946,7 @@ async function uploadReport(report, attachments, options) {
   }
   if (!flakinessAccessToken) {
     const reason = "No FLAKINESS_ACCESS_TOKEN found";
-    if (process.env.CI)
+    if (isCI())
       logger.warn(`[flakiness.io] \u26A0 Skipping upload: ${reason}`);
     return { status: "skipped", reason };
   }
@@ -1497,12 +1501,24 @@ function quoteShellArgument(argument) {
   return JSON.stringify(argument);
 }
 
+// src/showReportMessage.ts
+import path4 from "node:path";
+import { styleText as styleText2 } from "node:util";
+function showReportMessage(reportFolder) {
+  if (isCI())
+    return `Flakiness report written to ${path4.resolve(reportFolder)}`;
+  const command = showReportCommand(reportFolder);
+  return `To open last Flakiness report, run:
+
+  ${styleText2("cyan", command)}`;
+}
+
 // src/writeReport.ts
 import fs8 from "fs";
-import path4 from "path";
+import path5 from "path";
 async function writeReport(report, attachments, outputFolder) {
-  const reportPath = path4.join(outputFolder, "report.json");
-  const attachmentsFolder = path4.join(outputFolder, "attachments");
+  const reportPath = path5.join(outputFolder, "report.json");
+  const attachmentsFolder = path5.join(outputFolder, "attachments");
   await fs8.promises.rm(outputFolder, { recursive: true, force: true });
   await fs8.promises.mkdir(outputFolder, { recursive: true });
   await fs8.promises.writeFile(reportPath, JSON.stringify(report), "utf-8");
@@ -1510,7 +1526,7 @@ async function writeReport(report, attachments, outputFolder) {
     await fs8.promises.mkdir(attachmentsFolder);
   const movedAttachments = [];
   for (const attachment of attachments) {
-    const attachmentPath = path4.join(attachmentsFolder, attachment.id);
+    const attachmentPath = path5.join(attachmentsFolder, attachment.id);
     if (attachment.type === "file")
       await fs8.promises.cp(attachment.path, attachmentPath);
     else if (attachment.type === "buffer")
@@ -1535,6 +1551,7 @@ export {
   readReport,
   showReport,
   showReportCommand,
+  showReportMessage,
   uploadReport,
   writeReport
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "private": false,
   "repository": {
     "type": "git",

package/types/src/_internalUtils.d.ts

@@ -11,5 +11,14 @@ export declare function putBuffer(input: RequestInfo | URL, body: Buffer, header
 export declare function shell(command: string, args?: string[], options?: SpawnSyncOptionsWithStringEncoding): string | undefined;
 export declare function sha1Text(data: crypto.BinaryLike): string;
 export declare function sha1File(filePath: string): Promise<string>;
+/**
+ * Whether the current process is running on CI.
+ *
+ * Virtually every CI provider (GitHub Actions, GitLab, CircleCI, …) sets the `CI`
+ * environment variable, usually to `true` or `1`. An explicit `false`/`0`/empty
+ * value is treated as an opt-out rather than as "on" — `process.env.CI` is a
+ * non-empty truthy string in those cases too, so a plain truthiness check is wrong.
+ */
+export declare function isCI(): boolean;
 export declare function randomUUIDBase62(): string;
 //# sourceMappingURL=_internalUtils.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"_internalUtils.d.ts","sourceRoot":"","sources":["../../src/_internalUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,kCAAkC,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,MAAM,MAAM,QAAQ,CAAC;AAM5B,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQ5E;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,IAAI,CAAC,GAAG;IAC/C,QAAQ,EAAE,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,GAAG,KAAK;CAC/C,CAAC;AAGF,wBAAsB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CASnG;AAED,eAAO,MAAM,YAAY,UAAqC,CAAC;AAY/D,wBAAsB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,OAAO,GAAE,MAAM,EAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,CAK3H;AAED,wBAAsB,SAAS,CAAC,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,GAAE,MAAM,EAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAU9I;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kCAAkC,sBAWnG;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,UAI/C;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAc1D;AAED,wBAAgB,gBAAgB,IAAI,MAAM,CAczC"}
+{"version":3,"file":"_internalUtils.d.ts","sourceRoot":"","sources":["../../src/_internalUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,kCAAkC,EAAE,MAAM,eAAe,CAAC;AAC9E,OAAO,MAAM,MAAM,QAAQ,CAAC;AAM5B,wBAAsB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQ5E;AAED,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,KAAK,SAAS,MAAM,IAAI,CAAC,GAAG;IAC/C,QAAQ,EAAE,CAAC,IAAI,KAAK,IAAI,KAAK,CAAC,QAAQ,GAAG,KAAK;CAC/C,CAAC;AAGF,wBAAsB,gBAAgB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE,MAAM,EAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CASnG;AAED,eAAO,MAAM,YAAY,UAAqC,CAAC;AAY/D,wBAAsB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,CAAC,EAAE,WAAW,EAAE,OAAO,GAAE,MAAM,EAAiB,GAAG,OAAO,CAAC,CAAC,CAAC,CAK3H;AAED,wBAAsB,SAAS,CAAC,KAAK,EAAE,WAAW,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,OAAO,GAAE,MAAM,EAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAU9I;AAED,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,kCAAkC,sBAWnG;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,UAAU,UAI/C;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAc1D;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,IAAI,OAAO,CAG9B;AAED,wBAAgB,gBAAgB,IAAI,MAAM,CAczC"}

package/types/src/index.d.ts

@@ -8,6 +8,7 @@ export { fetchTestDurations, type FetchTestDurationsOptions } from './fetchTestD
 export { readReport } from './readReport.js';
 export { showReport } from './showReport.js';
 export { showReportCommand } from './showReportCommand.js';
+export { showReportMessage } from './showReportMessage.js';
 export { uploadReport } from './uploadReport.js';
 export { writeReport } from './writeReport.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,kBAAkB,EAAE,KAAK,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAC7F,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC"}

package/types/src/showReportMessage.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Builds the human-facing message that test runners print after writing a report.
+ *
+ * In interactive environments this returns instructions for opening the report
+ * locally with the Flakiness CLI. On CI (the `CI` environment variable is set to
+ * anything other than `false`/`0`), where launching the local viewer isn't useful,
+ * it returns a one-liner pointing at the folder the report was written to instead.
+ *
+ * @param {string} reportFolder - Absolute or relative path to the report folder.
+ *
+ * @returns {string} A ready-to-print message.
+ *
+ * @example
+ * ```typescript
+ * console.log(showReportMessage('./flakiness-report'));
+ * // Interactive: "To open last Flakiness report, run:\n\n  npx flakiness show"
+ * // On CI:       "Flakiness report written to /abs/path/flakiness-report"
+ * ```
+ */
+export declare function showReportMessage(reportFolder: string): string;
+//# sourceMappingURL=showReportMessage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"showReportMessage.d.ts","sourceRoot":"","sources":["../../src/showReportMessage.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAM9D"}