@flakiness/sdk 0.129.4 → 0.131.0

package/lib/localReportServer.js

@@ -7,9 +7,14 @@ import compression from "compression";
 import debug from "debug";
 import express from "express";
 import "express-async-errors";
-import fs3 from "fs";
 import http2 from "http";
 
+// src/localReportApi.ts
+import { TypedHTTP } from "@flakiness/shared/common/typedHttp.js";
+import fs2 from "fs";
+import path2 from "path";
+import { z } from "zod/v4";
+
 // src/localGit.ts
 import { exec } from "child_process";
 import { promisify } from "util";
@@ -50,46 +55,9 @@ async function listLocalCommits(gitRoot, head, count) {
   }
 }
 
-// src/localReportApi.ts
-import { TypedHTTP } from "@flakiness/shared/common/typedHttp.js";
-import fs from "fs";
-import { z } from "zod/v4";
-var t = TypedHTTP.Router.create();
-var localReportRouter = {
-  ping: t.get({
-    handler: async () => {
-      return "pong";
-    }
-  }),
-  lastCommits: t.get({
-    handler: async ({ ctx }) => {
-      return ctx.commits;
-    }
-  }),
-  report: {
-    attachment: t.rawMethod("GET", {
-      input: z.object({
-        attachmentId: z.string().min(1).max(100).transform((id) => id)
-      }),
-      handler: async ({ ctx, input }) => {
-        const idx = ctx.attachmentIdToPath.get(input.attachmentId);
-        if (!idx)
-          throw TypedHTTP.HttpError.withCode("NOT_FOUND");
-        const buffer = await fs.promises.readFile(idx.path);
-        return TypedHTTP.ok(buffer, idx.contentType);
-      }
-    }),
-    json: t.get({
-      handler: async ({ ctx }) => {
-        return ctx.report;
-      }
-    })
-  }
-};
-
 // src/utils.ts
 import { ReportUtils } from "@flakiness/report";
-import fs2 from "fs";
+import fs from "fs";
 import http from "http";
 import https from "https";
 import path, { posix as posixPath, win32 as win32Path } from "path";
