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
fix: cancelling remote sync tasks dismisses modal (#67613)
Edward Pagetaa5c870dc457
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.tsxindex 007c6e0681e..58e56760047 100644--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.tsx+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.tsx@@ -1,5 +1,6 @@import { t } from "ttag";+import { ActionButton } from "metabase/common/components/ActionButton";import { useToast } from "metabase/common/hooks";import { useSelector } from "metabase/lib/redux";import { getUserIsAdmin } from "metabase/selectors/user";@@ -24,34 +25,33 @@ export function SyncProgressModal({}: SyncProgressModalProps) {const canCancel = useSelector(getUserIsAdmin);- const [cancelRemoteSyncCurrentTask, { isLoading: isCancelling }] =+ const [cancelRemoteSyncCurrentTask] =useCancelRemoteSyncCurrentTaskMutation();const [sendToast] = useToast();const onCancel = async () => {- if (!canCancel) {- return;- }+ try {+ await cancelRemoteSyncCurrentTask().unwrap();+ onDismiss();+ } catch (error: any) {+ let message = t`Failed to cancel sync`;- await cancelRemoteSyncCurrentTask()- .unwrap()- .catch((error: any) => {- let message = t`Failed to cancel sync`;+ if (typeof error?.data === "string") {+ message += `: ${error.data}`;+ }- if (typeof error?.data === "string") {- message += `: ${error.data}`;- }+ sendToast({+ message,+ icon: "warning",+ toastColor: "error",+ });- sendToast({- message,- icon: "warning",- toastColor: "error",- });+ if (message.match(/no active task/i)) {+ onDismiss();+ }- if (message.match(/no active task/i)) {- onDismiss();- }- });+ throw error;+ }};if (isError) {@@ -61,14 +61,18 @@ export function SyncProgressModal({<Text>{t`An error occurred during sync.`}</Text>{errorMessage && <Text>{errorMessage}</Text>}<Group justify="flex-end">- <Button onClick={onDismiss} variant="filled">{t`Close`}</Button>+ <Button+ data-testid="sync-error-close-button"+ onClick={onDismiss}+ variant="filled"+ >{t`Close`}</Button></Group></Stack></Modal>);}- const { title, progressLabel } = getModalContent(taskType, isCancelling);+ const { title, progressLabel } = getModalContent(taskType);return (<Modal@@ -84,9 +88,14 @@ export function SyncProgressModal({<Text size="sm">{t`Please wait until this finishes before editing content.`}</Text>- {!isCancelling && canCancel && (+ {canCancel && (<Group justify="flex-end">- <Button onClick={onCancel}>{t`Cancel`}</Button>+ <ActionButton+ actionFn={onCancel}+ normalText={t`Cancel`}+ activeText={t`Cancelling…`}+ failedText={t`Cancel`}+ /></Group>)}</Stack>@@ -96,15 +105,7 @@ export function SyncProgressModal({const getModalContent = (taskType: RemoteSyncTaskType,- isCancelling?: boolean,): { title: string; progressLabel: string } => {- if (isCancelling) {- return {- title: t`Cancelling`,- progressLabel: "",- };- }-if (taskType === "import") {return {title: t`Pulling from Git`,diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.unit.spec.tsxnew file mode 100644index 00000000000..ac80db21522--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncProgressModal.unit.spec.tsx@@ -0,0 +1,203 @@+import userEvent from "@testing-library/user-event";++import {+ findRequests,+ setupRemoteSyncCancelTaskEndpoint,+} from "__support__/server-mocks";+import { renderWithProviders, screen, waitFor } from "__support__/ui";+import { createMockUser } from "metabase-types/api/mocks";+import { createMockState } from "metabase-types/store/mocks";++import { SyncProgressModal } from "./SyncProgressModal";++const setup = ({+ taskType = "import" as const,+ progress = 0.5,+ isError = false,+ errorMessage = "",+ isAdmin = true,+ onDismiss = jest.fn(),+ cancelResponse,+}: {+ taskType?: "import" | "export";+ progress?: number;+ isError?: boolean;+ errorMessage?: string;+ isAdmin?: boolean;+ onDismiss?: jest.Mock;+ cancelResponse?: { status?: number; body?: any; delay?: number };+} = {}) => {+ if (cancelResponse) {+ setupRemoteSyncCancelTaskEndpoint(cancelResponse);+ }++ return {+ onDismiss,+ ...renderWithProviders(+ <SyncProgressModal+ taskType={taskType}+ progress={progress}+ isError={isError}+ errorMessage={errorMessage}+ onDismiss={onDismiss}+ />,+ {+ storeInitialState: createMockState({+ currentUser: createMockUser({ is_superuser: isAdmin }),+ }),+ },+ ),+ };+};++describe("SyncProgressModal", () => {+ beforeEach(() => {+ jest.clearAllMocks();+ });++ describe("progress state", () => {+ it("should show import progress modal for import task", () => {+ setup({ taskType: "import" });++ expect(screen.getByText("Pulling from Git")).toBeInTheDocument();+ expect(screen.getByText("Importing content…")).toBeInTheDocument();+ });++ it("should show export progress modal for export task", () => {+ setup({ taskType: "export" });++ expect(screen.getByText("Pushing to Git")).toBeInTheDocument();+ expect(screen.getByText("Exporting content…")).toBeInTheDocument();+ });++ it("should show progress bar with correct value", () => {+ setup({ progress: 0.75 });++ const progressBar = screen.getByRole("progressbar");+ expect(progressBar).toHaveAttribute("aria-valuenow", "75");+ });++ it("should show cancel button when user is admin", () => {+ setup({ isAdmin: true, cancelResponse: { status: 200 } });++ expect(+ screen.getByRole("button", { name: "Cancel" }),+ ).toBeInTheDocument();+ });++ it("should not show cancel button when user is not admin", () => {+ setup({ isAdmin: false });++ expect(+ screen.queryByRole("button", { name: "Cancel" }),+ ).not.toBeInTheDocument();+ });+ });++ describe("error state", () => {+ it("should show error modal with message", () => {+ setup({ isError: true, errorMessage: "Connection timeout" });++ expect(screen.getByText("Sync failed")).toBeInTheDocument();+ expect(+ screen.getByText("An error occurred during sync."),+ ).toBeInTheDocument();+ expect(screen.getByText("Connection timeout")).toBeInTheDocument();+ });++ it("should show close button in error state", () => {+ setup({ isError: true });++ expect(screen.getByText("Close")).toBeInTheDocument();+ });++ it("should call onDismiss when close button is clicked in error state", async () => {+ const onDismiss = jest.fn();+ setup({ isError: true, onDismiss });++ await userEvent.click(screen.getByTestId("sync-error-close-button"));++ expect(onDismiss).toHaveBeenCalled();+ });+ });++ describe("cancel functionality", () => {+ it("should call onDismiss when cancel succeeds", async () => {+ const onDismiss = jest.fn();+ setup({ isAdmin: true, onDismiss, cancelResponse: { status: 200 } });++ await userEvent.click(screen.getByRole("button", { name: "Cancel" }));++ await waitFor(async () => {+ const requests = await findRequests("POST");+ expect(+ requests.some((r) =>+ r.url.includes("/api/ee/remote-sync/current-task/cancel"),+ ),+ ).toBe(true);+ });++ await waitFor(() => {+ expect(onDismiss).toHaveBeenCalled();+ });+ });++ it("should show error toast when cancel fails", async () => {+ const onDismiss = jest.fn();+ setup({+ isAdmin: true,+ onDismiss,+ cancelResponse: { status: 500, body: "Server error" },+ });++ await userEvent.click(screen.getByRole("button", { name: "Cancel" }));++ await waitFor(async () => {+ const requests = await findRequests("POST");+ expect(+ requests.some((r) =>+ r.url.includes("/api/ee/remote-sync/current-task/cancel"),+ ),+ ).toBe(true);+ });++ // onDismiss should NOT be called on error (unless it's "no active task")+ expect(onDismiss).not.toHaveBeenCalled();+ });++ it("should call onDismiss when cancel fails with 'no active task' message", async () => {+ const onDismiss = jest.fn();+ setup({+ isAdmin: true,+ onDismiss,+ cancelResponse: { status: 400, body: "No active task to cancel" },+ });++ await userEvent.click(screen.getByRole("button", { name: "Cancel" }));++ await waitFor(async () => {+ const requests = await findRequests("POST");+ expect(+ requests.some((r) =>+ r.url.includes("/api/ee/remote-sync/current-task/cancel"),+ ),+ ).toBe(true);+ });++ await waitFor(() => {+ expect(onDismiss).toHaveBeenCalled();+ });+ });++ it("should disable cancel button while cancel is in progress", async () => {+ setup({+ isAdmin: true,+ cancelResponse: { status: 200, delay: 100 },+ });++ await userEvent.click(screen.getByRole("button", { name: "Cancel" }));++ expect(await screen.findByText("Cancelling…")).toBeInTheDocument();+ });+ });+});diff --git a/frontend/test/__support__/server-mocks/remote-sync.ts b/frontend/test/__support__/server-mocks/remote-sync.tsindex 78d7666a697..26df1f1cc55 100644--- a/frontend/test/__support__/server-mocks/remote-sync.ts+++ b/frontend/test/__support__/server-mocks/remote-sync.ts@@ -85,6 +85,29 @@ export const setupRemoteSyncImportEndpoint = ({);};+/**+ * Setup the remote-sync cancel task endpoint+ */+export const setupRemoteSyncCancelTaskEndpoint = ({+ status = 200,+ body = {},+ delay = 0,+}: { status?: number; body?: any; delay?: number } = {}) => {+ fetchMock.removeRoute("remote-sync-cancel-task");+ if (status === 200) {+ fetchMock.post("path:/api/ee/remote-sync/current-task/cancel", body, {+ name: "remote-sync-cancel-task",+ delay,+ });+ } else {+ fetchMock.post(+ "path:/api/ee/remote-sync/current-task/cancel",+ { status, body },+ { name: "remote-sync-cancel-task", delay },+ );+ }+};+/*** Setup all remote-sync endpoints at once*/