@flakiness/sdk 0.150.1 → 0.151.0

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@flakiness/sdk",
-  "version": "0.150.1",
+  "version": "0.151.0",
   "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flakiness/nodejs-sdk.git"
+  },
   "exports": {
     ".": {
       "types": "./types/src/index.d.ts",

package/lib/_internalUtils.js

@@ -1,90 +0,0 @@
-import { spawnSync } from "child_process";
-import crypto from "crypto";
-import fs from "fs";
-import util from "util";
-import zlib from "zlib";
-const asyncBrotliCompress = util.promisify(zlib.brotliCompress);
-async function compressTextAsync(text) {
-  return asyncBrotliCompress(text, {
-    chunkSize: 32 * 1024,
-    params: {
-      [zlib.constants.BROTLI_PARAM_QUALITY]: 6,
-      [zlib.constants.BROTLI_PARAM_MODE]: zlib.constants.BROTLI_MODE_TEXT
-    }
-  });
-}
-const 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();
-}
-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;
-  }
-}
-function sha1Text(data) {
-  const hash = crypto.createHash("sha1");
-  hash.update(data);
-  return hash.digest("hex");
-}
-function sha1File(filePath) {
-  return new Promise((resolve, reject) => {
-    const hash = crypto.createHash("sha1");
-    const stream = fs.createReadStream(filePath);
-    stream.on("data", (chunk) => {
-      hash.update(chunk);
-    });
-    stream.on("end", () => {
-      resolve(hash.digest("hex"));
-    });
-    stream.on("error", (err) => {
-      reject(err);
-    });
-  });
-}
-function randomUUIDBase62() {
-  const BASE62_CHARSET = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
-  let num = BigInt("0x" + crypto.randomUUID().replace(/-/g, ""));
-  if (num === 0n)
-    return BASE62_CHARSET[0];
-  const chars = [];
-  while (num > 0n) {
-    const remainder = Number(num % 62n);
-    num /= 62n;
-    chars.push(BASE62_CHARSET[remainder]);
-  }
-  return chars.reverse().join("");
-}
-export {
-  compressTextAsync,
-  errorText,
-  randomUUIDBase62,
-  retryWithBackoff,
-  sha1File,
-  sha1Text,
-  shell
-};
-//# sourceMappingURL=_internalUtils.js.map

package/lib/_stable-hash.d.js

@@ -1 +0,0 @@
-//# sourceMappingURL=_stable-hash.d.js.map

package/lib/ciUtils.js

@@ -1,41 +0,0 @@
-var CIUtils;
-((CIUtils2) => {
-  function runUrl() {
-    return githubActions() ?? azure() ?? process.env.CI_JOB_URL ?? process.env.BUILD_URL;
-  }
-  CIUtils2.runUrl = runUrl;
-})(CIUtils || (CIUtils = {}));
-function githubActions() {
-  const serverUrl = process.env.GITHUB_SERVER_URL || "https://github.com";
-  const repo = process.env.GITHUB_REPOSITORY;
-  const runId = process.env.GITHUB_RUN_ID;
-  if (!repo || !runId) return void 0;
-  try {
-    const url = new URL(`${serverUrl}/${repo}/actions/runs/${runId}`);
-    const attempt = process.env.GITHUB_RUN_ATTEMPT;
-    if (attempt) url.searchParams.set("attempt", attempt);
-    url.searchParams.set("check_suite_focus", "true");
-    return url.toString();
-  } catch (error) {
-    return void 0;
-  }
-}
-function azure() {
-  const collectionUri = process.env.SYSTEM_TEAMFOUNDATIONCOLLECTIONURI;
-  const project = process.env.SYSTEM_TEAMPROJECT;
-  const buildId = process.env.BUILD_BUILDID;
-  if (!collectionUri || !project || !buildId)
-    return void 0;
-  try {
-    const baseUrl = collectionUri.endsWith("/") ? collectionUri : `${collectionUri}/`;
-    const url = new URL(`${baseUrl}${project}/_build/results`);
-    url.searchParams.set("buildId", buildId);
-    return url.toString();
-  } catch (error) {
-    return void 0;
-  }
-}
-export {
-  CIUtils
-};
-//# sourceMappingURL=ciUtils.js.map

package/lib/createEnvironment.js

