Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

4.4 KB
Raw Blame
#!/usr/bin/env node

const { spawn } = require("child_process");
const fs = require("fs");
const os = require("os");
const path = require("path");

const { waitUntilReady, shell } = require("./cypress-runner-utils");

const tempDbPath = path.join(os.tmpdir(), `metabase-test-${process.pid}.db`);

function getJvmOptsFromDepsEdn(alias = "e2e") {
  const depsEdnPath = path.resolve(__dirname, "../../deps.edn");
  const depsEdn = fs.readFileSync(depsEdnPath, "utf8");
  const aliasBlockPattern = new RegExp(
    `:${alias}\\s*\\n\\s*\\{:jvm-opts\\s*\\[([\\s\\S]*?)\\]\\s*\\}`,
    "m",
  );
  const aliasBlock = depsEdn.match(aliasBlockPattern)?.[1];
  if (!aliasBlock) {
    throw new Error(`Could not find :jvm-opts for alias :${alias} in deps.edn`);
  }

  const jvmOpts = [...aliasBlock.matchAll(/"((?:\\.|[^"\\])*)"/g)].map(
    ([, option]) => JSON.parse(`"${option}"`),
  );
  return jvmOpts.join(" ");
}

// Ensure that the only two required env vars have values
process.env.MB_DB_FILE = process.env.MB_DB_FILE || tempDbPath;
process.env.MB_JETTY_PORT = process.env.MB_JETTY_PORT || 4000;
process.env.MB_CUSTOM_VIZ_PLUGIN_DEV_MODE_ENABLED =
  process.env.MB_CUSTOM_VIZ_PLUGIN_DEV_MODE_ENABLED || "true";

// Expose the `en-ZZ` pseudo-locale in the Cypress backend's language pickers and API validation.
process.env.MB_ENABLE_TEST_LOCALES = "true";

// Use the H2 sample database in E2E tests. Production ships SQLite, but the test suite was written
// against the H2 sample data; this defers migrating the tests to SQLite until after the release.
process.env.MB_SAMPLE_DATABASE_ENGINE = "h2";

// The warehouses the E2E suite connects to are all on localhost, so the warehouse network policy has to be off.
// It otherwise defaults to `external-only` whenever `is-hosted?` is true, which any spec calling
// `setTokenFeatures("all")` (or activating a cloud token) makes true -- and those specs would then be unable to
// add or sync a test database. Set here rather than in the `:e2e` deps.edn alias because CI runs the uberjar and
// never reads that alias. A spec that wants the policy on can set it through the settings API.
process.env.MB_WAREHOUSE_ALLOWED_NETWORKS = "allow-all";
// Metabot specs use a mock LLM server on localhost, so E2E runs must allow loopback LLM endpoints.
process.env.MB_LLM_ALLOWED_NETWORKS = "allow-all";

if (!process.env.CI) {
  // Use a temporary copy of the sample db so it won't use and lock the db used for local development
  process.env.MB_INTERNAL_DO_NOT_USE_SAMPLE_DB_DIR = path.resolve(
    __dirname,
    "../../e2e/tmp", // already exists and is .gitignored
  );
}

const CypressBackend = {
  server: {
    dbFile: process.env.MB_DB_FILE,
    host: `http://localhost:${process.env.MB_JETTY_PORT}`,
  },
  async runFromJar(jarPath = "target/uberjar/metabase.jar") {
    if (!fs.existsSync(jarPath)) {
      console.log("Build the JAR with ./bin/build.sh\n");
      throw new Error(`JAR ${jarPath} does not exist!`);
    }
    if (!this.server.process) {
      process.env.JDK_JAVA_OPTIONS = getJvmOptsFromDepsEdn();
      this.server.process = spawn("java", ["-jar", jarPath], {
        env: process.env,
        stdio: process.env.CI ? "ignore" : "inherit",
        detached: true,
      });
      await waitUntilReady(this.server);
      if (process.env.CI) {
        this.server.process.unref(); // detach console
      }
    }
  },
  async runFromSource() {
    if (!this.server.process) {
      const edition = process.env.MB_EDITION || "ee";

      this.server.process = spawn(
        "clojure",
        [`-M:run:${edition}:dev:dev-start:drivers:e2e`, "--hot"],
        {
          env: process.env,
          stdio: process.env.CI ? "ignore" : "inherit",
          detached: true,
        },
      );
      await waitUntilReady(this.server);
      if (process.env.CI) {
        this.server.process.unref(); // detach console
      }
    }
  },

  async stop() {
    if (this?.server?.process) {
      this.server.process.kill("SIGKILL");
      console.log(
        `Stopped backend (host=${this.server.host}, dbFile=${this.server.dbFile})`,
      );
    }
    try {
      if (this?.server?.dbFile) {
        fs.unlinkSync(`${this.server.dbFile}.mv.db`);
        fs.unlinkSync(`${this.server.dbFile}.trace.db`);
      }
    } catch (e) {}
  },
};

function getBackendPid() {
  return shell(`lsof -ti:${process.env.MB_JETTY_PORT} || echo ""`, {
    quiet: true,
  });
}

module.exports = { ...CypressBackend, getBackendPid };