Skip to content

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

(chore): Point ci-conductor reporter at a base-URL secret (#76067)

Nemanja Glumac42e75a07ba09
diff --git a/.github/workflows/e2e-test.yml b/.github/workflows/e2e-test.yml
index 9f915557b51..cad7b7c2fc5 100644
--- a/.github/workflows/e2e-test.yml
+++ b/.github/workflows/e2e-test.yml
@@ -37,10 +37,11 @@ env:
HASH: ${{ github.event.pull_request.head.sha || github.sha }}-${{ github.run_attempt }}
PR_NUMBER: ${{ github.event.pull_request.number || '' }}
JOB_NAME: ${{ inputs.name }}
- # ci-conductor failed-tests reporting (DEV-1999). Secret holds the webhooks
- # base URL (".../webhooks"); the reporter appends the endpoint. Callers pass
+ # ci-conductor reporting (DEV-1999). Secret holds the base origin
+ # (e.g. "https://conductor.<host>"); each consumer appends the path it needs
+ # (the reporter POSTs to "/webhooks/failed-tests"). Callers pass
# `secrets: inherit`; reporting no-ops when it's unset.
- CI_CONDUCTOR_WEBHOOK_URL: ${{ secrets.CI_CONDUCTOR_WEBHOOK_URL }}
+ CI_CONDUCTOR_BASE_URL: ${{ secrets.CI_CONDUCTOR_BASE_URL }}
# Shared secret sent as the `x-internal-secret` header to authenticate.
CI_CONDUCTOR_WEBHOOK_SECRET: ${{ secrets.CI_CONDUCTOR_WEBHOOK_SECRET }}
REPO_ID: ${{ github.event.repository.id }}
diff --git a/e2e/support/ci_conductor.ts b/e2e/support/ci_conductor.ts
index 7aea902984a..b6dd654a2a5 100644
--- a/e2e/support/ci_conductor.ts
+++ b/e2e/support/ci_conductor.ts
@@ -11,13 +11,13 @@ import fetch from "node-fetch"; // must be node-fetch v2 because it's non-esm
* than waiting for the whole job to finish — lets failures be tied back to the
* CI run (and through it the PR / release branch) before the job completes.
*
- * The webhooks base URL is only supplied via env in CI, so local runs no-op.
+ * The base URL is only supplied via env in CI, so local runs no-op.
*
* See DEV-1999.
*/
const {
- CI_CONDUCTOR_WEBHOOK_URL,
+ CI_CONDUCTOR_BASE_URL,
CI_CONDUCTOR_WEBHOOK_SECRET,
CI_CONDUCTOR_DRY_RUN,
REPO_ID,
@@ -281,7 +281,7 @@ export function extractFailedTests(
export async function reportFailedTestsToConductor(
tests: ConductorTest[],
): Promise<void> {
- if (tests.length === 0 || (!CI_CONDUCTOR_WEBHOOK_URL && !isDryRun)) {
+ if (tests.length === 0 || (!CI_CONDUCTOR_BASE_URL && !isDryRun)) {
return;
}
@@ -336,14 +336,15 @@ export async function reportFailedTestsToConductor(
return;
}
- if (!CI_CONDUCTOR_WEBHOOK_URL) {
+ if (!CI_CONDUCTOR_BASE_URL) {
// already excluded by the guard above; this also narrows the type
return;
}
- // CI_CONDUCTOR_WEBHOOK_URL holds the webhooks *base* (e.g. ".../webhooks");
- // we append the specific endpoint so the same secret can serve others later.
- const endpoint = `${CI_CONDUCTOR_WEBHOOK_URL.replace(/\/+$/, "")}/failed-tests`;
+ // CI_CONDUCTOR_BASE_URL holds the ci-conductor base origin (e.g.
+ // "https://conductor.<host>"); we append this endpoint's path. Other
+ // consumers (e.g. the quarantine gate's /api/quarantine) build their own.
+ const endpoint = `${CI_CONDUCTOR_BASE_URL.replace(/\/+$/, "")}/webhooks/failed-tests`;
// ci-conductor authenticates this endpoint via the x-internal-secret header.
const headers: Record<string, string> = {
diff --git a/e2e/support/ci_conductor.unit.spec.ts b/e2e/support/ci_conductor.unit.spec.ts
index 7fab957b795..0544d3adafa 100644
--- a/e2e/support/ci_conductor.unit.spec.ts
+++ b/e2e/support/ci_conductor.unit.spec.ts
@@ -349,7 +349,7 @@ describe("resolveScreenshotPath", () => {
});
describe("reportFailedTestsToConductor", () => {
- const url = "https://conductor.example/webhooks";
+ const url = "https://conductor.example";
const endpoint = "https://conductor.example/webhooks/failed-tests";
const oneTest = [{ name: "a test", file: "foo.cy.spec.ts" }];
@@ -358,9 +358,9 @@ describe("reportFailedTestsToConductor", () => {
mockFetch.mockResolvedValue({ ok: true, status: 200, statusText: "OK" });
});
- it("no-ops when the webhook URL is not configured", async () => {
+ it("no-ops when the base URL is not configured", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: undefined,
+ CI_CONDUCTOR_BASE_URL: undefined,
});
await reportFailedTestsToConductor(oneTest);
@@ -369,7 +369,7 @@ describe("reportFailedTestsToConductor", () => {
it("no-ops when there are no failures to report", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
});
await reportFailedTestsToConductor([]);
@@ -378,7 +378,7 @@ describe("reportFailedTestsToConductor", () => {
it("POSTs the failures with parsed numeric ids and forwarded tests", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
REPO_ID: "123",
GITHUB_RUN_ID: "456",
GITHUB_RUN_ATTEMPT: "2",
@@ -411,7 +411,7 @@ describe("reportFailedTestsToConductor", () => {
it("prefers COMMIT_SHA/TARGET_BRANCH but falls back to the ambient GITHUB_* vars", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
COMMIT_SHA: undefined,
GITHUB_SHA: "ambient-sha",
TARGET_BRANCH: undefined,
@@ -427,7 +427,7 @@ describe("reportFailedTestsToConductor", () => {
it("sends null attempt, sha, target_branch, and retries when their envs are missing", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
GITHUB_RUN_ATTEMPT: undefined,
CYPRESS_RETRIES: undefined,
COMMIT_SHA: undefined,
@@ -447,7 +447,7 @@ describe("reportFailedTestsToConductor", () => {
it("sends the x-internal-secret header when the secret is configured", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
CI_CONDUCTOR_WEBHOOK_SECRET: "s3cr3t",
});
@@ -460,7 +460,7 @@ describe("reportFailedTestsToConductor", () => {
it("omits the secret header when no secret is configured", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
CI_CONDUCTOR_WEBHOOK_SECRET: undefined,
});
@@ -473,7 +473,7 @@ describe("reportFailedTestsToConductor", () => {
it("appends the endpoint regardless of a trailing slash on the base URL", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: `${url}/`,
+ CI_CONDUCTOR_BASE_URL: `${url}/`,
});
await reportFailedTestsToConductor(oneTest);
@@ -482,7 +482,7 @@ describe("reportFailedTestsToConductor", () => {
it("uses JOB_ID env when set (populated by the resolve-job-id action)", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
JOB_ID: "789",
});
@@ -492,7 +492,7 @@ describe("reportFailedTestsToConductor", () => {
it("sends a null job_id when JOB_ID is missing or non-numeric", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
JOB_ID: "not-a-number",
});
@@ -502,7 +502,7 @@ describe("reportFailedTestsToConductor", () => {
it("sends null ids when the env vars are missing or non-numeric", async () => {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
REPO_ID: undefined,
GITHUB_RUN_ID: "not-a-number",
});
@@ -519,7 +519,7 @@ describe("reportFailedTestsToConductor", () => {
mockFetch.mockRejectedValue(new Error("network down"));
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
});
await expect(
@@ -534,7 +534,7 @@ describe("reportFailedTestsToConductor", () => {
const { reportFailedTestsToConductor } = await loadConductor({
CI_CONDUCTOR_DRY_RUN: "true",
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
REPO_ID: "123",
});
@@ -548,12 +548,12 @@ describe("reportFailedTestsToConductor", () => {
logSpy.mockRestore();
});
- it("logs in dry-run mode even when no webhook URL is configured", async () => {
+ it("logs in dry-run mode even when no base URL is configured", async () => {
const logSpy = jest.spyOn(console, "log").mockImplementation(() => {});
const { reportFailedTestsToConductor } = await loadConductor({
CI_CONDUCTOR_DRY_RUN: "true",
- CI_CONDUCTOR_WEBHOOK_URL: undefined,
+ CI_CONDUCTOR_BASE_URL: undefined,
});
await reportFailedTestsToConductor(oneTest);
@@ -572,7 +572,7 @@ describe("reportFailedTestsToConductor", () => {
});
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
});
await reportFailedTestsToConductor(oneTest);
@@ -589,7 +589,7 @@ describe("reportFailedTestsToConductor", () => {
fs.writeFileSync(file, bytes);
try {
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
});
await reportFailedTestsToConductor([
{ name: "t", file: "f.cy.spec.ts", screenshotPath: file },
@@ -607,7 +607,7 @@ describe("reportFailedTestsToConductor", () => {
it("omits the screenshot (and screenshotPath) when the file can't be read", async () => {
const errorSpy = jest.spyOn(console, "error").mockImplementation(() => {});
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
});
await reportFailedTestsToConductor([
@@ -633,7 +633,7 @@ describe("reportFailedTestsToConductor", () => {
});
const { reportFailedTestsToConductor } = await loadConductor({
- CI_CONDUCTOR_WEBHOOK_URL: url,
+ CI_CONDUCTOR_BASE_URL: url,
});
await expect(