@flakiness/sdk 0.149.0 → 0.150.0

package/README.md

@@ -1,11 +1,16 @@
-# Flakiness SDK
+# Flakiness Node.js SDK
 
-The Flakiness SDK provides a comprehensive set of tools for creating and managing Flakiness Reports in Node.js.
+The Flakiness SDK provides a comprehensive set of tools for creating and managing [Flakiness JSON Reports](https://github.com/flakiness/flakiness-report) in Node.js.
 
+## Installation
+
+```bash
+npm i @flakiness/sdk
+```
 
 ## Quick Start
 
-Here's a minimal example of creating a Flakiness report:
+Here's a minimal example of creating a Flakiness JSON Report:
 
 ```typescript
 import { 
@@ -74,7 +79,7 @@ Use this entry point when you need to process or manipulate reports in browser-b
 ## Top-Level Exports
 
 ### Report Type & Validation
-- **`FlakinessReport`** - Type definitions and validation for the Flakiness JSON Report format
+- **`FlakinessReport`** - Type definitions and validation for the [Flakiness JSON Report](https://github.com/flakiness/flakiness-report) format
 
 ### Building Reports
 - **`CIUtils`** - Utilities to extract CI/CD information (run URLs, environment detection)

package/lib/_internalUtils.js

@@ -1,12 +1,9 @@
-// src/_internalUtils.ts
 import { spawnSync } from "child_process";
 import crypto from "crypto";
 import fs from "fs";
-import http from "http";
-import https from "https";
 import util from "util";
 import zlib from "zlib";
-var asyncBrotliCompress = util.promisify(zlib.brotliCompress);
+const asyncBrotliCompress = util.promisify(zlib.brotliCompress);
 async function compressTextAsync(text) {
   return asyncBrotliCompress(text, {
     chunkSize: 32 * 1024,
@@ -16,7 +13,7 @@ async function compressTextAsync(text) {
     }
   });
 }
-var FLAKINESS_DBG = !!process.env.FLAKINESS_DBG;
+const FLAKINESS_DBG = !!process.env.FLAKINESS_DBG;
 function errorText(error) {
   return FLAKINESS_DBG ? error.stack : error.message;
 }
@@ -36,68 +33,6 @@ async function retryWithBackoff(job, backoff = []) {
   }
   return await job();
 }
-var httpUtils;
-((httpUtils2) => {
-  function createRequest({ url, method = "get", headers = {} }) {
-    let resolve;
-    let reject;
-    const responseDataPromise = new Promise((a, b) => {
-      resolve = a;
-      reject = b;
-    });
-    const protocol = url.startsWith("https") ? https : http;
-    headers = Object.fromEntries(Object.entries(headers).filter(([key, value]) => value !== void 0));
-    const request = protocol.request(url, { method, headers }, (res) => {
-      const chunks = [];
-      res.on("data", (chunk) => chunks.push(chunk));
-      res.on("end", () => {
-        if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300)
-          resolve(Buffer.concat(chunks));
-        else
-          reject(new Error(`Request to ${url} failed with ${res.statusCode}`));
-      });
-      res.on("error", (error) => reject(error));
-    });
-    request.on("error", reject);
-    return { request, responseDataPromise };
-  }
-  httpUtils2.createRequest = createRequest;
-  async function getBuffer(url, backoff) {
-    return await retryWithBackoff(async () => {
-      const { request, responseDataPromise } = createRequest({ url });
-      request.end();
-      return await responseDataPromise;
-    }, backoff);
-  }
-  httpUtils2.getBuffer = getBuffer;
-  async function getText(url, backoff) {
-    const buffer = await getBuffer(url, backoff);
-    return buffer.toString("utf-8");
-  }
-  httpUtils2.getText = getText;
-  async function getJSON(url) {
-    return JSON.parse(await getText(url));
-  }
-  httpUtils2.getJSON = getJSON;
-  async function postText(url, text, backoff) {
-    const headers = {
-      "Content-Type": "application/json",
-      "Content-Length": Buffer.byteLength(text) + ""
-    };
-    return await retryWithBackoff(async () => {
-      const { request, responseDataPromise } = createRequest({ url, headers, method: "post" });
-      request.write(text);
-      request.end();
-      return await responseDataPromise;
-    }, backoff);
-  }
-  httpUtils2.postText = postText;
-  async function postJSON(url, json, backoff) {
-    const buffer = await postText(url, JSON.stringify(json), backoff);
-    return JSON.parse(buffer.toString("utf-8"));
-  }
-  httpUtils2.postJSON = postJSON;
-})(httpUtils || (httpUtils = {}));
 function shell(command, args, options) {
   try {
     const result = spawnSync(command, args, { encoding: "utf-8", ...options });
@@ -146,7 +81,6 @@ function randomUUIDBase62() {
 export {
   compressTextAsync,
   errorText,
-  httpUtils,
   randomUUIDBase62,
   retryWithBackoff,
   sha1File,

package/lib/browser.js

@@ -1,154 +1,7 @@
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-
-// src/browser.ts
 import { FlakinessReport } from "@flakiness/flakiness-report";
-
-// src/reportUtilsBrowser.ts
-var reportUtilsBrowser_exports = {};
-__export(reportUtilsBrowser_exports, {
-  normalizeReport: () => normalizeReport,
-  stripAnsi: () => stripAnsi,
-  visitTests: () => visitTests
-});
-
-// src/normalizeReport.ts
-import stableObjectHash from "stable-hash";
-var Multimap = class {
-  _map = /* @__PURE__ */ new Map();
-  set(key, value) {
-    const set = this._map.get(key) ?? /* @__PURE__ */ new Set();
-    this._map.set(key, set);
-    set.add(value);
-  }
-  getAll(key) {
-    return Array.from(this._map.get(key) ?? []);
-  }
-};
-function normalizeReport(report) {
-  const gEnvs = /* @__PURE__ */ new Map();
-  const gSuites = /* @__PURE__ */ new Map();
-  const gTests = new Multimap();
-  const gSuiteIds = /* @__PURE__ */ new Map();
-  const gTestIds = /* @__PURE__ */ new Map();
-  const gEnvIds = /* @__PURE__ */ new Map();
-  const gSuiteChildren = new Multimap();
-  const gSuiteTests = new Multimap();
-  for (const env of report.environments) {
-    const envId = computeEnvId(env);
-    gEnvs.set(envId, env);
-    gEnvIds.set(env, envId);
-  }
-  const usedEnvIds = /* @__PURE__ */ new Set();
-  function visitTests2(tests, suiteId) {
-    for (const test of tests ?? []) {
-      const testId = computeTestId(test, suiteId);
-      gTests.set(testId, test);
-      gTestIds.set(test, testId);
-      gSuiteTests.set(suiteId, test);
-      for (const attempt of test.attempts) {
-        const env = report.environments[attempt.environmentIdx];
-        const envId = gEnvIds.get(env);
-        usedEnvIds.add(envId);
-      }
-    }
-  }
-  function visitSuite(suite, parentSuiteId) {
-    const suiteId = computeSuiteId(suite, parentSuiteId);
-    gSuites.set(suiteId, suite);
-    gSuiteIds.set(suite, suiteId);
-    for (const childSuite of suite.suites ?? []) {
-      visitSuite(childSuite, suiteId);
-      gSuiteChildren.set(suiteId, childSuite);
-    }
-    visitTests2(suite.tests ?? [], suiteId);
-  }
-  function transformTests(tests) {
-    const testIds = new Set(tests.map((test) => gTestIds.get(test)));
-    return [...testIds].map((testId) => {
-      const tests2 = gTests.getAll(testId);
-      const tags = tests2.map((test) => test.tags ?? []).flat();
-      return {
-        location: tests2[0].location,
-        title: tests2[0].title,
-        tags: tags.length ? tags : void 0,
-        attempts: tests2.map((t) => t.attempts).flat().map((attempt) => ({
-          ...attempt,
-          environmentIdx: envIdToIndex.get(gEnvIds.get(report.environments[attempt.environmentIdx]))
-        }))
-      };
-    });
-  }
-  function transformSuites(suites) {
-    const suiteIds = new Set(suites.map((suite) => gSuiteIds.get(suite)));
-    return [...suiteIds].map((suiteId) => {
-      const suite = gSuites.get(suiteId);
-      return {
-        location: suite.location,
-        title: suite.title,
-        type: suite.type,
-        suites: transformSuites(gSuiteChildren.getAll(suiteId)),
-        tests: transformTests(gSuiteTests.getAll(suiteId))
-      };
-    });
-  }
-  visitTests2(report.tests ?? [], "suiteless");
-  for (const suite of report.suites)
-    visitSuite(suite);
-  const newEnvironments = [...usedEnvIds];
-  const envIdToIndex = new Map(newEnvironments.map((envId, index) => [envId, index]));
-  return {
-    ...report,
-    environments: newEnvironments.map((envId) => gEnvs.get(envId)),
-    suites: transformSuites(report.suites),
-    tests: transformTests(report.tests ?? [])
-  };
-}
-function computeEnvId(env) {
-  return stableObjectHash(env);
-}
-function computeSuiteId(suite, parentSuiteId) {
-  return stableObjectHash({
-    parentSuiteId: parentSuiteId ?? "",
-    type: suite.type,
-    file: suite.location?.file ?? "",
-    title: suite.title
-  });
-}
-function computeTestId(test, suiteId) {
-  return stableObjectHash({
-    suiteId,
-    file: test.location?.file ?? "",
-    title: test.title
-  });
-}
-
-// src/stripAnsi.ts
-var ansiRegex = new RegExp("[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)|(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))", "g");
-function stripAnsi(str) {
-  return str.replace(ansiRegex, "");
-}
-
-// src/visitTests.ts
-function visitTests(report, testVisitor) {
-  function visitSuite(suite, parents) {
-    parents.push(suite);
-    for (const test of suite.tests ?? [])
-      testVisitor(test, parents);
-    for (const childSuite of suite.suites ?? [])
-      visitSuite(childSuite, parents);
-    parents.pop();
-  }
-  for (const test of report.tests ?? [])
-    testVisitor(test, []);
-  for (const suite of report.suites)
-    visitSuite(suite, []);
-}
+import * as ReportUtils from "./reportUtilsBrowser.js";
 export {
   FlakinessReport,
-  reportUtilsBrowser_exports as ReportUtils
+  ReportUtils
 };
 //# sourceMappingURL=browser.js.map

package/lib/ciUtils.js

@@ -1,4 +1,3 @@
-// src/ciUtils.ts
 var CIUtils;
 ((CIUtils2) => {
   function runUrl() {

package/lib/createEnvironment.js

@@ -1,110 +1,6 @@
-// src/createEnvironment.ts
 import fs from "fs";
 import os from "os";
-
-// src/_internalUtils.ts
-import { spawnSync } from "child_process";
-import http from "http";
-import https from "https";
-import util from "util";
-import zlib from "zlib";
-var asyncBrotliCompress = util.promisify(zlib.brotliCompress);
-var FLAKINESS_DBG = !!process.env.FLAKINESS_DBG;
-function errorText(error) {
-  return FLAKINESS_DBG ? error.stack : error.message;
-}
-async function retryWithBackoff(job, backoff = []) {
-  for (const timeout of backoff) {
-    try {
-      return await job();
-    } catch (e) {
-      if (e instanceof AggregateError)
-        console.error(`[flakiness.io err]`, errorText(e.errors[0]));
-      else if (e instanceof Error)
-        console.error(`[flakiness.io err]`, errorText(e));
-      else
-        console.error(`[flakiness.io err]`, e);
-      await new Promise((x) => setTimeout(x, timeout));
-    }
-  }
-  return await job();
-}
-var httpUtils;
-((httpUtils2) => {
-  function createRequest({ url, method = "get", headers = {} }) {
-    let resolve;
-    let reject;
-    const responseDataPromise = new Promise((a, b) => {
-      resolve = a;
-      reject = b;
-    });
-    const protocol = url.startsWith("https") ? https : http;
-    headers = Object.fromEntries(Object.entries(headers).filter(([key, value]) => value !== void 0));
-    const request = protocol.request(url, { method, headers }, (res) => {
-      const chunks = [];
-      res.on("data", (chunk) => chunks.push(chunk));
-      res.on("end", () => {
-        if (res.statusCode && res.statusCode >= 200 && res.statusCode < 300)
-          resolve(Buffer.concat(chunks));
-        else
-          reject(new Error(`Request to ${url} failed with ${res.statusCode}`));
-      });
-      res.on("error", (error) => reject(error));
-    });
-    request.on("error", reject);
-    return { request, responseDataPromise };
-  }
-  httpUtils2.createRequest = createRequest;
-  async function getBuffer(url, backoff) {
-    return await retryWithBackoff(async () => {
-      const { request, responseDataPromise } = createRequest({ url });
-      request.end();
-      return await responseDataPromise;
-    }, backoff);
-  }
-  httpUtils2.getBuffer = getBuffer;
-  async function getText(url, backoff) {
-    const buffer = await getBuffer(url, backoff);
-    return buffer.toString("utf-8");
-  }
-  httpUtils2.getText = getText;
-  async function getJSON(url) {
-    return JSON.parse(await getText(url));
-  }
-  httpUtils2.getJSON = getJSON;
-  async function postText(url, text, backoff) {
-    const headers = {
-      "Content-Type": "application/json",
-      "Content-Length": Buffer.byteLength(text) + ""
-    };
-    return await retryWithBackoff(async () => {
-      const { request, responseDataPromise } = createRequest({ url, headers, method: "post" });
-      request.write(text);
-      request.end();
-      return await responseDataPromise;
-    }, backoff);
-  }
-  httpUtils2.postText = postText;
-  async function postJSON(url, json, backoff) {
-    const buffer = await postText(url, JSON.stringify(json), backoff);
-    return JSON.parse(buffer.toString("utf-8"));
-  }
-  httpUtils2.postJSON = postJSON;
-})(httpUtils || (httpUtils = {}));
-function shell(command, args, options) {
-  try {
-    const result = spawnSync(command, args, { encoding: "utf-8", ...options });
-    if (result.status !== 0) {
-      return void 0;
-    }
-    return result.stdout.trim();
-  } catch (e) {
-    console.error(e);
-    return void 0;
-  }
-}
-
-// src/createEnvironment.ts
+import { shell } from "./_internalUtils.js";
 function readLinuxOSRelease() {
   const osReleaseText = fs.readFileSync("/etc/os-release", "utf-8");
   return new Map(osReleaseText.toLowerCase().split("\n").filter((line) => line.includes("=")).map((line) => {

package/lib/createTestStepSnippets.js

@@ -1,24 +1,6 @@
-// src/createTestStepSnippets.ts
 import { codeFrameColumns } from "@babel/code-frame";
 import fs from "fs";
-
-// src/visitTests.ts
-function visitTests(report, testVisitor) {
-  function visitSuite(suite, parents) {
-    parents.push(suite);
-    for (const test of suite.tests ?? [])
-      testVisitor(test, parents);
-    for (const childSuite of suite.suites ?? [])
-      visitSuite(childSuite, parents);
-    parents.pop();
-  }
-  for (const test of report.tests ?? [])
-    testVisitor(test, []);
-  for (const suite of report.suites)
-    visitSuite(suite, []);
-}
-
-// src/createTestStepSnippets.ts
+import { visitTests } from "./visitTests.js";
 function createTestStepSnippetsInplace(worktree, report) {
   const allSteps = /* @__PURE__ */ new Map();
   visitTests(report, (test) => {