The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Transform run cancellation (#62387)
Romeo Van Snick3038880e46a1
diff --git a/e2e/test/scenarios/admin/transforms.cy.spec.ts b/e2e/test/scenarios/admin/transforms.cy.spec.tsindex b01319a7a46..f5fa2fa47dc 100644--- a/e2e/test/scenarios/admin/transforms.cy.spec.ts+++ b/e2e/test/scenarios/admin/transforms.cy.spec.ts@@ -1194,6 +1194,96 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {});});+ describe("cancelation", () => {+ function createSlowTransform(seconds: number = 100) {+ H.createTransform(+ {+ name: "Slow transform",+ source: {+ type: "query",+ query: {+ database: WRITABLE_DB_ID,+ type: "native",+ native: {+ query: `SELECT name, cast(pg_sleep(${seconds}) as text) as slow FROM "Schema A"."Animals" LIMIT 1`,+ },+ },+ },+ target: {+ type: "table",+ name: TARGET_TABLE,+ schema: TARGET_SCHEMA,+ },+ tag_ids: [],+ },+ { visitTransform: true },+ );+ }++ it("should be possible to cancel a transform from the transform page", () => {+ createSlowTransform();+ getRunButton().click();+ getRunButton().should("have.text", "Running now…");+ getRunStatus().should("have.text", "Run in progress…");++ getCancelButton().click();+ H.modal().button("Yes").click();++ getRunButton().should("have.text", "Canceling…");+ getRunStatus().should("have.text", "Canceling…");++ // We need to pass a timeout here since canceling a transform can+ // take a while on the back end+ getRunButton({ timeout: 40_000 }).should("have.text", "Canceled");+ getRunStatus().should("contain", "Last run was canceled");+ });++ it("should be possible to cancel a transform from the runs page", () => {+ createSlowTransform();+ getRunButton().click();+ getRunButton().should("have.text", "Running now…");+ getRunStatus().should("have.text", "Run in progress…");++ getNavSidebar().findByText("Runs").click();+ getContentTable().within(() => {+ cy.findByText("In-progress").should("be.visible");+ cy.findByLabelText("Cancel run").click();+ });++ H.modal().button("Yes").click();++ getContentTable().findByText("Canceling").should("be.visible");+ getContentTable()+ .findByText("Canceled", { timeout: 30_000 })+ .should("be.visible");+ });++ it("should show a message when the run finished before it cancels", () => {+ createSlowTransform(1);+ getRunButton().click();+ getRunButton().should("have.text", "Running now…");+ getRunStatus().should("have.text", "Run in progress…");++ getCancelButton().click();+ H.modal().button("Yes").click();++ getRunButton().should("have.text", "Canceling…");+ getRunStatus().should("have.text", "Canceling…");++ // We need to pass a timeout here since canceling a transform can+ // take a while on the back end+ getRunButton({ timeout: 40_000 }).should("have.text", "Ran successfully");+ getRunStatus().should(+ "contain",+ "Last ran a few seconds ago successfully.",+ );+ getRunStatus().should(+ "contain",+ "This run succeeded before it had a chance to cancel.",+ );+ });+ });+describe("dependencies", () => {it("should render a table of dependencies", () => {createMbqlTransform({@@ -2063,8 +2153,16 @@ function getQueryEditor() {return cy.findByTestId("transform-query-editor");}-function getRunButton() {- return cy.findByTestId("run-button");+function getRunButton(options: { timeout?: number } = {}) {+ return cy.findByTestId("run-button", options);+}++function getCancelButton() {+ return cy.findByTestId("cancel-button");+}++function getRunStatus() {+ return cy.findByTestId("run-status");}function getRunListLink() {diff --git a/enterprise/backend/src/metabase_enterprise/transforms/api.clj b/enterprise/backend/src/metabase_enterprise/transforms/api.cljindex e2d8d8a4f87..e9522faf3b1 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/api.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/api.clj@@ -209,10 +209,10 @@(api.macros/defendpoint :post "/:id/cancel""Cancel the current run for a given transform."[{:keys [id]} :- [:map- [:id :string]]]+ [:id ms/PositiveInt]]](log/info "canceling transform " id)(api/check-superuser)- (let [run (api/check-404 (transform-run/running-run-for-run-id id))]+ (let [run (api/check-404 (transform-run/running-run-for-transform-id id))](transform-run-cancelation/mark-cancel-started-run! (:id run)))nil)diff --git a/enterprise/backend/src/metabase_enterprise/transforms/canceling.clj b/enterprise/backend/src/metabase_enterprise/transforms/canceling.cljindex 40fad6ab510..0c62714a8d6 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/canceling.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/canceling.clj@@ -84,15 +84,17 @@(start-job!))(defmethod task/init! ::CancelRuns [_]+ (log/info "Scheduling the cancelation background task.");; does not use the Quartz scheduler(.scheduleAtFixedRate scheduler#(try(log/trace "Checking for canceling items.")- (run! (fn [{:keys [id]}]- (try- (cancel-run! id)- (catch Throwable t- (log/error t (str "Error canceling " id)))))+ (run! (fn [cancelation]+ (let [id (:run_id cancelation)]+ (try+ (cancel-run! id)+ (catch Throwable t+ (log/error t (str "Error canceling " id))))))(wr.cancelation/reducible-canceled-local-runs))(catch Throwable t(log/error t "Error while canceling a transform run."))) 0 20 TimeUnit/SECONDS))diff --git a/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run.clj b/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run.cljindex 38d0bb09bef..d9eb4687949 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run.clj@@ -154,6 +154,12 @@:id id:is_active true))+(defn running-run-for-transform-id+ "Return a single active transform run or nil."+ [transform-id]+ (t2/select-one :model/TransformRun+ :transform_id transform-id+ :is_active true))(defn- timestamp-constraint[field-name date-string](let [{:keys [start end]}diff --git a/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run_cancelation.clj b/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run_cancelation.cljindex 76de86fa6c8..24a6ad0bc46 100644--- a/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run_cancelation.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms/models/transform_run_cancelation.clj@@ -11,17 +11,23 @@(defn mark-cancel-started-run!"Mark a started run for cancelation."- ([run-id]- (mark-cancel-started-run! run-id {}))- ([run-id properties]- (t2/insert! :model/TransformRunCancelation- (assoc properties- :run_id run-id)- {:where [:exists {:select [1]- :from [:transform_run]- :where [:and- [:= :transform_run.id run-id]- :transform_run.is_active]}]})))+ [run-id]+ (t2/query-one+ [(str "INSERT INTO transform_run_cancelation (run_id) "+ "SELECT ? "+ "WHERE "+ " EXISTS (SELECT 1 "+ " FROM transform_run "+ " WHERE (transform_run.id = ?) "+ " AND transform_run.is_active)"+ " AND NOT EXISTS (SELECT 1 "+ " FROM transform_run_cancelation "+ " WHERE run_id = ?)")+ run-id run-id run-id])+ (t2/update! :model/TransformRun+ :id run-id+ {:status "canceling"})+ nil)(defn reducible-canceled-local-runs"Return a reducible sequence of local canceled runs."diff --git a/enterprise/frontend/src/metabase-enterprise/api/transform.ts b/enterprise/frontend/src/metabase-enterprise/api/transform.tsindex 8f77a14384b..10bc1b75413 100644--- a/enterprise/frontend/src/metabase-enterprise/api/transform.ts+++ b/enterprise/frontend/src/metabase-enterprise/api/transform.ts@@ -1,7 +1,9 @@+import { isResourceNotFoundError } from "metabase/lib/errors";import type {CreateTransformRequest,ListTransformRunsRequest,ListTransformRunsResponse,+ RunTransformResponse,Transform,TransformId,UpdateTransformRequest,@@ -59,7 +61,7 @@ export const transformApi = EnterpriseApi.injectEndpoints({...(transforms?.flatMap(provideTransformTags) ?? []),]),}),- runTransform: builder.mutation<void, TransformId>({+ runTransform: builder.mutation<RunTransformResponse, TransformId>({query: (id) => ({method: "POST",url: `/api/ee/transform/${id}/run`,@@ -79,13 +81,64 @@ export const transformApi = EnterpriseApi.injectEndpoints({};}),);+try {- await queryFulfilled;+ const { data } = await queryFulfilled;++ dispatch(+ transformApi.util.updateQueryData("getTransform", id, (draft) => {+ if (draft.last_run == null) {+ return;+ }+ draft.last_run.id = data.run_id;+ }),+ );} catch {patchResult.undo();}},}),+ cancelCurrentTransformRun: builder.mutation<void, TransformId>({+ query: (id) => ({+ method: "POST",+ url: `/api/ee/transform/${id}/cancel`,+ }),+ invalidatesTags: (_, error, id) =>+ invalidateTags(error, [idTag("transform", id), tag("table")]),+ onQueryStarted: async (id, { dispatch, queryFulfilled }) => {+ const patchResult = dispatch(+ transformApi.util.updateQueryData("getTransform", id, (draft) => {+ if (draft.last_run) {+ draft.last_run.status = "canceling";+ }+ }),+ );++ try {+ await queryFulfilled;+ } catch (error) {+ if (+ typeof error === "object" &&+ error !== null &&+ "error" in error &&+ !isResourceNotFoundError(error.error)+ ) {+ // When the error is not a 404, undo the patch as something is wrong+ patchResult.undo();+ } else {+ // Avoid undoing the patch when the error is 404+ // as this will confuse the transform pages by setting the+ // status back to started even though we know the run must've+ // completed (in either succeeded, failed, timeout or canceled state).+ // We just don't know which state it is, so we leave it in canceling+ // state and trigger a re-fetch of the transform to get the latest state.+ dispatch(+ EnterpriseApi.util.invalidateTags([idTag("transform", id)]),+ );+ }+ }+ },+ }),createTransform: builder.mutation<Transform, CreateTransformRequest>({query: (body) => ({method: "POST",@@ -145,6 +198,7 @@ export const {useGetTransformQuery,useLazyGetTransformQuery,useRunTransformMutation,+ useCancelCurrentTransformRunMutation,useCreateTransformMutation,useUpdateTransformMutation,useDeleteTransformMutation,diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/analytics.ts b/enterprise/frontend/src/metabase-enterprise/transforms/analytics.tsindex 4ba3d888f61..d0a9ca94ee0 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/analytics.ts+++ b/enterprise/frontend/src/metabase-enterprise/transforms/analytics.ts@@ -1,7 +1,7 @@import { trackSimpleEvent } from "metabase/lib/analytics";import type { TransformId, TransformJobId } from "metabase-types/api";-export function trackTranformTriggerManualRun({+export function trackTransformTriggerManualRun({transformId,triggeredFrom,}: {@@ -15,7 +15,7 @@ export function trackTranformTriggerManualRun({});}-export function trackTranformJobTriggerManualRun({+export function trackTransformJobTriggerManualRun({jobId,triggeredFrom,}: {diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/JobView/ScheduleSection/ScheduleSection.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/JobView/ScheduleSection/ScheduleSection.tsxindex ad21f43e839..bd8465555ca 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/JobView/ScheduleSection/ScheduleSection.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/JobView/ScheduleSection/ScheduleSection.tsx@@ -11,7 +11,7 @@ import { timezoneToUTCOffset } from "metabase/lib/time-dayjs";import { useMetadataToasts } from "metabase/metadata/hooks";import { Box, Divider, Group, Icon, Tooltip } from "metabase/ui";import { useRunTransformJobMutation } from "metabase-enterprise/api";-import { trackTranformJobTriggerManualRun } from "metabase-enterprise/transforms/analytics";+import { trackTransformJobTriggerManualRun } from "metabase-enterprise/transforms/analytics";import { RunButton } from "../../../components/RunButton";import { SplitSection } from "../../../components/SplitSection";@@ -100,7 +100,7 @@ function RunButtonSection({ job }: RunButtonSectionProps) {return;}- trackTranformJobTriggerManualRun({+ trackTransformJobTriggerManualRun({jobId: job.id,triggeredFrom: "job-page",});diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunButton/RunButton.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunButton/RunButton.tsxindex 1b6c6ced348..1c7ef4cdcd9 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunButton/RunButton.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunButton/RunButton.tsx@@ -2,7 +2,7 @@ import { type ReactNode, type Ref, forwardRef, useState } from "react";import { useUpdateEffect } from "react-use";import { t } from "ttag";-import { Button, Icon, Loader } from "metabase/ui";+import { Button, Icon, Loader, Tooltip } from "metabase/ui";import type { TransformRun } from "metabase-types/api";const RECENT_TIMEOUT = 5000;@@ -10,11 +10,19 @@ const RECENT_TIMEOUT = 5000;type RunButtonProps = {run: TransformRun | null | undefined;isDisabled?: boolean;+ allowCancellation?: boolean;onRun: () => void;+ onCancel?: () => void;};export const RunButton = forwardRef(function RunButton(- { run, isDisabled: isExternallyDisabled = false, onRun }: RunButtonProps,+ {+ run,+ isDisabled: isExternallyDisabled = false,+ onRun,+ onCancel,+ allowCancellation = false,+ }: RunButtonProps,ref: Ref<HTMLButtonElement>,) {const [isRecent, setIsRecent] = useState(false);@@ -31,17 +39,28 @@ export const RunButton = forwardRef(function RunButton(}, [run]);return (- <Button- ref={ref}- variant="filled"- color={color}- leftSection={leftSection}- disabled={isDisabled}- data-testid="run-button"- onClick={onRun}- >- {label}- </Button>+ <Button.Group>+ <Button+ ref={ref}+ variant="filled"+ color={color}+ leftSection={leftSection}+ disabled={isDisabled}+ data-testid="run-button"+ onClick={onRun}+ >+ {label}+ </Button>+ {allowCancellation && run?.status === "started" && (+ <Tooltip label={t`Cancel`}>+ <Button+ onClick={onCancel}+ rightSection={<Icon name="close" aria-hidden />}+ data-testid="cancel-button"+ />+ </Tooltip>+ )}+ </Button.Group>);});@@ -71,6 +90,15 @@ function getRunButtonInfo({};}+ if (run?.status === "canceling") {+ return {+ label: t`Canceling…`,+ leftSection: <Loader size="sm" />,+ color: "text-secondary",+ isDisabled: true,+ };+ }+if (run == null || !isRecent || isDisabled) {return {label: t`Run now`,@@ -88,6 +116,15 @@ function getRunButtonInfo({};}+ if (run.status === "canceled") {+ return {+ label: t`Canceled`,+ color: "var(--mb-base-color-dubloon-30)",+ leftSection: <Icon name="close" color="white" aria-hidden />,+ isDisabled,+ };+ }+return {label: t`Run failed`,color: "error",diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunCancelButton/RunCancelButton.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunCancelButton/RunCancelButton.tsxnew file mode 100644index 00000000000..117a7c2bff7--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunCancelButton/RunCancelButton.tsx@@ -0,0 +1,82 @@+import { useDisclosure } from "@mantine/hooks";+import { t } from "ttag";++import { ConfirmModal } from "metabase/common/components/ConfirmModal";+import { isResourceNotFoundError } from "metabase/lib/errors";+import { useMetadataToasts } from "metabase/metadata/hooks";+import { ActionIcon, Icon, Tooltip } from "metabase/ui";+import {+ useCancelCurrentTransformRunMutation,+ useLazyGetTransformQuery,+} from "metabase-enterprise/api";+import type { Transform, TransformRunStatus } from "metabase-types/api";++export function RunCancelButton({+ status,+ transform,+}: {+ transform?: Transform;+ status: TransformRunStatus;+}) {+ const isRunning = status === "started";+ const [+ isConfirmCancelationModalOpen,+ { open: openCancelConfirmationModal, close: closeCancelConfirmationModal },+ ] = useDisclosure();+ const { sendErrorToast } = useMetadataToasts();+ const [fetchTransform, { isFetching }] = useLazyGetTransformQuery();+ const [cancelTransformRun, { isLoading: isCanceling }] =+ useCancelCurrentTransformRunMutation();++ const handleCancel = async () => {+ if (transform == null) {+ return;+ }+ const { error } = await cancelTransformRun(transform.id);+ closeCancelConfirmationModal();+ if (error && !isResourceNotFoundError(error)) {+ sendErrorToast(t`Failed to cancel transform`);+ } else {+ // fetch the transform to get the correct `last_run` info+ fetchTransform(transform.id);+ }+ return { error };+ };++ return (+ <>+ {isRunning && (+ <Tooltip label={t`Cancel`} position="bottom">+ <ActionIcon+ aria-label={t`Cancel run`}+ onClickCapture={(evt) => {+ evt.stopPropagation();+ openCancelConfirmationModal();+ }}+ disabled={isCanceling || isFetching}+ p={0}+ m={0}+ size="xs"+ >+ <Icon name="close" size={12} />+ </ActionIcon>+ </Tooltip>+ )}+ <ConfirmModal+ onClick={(evt) => {+ // Prevent click events from within the modal from bubbling up out of it.+ // This is needed because the model is rendered within the table row and the table+ // row has a click handler that navigates to the transform page.+ evt.stopPropagation();+ }}+ title={t`Cancel this run?`}+ opened={isConfirmCancelationModalOpen}+ onClose={closeCancelConfirmationModal}+ onConfirm={() => {+ handleCancel();+ }}+ closeButtonText={t`No`}+ />+ </>+ );+}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunCancelButton/index.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunCancelButton/index.tsxnew file mode 100644index 00000000000..2f41439f757--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunCancelButton/index.tsx@@ -0,0 +1 @@+export * from "./RunCancelButton";diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.module.css b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.module.cssnew file mode 100644index 00000000000..2d8f2e82f1f--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.module.css@@ -0,0 +1,5 @@+.runStatusInfo {+ flex-shrink: 0;+ flex-wrap: nowrap;+ white-space: nowrap;+}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.tsxindex 27446d6145b..e4d9206b3e7 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatusInfo/RunStatusInfo.tsx@@ -1,16 +1,21 @@import { Box, Group } from "metabase/ui";-import type { TransformRunStatus } from "metabase-types/api";+import type { Transform, TransformRunStatus } from "metabase-types/api";import { formatStatus } from "../../utils";+import { RunCancelButton } from "../RunCancelButton/RunCancelButton";import { RunErrorInfo } from "../RunErrorInfo";+import S from "./RunStatusInfo.module.css";+type RunStatusInfoProps = {+ transform?: Transform;status: TransformRunStatus;message: string | null;endTime: Date | null;};export function RunStatusInfo({+ transform,status,message,endTime,@@ -18,11 +23,12 @@ export function RunStatusInfo({const isError = status === "failed" || status === "timeout";return (- <Group gap="xs" wrap="nowrap">+ <Group gap="xs" className={S.runStatusInfo} wrap="nowrap"><Box c={isError ? "error" : undefined}>{formatStatus(status)}</Box>{isError && message != null && (<RunErrorInfo message={message} endTime={endTime} />)}+ <RunCancelButton transform={transform} status={status} /></Group>);}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/constants.ts b/enterprise/frontend/src/metabase-enterprise/transforms/constants.tsindex da844bf1c2c..bbe97338858 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/constants.ts+++ b/enterprise/frontend/src/metabase-enterprise/transforms/constants.ts@@ -2,7 +2,7 @@ import { isCypressActive } from "metabase/env";export const NAME_MAX_LENGTH = 254;-export const POLLING_INTERVAL = isCypressActive ? 100 : 3000;+export const POLLING_INTERVAL = isCypressActive ? 200 : 3000;export const FILTER_WIDGET_MIN_WIDTH = 300;export const FILTER_WIDGET_MAX_HEIGHT = 400;diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobPage/JobPage.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobPage/JobPage.tsxindex ae120ab85fd..404b826b731 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobPage/JobPage.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/JobPage/JobPage.tsx@@ -42,7 +42,7 @@ export function JobPage({ params }: JobPageProps) {});if (isPolling !== isPollingNeeded(job)) {- setIsPolling(!isPolling);+ setIsPolling(isPollingNeeded(job));}if (isLoading || error != null) {@@ -158,6 +158,8 @@ function getParsedParams({ jobId }: JobPageParams): JobPageParsedParams {};}-function isPollingNeeded(job?: TransformJob) {- return job?.last_run?.status === "started";+export function isPollingNeeded(job?: TransformJob) {+ return (+ job?.last_run?.status === "started" || job?.last_run?.status === "canceling"+ );}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunList/RunList.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunList/RunList.tsxindex affdeb47d7b..a787bad34c8 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunList/RunList.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunList/RunList.tsx@@ -102,6 +102,7 @@ function RunTable({ runs }: RunTableProps) {</td><td className={S.wrap}><RunStatusInfo+ transform={run.transform}status={run.status}message={run.message}endTime={diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsxindex c404fe460d5..f82434bc666 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/RunListPage/RunListPage.tsx@@ -1,4 +1,5 @@import type { Location } from "history";+import { useState } from "react";import { t } from "ttag";import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";@@ -8,6 +9,8 @@ import {useListTransformTagsQuery,useListTransformsQuery,} from "metabase-enterprise/api";+import { POLLING_INTERVAL } from "metabase-enterprise/transforms/constants";+import type { TransformRun } from "metabase-types/api";import type { RunListParams } from "../../types";@@ -46,20 +49,28 @@ function RunListPageBody({ params }: RunListPageBodyProps) {endTime,runMethods,} = params;++ const [isPolling, setIsPolling] = useState(false);+const {data,isLoading: isLoadingRuns,error: runsError,- } = useListTransformRunsQuery({- offset: page * PAGE_SIZE,- limit: PAGE_SIZE,- statuses,- transform_ids: transformIds,- transform_tag_ids: transformTagIds,- start_time: startTime,- end_time: endTime,- run_methods: runMethods,- });+ } = useListTransformRunsQuery(+ {+ offset: page * PAGE_SIZE,+ limit: PAGE_SIZE,+ statuses,+ transform_ids: transformIds,+ transform_tag_ids: transformTagIds,+ start_time: startTime,+ end_time: endTime,+ run_methods: runMethods,+ },+ {+ pollingInterval: POLLING_INTERVAL,+ },+ );const {data: transforms = [],isLoading: isLoadingTransforms,@@ -73,10 +84,18 @@ function RunListPageBody({ params }: RunListPageBodyProps) {const isLoading = isLoadingRuns || isLoadingTransforms || isLoadingTags;const error = runsError ?? transformsError ?? tagsError;+ if (isPolling !== isPollingNeeded(data?.data)) {+ setIsPolling(isPollingNeeded(data?.data));+ }+if (!data || isLoading || error != null) {return <LoadingAndErrorWrapper loading={isLoading} error={error} />;}+ const shouldPoll = isPollingNeeded(data.data);+ if (shouldPoll !== isPolling) {+ setIsPolling(shouldPoll);+ }return (<Stack data-testid="run-list-page"><FilterList transforms={transforms} tags={tags} params={params} />@@ -84,3 +103,7 @@ function RunListPageBody({ params }: RunListPageBodyProps) {</Stack>);}++export function isPollingNeeded(transformRuns?: TransformRun[]) {+ return transformRuns?.some((run) => run.status === "started") ?? false;+}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/RunSection/RunSection.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/RunSection/RunSection.tsxindex 1ad2fe45bfe..375d978e8ec 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/RunSection/RunSection.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/RunSection/RunSection.tsx@@ -1,14 +1,19 @@+import { useDisclosure } from "@mantine/hooks";import { Link } from "react-router";+import { usePrevious } from "react-use";import { t } from "ttag";+import { ConfirmModal } from "metabase/common/components/ConfirmModal";import { useSetting } from "metabase/common/hooks";+import { isResourceNotFoundError } from "metabase/lib/errors";import { useMetadataToasts } from "metabase/metadata/hooks";import { Anchor, Box, Divider, Group, Icon, Stack } from "metabase/ui";import {+ useCancelCurrentTransformRunMutation,useRunTransformMutation,useUpdateTransformMutation,} from "metabase-enterprise/api";-import { trackTranformTriggerManualRun } from "metabase-enterprise/transforms/analytics";+import { trackTransformTriggerManualRun } from "metabase-enterprise/transforms/analytics";import type { Transform, TransformTagId } from "metabase-types/api";import { RunButton } from "../../../components/RunButton";@@ -27,6 +32,7 @@ export function RunSection({ transform }: RunSectionProps) {<SplitSectionlabel={t`Run this transform`}description={t`This transform will be run whenever the jobs it belongs to are scheduled.`}+ data-testid="run-section"><Group p="lg" justify="space-between"><RunStatusSection transform={transform} />@@ -52,9 +58,11 @@ function RunStatusSection({ transform }: RunStatusSectionProps) {const { id, last_run } = transform;const systemTimezone = useSetting("system-timezone");+ const previousStatus = usePrevious(last_run?.status);+if (last_run == null) {return (- <Group gap="sm">+ <Group gap="sm" data-testid="run-status"><Icon c="text-secondary" name="calendar" /><Box>{t`This transform hasn’t been run before.`}</Box></Group>@@ -89,26 +97,34 @@ function RunStatusSection({ transform }: RunStatusSectionProps) {switch (status) {case "started":return (- <Group gap="sm">+ <Group gap="sm" data-testid="run-status"><Icon c="text-primary" name="sync" /><Box>{t`Run in progress…`}</Box></Group>);case "succeeded":return (- <Group gap="sm">- <Icon c="success" name="check_filled" />- <Box>- {endTimeText- ? t`Last ran ${endTimeText} successfully.`- : t`Last ran successfully.`}- </Box>- {runsInfo}- </Group>+ <Stack gap={0} data-testid="run-status">+ <Group gap="sm">+ <Icon c="success" name="check_filled" />+ <Box>+ {endTimeText+ ? t`Last ran ${endTimeText} successfully.`+ : t`Last ran successfully.`}+ </Box>+ {runsInfo}+ </Group>+ {previousStatus === "canceling" && (+ <Box+ c="text-light"+ ml="lg"+ >{t`This run succeeded before it had a chance to cancel.`}</Box>+ )}+ </Stack>);case "failed":return (- <Group gap={0}>+ <Group gap={0} data-testid="run-status"><Icon c="error" name="warning" mr="sm" /><Box mr={errorInfo ? "xs" : "sm"}>{endTimeText@@ -120,7 +136,7 @@ function RunStatusSection({ transform }: RunStatusSectionProps) {);case "timeout":return (- <Group gap={0}>+ <Group gap={0} data-testid="run-status"><Icon c="error" name="warning" mr="sm" /><Box mr={errorInfo ? "xs" : "sm"}>{endTimeText@@ -130,6 +146,25 @@ function RunStatusSection({ transform }: RunStatusSectionProps) {{errorInfo ?? runsInfo}</Group>);+ case "canceling":+ return (+ <Group gap="sm" data-testid="run-status">+ <Icon c="text-secondary" name="close" />+ <Box>{t`Canceling…`}</Box>+ </Group>+ );+ case "canceled":+ return (+ <Group gap="sm" data-testid="run-status">+ <Icon c="text-secondary" name="close" />+ <Box>+ {endTimeText+ ? t`Last run was canceled ${endTimeText}.`+ : t`Last run was canceled.`}+ </Box>+ {runsInfo}+ </Group>+ );default:return null;}@@ -141,22 +176,51 @@ type RunButtonSectionProps = {function RunButtonSection({ transform }: RunButtonSectionProps) {const [runTransform] = useRunTransformMutation();+ const [cancelTransform] = useCancelCurrentTransformRunMutation();const { sendErrorToast } = useMetadataToasts();+ const [+ isConfirmCancellationModalOpen,+ { close: closeConfirmModal, open: openConfirmModal },+ ] = useDisclosure(false);const handleRun = async () => {- trackTranformTriggerManualRun({+ trackTransformTriggerManualRun({transformId: transform.id,triggeredFrom: "transform-page",});-const { error } = await runTransform(transform.id);if (error) {sendErrorToast(t`Failed to run transform`);}- return { error };};- return <RunButton run={transform.last_run} onRun={handleRun} />;+ const handleCancel = async () => {+ const { error } = await cancelTransform(transform.id);+ if (error && !isResourceNotFoundError(error)) {+ sendErrorToast(t`Failed to cancel transform`);+ }+ };++ return (+ <>+ <RunButton+ allowCancellation+ run={transform.last_run}+ onRun={handleRun}+ onCancel={openConfirmModal}+ />+ <ConfirmModal+ title={t`Cancel this run?`}+ opened={isConfirmCancellationModalOpen}+ onClose={closeConfirmModal}+ onConfirm={() => {+ void handleCancel();+ closeConfirmModal();+ }}+ closeButtonText={t`No`}+ />+ </>+ );}type TagSectionProps = {diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsxindex 33996d95f1e..10a5c8c96cb 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/TransformPage.tsx@@ -16,7 +16,11 @@ import { ManageSection } from "./ManageSection";import { NameSection } from "./NameSection";import { RunSection } from "./RunSection";import { TargetSection } from "./TargetSection";-import { isTransformRunning, isTransformSyncing } from "./utils";+import {+ isTransformCanceling,+ isTransformRunning,+ isTransformSyncing,+} from "./utils";type TransformPageParams = {transformId: string;@@ -42,7 +46,7 @@ export function TransformPage({ params }: TransformPageProps) {});if (isPolling !== isPollingNeeded(transform)) {- setIsPolling(!isPolling);+ setIsPolling(isPollingNeeded(transform));}if (isLoading || error != null) {@@ -78,6 +82,8 @@ function getParsedParams({function isPollingNeeded(transform?: Transform) {return (transform != null &&- (isTransformRunning(transform) || isTransformSyncing(transform))+ (isTransformRunning(transform) ||+ isTransformSyncing(transform) ||+ isTransformCanceling(transform)));}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.ts b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.tsindex b2d1ad324b8..41c204d9ee6 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.ts+++ b/enterprise/frontend/src/metabase-enterprise/transforms/pages/TransformPage/utils.ts@@ -6,6 +6,11 @@ export function isTransformRunning(transform: Transform) {return lastRun?.status === "started";}+export function isTransformCanceling(transform: Transform) {+ const lastRun = transform.last_run;+ return lastRun?.status === "canceling";+}+export function isTransformSyncing(transform: Transform) {const lastRun = transform.last_run;diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/utils.ts b/enterprise/frontend/src/metabase-enterprise/transforms/utils.tsindex 21f85c38954..6f1a38d6465 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/utils.ts+++ b/enterprise/frontend/src/metabase-enterprise/transforms/utils.ts@@ -33,6 +33,10 @@ export function formatStatus(status: TransformRunStatus) {return `Failed`;case "timeout":return t`Timeout`;+ case "canceling":+ return t`Canceling`;+ case "canceled":+ return t`Canceled`;}}diff --git a/frontend/src/metabase-types/api/transform.ts b/frontend/src/metabase-types/api/transform.tsindex d2960a56eaf..09795eb0dd8 100644--- a/frontend/src/metabase-types/api/transform.ts+++ b/frontend/src/metabase-types/api/transform.ts@@ -47,7 +47,13 @@ export type TransformRun = {transform?: Transform;};-export type TransformRunStatus = "started" | "succeeded" | "failed" | "timeout";+export type TransformRunStatus =+ | "started"+ | "succeeded"+ | "failed"+ | "timeout"+ | "canceling"+ | "canceled";export type TransformRunMethod = "manual" | "cron";@@ -113,6 +119,11 @@ export type UpdateTransformTagRequest = {name?: string;};+export type RunTransformResponse = {+ run_id: TransformRunId;+ message?: string;+};+export type ListTransformJobsRequest = {last_run_start_time?: string;next_run_start_time?: string;diff --git a/frontend/src/metabase/lib/errors/messages.ts b/frontend/src/metabase/lib/errors/messages.tsindex 82f9c5a570a..e75e7a0c88f 100644--- a/frontend/src/metabase/lib/errors/messages.ts+++ b/frontend/src/metabase/lib/errors/messages.ts@@ -29,3 +29,7 @@ export function getResponseErrorMessage(error: unknown): string | undefined {return undefined;}++export function isResourceNotFoundError(error: any) {+ return error?.status === 404;+}