@flakiness/report 0.92.0 → 0.95.0

package/lib/reportUploader.js

@@ -1,115 +0,0 @@
-import fs from "fs";
-import { URL } from "url";
-import { brotliCompressSync } from "zlib";
-import { brotliCompressAsync, httpUtils, retryWithBackoff } from "./utils.js";
-class ReportUploader {
-  static optionsFromEnv(overrides) {
-    const flakinessAccessToken = overrides?.flakinessAccessToken ?? process.env["FLAKINESS_ACCESS_TOKEN"];
-    if (!flakinessAccessToken)
-      return void 0;
-    const flakinessEndpoint = overrides?.flakinessEndpoint ?? process.env["FLAKINESS_ENDPOINT"] ?? "https://flakiness.io";
-    return { flakinessAccessToken, flakinessEndpoint };
-  }
-  static async upload(options) {
-    const uploaderOptions = ReportUploader.optionsFromEnv(options);
-    if (!uploaderOptions) {
-      options.log?.(`[flakiness.io] Uploading skipped since no FLAKINESS_ACCESS_TOKEN is specified`);
-      return void 0;
-    }
-    const uploader = new ReportUploader(uploaderOptions);
-    const upload = uploader.createUpload(options.report, options.attachments);
-    const uploadResult = await upload.upload();
-    if (!uploadResult.success) {
-      options.log?.(`[flakiness.io] X Failed to upload to ${uploaderOptions.flakinessEndpoint}: ${uploadResult.message}`);
-      return { errorMessage: uploadResult.message };
-    }
-    options.log?.(`[flakiness.io] \u2713 Report uploaded ${uploadResult.message ?? ""}`);
-    if (uploadResult.reportUrl)
-      options.log?.(`[flakiness.io] ${uploadResult.reportUrl}`);
-  }
-  _options;
-  constructor(options) {
-    this._options = options;
-  }
-  createUpload(report, attachments) {
-    const upload = new ReportUpload(this._options, report, attachments);
-    return upload;
-  }
-}
-const HTTP_BACKOFF = [100, 500, 1e3, 1e3, 1e3, 1e3];
-class ReportUpload {
-  _report;
-  _attachments;
-  _options;
-  constructor(options, report, attachments) {
-    this._options = options;
-    this._report = report;
-    this._attachments = attachments;
-  }
-  async upload(options) {
-    const response = await httpUtils.postJSON(new URL("/api/run/startUpload", this._options.flakinessEndpoint).toString(), {
-      flakinessAccessToken: this._options.flakinessAccessToken,
-      attachmentIds: this._attachments.map((attachment) => attachment.id)
-    }, HTTP_BACKOFF).then((result) => ({ result, error: void 0 })).catch((e) => ({ error: e, result: void 0 }));
-    if (response?.error)
-      return { success: false, message: `flakiness.io returned error: ${response.error.message}` };
-    await Promise.all([
-      this._uploadReport(JSON.stringify(this._report), response.result.report_upload_url, options?.syncCompression ?? false),
-      ...this._attachments.map((attachment) => {
-        const uploadURL = response.result.attachment_upload_urls[attachment.id];
-        if (!uploadURL)
-          throw new Error("Internal error: missing upload URL for attachment!");
-        return this._uploadAttachment(attachment, uploadURL);
-      })
-    ]);
-    const response2 = await httpUtils.postJSON(new URL("/api/run/completeUpload", this._options.flakinessEndpoint).toString(), {
-      upload_token: response.result.upload_token
-    }, HTTP_BACKOFF).then((result) => ({ result, error: void 0 })).catch((e) => ({ error: e, result: void 0 }));
-    const url = response2?.result.report_url ? new URL(response2?.result.report_url, this._options.flakinessEndpoint).toString() : void 0;
-    return { success: true, reportUrl: url };
-  }
-  async _uploadReport(data, uploadUrl, syncCompression) {
-    const compressed = syncCompression ? brotliCompressSync(data) : await brotliCompressAsync(data);
-    const headers = {
-      "Content-Type": "application/json",
-      "Content-Length": Buffer.byteLength(compressed) + "",
-      "Content-Encoding": "br"
-    };
-    await retryWithBackoff(async () => {
-      const { request, responseDataPromise } = httpUtils.createRequest({
-        url: uploadUrl,
-        headers,
-        method: "put"
-      });
-      request.write(compressed);
-      request.end();
-      await responseDataPromise;
-    }, HTTP_BACKOFF);
-  }
-  async _uploadAttachment(attachment, uploadUrl) {
-    const bytesLength = attachment.path ? (await fs.promises.stat(attachment.path)).size : attachment.body ? Buffer.byteLength(attachment.body) : 0;
-    const headers = {
-      "Content-Type": attachment.contentType,
-      "Content-Length": bytesLength + ""
-    };
-    await retryWithBackoff(async () => {
-      const { request, responseDataPromise } = httpUtils.createRequest({
-        url: uploadUrl,
-        headers,
-        method: "put"
-      });
-      if (attachment.path) {
-        fs.createReadStream(attachment.path).pipe(request);
-      } else {
-        if (attachment.body)
-          request.write(attachment.body);
-        request.end();
-      }
-      await responseDataPromise;
-    }, HTTP_BACKOFF);
-  }
-}
-export {
-  ReportUploader
-};
-//# sourceMappingURL=reportUploader.js.map

