Skip to content

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

Allow disabling transform jobs (#73573)

Nick Fitzpatrickcb174b5d566e
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 8837882577d..8246581139d 100644
--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
@@ -3060,6 +3060,95 @@ describe("scenarios > admin > transforms > jobs", () => {
});
});
+ describe("active flag", () => {
+ beforeEach(() => {
+ cy.intercept("PUT", "/api/transform-job/active").as(
+ "bulkUpdateJobActive",
+ );
+ });
+
+ it("can disable and re-enable jobs from the list, the detail page, and in bulk", () => {
+ H.createTransformJob({ name: "Job A" });
+ H.createTransformJob({ name: "Job B" });
+
+ visitJobListPage();
+
+ cy.log("disable Job A from the row menu — no navigation");
+ getJobRow("Job A").icon("ellipsis").click();
+ H.popover().findByText("Disable").click();
+ cy.wait("@updateJob")
+ .its("request.body")
+ .should("deep.equal", { active: false });
+ H.undoToast().findByText("Job disabled").should("be.visible");
+ H.undoToast().findByRole("img", { name: /close/i }).click();
+ getJobRow("Job A").findByText("Disabled").should("be.visible");
+ cy.location("pathname").should("eq", "/data-studio/transforms/jobs");
+
+ cy.log("re-enable Job A from the row menu");
+ getJobRow("Job A").icon("ellipsis").click();
+ H.popover().findByText("Re-enable").click();
+ cy.wait("@updateJob")
+ .its("request.body")
+ .should("deep.equal", { active: true });
+ H.undoToast().findByText("Job enabled").should("be.visible");
+ H.undoToast().findByRole("img", { name: /close/i }).click();
+ getJobRow("Job A").findByText("Disabled").should("not.exist");
+
+ cy.log("disable Job A from the detail page");
+ getJobRow("Job A").click();
+ H.DataStudio.Jobs.header().icon("ellipsis").click();
+ H.popover().findByText("Disable").click();
+ cy.wait("@updateJob")
+ .its("request.body")
+ .should("deep.equal", { active: false });
+ H.undoToast().findByText("Job disabled").should("be.visible");
+ H.undoToast().findByRole("img", { name: /close/i }).click();
+ H.DataStudio.Jobs.editor().findByText("Disabled").should("be.visible");
+
+ cy.log("re-enable Job A from the detail page");
+ H.DataStudio.Jobs.header().icon("ellipsis").click();
+ H.popover().findByText("Re-enable").click();
+ cy.wait("@updateJob")
+ .its("request.body")
+ .should("deep.equal", { active: true });
+ H.DataStudio.Jobs.editor().findByText("Disabled").should("not.exist");
+
+ H.DataStudio.nav().findByRole("link", { name: "Jobs" }).click();
+
+ cy.log("bulk-disable: cancel from the modal does not fire the mutation");
+ openBulkActionsMenu();
+ H.popover().findByText("Disable all").click();
+ H.modal().button("Cancel").click();
+
+ cy.log(
+ "bulk-disable: confirming sends { active: false } and badges all rows",
+ );
+ openBulkActionsMenu();
+ H.popover().findByText("Disable all").click();
+ H.modal().button("Disable all").click();
+ cy.wait("@bulkUpdateJobActive")
+ .its("request.body")
+ .should("deep.equal", { active: false });
+ getJobRow("Job A").findByText("Disabled").should("be.visible");
+ getJobRow("Job B").findByText("Disabled").should("be.visible");
+
+ cy.log("mixed state: bulk menu shows both items, then bulk-re-enable");
+ getJobRow("Job A").icon("ellipsis").click();
+ H.popover().findByText("Re-enable").click();
+ cy.wait("@updateJob");
+ openBulkActionsMenu();
+ H.popover().within(() => {
+ cy.findByText("Disable all").should("be.visible");
+ cy.findByText("Re-enable all").should("be.visible").click();
+ });
+ cy.wait("@bulkUpdateJobActive")
+ .its("request.body")
+ .should("deep.equal", { active: true });
+ getJobRow("Job A").findByText("Disabled").should("not.exist");
+ getJobRow("Job B").findByText("Disabled").should("not.exist");
+ });
+ });
+
describe("default jobs and tags", () => {
it("should pre-create default jobs and tags", () => {
const jobNames = ["Hourly job", "Daily job", "Weekly job", "Monthly job"];
@@ -3835,6 +3924,16 @@ function visitJobListPage() {
return cy.visit("/data-studio/transforms/jobs");
}
+function getJobRow(name: string) {
+ return H.DataStudio.Jobs.list()
+ .findAllByRole("row")
+ .filter(`:contains("${name}")`);
+}
+
+function openBulkActionsMenu() {
+ cy.findByLabelText("More job options").click();
+}
+
function visitRunListPage() {
return cy.visit("/data-studio/transforms/runs");
}
diff --git a/frontend/src/metabase-types/api/mocks/transform.ts b/frontend/src/metabase-types/api/mocks/transform.ts
index 6fc4ae0730e..c91349c863c 100644
--- a/frontend/src/metabase-types/api/mocks/transform.ts
+++ b/frontend/src/metabase-types/api/mocks/transform.ts
@@ -159,6 +159,7 @@ export function createMockTransformJob(
description: null,
schedule: "0 0 0 * * ? *",
ui_display_type: "cron/builder",
+ active: true,
created_at: "2000-01-01T00:00:00Z",
updated_at: "2000-01-01T00:00:00Z",
...opts,
diff --git a/frontend/src/metabase-types/api/transform.ts b/frontend/src/metabase-types/api/transform.ts
index b5655dd8fed..81c6c86afc7 100644
--- a/frontend/src/metabase-types/api/transform.ts
+++ b/frontend/src/metabase-types/api/transform.ts
@@ -200,6 +200,7 @@ export type TransformJob = {
description: string | null;
schedule: string;
ui_display_type: ScheduleDisplayType;
+ active: boolean;
created_at: string;
updated_at: string;
@@ -246,6 +247,7 @@ export type UpdateTransformJobRequest = {
description?: string | null;
schedule?: string;
ui_display_type?: ScheduleDisplayType;
+ active?: boolean;
tag_ids?: TransformTagId[];
};
diff --git a/frontend/src/metabase/api/transform-job.ts b/frontend/src/metabase/api/transform-job.ts
index 9a3d39e4ab5..0554420f7e2 100644
--- a/frontend/src/metabase/api/transform-job.ts
+++ b/frontend/src/metabase/api/transform-job.ts
@@ -135,6 +135,18 @@ export const transformJobApi = Api.injectEndpoints({
invalidatesTags: (_, error) =>
invalidateTags(error, [listTag("transform-job")]),
}),
+ bulkUpdateTransformJobsActive: builder.mutation<
+ { updated: number; failed: number },
+ { active: boolean }
+ >({
+ query: (body) => ({
+ method: "PUT",
+ url: "/api/transform-job/active",
+ body,
+ }),
+ invalidatesTags: (_, error) =>
+ invalidateTags(error, [listTag("transform-job")]),
+ }),
}),
});
@@ -147,4 +159,5 @@ export const {
useCreateTransformJobMutation,
useUpdateTransformJobMutation,
useDeleteTransformJobMutation,
+ useBulkUpdateTransformJobsActiveMutation,
} = transformJobApi;
diff --git a/frontend/src/metabase/transforms/components/JobEditor/JobEditor.tsx b/frontend/src/metabase/transforms/components/JobEditor/JobEditor.tsx
index b912d2d4147..2ef4c4271d2 100644
--- a/frontend/src/metabase/transforms/components/JobEditor/JobEditor.tsx
+++ b/frontend/src/metabase/transforms/components/JobEditor/JobEditor.tsx
@@ -9,7 +9,7 @@ import {
PaneHeader,
PaneHeaderInput,
} from "metabase/data-studio/common/components/PaneHeader";
-import { Stack } from "metabase/ui";
+import { Group, Stack } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { ScheduleDisplayType, TransformTagId } from "metabase-types/api";
@@ -50,7 +50,7 @@ export function JobEditor({
<PageContainer data-testid="transforms-job-editor" gap="2.5rem">
<PaneHeader
title={
- <>
+ <Group align="center" gap="sm" wrap="nowrap">
<PaneHeaderInput
initialValue={job.name}
maxLength={NAME_MAX_LENGTH}
@@ -62,7 +62,12 @@ export function JobEditor({
<TransformBadge bg="background-warning-secondary">{t`Disabled`}</TransformBadge>
</LockedTransformsHoverCard>
)}
- </>
+ {!isMeterLocked && !job.active && (
+ <TransformBadge bg="background-warning-secondary">
+ {t`Disabled`}
+ </TransformBadge>
+ )}
+ </Group>
}
py={0}
breadcrumbs={
diff --git a/frontend/src/metabase/transforms/components/JobEditor/JobEditor.unit.spec.tsx b/frontend/src/metabase/transforms/components/JobEditor/JobEditor.unit.spec.tsx
new file mode 100644
index 00000000000..e1450a6ec60
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobEditor/JobEditor.unit.spec.tsx
@@ -0,0 +1,44 @@
+import { Route } from "react-router";
+
+import {
+ setupListTransformJobTransformsEndpoint,
+ setupListTransformTagsEndpoint,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen } from "__support__/ui";
+import type { TransformJob } from "metabase-types/api";
+import { createMockTransformJob } from "metabase-types/api/mocks";
+
+import { JobEditor } from "./JobEditor";
+
+function setup({
+ job = createMockTransformJob(),
+}: { job?: TransformJob } = {}) {
+ setupListTransformTagsEndpoint([]);
+ setupListTransformJobTransformsEndpoint(job.id, []);
+ renderWithProviders(
+ <Route
+ path="/"
+ component={() => (
+ <JobEditor
+ job={job}
+ onNameChange={jest.fn()}
+ onScheduleChange={jest.fn()}
+ onTagListChange={jest.fn()}
+ />
+ )}
+ />,
+ { withRouter: true, initialRoute: "/" },
+ );
+}
+
+describe("JobEditor", () => {
+ it("does not render a Disabled badge when the job is enabled", () => {
+ setup({ job: createMockTransformJob({ active: true }) });
+ expect(screen.queryByText("Disabled")).not.toBeInTheDocument();
+ });
+
+ it("renders a Disabled badge when the job is disabled", () => {
+ setup({ job: createMockTransformJob({ active: false }) });
+ expect(screen.getByText("Disabled")).toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/transforms/components/JobEditor/types.ts b/frontend/src/metabase/transforms/components/JobEditor/types.ts
index 1679913639c..73aa3eb479a 100644
--- a/frontend/src/metabase/transforms/components/JobEditor/types.ts
+++ b/frontend/src/metabase/transforms/components/JobEditor/types.ts
@@ -11,6 +11,7 @@ export type TransformJobInfo = {
description: string | null;
schedule: string;
ui_display_type: ScheduleDisplayType;
+ active?: boolean;
tag_ids?: TransformTagId[];
last_run?: TransformRun | null;
};
diff --git a/frontend/src/metabase/transforms/components/JobListMoreMenu/DisableAllJobsModal/DisableAllJobsModal.tsx b/frontend/src/metabase/transforms/components/JobListMoreMenu/DisableAllJobsModal/DisableAllJobsModal.tsx
new file mode 100644
index 00000000000..26c737b5d3b
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobListMoreMenu/DisableAllJobsModal/DisableAllJobsModal.tsx
@@ -0,0 +1,64 @@
+import { t } from "ttag";
+
+import { useBulkUpdateTransformJobsActiveMutation } from "metabase/api";
+import {
+ Form,
+ FormErrorMessage,
+ FormProvider,
+ FormSubmitButton,
+} from "metabase/forms";
+import { Box, Button, FocusTrap, Group, Modal, Stack, Text } from "metabase/ui";
+
+type DisableAllJobsModalProps = {
+ onConfirm: () => void;
+ onClose: () => void;
+};
+
+export function DisableAllJobsModal({
+ onConfirm,
+ onClose,
+}: DisableAllJobsModalProps) {
+ return (
+ <Modal
+ title={t`Disable all jobs?`}
+ opened
+ padding="xl"
+ onClose={onClose}
+ onClick={(event) => event.stopPropagation()}
+ >
+ <FocusTrap.InitialFocus />
+ <DisableAllJobsForm onConfirm={onConfirm} onClose={onClose} />
+ </Modal>
+ );
+}
+
+function DisableAllJobsForm({ onConfirm, onClose }: DisableAllJobsModalProps) {
+ const [bulkUpdate] = useBulkUpdateTransformJobsActiveMutation();
+
+ const handleSubmit = async () => {
+ const { failed } = await bulkUpdate({ active: false }).unwrap();
+ if (failed > 0) {
+ throw new Error(t`Failed to disable all jobs`);
+ }
+ onConfirm();
+ };
+
+ return (
+ <FormProvider initialValues={{}} onSubmit={handleSubmit}>
+ <Form>
+ <Stack gap="lg">
+ <Text>
+ {t`Any jobs that are currently running will finish and no new job runs will start.`}
+ </Text>
+ <Group>
+ <Box flex={1}>
+ <FormErrorMessage />
+ </Box>
+ <Button onClick={onClose}>{t`Cancel`}</Button>
+ <FormSubmitButton label={t`Disable all`} variant="filled" />
+ </Group>
+ </Stack>
+ </Form>
+ </FormProvider>
+ );
+}
diff --git a/frontend/src/metabase/transforms/components/JobListMoreMenu/DisableAllJobsModal/index.ts b/frontend/src/metabase/transforms/components/JobListMoreMenu/DisableAllJobsModal/index.ts
new file mode 100644
index 00000000000..74ac4a4d772
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobListMoreMenu/DisableAllJobsModal/index.ts
@@ -0,0 +1 @@
+export * from "./DisableAllJobsModal";
diff --git a/frontend/src/metabase/transforms/components/JobListMoreMenu/JobListMoreMenu.tsx b/frontend/src/metabase/transforms/components/JobListMoreMenu/JobListMoreMenu.tsx
new file mode 100644
index 00000000000..a068aac62aa
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobListMoreMenu/JobListMoreMenu.tsx
@@ -0,0 +1,74 @@
+import { useState } from "react";
+import { t } from "ttag";
+
+import { useBulkUpdateTransformJobsActiveMutation } from "metabase/api";
+import { useMetadataToasts } from "metabase/metadata/hooks";
+import { Button, Icon, Menu } from "metabase/ui";
+import type { TransformJob } from "metabase-types/api";
+
+import { DisableAllJobsModal } from "./DisableAllJobsModal";
+import type { JobListMoreMenuModalType } from "./types";
+
+type JobListMoreMenuProps = {
+ jobs: TransformJob[];
+};
+
+export function JobListMoreMenu({ jobs }: JobListMoreMenuProps) {
+ const [modalType, setModalType] = useState<JobListMoreMenuModalType>();
+ const [bulkUpdate] = useBulkUpdateTransformJobsActiveMutation();
+ const { sendErrorToast, sendSuccessToast } = useMetadataToasts();
+
+ const hasEnabledJobs = jobs.some((job) => job.active);
+ const hasDisabledJobs = jobs.some((job) => !job.active);
+
+ const handleReEnableAll = async () => {
+ const { data, error } = await bulkUpdate({ active: true });
+ if (error || (data?.failed ?? 0) > 0) {
+ sendErrorToast(t`Failed to re-enable all jobs`);
+ } else {
+ sendSuccessToast(t`All jobs re-enabled`);
+ }
+ };
+
+ const handleDisableAllConfirmed = () => {
+ sendSuccessToast(t`All jobs disabled`);
+ setModalType(undefined);
+ };
+
+ return (
+ <>
+ <Menu>
+ <Menu.Target>
+ <Button
+ aria-label={t`More job options`}
+ leftSection={<Icon name="ellipsis" />}
+ />
+ </Menu.Target>
+ <Menu.Dropdown onClick={(event) => event.stopPropagation()}>
+ {hasEnabledJobs && (
+ <Menu.Item
+ leftSection={<Icon name="pause" />}
+ onClick={() => setModalType("disable-all")}
+ >
+ {t`Disable all`}
+ </Menu.Item>
+ )}
+ {hasDisabledJobs && (
+ <Menu.Item
+ leftSection={<Icon name="play" />}
+ onClick={handleReEnableAll}
+ >
+ {t`Re-enable all`}
+ </Menu.Item>
+ )}
+ </Menu.Dropdown>
+ </Menu>
+ {modalType === "disable-all" && (
+ <DisableAllJobsModal
+ onConfirm={handleDisableAllConfirmed}
+ onClose={() => setModalType(undefined)}
+ />
+ )}
+ </>
+ );
+}
diff --git a/frontend/src/metabase/transforms/components/JobListMoreMenu/JobListMoreMenu.unit.spec.tsx b/frontend/src/metabase/transforms/components/JobListMoreMenu/JobListMoreMenu.unit.spec.tsx
new file mode 100644
index 00000000000..8e76f8a7a0f
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobListMoreMenu/JobListMoreMenu.unit.spec.tsx
@@ -0,0 +1,129 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+
+import { setupBulkUpdateTransformJobsActiveEndpoint } from "__support__/server-mocks";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import type { TransformJob } from "metabase-types/api";
+import { createMockTransformJob } from "metabase-types/api/mocks";
+
+import { JobListMoreMenu } from "./JobListMoreMenu";
+
+function setup({ jobs }: { jobs: TransformJob[] }) {
+ setupBulkUpdateTransformJobsActiveEndpoint(jobs.length);
+ renderWithProviders(<JobListMoreMenu jobs={jobs} />);
+}
+
+async function openMenu() {
+ await userEvent.click(screen.getByRole("button"));
+}
+
+async function expectBulkPut(active: boolean) {
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.lastCall("path:/api/transform-job/active", {
+ method: "PUT",
+ }),
+ ).toBeDefined();
+ });
+ const call = fetchMock.callHistory.lastCall(
+ "path:/api/transform-job/active",
+ { method: "PUT" },
+ );
+ expect(await call?.request?.json()).toEqual({ active });
+}
+
+describe("JobListMoreMenu", () => {
+ it("shows only 'Disable all' when every job is enabled", async () => {
+ setup({
+ jobs: [
+ createMockTransformJob({ id: 1, active: true }),
+ createMockTransformJob({ id: 2, active: true }),
+ ],
+ });
+ await openMenu();
+ expect(
+ await screen.findByRole("menuitem", { name: /Disable all/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("menuitem", { name: /Re-enable all/ }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows only 'Re-enable all' when every job is disabled", async () => {
+ setup({
+ jobs: [
+ createMockTransformJob({ id: 1, active: false }),
+ createMockTransformJob({ id: 2, active: false }),
+ ],
+ });
+ await openMenu();
+ expect(
+ await screen.findByRole("menuitem", { name: /Re-enable all/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("menuitem", { name: /Disable all/ }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows both items in mixed state", async () => {
+ setup({
+ jobs: [
+ createMockTransformJob({ id: 1, active: true }),
+ createMockTransformJob({ id: 2, active: false }),
+ ],
+ });
+ await openMenu();
+ expect(
+ await screen.findByRole("menuitem", { name: /Disable all/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.getByRole("menuitem", { name: /Re-enable all/ }),
+ ).toBeInTheDocument();
+ });
+
+ it("re-enables all jobs immediately without a confirmation modal", async () => {
+ setup({ jobs: [createMockTransformJob({ id: 1, active: false })] });
+ await openMenu();
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Re-enable all/ }),
+ );
+
+ await expectBulkPut(true);
+ expect(screen.queryByRole("dialog")).not.toBeInTheDocument();
+ });
+
+ it("disables all jobs only after confirming the modal", async () => {
+ setup({ jobs: [createMockTransformJob({ id: 1, active: true })] });
+ await openMenu();
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Disable all/ }),
+ );
+
+ expect(
+ await screen.findByRole("dialog", { name: "Disable all jobs?" }),
+ ).toBeInTheDocument();
+ expect(
+ fetchMock.callHistory.lastCall("path:/api/transform-job/active", {
+ method: "PUT",
+ }),
+ ).toBeUndefined();
+
+ await userEvent.click(screen.getByRole("button", { name: "Disable all" }));
+ await expectBulkPut(false);
+ });
+
+ it("does not fire the bulk mutation when the modal is canceled", async () => {
+ setup({ jobs: [createMockTransformJob({ id: 1, active: true })] });
+ await openMenu();
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Disable all/ }),
+ );
+ await userEvent.click(screen.getByRole("button", { name: "Cancel" }));
+
+ expect(
+ fetchMock.callHistory.lastCall("path:/api/transform-job/active", {
+ method: "PUT",
+ }),
+ ).toBeUndefined();
+ });
+});
diff --git a/frontend/src/metabase/transforms/components/JobListMoreMenu/index.ts b/frontend/src/metabase/transforms/components/JobListMoreMenu/index.ts
new file mode 100644
index 00000000000..2acbf547ea2
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobListMoreMenu/index.ts
@@ -0,0 +1 @@
+export * from "./JobListMoreMenu";
diff --git a/frontend/src/metabase/transforms/components/JobListMoreMenu/types.ts b/frontend/src/metabase/transforms/components/JobListMoreMenu/types.ts
new file mode 100644
index 00000000000..5f953d59794
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobListMoreMenu/types.ts
@@ -0,0 +1 @@
+export type JobListMoreMenuModalType = "disable-all";
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/DeleteJobModal.tsx b/frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/DeleteJobModal.tsx
similarity index 90%
rename from frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/DeleteJobModal.tsx
rename to frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/DeleteJobModal.tsx
index f561ef72cfe..8bda328ecd8 100644
--- a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/DeleteJobModal.tsx
+++ b/frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/DeleteJobModal.tsx
@@ -22,7 +22,13 @@ export function DeleteJobModal({
onClose,
}: DeleteJobModalProps) {
return (
- <Modal title={t`Delete this job?`} opened padding="xl" onClose={onClose}>
+ <Modal
+ title={t`Delete this job?`}
+ opened
+ padding="xl"
+ onClose={onClose}
+ onClick={(event) => event.stopPropagation()}
+ >
<FocusTrap.InitialFocus />
<DeleteJobForm job={job} onDelete={onDelete} onClose={onClose} />
</Modal>
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/DeleteJobModal.unit.spec.tsx b/frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/DeleteJobModal.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/DeleteJobModal.unit.spec.tsx
rename to frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/DeleteJobModal.unit.spec.tsx
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/index.ts b/frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/index.ts
similarity index 100%
rename from frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/DeleteJobModal/index.ts
rename to frontend/src/metabase/transforms/components/JobMoreMenu/DeleteJobModal/index.ts
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/JobMoreMenu.tsx b/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx
similarity index 64%
rename from frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/JobMoreMenu.tsx
rename to frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx
index f85624b94f2..986eb56b0bb 100644
--- a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/JobMoreMenu.tsx
+++ b/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.tsx
@@ -2,6 +2,7 @@ import { type MouseEvent, useState } from "react";
import { push } from "react-router-redux";
import { t } from "ttag";
+import { useUpdateTransformJobMutation } from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
import { useDispatch } from "metabase/redux";
import { ActionIcon, Icon, Menu } from "metabase/ui";
@@ -17,10 +18,28 @@ type JobMoreMenuProps = {
export function JobMoreMenu({ job }: JobMoreMenuProps) {
const [modalType, setModalType] = useState<JobMoreMenuModalType>();
+ const [updateJob] = useUpdateTransformJobMutation();
+ const { sendErrorToast, sendSuccessToast } = useMetadataToasts();
+
+ const handleToggleDisabled = async () => {
+ const nextActive = !job.active;
+ const { error } = await updateJob({ id: job.id, active: nextActive });
+ if (error) {
+ sendErrorToast(
+ nextActive ? t`Failed to enable job` : t`Failed to disable job`,
+ );
+ } else {
+ sendSuccessToast(nextActive ? t`Job enabled` : t`Job disabled`);
+ }
+ };
return (
<>
- <JobMenu onOpenModal={setModalType} />
+ <JobMenu
+ isDisabled={!job.active}
+ onOpenModal={setModalType}
+ onToggleDisabled={handleToggleDisabled}
+ />
{modalType != null && (
<JobModal
job={job}
@@ -33,10 +52,12 @@ export function JobMoreMenu({ job }: JobMoreMenuProps) {
}
type JobMenuProps = {
+ isDisabled: boolean;
onOpenModal: (modalType: JobMoreMenuModalType) => void;
+ onToggleDisabled: () => void;
};
-function JobMenu({ onOpenModal }: JobMenuProps) {
+function JobMenu({ isDisabled, onOpenModal, onToggleDisabled }: JobMenuProps) {
const handleIconClick = (event: MouseEvent) => {
event.preventDefault();
event.stopPropagation();
@@ -49,7 +70,13 @@ function JobMenu({ onOpenModal }: JobMenuProps) {
<Icon name="ellipsis" />
</ActionIcon>
</Menu.Target>
- <Menu.Dropdown>
+ <Menu.Dropdown onClick={(event) => event.stopPropagation()}>
+ <Menu.Item
+ leftSection={<Icon name={isDisabled ? "play" : "pause"} />}
+ onClick={onToggleDisabled}
+ >
+ {isDisabled ? t`Re-enable` : t`Disable`}
+ </Menu.Item>
<Menu.Item
leftSection={<Icon name="trash" />}
onClick={() => onOpenModal("delete")}
diff --git a/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.unit.spec.tsx b/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.unit.spec.tsx
new file mode 100644
index 00000000000..3fc91d200f9
--- /dev/null
+++ b/frontend/src/metabase/transforms/components/JobMoreMenu/JobMoreMenu.unit.spec.tsx
@@ -0,0 +1,87 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+
+import { setupUpdateTransformJobEndpoint } from "__support__/server-mocks";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import type { TransformJob } from "metabase-types/api";
+import { createMockTransformJob } from "metabase-types/api/mocks";
+
+import { JobMoreMenu } from "./JobMoreMenu";
+
+function setup({
+ job = createMockTransformJob(),
+}: { job?: TransformJob } = {}) {
+ setupUpdateTransformJobEndpoint(job);
+ renderWithProviders(<JobMoreMenu job={job} />);
+ return { job };
+}
+
+async function openMenu() {
+ await userEvent.click(screen.getByRole("button"));
+}
+
+describe("JobMoreMenu", () => {
+ it("shows 'Disable' when the job is enabled", async () => {
+ setup({ job: createMockTransformJob({ active: true }) });
+ await openMenu();
+ expect(
+ await screen.findByRole("menuitem", { name: /Disable/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("menuitem", { name: /Re-enable/ }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows 'Re-enable' when the job is disabled", async () => {
+ setup({ job: createMockTransformJob({ active: false }) });
+ await openMenu();
+ expect(
+ await screen.findByRole("menuitem", { name: /Re-enable/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("menuitem", { name: /Disable/ }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("calls the update mutation with active: false when disabling", async () => {
+ const { job } = setup({ job: createMockTransformJob({ active: true }) });
+ await openMenu();
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Disable/ }),
+ );
+
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.lastCall(`path:/api/transform-job/${job.id}`, {
+ method: "PUT",
+ }),
+ ).toBeDefined();
+ });
+ const call = fetchMock.callHistory.lastCall(
+ `path:/api/transform-job/${job.id}`,
+ { method: "PUT" },
+ );
+ expect(await call?.request?.json()).toEqual({ active: false });
+ });
+
+ it("calls the update mutation with active: true when enabling", async () => {
+ const { job } = setup({ job: createMockTransformJob({ active: false }) });
+ await openMenu();
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Re-enable/ }),
+ );
+
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.lastCall(`path:/api/transform-job/${job.id}`, {
+ method: "PUT",
+ }),
+ ).toBeDefined();
+ });
+ const call = fetchMock.callHistory.lastCall(
+ `path:/api/transform-job/${job.id}`,
+ { method: "PUT" },
+ );
+ expect(await call?.request?.json()).toEqual({ active: true });
+ });
+});
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/index.ts b/frontend/src/metabase/transforms/components/JobMoreMenu/index.ts
similarity index 100%
rename from frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/index.ts
rename to frontend/src/metabase/transforms/components/JobMoreMenu/index.ts
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/types.ts b/frontend/src/metabase/transforms/components/JobMoreMenu/types.ts
similarity index 100%
rename from frontend/src/metabase/transforms/pages/JobPage/JobMoreMenu/types.ts
rename to frontend/src/metabase/transforms/components/JobMoreMenu/types.ts
diff --git a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx
index 42768b1f3e0..0b6fb0197f2 100644
--- a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx
+++ b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.tsx
@@ -11,7 +11,8 @@ import { useSetting } from "metabase/common/hooks";
import { DataStudioBreadcrumbs } from "metabase/data-studio/common/components/DataStudioBreadcrumbs";
import { PageContainer } from "metabase/data-studio/common/components/PageContainer";
import { PaneHeader } from "metabase/data-studio/common/components/PaneHeader";
-import { useDispatch } from "metabase/redux";
+import { useDispatch, useSelector } from "metabase/redux";
+import { getUserIsAdmin } from "metabase/selectors/user";
import { LockedTransformsBanner } from "metabase/transforms/components/LockedTransformsBanner/LockedTransformsBanner";
import { TransformBadge } from "metabase/transforms/components/TransformBadge/TransformBadge";
import type { TreeTableColumnDef } from "metabase/ui";
@@ -30,10 +31,15 @@ import {
import * as Urls from "metabase/urls";
import type { TransformJob } from "metabase-types/api";
+import { JobListMoreMenu } from "../../components/JobListMoreMenu";
+import { JobMoreMenu } from "../../components/JobMoreMenu";
+
export const JobListPage = () => {
const dispatch = useDispatch();
const [searchQuery, setSearchQuery] = useState("");
+ const isAdmin = useSelector(getUserIsAdmin);
+
const { data: jobs = [], error, isLoading } = useListTransformJobsQuery({});
const handleRowActivate = useCallback(
@@ -68,21 +74,28 @@ export const JobListPage = () => {
</Ellipsified>
) : null,
},
- ...(isMeterLocked
+ {
+ id: "status",
+ maxWidth: 200,
+ cell: ({ row }) =>
+ isMeterLocked || !row.original.active ? (
+ <TransformBadge bg="background-secondary">
+ {t`Disabled`}
+ </TransformBadge>
+ ) : null,
+ },
+ ...(isAdmin
? ([
{
- id: "status",
- maxWidth: 200,
- cell: () => (
- <TransformBadge bg="background-secondary">
- {t`Disabled`}
- </TransformBadge>
- ),
+ id: "actions",
+ header: "",
+ width: 48,
+ cell: ({ row }) => <JobMoreMenu job={row.original} />,
},
] satisfies TreeTableColumnDef<TransformJob>[])
: []),
],
- [isMeterLocked],
+ [isMeterLocked, isAdmin],
);
const treeTableInstance = useTreeTableInstance({
@@ -128,12 +141,13 @@ export const JobListPage = () => {
component={ForwardRefLink}
to={Urls.newTransformJob()}
>{t`New`}</Button>
+ {isAdmin && jobs.length > 0 && <JobListMoreMenu jobs={jobs} />}
</Flex>
<Flex direction="column" flex={1} mih={0}>
<Card withBorder p={0}>
{isLoading ? (
- <TreeTableSkeleton columnWidths={[0.6, 0.3]} />
+ <TreeTableSkeleton columnWidths={[0.55, 0.3, 0.1, 0.05]} />
) : (
<TreeTable
instance={treeTableInstance}
diff --git a/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.unit.spec.tsx b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.unit.spec.tsx
new file mode 100644
index 00000000000..53c57f7181f
--- /dev/null
+++ b/frontend/src/metabase/transforms/pages/JobListPage/JobListPage.unit.spec.tsx
@@ -0,0 +1,214 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+import type { ReactNode } from "react";
+import { Route } from "react-router";
+
+import {
+ setupDeleteTransformJobEndpoint,
+ setupListTransformJobsEndpoint,
+ setupUpdateTransformJobEndpoint,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
+import { createMockState } from "metabase/redux/store/mocks/state";
+import type { TransformJob } from "metabase-types/api";
+import {
+ createMockTransformJob,
+ createMockUser,
+} from "metabase-types/api/mocks";
+
+import { JobListPage } from "./JobListPage";
+
+type MockTreeTableRow = {
+ id: string;
+ original: TransformJob;
+ getVisibleCells: () => Array<{
+ id: string;
+ column: { columnDef: { cell?: unknown } };
+ getContext: () => unknown;
+ }>;
+};
+
+type MockTreeTableInstance = {
+ table: { getRowModel: () => { rows: MockTreeTableRow[] } };
+};
+
+jest.mock("metabase/ui/components/data-display/TreeTable/TreeTable", () => {
+ const { flexRender } = jest.requireActual("@tanstack/react-table");
+ return {
+ TreeTable: ({
+ instance,
+ emptyState,
+ onRowClick,
+ }: {
+ instance: MockTreeTableInstance;
+ emptyState: ReactNode;
+ onRowClick?: (row: MockTreeTableRow, event: unknown) => void;
+ }) => {
+ const rows = instance.table.getRowModel().rows;
+ if (rows.length === 0) {
+ return <div data-testid="tree-table-mock">{emptyState}</div>;
+ }
+ return (
+ <div data-testid="tree-table-mock">
+ {rows.map((row) => (
+ <div
+ key={row.id}
+ data-testid="job-row"
+ data-job-id={row.original.id}
+ onClick={(event) => onRowClick?.(row, event)}
+ >
+ {row.getVisibleCells().map((cell) => (
+ <div key={cell.id} data-testid={`job-cell-${cell.id}`}>
+ {flexRender(cell.column.columnDef.cell, cell.getContext())}
+ </div>
+ ))}
+ </div>
+ ))}
+ </div>
+ );
+ },
+ };
+});
+
+async function setup({
+ jobs,
+ isAdmin = false,
+}: {
+ jobs: TransformJob[];
+ isAdmin?: boolean;
+}) {
+ setupListTransformJobsEndpoint(jobs);
+ jobs.forEach(setupUpdateTransformJobEndpoint);
+ jobs.forEach((job) => setupDeleteTransformJobEndpoint(job.id));
+
+ const path = "/transforms/jobs";
+ const { history } = renderWithProviders(
+ <Route path={path} component={JobListPage} />,
+ {
+ withRouter: true,
+ initialRoute: path,
+ storeInitialState: createMockState({
+ currentUser: createMockUser({ is_superuser: isAdmin }),
+ }),
+ },
+ );
+
+ await screen.findByTestId("tree-table-mock");
+ return { history };
+}
+
+async function findRow(jobId: number) {
+ const rows = await screen.findAllByTestId("job-row");
+ return rows.find((row) => row.dataset.jobId === String(jobId))!;
+}
+
+describe("JobListPage", () => {
+ it("hides the bulk-action menu for admins when there are no jobs", async () => {
+ await setup({ jobs: [], isAdmin: true });
+ expect(screen.queryByLabelText("ellipsis icon")).not.toBeInTheDocument();
+ });
+
+ it("renders a Disabled badge only on disabled rows", async () => {
+ await setup({
+ jobs: [
+ createMockTransformJob({ id: 1, name: "Enabled job", active: true }),
+ createMockTransformJob({ id: 2, name: "Disabled job", active: false }),
+ ],
+ });
+
+ const enabledRow = await findRow(1);
+ const disabledRow = await findRow(2);
+ expect(within(enabledRow).queryByText("Disabled")).not.toBeInTheDocument();
+ expect(within(disabledRow).getByText("Disabled")).toBeInTheDocument();
+ });
+
+ it("opens the row action menu without navigating to the detail page", async () => {
+ const { history } = await setup({
+ jobs: [createMockTransformJob({ id: 1, name: "Job", active: true })],
+ isAdmin: true,
+ });
+
+ const row = await findRow(1);
+ await userEvent.click(within(row).getByLabelText("ellipsis icon"));
+
+ expect(
+ await screen.findByRole("menuitem", { name: /Disable/ }),
+ ).toBeInTheDocument();
+ expect(history?.getCurrentLocation().pathname).toBe("/transforms/jobs");
+ });
+
+ it("disables a job from the row action menu without navigating", async () => {
+ const { history } = await setup({
+ jobs: [createMockTransformJob({ id: 1, name: "Job", active: true })],
+ isAdmin: true,
+ });
+
+ const row = await findRow(1);
+ await userEvent.click(within(row).getByLabelText("ellipsis icon"));
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Disable/ }),
+ );
+
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.lastCall("path:/api/transform-job/1", {
+ method: "PUT",
+ }),
+ ).toBeDefined();
+ });
+ const call = fetchMock.callHistory.lastCall("path:/api/transform-job/1", {
+ method: "PUT",
+ });
+ expect(await call?.request?.json()).toEqual({ active: false });
+ expect(history?.getCurrentLocation().pathname).toBe("/transforms/jobs");
+ });
+
+ it("deletes a job from the row action menu without visiting the detail page", async () => {
+ const { history } = await setup({
+ jobs: [createMockTransformJob({ id: 1, name: "Job", active: true })],
+ isAdmin: true,
+ });
+ const visited: string[] = [];
+ history?.listen((location) => visited.push(location.pathname));
+
+ const row = await findRow(1);
+ await userEvent.click(within(row).getByLabelText("ellipsis icon"));
+ await userEvent.click(
+ await screen.findByRole("menuitem", { name: /Delete/ }),
+ );
+ await userEvent.click(screen.getByRole("button", { name: "Delete job" }));
+
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.lastCall("path:/api/transform-job/1", {
+ method: "DELETE",
+ }),
+ ).toBeDefined();
+ });
+ expect(visited.some((path) => path.includes("/jobs/1"))).toBe(false);
+ });
+
+ it("hides the row action menu for non-admin users", async () => {
+ await setup({
+ jobs: [createMockTransformJob({ id: 1, name: "Job", active: true })],
+ isAdmin: false,
+ });
+
+ const row = await findRow(1);
+ expect(
+ within(row).queryByLabelText("ellipsis icon"),
+ ).not.toBeInTheDocument();
+ });
+
+ it("hides the bulk-action menu for non-admin users even with jobs", async () => {
+ await setup({
+ jobs: [
+ createMockTransformJob({ id: 1, name: "Job A", active: true }),
+ createMockTransformJob({ id: 2, name: "Job B", active: true }),
+ ],
+ isAdmin: false,
+ });
+
+ expect(screen.queryByLabelText("ellipsis icon")).not.toBeInTheDocument();
+ });
+});
diff --git a/frontend/src/metabase/transforms/pages/JobPage/JobPage.tsx b/frontend/src/metabase/transforms/pages/JobPage/JobPage.tsx
index 9879e3a0f82..dc930ba53e8 100644
--- a/frontend/src/metabase/transforms/pages/JobPage/JobPage.tsx
+++ b/frontend/src/metabase/transforms/pages/JobPage/JobPage.tsx
@@ -23,10 +23,9 @@ import type {
} from "metabase-types/api";
import { JobEditor } from "../../components/JobEditor";
+import { JobMoreMenu } from "../../components/JobMoreMenu";
import { POLLING_INTERVAL } from "../../constants";
-import { JobMoreMenu } from "./JobMoreMenu";
-
type JobPageParams = {
jobId: string;
};
diff --git a/frontend/test/__support__/server-mocks/transform.ts b/frontend/test/__support__/server-mocks/transform.ts
index 05e7f41354f..011d6ff9715 100644
--- a/frontend/test/__support__/server-mocks/transform.ts
+++ b/frontend/test/__support__/server-mocks/transform.ts
@@ -62,6 +62,10 @@ export function setupUpdateTransformJobEndpoint(job: TransformJob) {
fetchMock.put(`path:/api/transform-job/${job.id}`, job);
}
+export function setupBulkUpdateTransformJobsActiveEndpoint(updated: number) {
+ fetchMock.put("path:/api/transform-job/active", { updated });
+}
+
export function setupRunTransformJobEndpoint(jobId: TransformJobId) {
fetchMock.post(`path:/api/transform-job/${jobId}/run`, 200);
}
diff --git a/resources/migrations/061/20260504_transform_job_active.yaml b/resources/migrations/061/20260504_transform_job_active.yaml
new file mode 100644
index 00000000000..9fe94748722
--- /dev/null
+++ b/resources/migrations/061/20260504_transform_job_active.yaml
@@ -0,0 +1,23 @@
+## Add active column to transform_job to allow disabling individual jobs
+
+databaseChangeLog:
+ - logicalFilePath: migrations/061_update_migrations.yaml
+ - changeSet:
+ id: v61.2026-05-04T12:00:00
+ author: npfitz
+ comment: Add active column to transform_job
+ changes:
+ - addColumn:
+ tableName: transform_job
+ columns:
+ - column:
+ name: active
+ type: ${boolean.type}
+ defaultValueBoolean: true
+ constraints:
+ nullable: false
+ remarks: Whether the job is active. Inactive jobs do not run on schedule.
+ rollback:
+ - dropColumn:
+ tableName: transform_job
+ columnName: active
diff --git a/src/metabase/transforms/core.clj b/src/metabase/transforms/core.clj
index ea2ebc0e482..7f17321db1e 100644
--- a/src/metabase/transforms/core.clj
+++ b/src/metabase/transforms/core.clj
@@ -62,6 +62,7 @@
initialize-job!
update-job!
delete-job!
+ delete-trigger!
existing-trigger]
[metabase.transforms.models.transform
update-transform-tags!]
@@ -72,6 +73,8 @@
[metabase.transforms.models.transform-run-cancelation
mark-cancel-started-run!]
[metabase.transforms.models.transform-job
+ activate-job!
+ deactivate-job!
update-job-tags!]
[metabase.transforms.models.transform-tag
tag-name-exists?
diff --git a/src/metabase/transforms/models/transform_job.clj b/src/metabase/transforms/models/transform_job.clj
index 6dcbdd8d510..10d81d3e8cd 100644
--- a/src/metabase/transforms/models/transform_job.clj
+++ b/src/metabase/transforms/models/transform_job.clj
@@ -3,10 +3,12 @@
[clojure.set :as set]
[medley.core :as m]
[metabase.api.common :as api]
+ [metabase.app-db.cluster-lock :as cluster-lock]
[metabase.models.interface :as mi]
[metabase.models.serialization :as serdes]
[metabase.transforms.models.job-run :as transforms.job-run]
[metabase.transforms.models.transform :as transform]
+ [metabase.transforms.schedule :as transforms.schedule]
[metabase.util :as u]
[metabase.util.i18n :as i18n]
[methodical.core :as methodical]
@@ -79,6 +81,37 @@
(for [job jobs]
(assoc job :last_run (get last-executions (:id job)))))))
+(defn- active-flip-lock-name
+ "Per-job cluster-lock keyword used to serialize `:active` flips of the same job across the
+ cluster. Concurrent flips of *different* jobs run in parallel."
+ [job-id]
+ (keyword "metabase.transforms.transform-job-active" (str job-id)))
+
+(defn activate-job!
+ "Activate a transform job: set `:active` to true and (re)create its Quartz trigger from the
+ job's stored schedule so cron firings begin again. Idempotent — calling on an already-active
+ job is a no-op.
+
+ Concurrent activate/deactivate of the same job is serialized by a per-job cluster lock so
+ the app-DB row and the Quartz trigger cannot diverge. The lock is held across the trigger
+ write."
+ [job-id]
+ (cluster-lock/with-cluster-lock (active-flip-lock-name job-id)
+ (when (pos? (t2/update! :model/TransformJob {:id job-id, :active false} {:active true}))
+ (transforms.schedule/initialize-job! (t2/select-one :model/TransformJob :id job-id)))))
+
+(defn deactivate-job!
+ "Deactivate a transform job: set `:active` to false and remove its Quartz trigger so cron
+ firings stop. Manual runs via the API still work. Idempotent — calling on an already-inactive
+ job is a no-op.
+
+ Concurrent activate/deactivate of the same job is serialized by a per-job cluster lock — see
+ [[activate-job!]]."
+ [job-id]
+ (cluster-lock/with-cluster-lock (active-flip-lock-name job-id)
+ (when (pos? (t2/update! :model/TransformJob {:id job-id, :active true} {:active false}))
+ (transforms.schedule/delete-trigger! job-id))))
+
(defn update-job-tags!
"Update the tags associated with a job using smart diff logic.
Only modifies what has changed: deletes removed tags, updates positions for moved tags,
@@ -184,8 +217,9 @@
(defmethod serdes/make-spec "TransformJob"
[_model-name opts]
- {:copy [:entity_id :built_in_type :schedule :ui_display_type]
+ {:copy [:entity_id :built_in_type :schedule :ui_display_type :active]
:skip []
+ :defaults {:active true}
:transform {:name {:export str :import identity}
:description {:export str :import identity}
:created_at (serdes/date)
diff --git a/src/metabase/transforms/schedule.clj b/src/metabase/transforms/schedule.clj
index 1c83f78d735..a2ff00a6eae 100644
--- a/src/metabase/transforms/schedule.clj
+++ b/src/metabase/transforms/schedule.clj
@@ -67,8 +67,9 @@
(first (task/existing-triggers (job-key job-id-or-trigger)
(trigger-key job-id-or-trigger))))
-(defn- delete-trigger!
- "Delete the trigger for a transform job."
+(defn delete-trigger!
+ "Delete the trigger for a transform job. Leaves the underlying Quartz job definition intact so it
+ can be re-scheduled later via [[initialize-job!]]."
([job-id-or-trigger]
(if (number? job-id-or-trigger)
(if-let [trigger (existing-trigger job-id-or-trigger)]
@@ -124,5 +125,5 @@
(defmethod task/init! ::RunTransform [_]
(log/info "Initializing transform job execution jobs")
- (->> (t2/select :model/TransformJob)
+ (->> (t2/select :model/TransformJob :active true)
(run! initialize-job!)))
diff --git a/src/metabase/transforms_rest/api/transform_job.clj b/src/metabase/transforms_rest/api/transform_job.clj
index 8329e05de58..fa8f6e880e0 100644
--- a/src/metabase/transforms_rest/api/transform_job.clj
+++ b/src/metabase/transforms_rest/api/transform_job.clj
@@ -43,6 +43,7 @@
[:description [:maybe [:or :string LocalizedString]]]
[:schedule :string]
[:ui_display_type [:enum :cron/raw :cron/builder]]
+ [:active :boolean]
[:entity_id [:maybe :string]]
[:created_at :any]
[:updated_at :any]
@@ -121,50 +122,86 @@
;; Return with hydrated tag_ids
(t2/hydrate job :tag_ids)))
+(api.macros/defendpoint :put "/active" :- [:map {:closed true}
+ [:updated :int]
+ [:failed :int]]
+ "Activate or deactivate every transform job. Inactive jobs do not run on schedule. Manual runs
+ via `POST /api/transform-job/:job-id/run` ignore this flag.
+
+ Reports per-job outcome counts: `:updated` (successfully flipped) and `:failed` (raised an
+ error during the flip — the row update or Quartz write failed and was logged)."
+ [_route-params
+ _query-params
+ {:keys [active]} :- [:map [:active :boolean]]]
+ (api/check-superuser)
+ (log/info "Setting active =" active "on all transform jobs")
+ (let [op (if active transforms.core/activate-job! transforms.core/deactivate-job!)
+ verb (if active "activate" "deactivate")
+ candidates (t2/select :model/TransformJob :active (not active))
+ try-op (fn [job]
+ (try
+ (op (:id job))
+ :ok
+ (catch Throwable t
+ (log/errorf t "Failed to %s transform job %d" verb (:id job))
+ :failed)))
+ outcomes (frequencies (map try-op candidates))]
+ {:updated (get outcomes :ok 0)
+ :failed (get outcomes :failed 0)}))
+
(api.macros/defendpoint :put "/:job-id" :- TransformJobResponse
"Update a transform job."
[{:keys [job-id]} :- [:map
[:job-id ms/PositiveInt]]
_query-params
{tag-ids :tag_ids
- :keys [name description schedule ui_display_type]} :- [:map
- [:name {:optional true} ms/NonBlankString]
- [:description {:optional true} [:maybe ms/NonBlankString]]
- [:schedule {:optional true} ms/NonBlankString]
- [:ui_display_type
- {:optional true}
- (ms/enum-decode-keyword ui-display-types)]
- [:tag_ids {:optional true} [:sequential ms/PositiveInt]]]]
+ :keys [name description schedule ui_display_type active]} :- [:map
+ [:name {:optional true} ms/NonBlankString]
+ [:description {:optional true} [:maybe ms/NonBlankString]]
+ [:schedule {:optional true} ms/NonBlankString]
+ [:ui_display_type
+ {:optional true}
+ (ms/enum-decode-keyword ui-display-types)]
+ [:active {:optional true} :boolean]
+ [:tag_ids {:optional true} [:sequential ms/PositiveInt]]]]
(log/info "Updating transform job" job-id)
(let [existing-job (t2/hydrate (t2/select-one :model/TransformJob :id job-id) :tag_ids)]
;; Check write permission on both current state and final state (with new tags if provided)
(api/write-check existing-job)
(when (some? tag-ids)
- (api/write-check (assoc existing-job :tag_ids tag-ids))))
- ;; Validate cron expression if provided
- (when schedule
- (api/check-400 (transforms.core/validate-cron-expression schedule)
- (deferred-tru "Invalid cron expression: {0}" schedule)))
- ;; Validate tag IDs if provided
- (when (seq tag-ids)
- (let [existing-tags (set (t2/select-pks-vec :model/TransformTag :id [:in tag-ids]))]
- (api/check-400 (= (set tag-ids) existing-tags)
- (deferred-tru "Some tag IDs do not exist"))))
- (t2/with-transaction [_conn]
- (when-let [updates (m/assoc-some nil
- :name name
- :description description
- :schedule schedule
- :ui_display_type ui_display_type)]
- (t2/update! :model/TransformJob job-id updates))
+ (api/write-check (assoc existing-job :tag_ids tag-ids)))
+ ;; Validate cron expression if provided
(when schedule
- (transforms.core/update-job! job-id schedule))
- ;; Update tag associations if provided
- (when (some? tag-ids)
- (transforms.core/update-job-tags! job-id tag-ids))
- ;; Return updated job with hydration
- (-> (t2/select-one :model/TransformJob :id job-id)
- (t2/hydrate :tag_ids :last_run))))
+ (api/check-400 (transforms.core/validate-cron-expression schedule)
+ (deferred-tru "Invalid cron expression: {0}" schedule)))
+ ;; Validate tag IDs if provided
+ (when (seq tag-ids)
+ (let [existing-tags (set (t2/select-pks-vec :model/TransformTag :id [:in tag-ids]))]
+ (api/check-400 (= (set tag-ids) existing-tags)
+ (deferred-tru "Some tag IDs do not exist"))))
+ (let [was-active (:active existing-job)
+ will-be-active (if (some? active) active was-active)]
+ ;; DB writes that can fail commit before any Quartz side effect, so a tag FK race or
+ ;; non-toggle-update failure can't roll back state already written to the scheduler.
+ (t2/with-transaction [_conn]
+ (when-let [updates (m/assoc-some nil
+ :name name
+ :description description
+ :schedule schedule
+ :ui_display_type ui_display_type)]
+ (t2/update! :model/TransformJob job-id updates))
+ (when (some? tag-ids)
+ (transforms.core/update-job-tags! job-id tag-ids)))
+ (when (some? active)
+ (if active
+ (transforms.core/activate-job! job-id)
+ (transforms.core/deactivate-job! job-id)))
+ ;; A schedule edit on a job that stays active needs a separate trigger rebuild;
+ ;; activate-job! only runs when :active toggled false→true.
+ (when (and schedule was-active will-be-active)
+ (transforms.core/update-job! job-id schedule))
+ (-> (t2/select-one :model/TransformJob :id job-id)
+ (t2/hydrate :tag_ids :last_run)))))
(api.macros/defendpoint :delete "/:job-id" :- nil
"Delete a transform job."
diff --git a/test/metabase/transforms_rest/api/transform_job_test.clj b/test/metabase/transforms_rest/api/transform_job_test.clj
index c0e19d64638..b085f3cffc7 100644
--- a/test/metabase/transforms_rest/api/transform_job_test.clj
+++ b/test/metabase/transforms_rest/api/transform_job_test.clj
@@ -59,6 +59,7 @@
(is (= (:id job) (:id response)))
(is (= "Test Job" (:name response)))
(is (= [(:id tag)] (:tag_ids response)))
+ (is (true? (:active response)))
(is (nil? (:last_run response)))))
(testing "Returns 404 for non-existent job"
@@ -173,6 +174,120 @@
(is (string? response))
(is (re-find #"Invalid cron expression" response))))))))))
+(deftest update-job-active-test
+ (testing "PUT /api/transform-job/:id can toggle the active flag"
+ (mt/with-data-analyst-role! (mt/user->id :lucky)
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/with-temp [:model/TransformJob job {:name "Toggle Me" :schedule "0 0 0 * * ?"}]
+ (testing "Defaults to true"
+ (is (true? (:active (mt/user-http-request :lucky :get 200 (str "transform-job/" (:id job)))))))
+ (testing "Can be set to false"
+ (let [response (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:active false})]
+ (is (false? (:active response))))
+ (is (false? (:active (mt/user-http-request :lucky :get 200 (str "transform-job/" (:id job))))))
+ (is (false? (t2/select-one-fn :active :model/TransformJob :id (:id job)))))
+ (testing "Can be set back to true"
+ (let [response (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:active true})]
+ (is (true? (:active response))))
+ (is (true? (:active (mt/user-http-request :lucky :get 200 (str "transform-job/" (:id job))))))
+ (is (true? (t2/select-one-fn :active :model/TransformJob :id (:id job))))))))))
+
+(deftest update-all-jobs-active-test
+ (testing "PUT /api/transform-job/active flips every job's active flag"
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/with-temp [:model/TransformJob job-1 {:name "Job 1" :schedule "0 0 0 * * ?"}
+ :model/TransformJob job-2 {:name "Job 2" :schedule "0 0 0 * * ?" :active false}
+ :model/TransformJob job-3 {:name "Job 3" :schedule "0 0 0 * * ?"}]
+ (let [job-ids [(:id job-1) (:id job-2) (:id job-3)]
+ active-by-id (fn [] (t2/select-fn->fn :id :active :model/TransformJob :id [:in job-ids]))]
+ (testing "Deactivates all jobs"
+ (let [pending (t2/count :model/TransformJob :active true)]
+ (is (=? {:updated pending :failed zero?}
+ (mt/user-http-request :crowberto :put 200 "transform-job/active" {:active false}))))
+ (is (every? false? (vals (active-by-id)))))
+ (testing "Reactivates all jobs"
+ (let [pending (t2/count :model/TransformJob :active false)]
+ (is (=? {:updated pending :failed zero?}
+ (mt/user-http-request :crowberto :put 200 "transform-job/active" {:active true}))))
+ (is (every? true? (vals (active-by-id))))))))))
+
+(deftest update-all-jobs-active-counts-test
+ (testing "PUT /api/transform-job/active reports :failed for jobs whose flip raises"
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/with-temp [:model/TransformJob _ {:name "OK" :schedule "0 0 0 * * ?"}
+ :model/TransformJob job-bad {:name "Boom" :schedule "0 0 0 * * ?"}]
+ (let [orig (mt/original-fn #'transforms.schedule/delete-trigger!)]
+ (mt/with-dynamic-fn-redefs [transforms.schedule/delete-trigger!
+ (fn [job-id]
+ (if (= job-id (:id job-bad))
+ (throw (ex-info "boom" {}))
+ (orig job-id)))]
+ (is (=? {:updated #(<= 1 %)
+ :failed #(<= 1 %)}
+ (mt/user-http-request :crowberto :put 200 "transform-job/active" {:active false})))))))))
+
+(deftest update-all-jobs-active-permissions-test
+ (testing "PUT /api/transform-job/active requires superuser"
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/user-http-request :rasta :put 403 "transform-job/active" {:active false}))
+ (testing "data analysts are also rejected"
+ (mt/with-data-analyst-role! (mt/user->id :lucky)
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/user-http-request :lucky :put 403 "transform-job/active" {:active false}))))))
+
+(deftest active-trigger-lifecycle-test
+ (testing "PUT /api/transform-job/:id syncs the Quartz trigger with :active"
+ (mt/with-data-analyst-role! (mt/user->id :lucky)
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/with-temp-scheduler!
+ (mt/with-temp [:model/TransformJob job {:name "Triggered" :schedule "0 0 0 * * ?"}]
+ ;; with-temp doesn't run the API's create handler, so seed the trigger ourselves to
+ ;; mirror the post-create state.
+ (transforms.schedule/initialize-job! job)
+ (try
+ (testing "Deactivating removes the trigger"
+ (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:active false})
+ (is (nil? (transforms.schedule/existing-trigger (:id job)))))
+ (testing "Reactivating recreates the trigger from the stored schedule"
+ (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:active true})
+ (is (some? (transforms.schedule/existing-trigger (:id job)))))
+ (testing "Schedule edits on an inactive job do not resurrect the trigger"
+ (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:active false})
+ (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:schedule "0 0 1 * * ?"})
+ (is (nil? (transforms.schedule/existing-trigger (:id job))))
+ (testing "but the new schedule is persisted in the DB"
+ (is (= "0 0 1 * * ?" (t2/select-one-fn :schedule :model/TransformJob :id (:id job)))))
+ (testing "and reactivating builds a trigger using the updated schedule"
+ (mt/user-http-request :lucky :put 200 (str "transform-job/" (:id job))
+ {:active true})
+ (is (= "0 0 1 * * ?" (:schedule (transforms.schedule/existing-trigger (:id job)))))))
+ (finally
+ (transforms.schedule/delete-job! (:id job))))))))))
+
+(deftest active-bulk-trigger-lifecycle-test
+ (testing "PUT /api/transform-job/active syncs every job's Quartz trigger"
+ (mt/with-premium-features #{:transforms-basic}
+ (mt/with-temp-scheduler!
+ (mt/with-temp [:model/TransformJob job-1 {:name "Bulk 1" :schedule "0 0 0 * * ?"}
+ :model/TransformJob job-2 {:name "Bulk 2" :schedule "0 0 0 * * ?"}]
+ (let [job-ids [(:id job-1) (:id job-2)]]
+ (run! transforms.schedule/initialize-job! [job-1 job-2])
+ (try
+ (testing "Bulk deactivate clears triggers for all flipped jobs"
+ (mt/user-http-request :crowberto :put 200 "transform-job/active" {:active false})
+ (is (every? nil? (map transforms.schedule/existing-trigger job-ids))))
+ (testing "Bulk activate rebuilds triggers"
+ (mt/user-http-request :crowberto :put 200 "transform-job/active" {:active true})
+ (is (every? some? (map transforms.schedule/existing-trigger job-ids))))
+ (finally
+ (run! transforms.schedule/delete-job! job-ids)))))))))
+
(deftest update-job-remove-tags-test
(testing "PUT /api/transform-job/:id"
(mt/with-data-analyst-role! (mt/user->id :lucky)