taiko/lib/util.js

Taiko is a Node.js library for automating Chromium based browsers

const isWin = require("node:os").platform() === "win32";
const Module = require("node:module");
const path = require("node:path");
// @injectable — reassignable by test seam; see if (TAIKO_ENABLE_TEST_HOOKS) block below
let { spawnSync } = require("node:child_process");
const { realpathSync } = require("node:fs");
// @injectable — reassignable by test seam; see if (TAIKO_ENABLE_TEST_HOOKS) block below
let { readFileSync, existsSync } = require("node:fs");

module.exports.removeQuotes = (textWithQuotes, textWithoutQuotes) => {
  return textWithQuotes
    .replace(/\\n/g, "\n")
    .replace(/\\'/g, "'")
    .replace(`'${textWithoutQuotes}'`, () => textWithoutQuotes);
};

module.exports.symbols = {
  pass: isWin ? "[PASS] " : " ✔ ",
  fail: isWin ? "[FAIL] " : " ✘ ",
};

module.exports.isTaikoRunner = (path) => {
  try {
    if (!path.includes("taiko.js")) {
      const link = realpathSync(path);
      return link?.includes("taiko.js");
    }
    return path?.includes("taiko.js");
  } catch (_e) {
    return Module._nodeModulePaths("taiko").some(
      (val) => path === `${val}.bin/taiko`,
    );
  }
};

module.exports.trimCharLeft = (baseString, char) => {
  if (!baseString) {
    return "";
  }
  const splitedString = baseString.split(char);
  return splitedString[splitedString.length - 1];
};

module.exports.isSameUrl = (url1, url2) => {
  if (url1 === url2) {
    return true;
  }
  const parsedUrl1 = new URL(url1);
  const parsedUrl2 = new URL(url2);
  if (
    parsedUrl1.protocol === "file:" &&
    parsedUrl2.protocol === "file:" &&
    path.relative(parsedUrl1.pathname, parsedUrl2.pathname) === "" &&
    parsedUrl1.search === parsedUrl2.search &&
    parsedUrl1.hash === parsedUrl2.hash
  ) {
    return true;
  }
  return false;
};

module.exports.escapeHtml = (str) => {
  const chars = {
    "&": "&",
    "<": "&lt;",
    ">": "&gt;",
    '"': "&quot;",
    "'": "&#039;",
  };
  const pattern = new RegExp(`[${Object.keys(chars).join("")}]`, "g");
  return str.replace(pattern, (m) => chars[m]);
};
module.exports.taikoInstallationLocation = () => {
  const packageJSONFilePath = "./package.json";
  if (!existsSync(packageJSONFilePath)) {
    return path.join(
      spawnSync("npm", ["root", "-g"]).output[1].toString().trim(),
      "taiko",
    );
  }
  let installLocation = "";
  const jsonData = JSON.parse(readFileSync(packageJSONFilePath, "utf-8"));
  if (jsonData.dependencies?.taiko) {
    installLocation = path.join(
      spawnSync("npm", ["root"]).output[1].toString().trim(),
      "taiko",
    );
  } else if (jsonData.name.toLowerCase() === "taiko") {
    installLocation = process.cwd();
  } else {
    installLocation = path.join(
      spawnSync("npm", ["root", "-g"]).output[1].toString().trim(),
      "taiko",
    );
  }
  return installLocation;
};

// ─── TEST SEAM ─── active only when TAIKO_ENABLE_TEST_HOOKS=1 ───────────────
// createTestAccessors and createTestDefaults MUST live in this file because
// they close over module-private variables. See test-support/testHooks.js.
if (process.env.TAIKO_ENABLE_TEST_HOOKS) {
  const { defineTestHooks } = require("../test-support/testHooks");
  const createTestAccessors = () => ({
    spawnSync: {
      get: () => spawnSync,
      set: (value) => {
        spawnSync = value;
      },
    },
    readFileSync: {
      get: () => readFileSync,
      set: (value) => {
        readFileSync = value;
      },
    },
    existsSync: {
      get: () => existsSync,
      set: (value) => {
        existsSync = value;
      },
    },
  });
  const createTestDefaults = () => ({
    spawnSync,
    readFileSync,
    existsSync,
  });
  defineTestHooks(module.exports, createTestAccessors(), createTestDefaults());
}