package/lib/systemUtilizationSampler.js

@@ -1,70 +0,0 @@
-import { spawnSync } from "child_process";
-import os from "os";
-function getAvailableMemMacOS() {
-  const lines = spawnSync("vm_stat", { encoding: "utf8" }).stdout.trim().split("\n");
-  const pageSize = parseInt(lines[0].match(/page size of (\d+) bytes/)[1], 10);
-  if (isNaN(pageSize)) {
-    console.warn("[flakiness.io] Error detecting macos page size");
-    return 0;
-  }
-  let totalFree = 0;
-  for (const line of lines) {
-    if (/Pages (free|inactive|speculative):/.test(line)) {
-      const match = line.match(/\d+/);
-      if (match)
-        totalFree += parseInt(match[0], 10);
-    }
-  }
-  return totalFree * pageSize;
-}
-function getSystemUtilization() {
-  let idleTicks = 0;
-  let totalTicks = 0;
-  for (const cpu of os.cpus()) {
-    totalTicks += cpu.times.user + cpu.times.nice + cpu.times.sys + cpu.times.irq + cpu.times.idle;
-    idleTicks += cpu.times.idle;
-  }
-  return {
-    idleTicks,
-    totalTicks,
-    timestamp: Date.now(),
-    freeBytes: os.platform() === "darwin" ? getAvailableMemMacOS() : os.freemem()
-  };
-}
-function toFKUtilization(sample, previous) {
-  const idleTicks = sample.idleTicks - previous.idleTicks;
-  const totalTicks = sample.totalTicks - previous.totalTicks;
-  const cpuUtilization = Math.floor((1 - idleTicks / totalTicks) * 1e4) / 100;
-  const memoryUtilization = Math.floor((1 - sample.freeBytes / os.totalmem()) * 1e4) / 100;
-  return {
-    cpuUtilization,
-    memoryUtilization,
-    dts: sample.timestamp - previous.timestamp
-  };
-}
-class SystemUtilizationSampler {
-  result;
-  _lastSample = getSystemUtilization();
-  _timer;
-  constructor() {
-    this.result = {
-      samples: [],
-      startTimestamp: this._lastSample.timestamp,
-      totalMemoryBytes: os.totalmem()
-    };
-    this._timer = setTimeout(this._addSample.bind(this), 50);
-  }
-  _addSample() {
-    const sample = getSystemUtilization();
-    this.result.samples.push(toFKUtilization(sample, this._lastSample));
-    this._lastSample = sample;
-    this._timer = setTimeout(this._addSample.bind(this), 1e3);
-  }
-  dispose() {
-    clearTimeout(this._timer);
-  }
-}
-export {
-  SystemUtilizationSampler
-};
-//# sourceMappingURL=systemUtilizationSampler.js.map

package/lib/utils.js

