The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
import { execFileSync } from "node:child_process";
import fs from "node:fs";
import path from "node:path";
import { plugin as cypressGrepPlugin } from "@cypress/grep/plugin";
import cypressOnFix from "cypress-on-fix";
import installLogsPrinter from "cypress-terminal-report/src/installLogsPrinter";
import { BACKEND_HOST, BACKEND_PORT } from "../runner/constants/backend-port";
import {
extractFailedTests,
recordFailedTestsForQuarantine,
reportFailedTestsToConductor,
} from "./ci_conductor";
import * as ciTasks from "./ci_tasks";
import { collectFailingTests } from "./collectFailedTests";
import {
copyDirectory,
readDirectory,
removeDirectory,
verifyDownloadTasks,
} from "./commands/downloads/downloadUtils";
import * as dbTasks from "./db_tasks";
import {
backendRequest,
requestAsAdmin,
} from "./helpers/e2e-admin-request-tasks";
import {
startCustomVizDevServer,
stopCustomVizDevServer,
} from "./helpers/e2e-custom-viz-dev-server-tasks";
import {
copyDataAppsFixture,
removeDataAppPaths,
writeDataAppFiles,
} from "./helpers/e2e-data-app-tasks";
import { signJwt } from "./helpers/e2e-jwt-tasks";
import {
startMockLlmServer,
stopMockLlmServer,
} from "./helpers/e2e-mock-llm-tasks";
import {
startMockOidcServer,
stopMockOidcServer,
} from "./helpers/e2e-mock-oidc-tasks";
const createBundler = require("@bahmutov/cypress-esbuild-preprocessor"); // This function is called when a project is opened or re-opened (e.g. due to the project's config changing)
const coverageTask = require("@cypress/code-coverage/task");
const {
NodeModulesPolyfillPlugin,
} = require("@esbuild-plugins/node-modules-polyfill");
const cypressSplit = require("cypress-split");
const {
sideEffectFreeModulesPlugin,
} = require("../../frontend/build/shared/esbuild/side-effect-free-modules-plugin");
const isInstrumented = process.env.INSTRUMENT_COVERAGE === "true";
// The Cypress config process runs with cwd = this file's directory
// (e2e/support), so @cypress/code-coverage writes .nyc_output/out.json here.
// NYC_OUTPUT_FILE is anchored to __dirname to read from that same place;
// COVERAGE_MANIFEST_RAW_DIR points at e2e/coverage-manifest-raw, which the
// nightly workflow uploads.
const COVERAGE_MANIFEST_RAW_DIR = path.resolve(
__dirname,
"../coverage-manifest-raw",
);
const NYC_OUTPUT_FILE = path.resolve(__dirname, ".nyc_output/out.json");
// Function metadata (name + line per Istanbul function index), accumulated
// across the specs this process runs and shipped with the raw shard artifact.
// The f-counter indices in the per-spec/per-test entries are only meaningful
// against the exact instrumented bundle that produced them; this file makes
// the artifact self-describing for offline analysis (test-overlap heat maps)
// without rebuilding that bundle. Named uniquely per process so shard
// artifacts can merge into one directory without clobbering each other —
// consumers shallow-merge all fnmap-*.json (same file => identical entries).
const FNMAP_FILE = path.join(
COVERAGE_MANIFEST_RAW_DIR,
`fnmap-${require("node:crypto").randomUUID()}.json`,
);
const isEnterprise = process.env["MB_EDITION"] === "ee";
const isCI = !!process.env.CI;
const snowplowMicroUrl = process.env["MB_SNOWPLOW_URL"];
// Per-test capture state, fed by the recordTestCapture task that the
// support-file afterEach calls (e2e/support/per-test-capture.js). Each entry
// is one test attempt: { title, f: {file: {fnIdx: firedCount}}, routes,
// pages }. The function counts arrive already per-test — the support file
// reads them from the app windows' Istanbul counters and zeroes those after
// each flush.
let perTestEntries = [];
const perTestCaptureTasks = {
recordTestCapture({ title, f, routes, pages }) {
perTestEntries.push({ title, f, routes, pages });
return null;
},
resetTestCapture() {
perTestEntries = [];
return null;
},
};
// Records name + line for every instrumented function in files this process
// hasn't seen yet. The metadata is identical for a given file across specs
// (same bundle), so first sighting wins.
function appendFnMap(coverage) {
let fnMap = {};
try {
fnMap = JSON.parse(fs.readFileSync(FNMAP_FILE, "utf8"));
} catch {
// First spec of the run.
}
let changed = false;
for (const [file, fileCov] of Object.entries(coverage)) {
if (fnMap[file] || !fileCov.fnMap) {
continue;
}
const entry = {};
for (const [idx, fn] of Object.entries(fileCov.fnMap)) {
entry[idx] = {
name: fn.name,
line: fn.decl?.start?.line ?? fn.loc?.start?.line ?? null,
};
}
fnMap[file] = entry;
changed = true;
}
if (changed) {
fs.writeFileSync(FNMAP_FILE, JSON.stringify(fnMap));
}
}
// Persists raw __coverage__ counters per spec, plus the per-test breakdown
// (function deltas and API routes). The manifest builder reads these later,
// applies baseline subtraction, and maps surviving files to modules. We
// delete .nyc_output/out.json between specs so each entry reflects only that
// spec's execution — @cypress/code-coverage otherwise accumulates.
function writeSpecCoverageEntry(spec) {
// Consume the per-test state up front so a missing/corrupt out.json can't
// leak one spec's tests into the next spec's entry.
const tests = perTestEntries;
perTestEntries = [];
if (!fs.existsSync(NYC_OUTPUT_FILE)) {
return;
}
const coverage = JSON.parse(fs.readFileSync(NYC_OUTPUT_FILE, "utf8"));
fs.mkdirSync(COVERAGE_MANIFEST_RAW_DIR, { recursive: true });
appendFnMap(coverage);
// The manifest builder only needs per-file function counters to compute the
// baseline greater-delta. Drop statement/branch maps and counters, and drop
// files where no function was invoked. Cuts each entry from ~25MB to <200KB.
const trimmed = {};
for (const [file, fc] of Object.entries(coverage)) {
if (!Object.values(fc.f || {}).some((c) => c > 0)) {
continue;
}
trimmed[file] = { f: fc.f };
}
fs.mkdirSync(COVERAGE_MANIFEST_RAW_DIR, { recursive: true });
const entryName = spec.relative.replace(/[\\/]/g, "__") + ".json";
fs.writeFileSync(
path.join(COVERAGE_MANIFEST_RAW_DIR, entryName),
JSON.stringify({ spec: spec.relative, coverage: trimmed, tests }),
);
fs.unlinkSync(NYC_OUTPUT_FILE);
}
// docs say that tsconfig paths should handle aliases, but they don't
const assetsResolverPlugin = {
name: "assetsResolver",
setup(build) {
// Redirect all paths starting with "assets/" to "resources/"
build.onResolve({ filter: /^assets\// }, (args) => {
return {
path: path.join(
__dirname,
"../../resources/frontend_client/app",
args.path,
),
};
});
},
};
const defaultConfig = {
// Expose non-sensitive environment variables synchronously via Cypress.expose()
// These are safe to expose in the browser and are used for configuration
expose: {
CI: isCI,
IS_ENTERPRISE: isEnterprise,
MB_EDITION: process.env["MB_EDITION"],
ENABLE_NETWORK_THROTTLING: !!process.env["ENABLE_NETWORK_THROTTLING"],
SNOWPLOW_MICRO_URL: snowplowMicroUrl,
CLIENT_PORT: process.env["CLIENT_PORT"],
feHealthcheck: process.env["FE_HEALTHCHECK_URL"]
? { enabled: true, url: process.env["FE_HEALTHCHECK_URL"] }
: undefined,
// Lets @cypress/code-coverage/support skip its hooks entirely on
// uninstrumented runs, instead of logging a warning on every spec.
coverage: isInstrumented,
},
allowCypressEnv: false,
// This is the functionality of the old cypress-plugins.js file
setupNodeEvents(cypressOn, config) {
// `on` is used to hook into various events Cypress emits
// `config` is the resolved Cypress config
// Build custom-viz .tgz fixtures from sources
execFileSync(
"node",
[
path.resolve(
__dirname,
"../../enterprise/frontend/src/custom-viz/fixtures/build-example-custom-viz.mjs",
),
],
{ stdio: "inherit" },
);
// Use cypress-on-fix to enable multiple handlers
const on = cypressOnFix(cypressOn);
// CLI grep can't handle commas in the name
// needed when we want to run only specific tests
config.expose.grep ??= process.env.GREP;
// cypress-terminal-report
if (isCI) {
installLogsPrinter(on, {
printLogsToConsole: "never",
});
}
/********************************************************************
** PREPROCESSOR **
********************************************************************/
on(
"file:preprocessor",
createBundler({
loader: {
".svg": "text",
},
plugins: [
NodeModulesPolyfillPlugin(),
assetsResolverPlugin,
sideEffectFreeModulesPlugin,
],
sourcemap: "inline",
}),
);
/********************************************************************
** BROWSERS **
********************************************************************/
on("before:browser:launch", (browser = {}, launchOptions) => {
if (browser.name === "chrome" || browser.name === "chromium") {
// Open dev tools in Chrome by default when in headed mode
if (browser.isHeaded) {
launchOptions.args.push("--auto-open-devtools-for-tabs");
}
launchOptions.args.push("--blink-settings=preferredColorScheme=1");
}
// Start browsers with prefers-reduced-motion set to "reduce"
if (browser.family === "firefox") {
launchOptions.preferences["ui.prefersReducedMotion"] = 1;
}
if (browser.family === "chromium") {
launchOptions.args.push("--force-prefers-reduced-motion");
}
return launchOptions;
});
/********************************************************************
** TASKS **
********************************************************************/
on("task", {
log(...messages) {
console.log(...messages);
return null; // tasks must have a return value
},
...dbTasks,
...ciTasks,
...verifyDownloadTasks,
readDirectory,
copyDirectory,
removeDirectory,
signJwt,
backendRequest,
requestAsAdmin,
startMockLlmServer,
stopMockLlmServer,
startMockOidcServer,
stopMockOidcServer,
startCustomVizDevServer,
stopCustomVizDevServer,
copyDataAppsFixture,
writeDataAppFiles,
removeDataAppPaths,
...perTestCaptureTasks,
});
/********************************************************************
** CONFIG **
********************************************************************/
// `grepIntegrationFolder` needs to point to the root!
// See: https://github.com/cypress-io/cypress/issues/24452#issuecomment-1295377775
config.expose.grepIntegrationFolder = "../../";
config.expose.grepFilterSpecs = true;
config.expose.grepOmitFiltered = true;
cypressGrepPlugin(config);
if (isCI) {
cypressSplit(on, config);
collectFailingTests(on, config);
}
if (isInstrumented) {
coverageTask(on, config);
}
// Surface the resolved Cypress retry ceiling so the ci-conductor reporter
// can include it in the payload (CYPRESS_RETRIES isn't otherwise set in CI;
// the value lives in mainConfig.retries.runMode). DEV-1999.
const resolvedRetries =
typeof config.retries === "number"
? config.retries
: (config.retries?.runMode ?? 0);
process.env.CYPRESS_RETRIES = String(resolvedRetries);
on("after:spec", async (spec, results) => {
// Report failures to ci-conductor mid-run (no-ops unless configured).
if (isCI) {
// Reporting to ci-conductor must NEVER break the test run, so this is
// a hard backstop around everything — extraction, payload build, and
// the request. The reporter also handles its own errors internally.
try {
const failedTests = extractFailedTests(spec, results);
// Persist ultimate failures for the post-run quarantine gate (DEV-2082).
recordFailedTestsForQuarantine(failedTests);
await reportFailedTestsToConductor(failedTests);
} catch (error) {
console.error("[ci-conductor] reporting failed (ignored)", error);
}
}
// this is an official workaround to keep recordings of the failed specs only
// https://docs.cypress.io/guides/guides/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests
if (results && results.video) {
// Do we have test failures?
if (
results &&
results.video &&
results.stats.failures === 0 &&
process.env.CYPRESS_KEEP_VIDEOS !== "true"
) {
// delete the video if the spec passed
fs.unlinkSync(results.video);
}
}
if (isInstrumented) {
// Don't let a bad/partial coverage file abort the nightly shard - at
// worst we lose this spec's entry, not the whole run.
try {
writeSpecCoverageEntry(spec);
} catch (error) {
console.error(
"[coverage] failed to write spec entry (ignored)",
error,
);
}
}
});
return config;
},
baseUrl: `http://${BACKEND_HOST}:${BACKEND_PORT}`,
defaultBrowser: process.env.CYPRESS_BROWSER ?? "chrome",
supportFile: "e2e/support/cypress.js",
chromeWebSecurity: false,
modifyObstructiveCode: false,
// New `specPattern` is the combination of the old:
// 1. testFiles and
// 2. integrationFolder
specPattern: "e2e/test/**/*.cy.spec.{js,ts}",
viewportHeight: 800,
viewportWidth: 1280,
// enable video recording in run mode
video: process.env["CYPRESS_VIDEO"] !== "false",
videoCompression: false,
};
const mainConfig = {
...defaultConfig,
numTestsKeptInMemory: process.env["CI"] ? 1 : 50,
reporter: "cypress-multi-reporters",
reporterOptions: {
configFile: false,
// 🤯 mochawesome != cypress-mochawesome-reporter != mochaAwesome (this form does not exist) 🤯
// See https://glebbahmutov.com/blog/the-awesome-battle/ to compare the first two.
reporterEnabled: "mochawesome, mocha-junit-reporter",
mochawesomeReporterOptions: {
// https://github.com/adamgruber/mochawesome (NOT https://www.npmjs.com/package/cypress-mochawesome-reporter)
reportDir: "cypress/reports/mochareports",
reportFilename: "[status]-[name]",
quiet: true,
html: true,
json: true,
},
// 🤯🤮mochaJunitReporterReporterOptions 🤮🤯
// Exercise care when using this poorly documented key:
// - https://stackoverflow.com/questions/51180963/cypress-tests-with-mocha-multi-reports-not-able-to-get-aggregated-results-for-a
// - https://stackoverflow.com/questions/37965049/mocha-multi-reporter-with-junit
// For the curious, ChatGPT 3.5 does NOT get it right
mochaJunitReporterReporterOptions: {
mochaFile: "./target/junit/[hash].xml",
toConsole: false,
},
},
retries: {
runMode:
process.env["CYPRESS_RETRIES"] != null
? parseInt(process.env["CYPRESS_RETRIES"], 10)
: 1,
openMode: 0,
},
};
module.exports = {
defaultConfig,
mainConfig,
};