Skip to content

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

Wait for the exact transform and job runs in transforms e2e tests (#85619)

Andersonce010766f2fb
diff --git a/e2e/support/helpers/e2e-transform-helpers.ts b/e2e/support/helpers/e2e-transform-helpers.ts
index 081d6dbce9e..971951d5063 100644
--- a/e2e/support/helpers/e2e-transform-helpers.ts
+++ b/e2e/support/helpers/e2e-transform-helpers.ts
@@ -2,11 +2,17 @@ import { WRITABLE_DB_ID } from "e2e/support/cypress_data";
import type {
Collection,
CollectionId,
+ ListTransformJobRunsResponse,
PythonTransformTableAliases,
+ RunTransformJobResponse,
+ RunTransformResponse,
SchemaName,
TemplateTags,
TransformId,
+ TransformJobId,
+ TransformJobRunId,
TransformRun,
+ TransformRunId,
TransformRunStatus,
TransformSourceCheckpointStrategy,
TransformTagId,
@@ -16,6 +22,37 @@ import { createTransform } from "./api";
import { getTableId } from "./e2e-qa-databases-helpers";
import { retryRequest } from "./e2e-request-helpers";
+const TERMINAL_RUN_STATUSES = [
+ "succeeded",
+ "failed",
+ "timeout",
+ "canceled",
+] as const satisfies readonly TransformRunStatus[];
+
+type TerminalRunStatus = (typeof TERMINAL_RUN_STATUSES)[number];
+
+const RUN_BUTTON_TEXT: Record<TerminalRunStatus, string> = {
+ succeeded: "Ran successfully",
+ failed: "Run failed",
+ timeout: "Run failed",
+ canceled: "Canceled",
+};
+
+const RUN_STATUS_TEXT: Record<TerminalRunStatus, RegExp> = {
+ succeeded: /^Last ran .*successfully\./,
+ failed: /^Last run failed/,
+ timeout: /^Last run timed out/,
+ canceled: /^Last run was canceled/,
+};
+
+type RunWaitOptions = {
+ timeout?: number;
+};
+
+function isTerminalRunStatus(status: string | null | undefined) {
+ return TERMINAL_RUN_STATUSES.some((terminal) => terminal === status);
+}
+
export function createTransformCollection({
name,
parent_id = null,
@@ -36,19 +73,19 @@ export function visitTransform(transformId: TransformId) {
}
export function runTransform(transformId: TransformId) {
- return cy.request("POST", `/api/transform/${transformId}/run`);
+ return cy.request<RunTransformResponse>(
+ "POST",
+ `/api/transform/${transformId}/run`,
+ );
}
export function runTransformAndWaitForStatus(
transformId: TransformId,
- status: TransformRunStatus,
+ status: TerminalRunStatus,
) {
- return runTransform(transformId).then(({ body: run }) => {
- return retryRequest(
- () => cy.request("GET", `/api/transform/run/${run.run_id}`),
- (response) => response.status === 200 && response.body.status === status,
- );
- });
+ return runTransform(transformId).then(({ body }) =>
+ waitForTransformRunStatus(body.run_id, status),
+ );
}
export function runTransformAndWaitForSuccess(transformId: TransformId) {
@@ -74,6 +111,114 @@ export function waitForSucceededTransformRuns() {
);
}
+/**
+ * Polls the transform run until it ends and checks that it ended with `status`, so a run that ends
+ * with another status fails right away instead of exhausting the retries.
+ */
+export function waitForTransformRunStatus(
+ runId: TransformRunId,
+ status: TerminalRunStatus,
+ { timeout }: RunWaitOptions = {},
+) {
+ return retryRequest(
+ () => cy.request<TransformRun>("GET", `/api/transform/run/${runId}`),
+ ({ body }) => isTerminalRunStatus(body.status),
+ timeout,
+ ).then(({ body }) => {
+ expect(body.status, `status of transform run ${runId}`).to.eq(status);
+ });
+}
+
+/**
+ * Polls the job run until it ends and checks that it ended with `status`.
+ */
+export function waitForTransformJobRunStatus(
+ jobId: TransformJobId,
+ jobRunId: TransformJobRunId,
+ status: TerminalRunStatus,
+ { timeout }: RunWaitOptions = {},
+) {
+ const getJobRunStatus = ({ body }: { body: ListTransformJobRunsResponse }) =>
+ body.data.find((jobRun) => jobRun.id === jobRunId)?.status;
+
+ return retryRequest(
+ () =>
+ cy.request<ListTransformJobRunsResponse>(
+ "GET",
+ `/api/transform-job/${jobId}/runs`,
+ ),
+ (response) => isTerminalRunStatus(getJobRunStatus(response)),
+ timeout,
+ ).then((response) => {
+ expect(getJobRunStatus(response), `status of job run ${jobRunId}`).to.eq(
+ status,
+ );
+ });
+}
+
+/**
+ * Clicks the run button on a transform's run page, waits until the run that this click started ends
+ * with `status`, then checks that the page shows that status.
+ */
+export function runTransformFromUiAndWaitForStatus(
+ status: TerminalRunStatus,
+ options: RunWaitOptions = {},
+) {
+ cy.intercept("POST", "/api/transform/*/run").as("runTransformFromUi");
+ getRunButton().click();
+ cy.wait<unknown, RunTransformResponse>("@runTransformFromUi").then(
+ ({ response }) => {
+ expect(response?.statusCode).to.eq(202);
+ expect(response?.body.run_id, "accepted run id").to.be.a("number");
+ if (response?.body.run_id != null) {
+ waitForTransformRunStatus(response.body.run_id, status, options);
+ }
+ },
+ );
+ assertRunStatusShown(status);
+}
+
+/**
+ * Clicks the run button on a job page, waits until the job run that this click started ends with
+ * `status`, then checks that the page shows that status.
+ */
+export function runTransformJobFromUiAndWaitForStatus(
+ status: TerminalRunStatus,
+ options: RunWaitOptions = {},
+) {
+ cy.intercept("POST", "/api/transform-job/*/run").as("runTransformJobFromUi");
+ getRunButton().click();
+ cy.wait<unknown, RunTransformJobResponse>("@runTransformJobFromUi").then(
+ ({ request, response }) => {
+ expect(response?.statusCode).to.eq(202);
+ const jobId = getJobIdFromRunUrl(request.url);
+ const jobRunId = response?.body.job_run_id;
+ expect(jobRunId, "accepted job run id").to.be.a("number");
+ if (jobRunId != null) {
+ waitForTransformJobRunStatus(jobId, jobRunId, status, options);
+ }
+ },
+ );
+ assertRunStatusShown(status);
+}
+
+function getJobIdFromRunUrl(url: string): TransformJobId {
+ const [, jobId] =
+ new URL(url).pathname.match(/\/api\/transform-job\/(\d+)\/run$/) ?? [];
+ return Number(jobId);
+}
+
+function getRunButton() {
+ return cy.findAllByTestId("run-button").eq(0);
+}
+
+function assertRunStatusShown(status: TerminalRunStatus) {
+ getRunButton().should("have.text", RUN_BUTTON_TEXT[status]);
+ cy.findByTestId("run-status")
+ .invoke("text")
+ .should("match", RUN_STATUS_TEXT[status]);
+}
+
export function createMbqlTransform({
sourceTable,
sourceSchema,
@@ -319,8 +464,7 @@ export function createAndRunSqlTransform({
visitTransform: false,
wrapId: false,
}).then(({ body: transform }) => {
- cy.request("POST", `/api/transform/${transform.id}/run`);
- waitForSucceededTransformRuns();
+ runTransformAndWaitForSuccess(transform.id);
return cy.wrap({
transformId: transform.id,
diff --git a/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
index 354e0ed687f..4690f2e197e 100644
--- a/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
@@ -17,7 +17,6 @@ describe("scenarios > data-studio > transforms > template tags", () => {
H.resyncDatabase({ dbId: WRITABLE_DB_ID, tableName: SOURCE_TABLE });
cy.intercept("PUT", "/api/transform/*").as("updateTransform");
- cy.intercept("POST", "/api/transform/*/run").as("runTransform");
});
it("should be possible to use template tags in an SQL transform, and the data reference, snippets and multiple template tags in a new SQL transform", () => {
@@ -345,16 +344,10 @@ function editorSidebar() {
function assertIsTransformRunnable() {
H.DataStudio.Transforms.runTab().click();
- getRunButton().click();
- cy.wait("@runTransform");
- getRunButton().should("have.text", "Ran successfully");
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.definitionTab().click();
}
-function getRunButton(options: { timeout?: number } = {}) {
- return cy.findAllByTestId("run-button").eq(0, options);
-}
-
function assertNoParameterSettingsAreVisible() {
editorSidebar().within(() => {
cy.findByLabelText("Variable type").should("exist");
diff --git a/e2e/test/scenarios/data-studio/transforms/transforms-incremental.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms-incremental.cy.spec.ts
index 8794f26dda7..ac830dfccbb 100644
--- a/e2e/test/scenarios/data-studio/transforms/transforms-incremental.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/transforms-incremental.cy.spec.ts
@@ -24,7 +24,6 @@ describe("scenarios > admin > transforms incremental", () => {
cy.intercept("POST", "/api/transform/*/reset-checkpoint").as(
"resetCheckpoint",
);
- cy.intercept("POST", "/api/transform/*/run").as("runTransform");
});
afterEach(() => {
@@ -70,7 +69,7 @@ describe("scenarios > admin > transforms incremental", () => {
cy.log("run the transform");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -96,7 +95,7 @@ describe("scenarios > admin > transforms incremental", () => {
cy.go("back");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log(
"verify the new element was picked up in the incremental transfer",
@@ -133,7 +132,7 @@ describe("scenarios > admin > transforms incremental", () => {
"go to Runs tab, run transform again and check new run has checkpoint to 31",
);
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.findByRole("link", { name: "See all runs" }).click();
cy.findByRole("treegrid", { name: "Transform runs" }).within(() => {
cy.findAllByRole("row", { name: /MBQL transform/i })
@@ -206,7 +205,9 @@ def transform(animals):
cy.log("run the transform");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded", {
+ timeout: PYTHON_TRANSFORM_RUN_TIMEOUT,
+ });
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -232,7 +233,9 @@ def transform(animals):
cy.go("back");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded", {
+ timeout: PYTHON_TRANSFORM_RUN_TIMEOUT,
+ });
cy.log(
"verify the new element was picked up in the incremental transfer",
@@ -269,7 +272,9 @@ def transform(animals):
"go to Runs tab, run transform again and check new run has checkpoint to 31",
);
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded", {
+ timeout: PYTHON_TRANSFORM_RUN_TIMEOUT,
+ });
cy.findByRole("link", { name: "See all runs" }).click();
cy.findByRole("treegrid", { name: "Transform runs" }).within(() => {
cy.findAllByRole("row", { name: /Python transform/i })
@@ -327,7 +332,7 @@ def transform(animals):
cy.log("run the transform");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -352,7 +357,7 @@ def transform(animals):
cy.go("back");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log(
"verify the new element was picked up in the incremental transfer",
@@ -389,7 +394,7 @@ def transform(animals):
"go to Runs tab, run transform again and check new run has checkpoint to 31",
);
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.findByRole("link", { name: "See all runs" }).click();
cy.findByRole("treegrid", { name: "Transform runs" }).within(() => {
cy.findAllByRole("row", { name: /SQL transform/i })
@@ -410,18 +415,6 @@ function visitTransformListPage() {
return cy.visit("/data-studio/transforms");
}
-function runTransformAndWaitForSuccess(
- options: { timeout?: number } = { timeout: PYTHON_TRANSFORM_RUN_TIMEOUT },
-) {
- getRunButton().click();
- cy.wait("@runTransform").its("response.statusCode").should("eq", 202);
- getRunButton(options).should("have.text", "Ran successfully");
-}
-
-function getRunButton(options: { timeout?: number } = {}) {
- return cy.findAllByTestId("run-button").eq(0, options);
-}
-
function getQueryEditor() {
return cy.findByTestId("transform-query-editor");
}
diff --git a/e2e/test/scenarios/data-studio/transforms/transforms-inspect.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms-inspect.cy.spec.ts
index 33bbf356639..ebf90f467ab 100644
--- a/e2e/test/scenarios/data-studio/transforms/transforms-inspect.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/transforms-inspect.cy.spec.ts
@@ -418,8 +418,7 @@ function createAndRunMbqlJoinTransform({
},
})
.then(({ body: transform }) => {
- cy.request("POST", `/api/transform/${transform.id}/run`);
- H.waitForSucceededTransformRuns();
+ H.runTransformAndWaitForSuccess(transform.id);
return cy.wrap({ transformId: transform.id });
})
.then(({ transformId }) => {
diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
index 56d5b277411..3ade540f927 100644
--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
@@ -110,7 +110,7 @@ describe("scenarios > admin > transforms", { tags: ["@external"] }, () => {
cy.log("run the transform and make sure its table can be queried");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -186,7 +186,7 @@ describe("scenarios > admin > transforms", { tags: ["@external"] }, () => {
cy.log("run the transform and make sure its table can be queried");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -317,7 +317,7 @@ describe("scenarios > admin > transforms", { tags: ["@external"] }, () => {
cy.log("run the transform and make sure its table can be queried");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -375,7 +375,7 @@ describe("scenarios > admin > transforms", { tags: ["@external"] }, () => {
cy.log("run the transform and make sure its table can be queried");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -420,7 +420,7 @@ LIMIT
cy.log("run the transform and make sure its table can be queried");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_trigger_manual_run",
});
@@ -470,7 +470,7 @@ LIMIT
cy.log("run the transform and verify the table");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getSchemaLink()
@@ -859,7 +859,7 @@ LIMIT
cy.log("run the transform and verify the table");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getSchemaLink()
@@ -900,7 +900,7 @@ LIMIT
cy.log("run the transform and verify the table");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getSchemaLink()
@@ -918,7 +918,7 @@ LIMIT
cy.log("create and run a transform");
createMbqlTransform({ visitTransform: true });
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("modify the transform after running");
H.DataStudio.Transforms.settingsTab().click();
@@ -940,7 +940,7 @@ LIMIT
cy.log("run the transform and verify the new table");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getSchemaLink()
@@ -964,7 +964,7 @@ LIMIT
cy.log("create and run a transform");
createMbqlTransform({ visitTransform: true });
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("modify the transform after running");
H.DataStudio.Transforms.settingsTab().click();
@@ -987,7 +987,7 @@ LIMIT
cy.log("run the transform and verify the new table");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getSchemaLink()
@@ -1011,7 +1011,7 @@ LIMIT
cy.log("create and run a transform");
createMbqlTransform({ visitTransform: true });
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("delete the old target without creating the new one");
H.DataStudio.Transforms.settingsTab().click();
@@ -1034,7 +1034,7 @@ LIMIT
cy.log("run the transform to re-create the original target");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("verify the target is available");
H.DataStudio.Transforms.settingsTab().click();
@@ -1047,7 +1047,7 @@ LIMIT
cy.log("run a transform so its target table exists");
createMbqlTransform({ visitTransform: true });
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("change another transform's target to that table");
createMbqlTransform({
@@ -1098,7 +1098,7 @@ LIMIT
cy.log("after table creation");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getSchemaLink().click();
H.main().within(() => {
@@ -1165,7 +1165,7 @@ LIMIT
cy.log("run the transform and make sure the query has changed");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().click();
@@ -1200,7 +1200,7 @@ LIMIT
cy.log("run the transform and make sure the query has changed");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().click();
H.queryBuilderHeader().findByText(DB_NAME).should("be.visible");
@@ -1267,7 +1267,7 @@ LIMIT
cy.log("run the transform and make sure the query has changed");
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().click();
H.queryBuilderHeader().findByText(DB_NAME).should("be.visible");
@@ -1285,7 +1285,7 @@ LIMIT
visitTransform: true,
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("create and run another transform");
createSqlTransform({
@@ -1294,7 +1294,7 @@ LIMIT
visitTransform: true,
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
cy.log("assert that the list is filtered by the current transform");
getRunListLink().click();
@@ -1336,7 +1336,7 @@ LIMIT
cy.log("create a transform and the table");
createMbqlTransform({ visitTransform: true });
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().should("have.attr", "aria-disabled", "false");
@@ -1361,7 +1361,7 @@ LIMIT
visitTransform: true,
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().should("have.attr", "aria-disabled", "false");
@@ -1555,7 +1555,7 @@ LIMIT
visitTransform: true,
}).then(() => {
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
});
createMbqlTransform({
@@ -1565,7 +1565,7 @@ LIMIT
visitTransform: true,
}).then(() => {
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
});
createMbqlTransform({
@@ -1636,7 +1636,7 @@ LIMIT
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().click();
H.queryBuilderHeader()
@@ -1690,7 +1690,7 @@ LIMIT
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().click();
H.queryBuilderHeader()
@@ -1715,7 +1715,7 @@ LIMIT
`,
);
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
H.DataStudio.Transforms.settingsTab().click();
getTableLink().click();
H.queryBuilderHeader()
@@ -2606,6 +2606,12 @@ describe("scenarios > admin > transforms > jobs", () => {
});
describe("runs", () => {
+ beforeEach(() => {
+ cy.intercept("GET", "/api/transform-job/*/transforms").as(
+ "jobTransforms",
+ );
+ });
+
it("should be able to manually run a job", () => {
H.createTransformTag({ name: "New tag" }).then(({ body: tag }) => {
createMbqlTransform({
@@ -2618,13 +2624,14 @@ describe("scenarios > admin > transforms > jobs", () => {
});
cy.log("the job renders its transforms table");
+ cy.wait("@jobTransforms");
H.DataStudio.Jobs.editor()
.findByText("Transforms")
.scrollIntoView()
.should("be.visible");
getJobTransformTable().findByText("MBQL transform").should("be.visible");
- runTransformAndWaitForSuccess();
+ H.runTransformJobFromUiAndWaitForStatus("succeeded");
H.expectUnstructuredSnowplowEvent({
event: "transform_job_trigger_manual_run",
});
@@ -2637,11 +2644,15 @@ describe("scenarios > admin > transforms > jobs", () => {
getRunsNavLink().click();
getDetailedViewSwitch().click();
- getTransformRunTable().within(() => {
- cy.findByText("MBQL transform").should("be.visible");
- cy.findByText("Success").should("be.visible");
- cy.findByText("Manual").should("be.visible");
- });
+ cy.log("the manual run is listed, whatever scheduled runs exist");
+ getTransformRunTable()
+ .findAllByRole("row")
+ .filter(':contains("Manual")')
+ .should("have.length", 1)
+ .within(() => {
+ cy.findByText("MBQL transform").should("be.visible");
+ cy.findByText("Success").should("be.visible");
+ });
});
it("should display the error message from a failed run", () => {
@@ -2655,7 +2666,9 @@ describe("scenarios > admin > transforms > jobs", () => {
{ visitTransformJob: true },
);
});
- runTransformAndWaitForFailure();
+ cy.log("the run button stays disabled until the job transforms load");
+ cy.wait("@jobTransforms");
+ H.runTransformJobFromUiAndWaitForStatus("failed");
H.DataStudio.Jobs.editor().findByText(
"Last run failed a few seconds ago.",
);
@@ -2778,7 +2791,7 @@ describe("scenarios > admin > transforms > runs", () => {
visitTransform: true,
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForSuccess();
+ H.runTransformFromUiAndWaitForStatus("succeeded");
createSqlTransform({
sourceQuery: "SELECT * FROM abc",
targetTable: TARGET_TABLE_2,
@@ -2786,7 +2799,7 @@ describe("scenarios > admin > transforms > runs", () => {
visitTransform: true,
});
H.DataStudio.Transforms.runTab().click();
- runTransformAndWaitForFailure();
+ H.runTransformFromUiAndWaitForStatus("failed");
cy.log("the failed run shows its error message");
getRunErrorInfoButton().click();
@@ -3462,16 +3475,6 @@ function getDetailedViewSwitch() {
return cy.findByTestId("detailed-view-switch");
}
-function runTransformAndWaitForSuccess() {
- getRunButton().click();
- getRunButton().should("have.text", "Ran successfully");
-}
-
-function runTransformAndWaitForFailure() {
- getRunButton().click();
- getRunButton().should("have.text", "Run failed");
-}
-
function createMbqlTransform(
opts: {
sourceTable?: string;
diff --git a/frontend/src/metabase-types/api/transform.ts b/frontend/src/metabase-types/api/transform.ts
index bc3f10957e3..7a238147299 100644
--- a/frontend/src/metabase-types/api/transform.ts
+++ b/frontend/src/metabase-types/api/transform.ts
@@ -329,6 +329,11 @@ export type RunTransformResponse = {
message?: string;
};
+export type RunTransformJobResponse = {
+ job_run_id: TransformJobRunId | null;
+ message?: string;
+};
+
export type ListTransformsRequest = {
"last-run-start-time"?: string;
"last-run-statuses"?: TransformRunStatus[];
diff --git a/frontend/src/metabase/api/transform-job.ts b/frontend/src/metabase/api/transform-job.ts
index 516fae18514..77c7a6e07bb 100644
--- a/frontend/src/metabase/api/transform-job.ts
+++ b/frontend/src/metabase/api/transform-job.ts
@@ -4,6 +4,7 @@ import type {
ListTransformJobRunsRequest,
ListTransformJobRunsResponse,
ListTransformJobsRequest,
+ RunTransformJobResponse,
Transform,
TransformJob,
TransformJobId,
@@ -75,7 +76,7 @@ export const transformJobApi = Api.injectEndpoints({
idTag("transform-job", jobId),
],
}),
- runTransformJob: builder.mutation<void, TransformJobId>({
+ runTransformJob: builder.mutation<RunTransformJobResponse, TransformJobId>({
query: (id) => ({
method: "POST",
url: `/api/transform-job/${id}/run`,