@@ -1,65 +0,0 @@
-import fs from "fs";
-import os from "os";
-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) => {
-    line = line.trim();
-    let [key, value] = line.split("=");
-    if (value.startsWith('"') && value.endsWith('"'))
-      value = value.substring(1, value.length - 1);
-    return [key, value];
-  }));
-}
-function osLinuxInfo() {
-  const arch = shell(`uname`, [`-m`]);
-  const osReleaseMap = readLinuxOSRelease();
-  const name = osReleaseMap.get("name") ?? shell(`uname`);
-  const version = osReleaseMap.get("version_id");
-  return { name, arch, version };
-}
-function osDarwinInfo() {
-  const name = "macos";
-  const arch = shell(`uname`, [`-m`]);
-  const version = shell(`sw_vers`, [`-productVersion`]);
-  return { name, arch, version };
-}
-function osWinInfo() {
-  const name = "win";
-  const arch = process.arch;
-  const version = os.release();
-  return { name, arch, version };
-}
-function getOSInfo() {
-  if (process.platform === "darwin")
-    return osDarwinInfo();
-  if (process.platform === "win32")
-    return osWinInfo();
-  return osLinuxInfo();
-}
-function extractEnvConfiguration() {
-  const ENV_PREFIX = "FK_ENV_";
-  return Object.fromEntries(
-    Object.entries(process.env).filter(([key]) => key.toUpperCase().startsWith(ENV_PREFIX.toUpperCase())).map(([key, value]) => [key.substring(ENV_PREFIX.length).toLowerCase(), (value ?? "").trim().toLowerCase()])
-  );
-}
-function createEnvironment(options) {
-  const osInfo = getOSInfo();
-  return {
-    name: options.name,
-    systemData: {
-      osArch: osInfo.arch,
-      osName: osInfo.name,
-      osVersion: osInfo.version
-    },
-    userSuppliedData: {
-      ...extractEnvConfiguration(),
-      ...options.userSuppliedData ?? {}
-    },
-    opaqueData: options.opaqueData
-  };
-}
-export {
-  createEnvironment
-};
-//# sourceMappingURL=createEnvironment.js.map

package/lib/createTestStepSnippets.js

@@ -1,47 +0,0 @@
-import { codeFrameColumns } from "@babel/code-frame";
-import fs from "fs";
-import { visitTests } from "./visitTests.js";
-function createTestStepSnippetsInplace(worktree, report) {
-  const allSteps = /* @__PURE__ */ new Map();
-  visitTests(report, (test) => {
-    for (const attempt of test.attempts) {
-      for (const step of attempt.steps ?? []) {
-        if (!step.location)
-          continue;
-        let fileSteps = allSteps.get(step.location.file);
-        if (!fileSteps) {
-          fileSteps = /* @__PURE__ */ new Set();
-          allSteps.set(step.location.file, fileSteps);
-        }
-        fileSteps.add(step);
-      }
-    }
-  });
-  for (const [gitFilePath, steps] of allSteps) {
-    let source;
-    try {
-      source = fs.readFileSync(worktree.absolutePath(gitFilePath), "utf-8");
-    } catch (e) {
-      continue;
-    }
-    const lines = source.split("\n").length;
-    const highlighted = codeFrameColumns(source, { start: { line: lines, column: 1 } }, { highlightCode: true, linesAbove: lines, linesBelow: 0 });
-    const highlightedLines = highlighted.split("\n");
-    const lineWithArrow = highlightedLines[highlightedLines.length - 1];
-    for (const step of steps) {
-      if (!step.location)
-        continue;
-      if (step.location.line < 2 || step.location.line >= lines)
-        continue;
-      const snippetLines = highlightedLines.slice(step.location.line - 2, step.location.line + 1);
-      const index = lineWithArrow.indexOf("^");
-      const shiftedArrow = lineWithArrow.slice(0, index) + " ".repeat(step.location.column - 1) + lineWithArrow.slice(index);
-      snippetLines.splice(2, 0, shiftedArrow);
-      step.snippet = snippetLines.join("\n");
-    }
-  }
-}
-export {
-  createTestStepSnippetsInplace
-};
-//# sourceMappingURL=createTestStepSnippets.js.map

package/lib/flakinessProjectConfig.js