@@ -1,322 +0,0 @@
-import assert from "assert";
-import { spawnSync } from "child_process";
-import crypto from "crypto";
-import fs from "fs";
-import http from "http";
-import https from "https";
-import os from "os";
-import { posix as posixPath, win32 as win32Path } from "path";
-import util from "util";
-import zlib from "zlib";
-const gzipAsync = util.promisify(zlib.gzip);
-const gunzipAsync = util.promisify(zlib.gunzip);
-const gunzipSync = zlib.gunzipSync;
-const brotliCompressAsync = util.promisify(zlib.brotliCompress);
-const brotliCompressSync = zlib.brotliCompressSync;
-async function existsAsync(aPath) {
-  return fs.promises.stat(aPath).then(() => true).catch((e) => false);
-}
-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 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 sha1Buffer(data) {
-  const hash = crypto.createHash("sha1");
-  hash.update(data);
-  return hash.digest("hex");
-}
-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]`, e.errors[0].message);
-      else if (e instanceof Error)
-        console.error(`[flakiness.io err]`, e.message);
-      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;
-    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 = {}));
-const 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, "");
-}
-function shell(command, args, options) {
-  try {
-    const result = spawnSync(command, args, { encoding: "utf-8", ...options });
-    if (result.status !== 0) {
-      console.log(result);
-      console.log(options);
-      return void 0;
-    }
-    return result.stdout.trim();
-  } catch (e) {
-    console.log(e);
-    return void 0;
-  }
-}
-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 inferRunUrl() {
-  if (process.env.GITHUB_REPOSITORY && process.env.GITHUB_RUN_ID)
-    return `https://github.com/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}`;
-  return void 0;
-}
-function parseStringDate(dateString) {
-  return +new Date(dateString);
-}
-function gitCommitInfo(gitRepo) {
-  const sha = shell(`git`, ["rev-parse", "HEAD"], {
-    cwd: gitRepo,
-    encoding: "utf-8"
-  });
-  assert(sha, `FAILED: git rev-parse HEAD @ ${gitRepo}`);
-  return sha.trim();
-}
-function computeGitRoot(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 normalizePath(root);
-}
-const IS_WIN32_PATH = new RegExp("^[a-zA-Z]:\\\\", "i");
-const IS_ALMOST_POSIX_PATH = new RegExp("^[a-zA-Z]:/", "i");
-function normalizePath(aPath) {
-  if (IS_WIN32_PATH.test(aPath)) {
-    aPath = aPath.split(win32Path.sep).join(posixPath.sep);
-  }
-  if (IS_ALMOST_POSIX_PATH.test(aPath))
-    return "/" + aPath[0] + aPath.substring(2);
-  return aPath;
-}
-function getCallerLocation(gitRoot, offset = 0) {
-  const err = new Error();
-  const stack = err.stack?.split("\n");
-  const caller = stack?.[2 + offset]?.trim();
-  const match = caller?.match(/\((.*):(\d+):(\d+)\)$/);
-  if (!match)
-    return void 0;
-  const [, filePath, line, column] = match;
-  return {
-    file: gitFilePath(gitRoot, normalizePath(filePath)),
-    line: Number(line),
-    column: Number(column)
-  };
-}
-function parseStackLocations() {
-  const err = new Error();
-  const stack = err.stack?.split("\n").slice(2);
-  if (!stack)
-    return [];
-  const result = [];
-  for (const caller of stack) {
-    const match = caller.trim().match(/\((.*):(\d+):(\d+)\)$/);
-    if (!match)
-      continue;
-    const [, file, line, column] = match;
-    result.push({ file, line, column });
-  }
-  return result;
-}
-function gitFilePath(gitRoot, absolutePath) {
-  return posixPath.relative(gitRoot, absolutePath);
-}
-function parseDurationMS(value) {
-  if (isNaN(value))
-    throw new Error("Duration cannot be NaN");
-  if (value < 0)
-    throw new Error(`Duration cannot be less than 0, found ${value}`);
-  return value | 0;
-}
-function createEnvironment(options) {
-  const osInfo = getOSInfo();
-  return {
-    name: options.name,
-    systemData: {
-      osArch: osInfo.arch,
-      osName: osInfo.name,
-      osVersion: osInfo.version
-    },
-    userSuppliedData: {
-      ...extractEnvConfiguration(),
-      ...options.userSuppliedData ?? {}
-    }
-  };
-}
-function createEnvironments(projects) {
-  const envConfiguration = extractEnvConfiguration();
-  const osInfo = getOSInfo();
-  let uniqueNames = /* @__PURE__ */ new Set();
-  const result = /* @__PURE__ */ new Map();
-  for (const project of projects) {
-    let defaultName = project.name;
-    if (!defaultName.trim())
-      defaultName = "anonymous";
-    let name = defaultName;
-    for (let i = 2; uniqueNames.has(name); ++i)
-      name = `${defaultName}-${i}`;
-    uniqueNames.add(defaultName);
-    result.set(project, {
-      name,
-      systemData: {
-        osArch: osInfo.arch,
-        osName: osInfo.name,
-        osVersion: osInfo.version
-      },
-      userSuppliedData: {
-        ...envConfiguration,
-        ...project.metadata
-      },
-      opaqueData: {
-        project
-      }
-    });
-  }
-  return result;
-}
-export {
-  brotliCompressAsync,
-  brotliCompressSync,
-  computeGitRoot,
-  createEnvironment,
-  createEnvironments,
-  existsAsync,
-  extractEnvConfiguration,
-  getCallerLocation,
-  getOSInfo,
-  gitCommitInfo,
-  gitFilePath,
-  gunzipAsync,
-  gunzipSync,
-  gzipAsync,
-  httpUtils,
-  inferRunUrl,
-  normalizePath,
-  parseDurationMS,
-  parseStackLocations,
-  parseStringDate,
-  retryWithBackoff,
-  sha1Buffer,
-  sha1File,
-  shell,
-  stripAnsi
-};
-//# sourceMappingURL=utils.js.map