@@ -200,7 +168,7 @@ async function resolveAttachmentPaths(report, attachmentsDir) {
   return { attachmentIdToPath, missingAttachments: Array.from(missingAttachments) };
 }
 async function listFilesRecursively(dir, result = []) {
-  const entries = await fs2.promises.readdir(dir, { withFileTypes: true });
+  const entries = await fs.promises.readdir(dir, { withFileTypes: true });
   for (const entry of entries) {
     const fullPath = path.join(dir, entry.name);
     if (entry.isDirectory())
@@ -213,17 +181,27 @@ async function listFilesRecursively(dir, result = []) {
 var IS_WIN32_PATH = new RegExp("^[a-zA-Z]:\\\\", "i");
 var IS_ALMOST_POSIX_PATH = new RegExp("^[a-zA-Z]:/", "i");
 
-// src/localReportServer.ts
-var logHTTPServer = debug("fk:http");
-var LocalReportServer = class _LocalReportServer {
-  constructor(_server, _port, _authToken) {
-    this._server = _server;
-    this._port = _port;
-    this._authToken = _authToken;
+// src/localReportApi.ts
+var ReportInfo = class {
+  constructor(_options) {
+    this._options = _options;
   }
-  static async create(options) {
-    const report = JSON.parse(await fs3.promises.readFile(options.reportPath, "utf-8"));
-    const attachmentsDir = options.attachmentsFolder;
+  report;
+  attachmentIdToPath = /* @__PURE__ */ new Map();
+  commits = [];
+  async refresh() {
+    const report = await fs2.promises.readFile(this._options.reportPath, "utf-8").then((x) => JSON.parse(x)).catch((e) => void 0);
+    if (!report) {
+      this.report = void 0;
+      this.commits = [];
+      this.attachmentIdToPath = /* @__PURE__ */ new Map();
+      return;
+    }
+    if (JSON.stringify(report) === JSON.stringify(this.report))
+      return;
+    this.report = report;
+    this.commits = await listLocalCommits(path2.dirname(this._options.reportPath), report.commitId, 100);
+    const attachmentsDir = this._options.attachmentsFolder;
     const { attachmentIdToPath, missingAttachments } = await resolveAttachmentPaths(report, attachmentsDir);
     if (missingAttachments.length) {
       const first = missingAttachments.slice(0, 3);
@@ -232,7 +210,52 @@ var LocalReportServer = class _LocalReportServer {
       if (missingAttachments.length > 3)
         console.warn(`...and ${missingAttachments.length - 3} more missing attachments.`);
     }
-    const commits = await listLocalCommits(process.cwd(), report.commitId, 100);
+    this.attachmentIdToPath = attachmentIdToPath;
+  }
+};
+var t = TypedHTTP.Router.create();
+var localReportRouter = {
+  ping: t.get({
+    handler: async () => {
+      return "pong";
+    }
+  }),
+  lastCommits: t.get({
+    handler: async ({ ctx }) => {
+      return ctx.reportInfo.commits;
+    }
+  }),
+  report: {
+    attachment: t.rawMethod("GET", {
+      input: z.object({
+        attachmentId: z.string().min(1).max(100).transform((id) => id)
+      }),
+      handler: async ({ ctx, input }) => {
+        const idx = ctx.reportInfo.attachmentIdToPath.get(input.attachmentId);
+        if (!idx)
+          throw TypedHTTP.HttpError.withCode("NOT_FOUND");
+        const buffer = await fs2.promises.readFile(idx.path);
+        return TypedHTTP.ok(buffer, idx.contentType);
+      }
+    }),
+    json: t.get({
+      handler: async ({ ctx }) => {
+        await ctx.reportInfo.refresh();
+        return ctx.reportInfo.report;
+      }
+    })
+  }
+};
+
+// src/localReportServer.ts
+var logHTTPServer = debug("fk:http");
+var LocalReportServer = class _LocalReportServer {
+  constructor(_server, _port, _authToken) {
+    this._server = _server;
+    this._port = _port;
+    this._authToken = _authToken;
+  }
+  static async create(options) {
     const app = express();
     app.set("etag", false);
     const authToken = randomUUIDBase62();
@@ -255,9 +278,10 @@ var LocalReportServer = class _LocalReportServer {
       });
       next();
     });
+    const reportInfo = new ReportInfo(options);
     app.use("/" + authToken, createTypedHttpExpressMiddleware({
       router: localReportRouter,
-      createRootContext: async ({ req, res, input }) => ({ report, commits, attachmentIdToPath })
+      createRootContext: async ({ req, res, input }) => ({ reportInfo })
     }));
     app.use((err, req, res, next) => {
       if (err instanceof TypedHTTP2.HttpError)

package/lib/playwright-test.js

@@ -2,13 +2,13 @@
 import { ReportUtils as ReportUtils2 } from "@flakiness/report";
 import { Multimap } from "@flakiness/shared/common/multimap.js";
 import chalk2 from "chalk";
-import fs8 from "fs";
-import path5 from "path";
+import fs7 from "fs";
+import path6 from "path";
 
 // src/cli/cmd-show-report.ts
 import chalk from "chalk";
 import open from "open";
-import path4 from "path";
+import path5 from "path";
 
 // src/flakinessConfig.ts
 import fs2 from "fs";
@@ -139,6 +139,29 @@ var ansiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:
 function stripAnsi(str) {
   return str.replace(ansiRegex, "");
 }
+async function saveReportAndAttachments(report, attachments, outputFolder) {
+  const reportPath = path.join(outputFolder, "report.json");
+  const attachmentsFolder = path.join(outputFolder, "attachments");
+  await fs.promises.rm(outputFolder, { recursive: true, force: true });
+  await fs.promises.mkdir(outputFolder, { recursive: true });
+  await fs.promises.writeFile(reportPath, JSON.stringify(report), "utf-8");
+  if (attachments.length)
+    await fs.promises.mkdir(attachmentsFolder);
+  const movedAttachments = [];
+  for (const attachment of attachments) {
+    const attachmentPath = path.join(attachmentsFolder, attachment.id);
+    if (attachment.path)
+      await fs.promises.cp(attachment.path, attachmentPath);
+    else if (attachment.body)
+      await fs.promises.writeFile(attachmentPath, attachment.body);
+    movedAttachments.push({
+      contentType: attachment.contentType,
+      id: attachment.id,
+      path: attachmentPath
+    });
+  }
+  return movedAttachments;
+}
 function shell(command, args, options) {
   try {
     const result = spawnSync(command, args, { encoding: "utf-8", ...options });
@@ -429,9 +452,14 @@ import compression from "compression";
 import debug from "debug";
 import express from "express";
 import "express-async-errors";
-import fs5 from "fs";
 import http2 from "http";
 
+// src/localReportApi.ts
+import { TypedHTTP as TypedHTTP2 } from "@flakiness/shared/common/typedHttp.js";
+import fs4 from "fs";
+import path4 from "path";
+import { z } from "zod/v4";
+
 // src/localGit.ts
 import { exec } from "child_process";
 import { promisify } from "util";
@@ -473,9 +501,37 @@ async function listLocalCommits(gitRoot, head, count) {
 }
 
 // src/localReportApi.ts
-import { TypedHTTP as TypedHTTP2 } from "@flakiness/shared/common/typedHttp.js";
-import fs4 from "fs";
-import { z } from "zod/v4";
+var ReportInfo = class {
+  constructor(_options) {
+    this._options = _options;
+  }
+  report;
+  attachmentIdToPath = /* @__PURE__ */ new Map();
+  commits = [];
+  async refresh() {
+    const report = await fs4.promises.readFile(this._options.reportPath, "utf-8").then((x) => JSON.parse(x)).catch((e) => void 0);
+    if (!report) {
+      this.report = void 0;
+      this.commits = [];
+      this.attachmentIdToPath = /* @__PURE__ */ new Map();
+      return;
+    }
+    if (JSON.stringify(report) === JSON.stringify(this.report))
+      return;
+    this.report = report;
+    this.commits = await listLocalCommits(path4.dirname(this._options.reportPath), report.commitId, 100);
+    const attachmentsDir = this._options.attachmentsFolder;
+    const { attachmentIdToPath, missingAttachments } = await resolveAttachmentPaths(report, attachmentsDir);
+    if (missingAttachments.length) {
+      const first = missingAttachments.slice(0, 3);
+      for (let i = 0; i < 3 && i < missingAttachments.length; ++i)
+        console.warn(`Missing attachment with id ${missingAttachments[i]}`);
+      if (missingAttachments.length > 3)
+        console.warn(`...and ${missingAttachments.length - 3} more missing attachments.`);
+    }
+    this.attachmentIdToPath = attachmentIdToPath;
+  }
+};
 var t = TypedHTTP2.Router.create();
 var localReportRouter = {
   ping: t.get({
@@ -485,7 +541,7 @@ var localReportRouter = {
   }),
   lastCommits: t.get({
     handler: async ({ ctx }) => {
-      return ctx.commits;
+      return ctx.reportInfo.commits;
     }
   }),
   report: {
@@ -494,7 +550,7 @@ var localReportRouter = {
         attachmentId: z.string().min(1).max(100).transform((id) => id)
       }),
       handler: async ({ ctx, input }) => {
-        const idx = ctx.attachmentIdToPath.get(input.attachmentId);
+        const idx = ctx.reportInfo.attachmentIdToPath.get(input.attachmentId);
         if (!idx)
           throw TypedHTTP2.HttpError.withCode("NOT_FOUND");
         const buffer = await fs4.promises.readFile(idx.path);
@@ -503,7 +559,8 @@ var localReportRouter = {
     }),
     json: t.get({
       handler: async ({ ctx }) => {
-        return ctx.report;
+        await ctx.reportInfo.refresh();
+        return ctx.reportInfo.report;
       }
     })
   }
@@ -518,17 +575,6 @@ var LocalReportServer = class _LocalReportServer {
     this._authToken = _authToken;
   }
   static async create(options) {
-    const report = JSON.parse(await fs5.promises.readFile(options.reportPath, "utf-8"));
-    const attachmentsDir = options.attachmentsFolder;
-    const { attachmentIdToPath, missingAttachments } = await resolveAttachmentPaths(report, attachmentsDir);
-    if (missingAttachments.length) {
-      const first = missingAttachments.slice(0, 3);
-      for (let i = 0; i < 3 && i < missingAttachments.length; ++i)
-        console.warn(`Missing attachment with id ${missingAttachments[i]}`);
-      if (missingAttachments.length > 3)
-        console.warn(`...and ${missingAttachments.length - 3} more missing attachments.`);
-    }
-    const commits = await listLocalCommits(process.cwd(), report.commitId, 100);
     const app = express();
     app.set("etag", false);
     const authToken = randomUUIDBase62();
@@ -551,9 +597,10 @@ var LocalReportServer = class _LocalReportServer {
       });
       next();
     });
+    const reportInfo = new ReportInfo(options);
     app.use("/" + authToken, createTypedHttpExpressMiddleware({
       router: localReportRouter,
-      createRootContext: async ({ req, res, input }) => ({ report, commits, attachmentIdToPath })
+      createRootContext: async ({ req, res, input }) => ({ reportInfo })
     }));
     app.use((err2, req, res, next) => {
       if (err2 instanceof TypedHTTP3.HttpError)
@@ -587,7 +634,7 @@ var LocalReportServer = class _LocalReportServer {
 
 // src/cli/cmd-show-report.ts
 async function cmdShowReport(reportFolder) {
-  const reportPath = path4.join(reportFolder, "report.json");
+  const reportPath = path5.join(reportFolder, "report.json");
   const session = await FlakinessSession.load();
   const config = await FlakinessConfig.load();
   const projectPublicId = config.projectPublicId();
@@ -610,12 +657,12 @@ async function cmdShowReport(reportFolder) {
 
 // src/createTestStepSnippets.ts
 import { codeFrameColumns } from "@babel/code-frame";
-import fs6 from "fs";
+import fs5 from "fs";
 function createTestStepSnippets(filepathToSteps) {
   for (const [filepath, steps] of filepathToSteps) {
     let source;
     try {
-      source = fs6.readFileSync(filepath, "utf-8");
+      source = fs5.readFileSync(filepath, "utf-8");
     } catch (e) {
       continue;
     }
@@ -640,7 +687,7 @@ function createTestStepSnippets(filepathToSteps) {
 // src/reportUploader.ts
 import { compressTextAsync, compressTextSync } from "@flakiness/shared/node/compression.js";
 import assert2 from "assert";
-import fs7 from "fs";
+import fs6 from "fs";
 import { URL } from "url";
 var ReportUploader = class _ReportUploader {
   static optionsFromEnv(overrides) {
@@ -738,16 +785,16 @@ var ReportUpload = class {
           url: uploadUrl,
           headers: {
             "Content-Type": attachment.contentType,
-            "Content-Length": (await fs7.promises.stat(attachmentPath)).size + ""
+            "Content-Length": (await fs6.promises.stat(attachmentPath)).size + ""
           },
           method: "put"
         });
-        fs7.createReadStream(attachmentPath).pipe(request);
+        fs6.createReadStream(attachmentPath).pipe(request);
         await responseDataPromise;
       }, HTTP_BACKOFF);
       return;
     }
-    let buffer = attachment.body ? attachment.body : attachment.path ? await fs7.promises.readFile(attachment.path) : void 0;
+    let buffer = attachment.body ? attachment.body : attachment.path ? await fs6.promises.readFile(attachment.path) : void 0;
     assert2(buffer);
     const encoding = compressable ? "br" : void 0;
     if (compressable)
@@ -844,7 +891,7 @@ var err = (txt) => console.error(chalk2.red(`[flakiness.io] ${txt}`));
 var FlakinessReporter = class {
   constructor(_options = {}) {
     this._options = _options;
-    this._outputFolder = path5.join(process.cwd(), this._options.outputFolder ?? process.env.FLAKINESS_OUTPUT_DIR ?? "flakiness-report");
+    this._outputFolder = path6.join(process.cwd(), this._options.outputFolder ?? process.env.FLAKINESS_OUTPUT_DIR ?? "flakiness-report");
   }
   _config;
   _rootSuite;
@@ -947,7 +994,7 @@ var FlakinessReporter = class {
       location: pwStep.location ? this._createLocation(context, pwStep.location) : void 0
     };
     if (pwStep.location) {
-      const resolvedPath = path5.resolve(pwStep.location.file);
+      const resolvedPath = path6.resolve(pwStep.location.file);
       this._filepathToSteps.set(resolvedPath, step);
     }
     if (pwStep.error)
@@ -996,10 +1043,10 @@ var FlakinessReporter = class {
     const environmentsMap = createEnvironments(this._config.projects);
     if (this._options.collectBrowserVersions) {
       try {
-        let playwrightPath = fs8.realpathSync(process.argv[1]);
-        while (path5.basename(playwrightPath) !== "test")
-          playwrightPath = path5.dirname(playwrightPath);
-        const module = await import(path5.join(playwrightPath, "index.js"));
+        let playwrightPath = fs7.realpathSync(process.argv[1]);
+        while (path6.basename(playwrightPath) !== "test")
+          playwrightPath = path6.dirname(playwrightPath);
+        const module = await import(path6.join(playwrightPath, "index.js"));
         for (const [project, env] of environmentsMap) {
           const { browserName = "chromium", channel, headless } = project.use;
           let browserType;
@@ -1048,25 +1095,7 @@ var FlakinessReporter = class {
     for (const unaccessibleAttachment of context.unaccessibleAttachmentPaths)
       warn(`cannot access attachment ${unaccessibleAttachment}`);
     this._report = report;
-    const reportPath = path5.join(this._outputFolder, "report.json");
-    const attachmentsFolder = path5.join(this._outputFolder, "attachments");
-    await fs8.promises.rm(this._outputFolder, { recursive: true, force: true });
-    await fs8.promises.mkdir(this._outputFolder, { recursive: true });
-    await fs8.promises.writeFile(reportPath, JSON.stringify(report), "utf-8");
-    if (context.attachments.size)
-      await fs8.promises.mkdir(attachmentsFolder);
-    for (const attachment of context.attachments.values()) {
-      const attachmentPath = path5.join(attachmentsFolder, attachment.id);
-      if (attachment.path)
-        await fs8.promises.cp(attachment.path, attachmentPath);
-      else if (attachment.body)
-        await fs8.promises.writeFile(attachmentPath, attachment.body);
-      this._attachments.push({
-        contentType: attachment.contentType,
-        id: attachment.id,
-        path: attachmentPath
-      });
-    }
+    this._attachments = await saveReportAndAttachments(report, Array.from(context.attachments.values()), this._outputFolder);
     this._result = result;
   }
   async onExit() {
@@ -1084,12 +1113,12 @@ var FlakinessReporter = class {
     if (shouldOpen) {
       await cmdShowReport(this._outputFolder);
     } else {
-      const defaultOutputFolder = path5.join(process.cwd(), "flakiness-report");
-      const folder = defaultOutputFolder === this._outputFolder ? "" : path5.relative(process.cwd(), this._outputFolder);
+      const defaultOutputFolder = path6.join(process.cwd(), "flakiness-report");
+      const folder = defaultOutputFolder === this._outputFolder ? "" : path6.relative(process.cwd(), this._outputFolder);
       console.log(`
-To open last Flakiness report run:
+To open last Flakiness report, install Flakiness CLI tool and run:
 
-  ${chalk2.cyan(`npx flakiness show-report ${folder}`)}
+  ${chalk2.cyan(`flakiness show ${folder}`)}
       `);
     }
   }

package/lib/utils.js

@@ -123,6 +123,29 @@ var ansiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:
 function stripAnsi(str) {
   return str.replace(ansiRegex, "");
 }
+async function saveReportAndAttachments(report, attachments, outputFolder) {
+  const reportPath = path.join(outputFolder, "report.json");
+  const attachmentsFolder = path.join(outputFolder, "attachments");
+  await fs.promises.rm(outputFolder, { recursive: true, force: true });
+  await fs.promises.mkdir(outputFolder, { recursive: true });
+  await fs.promises.writeFile(reportPath, JSON.stringify(report), "utf-8");
+  if (attachments.length)
+    await fs.promises.mkdir(attachmentsFolder);
+  const movedAttachments = [];
+  for (const attachment of attachments) {
+    const attachmentPath = path.join(attachmentsFolder, attachment.id);
+    if (attachment.path)
+      await fs.promises.cp(attachment.path, attachmentPath);
+    else if (attachment.body)
+      await fs.promises.writeFile(attachmentPath, attachment.body);
+    movedAttachments.push({
+      contentType: attachment.contentType,
+      id: attachment.id,
+      path: attachmentPath
+    });
+  }
+  return movedAttachments;
+}
 function shell(command, args, options) {
   try {
     const result = spawnSync(command, args, { encoding: "utf-8", ...options });
@@ -342,6 +365,7 @@ export {
   parseStringDate,
   resolveAttachmentPaths,
   retryWithBackoff,
+  saveReportAndAttachments,
   sha1Buffer,
   sha1File,
   shell,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "0.129.4",
+  "version": "0.131.0",
   "private": false,
   "bin": {
     "flakiness": "./lib/cli/cli.js"
@@ -39,13 +39,18 @@
   "description": "",
   "types": "./types/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build:all": "npm run build:win && npm run build:linux && npm run build:mac && npm run build:alpine && npm run build:mac_intel",
+    "build:win": "bun build ./lib/cli/cli.js --compile --minify --target=bun-windows-x64 --outfile dist/flakiness-win-x64.exe",
+    "build:linux": "bun build ./lib/cli/cli.js --compile --minify --target=bun-linux-x64 --outfile dist/flakiness-linux-x64",
+    "build:alpine": "bun build ./lib/cli/cli.js --compile --minify --target=bun-linux-x64-musl --outfile dist/flakiness-linux-x64-alpine",
+    "build:mac": "bun build ./lib/cli/cli.js --compile --minify --target=bun-darwin-arm64 --outfile dist/flakiness-macos-arm64",
+    "build:mac_intel": "bun build ./lib/cli/cli.js --compile --minify --target=bun-darwin-x64 --outfile dist/flakiness-macos-x64"
   },
   "keywords": [],
   "author": "Degu Labs, Inc",
   "license": "Fair Source 100",
   "devDependencies": {
-    "@flakiness/server": "0.129.4",
+    "@flakiness/server": "0.131.0",
     "@playwright/test": "^1.54.0",
     "@types/babel__code-frame": "^7.0.6",
     "@types/compression": "^1.8.1",
@@ -53,8 +58,8 @@
   },
   "dependencies": {
     "@babel/code-frame": "^7.26.2",
-    "@flakiness/report": "0.129.4",
-    "@flakiness/shared": "0.129.4",
+    "@flakiness/report": "0.131.0",
+    "@flakiness/shared": "0.131.0",
     "@rgrove/parse-xml": "^4.2.0",
     "body-parser": "^1.20.3",
     "chalk": "^5.6.2",