@@ -1,143 +0,0 @@
-import fs from "fs";
-import path from "path";
-import { GitWorktree } from "./gitWorktree.js";
-function createConfigPath(dir) {
-  return path.join(dir, ".flakiness", "config.json");
-}
-let gConfigPath;
-function ensureConfigPath() {
-  if (!gConfigPath)
-    gConfigPath = computeConfigPath();
-  return gConfigPath;
-}
-function computeConfigPath() {
-  for (let p = process.cwd(); p !== path.resolve(p, ".."); p = path.resolve(p, "..")) {
-    const configPath = createConfigPath(p);
-    if (fs.existsSync(configPath))
-      return configPath;
-  }
-  try {
-    const worktree = GitWorktree.create(process.cwd());
-    return createConfigPath(worktree.rootPath());
-  } catch (e) {
-    return createConfigPath(process.cwd());
-  }
-}
-class FlakinessProjectConfig {
-  constructor(_configPath, _config) {
-    this._configPath = _configPath;
-    this._config = _config;
-  }
-  /**
-   * Loads the Flakiness project configuration from disk.
-   *
-   * Searches for an existing `.flakiness/config.json` file starting from the current working
-   * directory and walking up the directory tree. If no config exists, it determines the
-   * appropriate location (git root or current directory) for future saves.
-   *
-   * @returns {Promise<FlakinessProjectConfig>} Promise that resolves to a FlakinessProjectConfig
-   *   instance. If no config file exists, returns an instance with default/empty values.
-   *
-   * @example
-   * ```typescript
-   * const config = await FlakinessProjectConfig.load();
-   * const projectId = config.projectPublicId();
-   * ```
-   */
-  static async load() {
-    const configPath = ensureConfigPath();
-    const data = await fs.promises.readFile(configPath, "utf-8").catch((e) => void 0);
-    const json = data ? JSON.parse(data) : {};
-    return new FlakinessProjectConfig(configPath, json);
-  }
-  /**
-   * Creates a new empty Flakiness project configuration.
-   *
-   * Creates a configuration instance with no values set. Use this when you want to build
-   * a configuration from scratch. Call `save()` to persist it to disk.
-   *
-   * @returns {FlakinessProjectConfig} A new empty configuration instance.
-   *
-   * @example
-   * ```typescript
-   * const config = FlakinessProjectConfig.createEmpty();
-   * config.setProjectPublicId('my-project-id');
-   * await config.save();
-   * ```
-   */
-  static createEmpty() {
-    return new FlakinessProjectConfig(ensureConfigPath(), {});
-  }
-  /**
-   * Returns the absolute path to the configuration file.
-   *
-   * @returns {string} Absolute path to `.flakiness/config.json`.
-   */
-  path() {
-    return this._configPath;
-  }
-  /**
-   * Returns the project's public ID, if configured.
-   *
-   * The project public ID is used to associate reports with a specific Flakiness.io project.
-   *
-   * @returns {string | undefined} Project public ID, or `undefined` if not set.
-   */
-  projectPublicId() {
-    return this._config.projectPublicId;
-  }
-  /**
-   * Returns the report viewer URL, either custom or default.
-   *
-   * @returns {string} Custom report viewer URL if configured, otherwise the default
-   *   `https://report.flakiness.io`.
-   */
-  reportViewerUrl() {
-    return this._config.customReportViewerUrl ?? "https://report.flakiness.io";
-  }
-  /**
-   * Sets or clears the custom report viewer URL.
-   *
-   * @param {string | undefined} url - Custom report viewer URL to use, or `undefined` to
-   *   clear and use the default URL.
-   */
-  setCustomReportViewerUrl(url) {
-    if (url)
-      this._config.customReportViewerUrl = url;
-    else
-      delete this._config.customReportViewerUrl;
-  }
-  /**
-   * Sets the project's public ID.
-   *
-   * @param {string | undefined} projectId - Project public ID to set, or `undefined` to clear.
-   */
-  setProjectPublicId(projectId) {
-    this._config.projectPublicId = projectId;
-  }
-  /**
-   * Saves the configuration to disk.
-   *
-   * Writes the current configuration values to `.flakiness/config.json`. Creates the
-   * `.flakiness` directory if it doesn't exist.
-   *
-   * @returns {Promise<void>} Promise that resolves when the file has been written.
-   *
-   * @throws {Error} Throws if unable to create directories or write the file.
-   *
-   * @example
-   * ```typescript
-   * const config = await FlakinessProjectConfig.load();
-   * config.setProjectPublicId('my-project');
-   * await config.save();
-   * ```
-   */
-  async save() {
-    await fs.promises.mkdir(path.dirname(this._configPath), { recursive: true });
-    await fs.promises.writeFile(this._configPath, JSON.stringify(this._config, null, 2));
-  }
-}
-export {
-  FlakinessProjectConfig
-};
-//# sourceMappingURL=flakinessProjectConfig.js.map

