Skip to content

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

Disable transform editing buttons when running (#63642)

Alexander Polyankin96f1ef42a2be
diff --git a/e2e/test/scenarios/admin/transforms.cy.spec.ts b/e2e/test/scenarios/admin/transforms.cy.spec.ts
index a341890de01..82a19888cd9 100644
--- a/e2e/test/scenarios/admin/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/admin/transforms.cy.spec.ts
@@ -1141,7 +1141,7 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {
createMbqlTransform({ visitTransform: true });
cy.log("delete the transform");
- getTransformPage().button("Delete").click();
+ getTransformPage().button("Delete transform").click();
H.modal().within(() => {
cy.findByLabelText("Delete the transform only").should("not.exist");
cy.findByLabelText("Delete the transform and the table").should(
@@ -1160,7 +1160,7 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {
runTransformAndWaitForSuccess();
cy.log("delete the transform but keep the table");
- getTransformPage().button("Delete").click();
+ getTransformPage().button("Delete transform").click();
H.modal().within(() => {
cy.findByLabelText("Delete the transform only").should("be.checked");
cy.button("Delete transform only").click();
@@ -1179,7 +1179,7 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {
runTransformAndWaitForSuccess();
cy.log("delete the transform and the table");
- getTransformPage().button("Delete").click();
+ getTransformPage().button("Delete transform").click();
H.modal().within(() => {
cy.findByLabelText("Delete the transform and the table").click();
cy.button("Delete transform and table").click();
diff --git a/enterprise/frontend/src/metabase-enterprise/api/transform.ts b/enterprise/frontend/src/metabase-enterprise/api/transform.ts
index dda95ceea69..8f77a14384b 100644
--- a/enterprise/frontend/src/metabase-enterprise/api/transform.ts
+++ b/enterprise/frontend/src/metabase-enterprise/api/transform.ts
@@ -132,8 +132,8 @@ export const transformApi = EnterpriseApi.injectEndpoints({
method: "DELETE",
url: `/api/ee/transform/${id}/table`,
}),
- invalidatesTags: (_, error, id) =>
- invalidateTags(error, [idTag("transform", id), listTag("table")]),
+ invalidatesTags: (_, error) =>
+ invalidateTags(error, [listTag("transform"), listTag("table")]),
}),
}),
});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.tsx
index e1cc0f00267..ce4055a5dce 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.tsx
@@ -11,6 +11,7 @@ import type { Transform } from "metabase-types/api";
import { QueryView } from "../../../components/QueryView";
import { TitleSection } from "../../../components/TitleSection";
import { getTransformListUrl, getTransformQueryUrl } from "../../../urls";
+import { isTransformRunning } from "../utils";
import { DeleteTransformModal } from "./DeleteTransformModal";
@@ -41,11 +42,14 @@ type EditQueryButtonProps = {
};
function EditQueryButton({ transform }: EditQueryButtonProps) {
+ const isDisabled = isTransformRunning(transform);
+
return (
<Button
- component={Link}
+ component={isDisabled ? undefined : Link}
to={getTransformQueryUrl(transform.id)}
leftSection={<Icon name="pencil_lines" aria-hidden />}
+ disabled={isDisabled}
>
{t`Edit query`}
</Button>
@@ -71,9 +75,10 @@ function DeleteTransformButton({ transform }: DeleteTransformButtonProps) {
<>
<Button
leftSection={<Icon name="trash" aria-hidden />}
+ disabled={isTransformRunning(transform)}
onClick={openModal}
>
- {t`Delete`}
+ {t`Delete transform`}
</Button>
{isModalOpened && (
<DeleteTransformModal
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.unit.spec.tsx
new file mode 100644
index 00000000000..05d0bd46a71
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/ManageSection/ManageSection.unit.spec.tsx
@@ -0,0 +1,67 @@
+import { Route } from "react-router";
+
+import { renderWithProviders, screen } from "__support__/ui";
+import { getTransformUrl } from "metabase-enterprise/transforms/urls";
+import type { Transform } from "metabase-types/api";
+import {
+ createMockTransform,
+ createMockTransformRun,
+} from "metabase-types/api/mocks";
+
+import { ManageSection } from "./ManageSection";
+
+type SetupOpts = {
+ transform?: Transform;
+};
+
+function setup({ transform = createMockTransform() }: SetupOpts) {
+ renderWithProviders(
+ <Route
+ path={getTransformUrl(transform.id)}
+ component={() => <ManageSection transform={transform} />}
+ />,
+ { withRouter: true, initialRoute: getTransformUrl(transform.id) },
+ );
+}
+
+describe("ManageSection", () => {
+ it("should disable the edit query button when the transform is running", () => {
+ setup({
+ transform: createMockTransform({
+ last_run: createMockTransformRun({ status: "started" }),
+ }),
+ });
+ const button = screen.getByRole("button", { name: "Edit query" });
+ expect(button).toBeDisabled();
+ });
+
+ it("should not disable the edit query button when the transform is not running", () => {
+ setup({
+ transform: createMockTransform({
+ last_run: createMockTransformRun({ status: "failed" }),
+ }),
+ });
+ const button = screen.getByRole("link", { name: "Edit query" });
+ expect(button).toBeEnabled();
+ });
+
+ it("should disable the delete button when the transform is running", () => {
+ setup({
+ transform: createMockTransform({
+ last_run: createMockTransformRun({ status: "started" }),
+ }),
+ });
+ const button = screen.getByRole("button", { name: "Delete transform" });
+ expect(button).toBeDisabled();
+ });
+
+ it("should not disable the delete button when the transform is not running", () => {
+ setup({
+ transform: createMockTransform({
+ last_run: createMockTransformRun({ status: "succeeded" }),
+ }),
+ });
+ const button = screen.getByRole("button", { name: "Delete transform" });
+ expect(button).toBeEnabled();
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.tsx
index 04d35524b69..114ff238e74 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.tsx
@@ -27,6 +27,7 @@ import {
getQueryBuilderUrl,
getTableMetadataUrl,
} from "../../../urls";
+import { isTransformRunning } from "../utils";
import { UpdateTargetModal } from "./UpdateTargetModal";
@@ -76,7 +77,6 @@ function TargetInfo({ transform }: TargetInfoProps) {
);
const database = table?.db ?? databaseFromApi;
-
const isLoading = isDatabaseLoading || isSchemasLoading;
if (isLoading) {
@@ -185,6 +185,7 @@ function EditTargetButton({ transform }: EditTargetButtonProps) {
<>
<Button
leftSection={<Icon name="pencil_lines" aria-hidden />}
+ disabled={isTransformRunning(transform)}
onClick={openModal}
>
{t`Change target`}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.unit.spec.tsx
new file mode 100644
index 00000000000..2fa90257b3a
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TargetSection/TargetSection.unit.spec.tsx
@@ -0,0 +1,47 @@
+import { Route } from "react-router";
+
+import { renderWithProviders, screen } from "__support__/ui";
+import { getTransformUrl } from "metabase-enterprise/transforms/urls";
+import type { Transform } from "metabase-types/api";
+import {
+ createMockTransform,
+ createMockTransformRun,
+} from "metabase-types/api/mocks";
+
+import { TargetSection } from "./TargetSection";
+
+type SetupOpts = {
+ transform?: Transform;
+};
+
+function setup({ transform = createMockTransform() }: SetupOpts) {
+ renderWithProviders(
+ <Route
+ path={getTransformUrl(transform.id)}
+ component={() => <TargetSection transform={transform} />}
+ />,
+ { withRouter: true, initialRoute: getTransformUrl(transform.id) },
+ );
+}
+
+describe("TargetSection", () => {
+ it("should disable the change target button when the transform is running", () => {
+ setup({
+ transform: createMockTransform({
+ last_run: createMockTransformRun({ status: "started" }),
+ }),
+ });
+ const button = screen.getByRole("button", { name: "Change target" });
+ expect(button).toBeDisabled();
+ });
+
+ it("should not disable the change target button when the transform is not running", () => {
+ setup({
+ transform: createMockTransform({
+ last_run: createMockTransformRun({ status: "failed" }),
+ }),
+ });
+ const button = screen.getByRole("button", { name: "Change target" });
+ expect(button).toBeEnabled();
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx
index e709287cbe0..33996d95f1e 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx
@@ -3,7 +3,6 @@ import { t } from "ttag";
import { skipToken } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
-import { parseTimestamp } from "metabase/lib/time-dayjs";
import * as Urls from "metabase/lib/urls";
import { Stack } from "metabase/ui";
import { useGetTransformQuery } from "metabase-enterprise/api";
@@ -17,6 +16,7 @@ import { ManageSection } from "./ManageSection";
import { NameSection } from "./NameSection";
import { RunSection } from "./RunSection";
import { TargetSection } from "./TargetSection";
+import { isTransformRunning, isTransformSyncing } from "./utils";
type TransformPageParams = {
transformId: string;
@@ -76,28 +76,8 @@ function getParsedParams({
}
function isPollingNeeded(transform?: Transform) {
- const lastRun = transform?.last_run;
-
- if (transform == null || lastRun == null) {
- return false;
- }
-
- if (lastRun.status === "started") {
- return true;
- }
-
- // If the last run succeeded but there is no table yet, wait for the sync to
- // finish. If the transform is changed until the sync finishes, stop polling,
- // because the table could be already deleted.
- if (
- transform.table == null &&
- lastRun.status === "succeeded" &&
- lastRun.end_time != null
- ) {
- const endedAt = parseTimestamp(lastRun.end_time);
- const updatedAt = parseTimestamp(transform.updated_at);
- return endedAt.isAfter(updatedAt);
- }
-
- return false;
+ return (
+ transform != null &&
+ (isTransformRunning(transform) || isTransformSyncing(transform))
+ );
}
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.ts
new file mode 100644
index 00000000000..b2d1ad324b8
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.ts
@@ -0,0 +1,26 @@
+import { parseTimestamp } from "metabase/lib/time-dayjs";
+import type { Transform } from "metabase-types/api";
+
+export function isTransformRunning(transform: Transform) {
+ const lastRun = transform.last_run;
+ return lastRun?.status === "started";
+}
+
+export function isTransformSyncing(transform: Transform) {
+ const lastRun = transform.last_run;
+
+ // If the last run succeeded but there is no table yet, wait for the sync to
+ // finish. If the transform is changed until the sync finishes, stop polling,
+ // because the table could be already deleted.
+ if (
+ transform.table == null &&
+ lastRun?.status === "succeeded" &&
+ lastRun?.end_time != null
+ ) {
+ const endedAt = parseTimestamp(lastRun.end_time);
+ const updatedAt = parseTimestamp(transform.updated_at);
+ return endedAt.isAfter(updatedAt);
+ }
+
+ return false;
+}