package/lib/gitWorktree.js

@@ -1,208 +0,0 @@
-import assert from "assert";
-import { exec } from "child_process";
-import debug from "debug";
-import { posix as posixPath, win32 as win32Path } from "path";
-import { promisify } from "util";
-import { shell } from "./_internalUtils.js";
-const log = debug("fk:git");
-const execAsync = promisify(exec);
-const IS_WIN32_PATH = new RegExp("^[a-zA-Z]:\\\\", "i");
-const IS_ALMOST_POSIX_PATH = new RegExp("^[a-zA-Z]:/", "i");
-function toPosixAbsolutePath(absolutePath) {
-  if (IS_WIN32_PATH.test(absolutePath)) {
-    absolutePath = absolutePath.split(win32Path.sep).join(posixPath.sep);
-  }
-  if (IS_ALMOST_POSIX_PATH.test(absolutePath))
-    return "/" + absolutePath[0] + absolutePath.substring(2);
-  return absolutePath;
-}
-function toNativeAbsolutePath(posix) {
-  if (process.platform !== "win32")
-    return posix;
-  assert(posix.startsWith("/"), "The path must be absolute");
-  const m = posix.match(/^\/([a-zA-Z])(\/.*)?$/);
-  assert(m, `Invalid POSIX path: ${posix}`);
-  const drive = m[1];
-  const rest = (m[2] ?? "").split(posixPath.sep).join(win32Path.sep);
-  return drive.toUpperCase() + ":" + rest;
-}
-class GitWorktree {
-  constructor(_gitRoot) {
-    this._gitRoot = _gitRoot;
-    this._posixGitRoot = toPosixAbsolutePath(this._gitRoot);
-  }
-  /**
-   * Creates a GitWorktree instance from any path inside a git repository.
-   *
-   * @param {string} somePathInsideGitRepo - Any path (file or directory) within a git repository.
-   *   Can be absolute or relative. The function will locate the git root directory.
-   *
-   * @returns {GitWorktree} A new GitWorktree instance bound to the discovered git root.
-   *
-   * @throws {Error} Throws if the path is not inside a git repository or if git commands fail.
-   *
-   * @example
-   * ```typescript
-   * const worktree = GitWorktree.create('./src/my-test.ts');
-   * const gitRoot = worktree.rootPath();
-   * ```
-   */
-  static create(somePathInsideGitRepo) {
-    const root = shell(`git`, ["rev-parse", "--show-toplevel"], {
-      cwd: somePathInsideGitRepo,
-      encoding: "utf-8"
-    });
-    assert(root, `FAILED: git rev-parse --show-toplevel HEAD @ ${somePathInsideGitRepo}`);
-    return new GitWorktree(root);
-  }
-  _posixGitRoot;
-  /**
-   * Returns the native absolute path of the git repository root directory.
-   *
-   * @returns {string} Native absolute path to the git root. Format matches the current platform
-   *   (Windows or POSIX).
-   *
-   * @example
-   * ```typescript
-   * const root = worktree.rootPath();
-   * // On Windows: 'D:\project'
-   * // On Unix: '/project'
-   * ```
-   */
-  rootPath() {
-    return this._gitRoot;
-  }
-  /**
-   * Returns the commit ID (SHA-1 hash) of the current HEAD commit.
-   *
-   * @returns {FlakinessReport.CommitId} Full 40-character commit hash of the HEAD commit.
-   *
-   * @throws {Error} Throws if git command fails or repository is in an invalid state.
-   *
-   * @example
-   * ```typescript
-   * const commitId = worktree.headCommitId();
-   * // Returns: 'a1b2c3d4e5f6...' (40-character SHA-1)
-   * ```
-   */
-  headCommitId() {
-    const sha = shell(`git`, ["rev-parse", "HEAD"], {
-      cwd: this._gitRoot,
-      encoding: "utf-8"
-    });
-    assert(sha, `FAILED: git rev-parse HEAD @ ${this._gitRoot}`);
-    return sha.trim();
-  }
-  /**
-   * Converts a native absolute path to a git-relative POSIX path.
-   *
-   * Takes any absolute path (Windows or POSIX format) and converts it to a POSIX path
-   * relative to the git repository root. This is essential for Flakiness reports where
-   * all file paths must be git-relative and use POSIX separators.
-   *
-   * @param {string} absolutePath - Native absolute path to convert. Can be in Windows format
-   *   (e.g., `D:\project\src\test.ts`) or POSIX format (e.g., `/project/src/test.ts`).
-   *
-   * @returns {FlakinessReport.GitFilePath} POSIX path relative to git root (e.g., `src/test.ts`).
-   *   Returns an empty string if the path is the git root itself.
-   *
-   * @example
-   * ```typescript
-   * const gitPath = worktree.gitPath('/Users/project/src/test.ts');
-   * // Returns: 'src/test.ts'
-   * ```
-   */
-  gitPath(absolutePath) {
-    return posixPath.relative(this._posixGitRoot, toPosixAbsolutePath(absolutePath));
-  }
-  /**
-   * Converts a git-relative POSIX path to a native absolute path.
-   *
-   * Takes a POSIX path relative to the git root and converts it to the native absolute path
-   * format for the current platform (Windows or POSIX). This is the inverse of `gitPath()`.
-   *
-   * @param {FlakinessReport.GitFilePath} relativePath - POSIX path relative to git root
-   *   (e.g., `src/test.ts`).
-   *
-   * @returns {string} Native absolute path. On Windows, returns Windows format (e.g., `D:\project\src\test.ts`).
-   *   On POSIX systems, returns POSIX format (e.g., `/project/src/test.ts`).
-   *
-   * @example
-   * ```typescript
-   * const absolutePath = worktree.absolutePath('src/test.ts');
-   * // On Windows: 'D:\project\src\test.ts'
-   * // On Unix: '/project/src/test.ts'
-   * ```
-   */
-  absolutePath(relativePath) {
-    return toNativeAbsolutePath(posixPath.join(this._posixGitRoot, relativePath));
-  }
-  /**
-   * Lists recent commits from the repository.
-   *
-   * Retrieves commit information including commit ID, timestamp, author, message, and parent commits.
-   * Note: CI environments often have shallow checkouts with limited history, which may affect
-   * the number of commits returned.
-   *
-   * @param {number} count - Maximum number of commits to retrieve, starting from HEAD.
-   *
-   * @returns {Promise<GitCommit[]>} Promise that resolves to an array of commit objects, ordered
-   *   from most recent to oldest. Each commit includes:
-   *   - `commitId` - Full commit hash
-   *   - `timestamp` - Commit timestamp in milliseconds since Unix epoch
-   *   - `message` - Commit message (subject line)
-   *   - `author` - Author name
-   *   - `parents` - Array of parent commit IDs
-   *
-   * @example
-   * ```typescript
-   * const commits = await worktree.listCommits(10);
-   * console.log(`Latest commit: ${commits[0].message}`);
-   * ```
-   */
-  async listCommits(count) {
-    return await listCommits(this._gitRoot, "HEAD", count);
-  }
-}
-async function listCommits(gitRoot, head, count) {
-  const FIELD_SEPARATOR = "|~|";
-  const RECORD_SEPARATOR = "\0";
-  const prettyFormat = [
-    "%H",
-    // Full commit hash
-    "%ct",
-    // Commit timestamp (Unix seconds)
-    "%an",
-    // Author name
-    "%s",
-    // Subject line
-    "%P"
-    // Parent hashes (space-separated)
-  ].join(FIELD_SEPARATOR);
-  const command = `git log ${head} -n ${count} --pretty=format:"${prettyFormat}" -z`;
-  try {
-    const { stdout } = await execAsync(command, { cwd: gitRoot });
-    if (!stdout) {
-      return [];
-    }
-    return stdout.trim().split(RECORD_SEPARATOR).filter((record) => record).map((record) => {
-      const [commitId, timestampStr, author, message, parentsStr] = record.split(FIELD_SEPARATOR);
-      const parents = parentsStr ? parentsStr.split(" ").filter((p) => p) : [];
-      return {
-        commitId,
-        timestamp: parseInt(timestampStr, 10) * 1e3,
-        author,
-        message,
-        parents,
-        walkIndex: 0
-      };
-    });
-  } catch (error) {
-    log(`Failed to list commits for repository at ${gitRoot}:`, error);
-    return [];
-  }
-}
-export {
-  GitWorktree
-};
-//# sourceMappingURL=gitWorktree.js.map