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
Add error info to transform job page (#63623)
Romeo Van Snicke8f125c19b9e
diff --git a/e2e/test/scenarios/admin/transforms.cy.spec.ts b/e2e/test/scenarios/admin/transforms.cy.spec.tsindex d24279f1baf..f23faf13440 100644--- a/e2e/test/scenarios/admin/transforms.cy.spec.ts+++ b/e2e/test/scenarios/admin/transforms.cy.spec.ts@@ -1345,7 +1345,7 @@ LIMIT"contain","Last ran a few seconds ago successfully.",);- getRunStatus().should(+ getRunSection().should("contain","This run succeeded before it had a chance to cancel.",);@@ -1626,6 +1626,11 @@ describe("scenarios > admin > transforms > jobs", () => {event: "transform_job_trigger_manual_run",triggered_from: "job-page",});++ getJobPage()+ .findByText("Last ran a few seconds ago successfully.")+ .should("be.visible");+getNavSidebar().findByText("Runs").click();getContentTable().within(() => {cy.findByText("MBQL transform").should("be.visible");@@ -1633,6 +1638,23 @@ describe("scenarios > admin > transforms > jobs", () => {cy.findByText("Manual").should("be.visible");});});++ it("should display the error message from a failed run", () => {+ H.createTransformTag({ name: "New tag" }).then(({ body: tag }) => {+ createSqlTransform({+ sourceQuery: "SELECT * FROM abc",+ tagIds: [tag.id],+ });+ H.createTransformJob(+ { name: "New job", tag_ids: [tag.id] },+ { visitTransformJob: true },+ );+ });+ runJobAndWaitForFailure();+ getJobPage().findByText("Last run failed a few seconds ago.");+ getRunErrorInfoButton().click();+ H.modal().should("contain.text", 'relation "abc" does not exist');+ });});describe("deletion", () => {@@ -2243,6 +2265,10 @@ function getRunStatus() {return cy.findByTestId("run-status");}+function getRunSection() {+ return cy.findByTestId("run-section");+}+function getRunListLink() {return cy.findByRole("link", { name: "See all runs" });}@@ -2359,6 +2385,11 @@ function runJobAndWaitForSuccess() {getRunButton().should("have.text", "Ran successfully");}+function runJobAndWaitForFailure() {+ getRunButton().click();+ getRunButton().should("have.text", "Run failed");+}+function createMbqlTransform({sourceTable = SOURCE_TABLE,targetTable = TARGET_TABLE,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 1ce623a5ee7..906c60bea44 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@@ -14,6 +14,7 @@ import type {} from "metabase-types/api";import { RunButton } from "../../../components/RunButton";+import { RunStatus } from "../../../components/RunStatus";import { SplitSection } from "../../../components/SplitSection";import type { TransformJobInfo } from "../types";@@ -38,7 +39,11 @@ export function ScheduleSection({<ScheduleWidget job={job} onChangeSchedule={onScheduleChange} /></Box><Divider />- <Group px="xl" py="md" justify="end">+ <Group px="xl" py="md" justify="space-between">+ <RunStatus+ run={job?.last_run ?? null}+ neverRunMessage={t`This job hasn’t been run before.`}+ /><RunButtonSection job={job} /></Group></SplitSection>diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatus/RunStatus.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatus/RunStatus.tsxnew file mode 100644index 00000000000..70cdefa20ff--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatus/RunStatus.tsx@@ -0,0 +1,113 @@+import { t } from "ttag";++import { useSetting } from "metabase/common/hooks";+import { Box, Group, Icon } from "metabase/ui";+import { parseTimestampWithTimezone } from "metabase-enterprise/transforms/utils";+import type { TransformRun } from "metabase-types/api";++import { RunErrorInfo } from "../RunErrorInfo";++type RunStatusSectionProps = {+ run: TransformRun | null;+ neverRunMessage: string;+ runInfo?: React.ReactNode;+};++export function RunStatus({+ run,+ neverRunMessage,+ runInfo = null,+}: RunStatusSectionProps) {+ const systemTimezone = useSetting("system-timezone");++ if (run == null) {+ return (+ <Group gap="sm">+ <Icon c="text-secondary" name="calendar" />+ <Box>{neverRunMessage}</Box>+ </Group>+ );+ }++ const { status, end_time, message } = run;+ const endTime =+ end_time != null+ ? parseTimestampWithTimezone(end_time, systemTimezone)+ : null;+ const endTimeText = endTime != null ? endTime.fromNow() : null;++ const errorInfo =+ message != null ? (+ <RunErrorInfo+ message={message}+ endTime={endTime ? endTime.toDate() : null}+ />+ ) : null;++ switch (status) {+ case "started":+ return (+ <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" data-testid="run-status">+ <Icon c="success" name="check_filled" />+ <Box>+ {endTimeText+ ? t`Last ran ${endTimeText} successfully.`+ : t`Last ran successfully.`}+ </Box>+ {runInfo}+ </Group>+ );+ case "failed":+ return (+ <Group gap={0} data-testid="run-status">+ <Icon c="error" name="warning" mr="sm" />+ <Box mr={errorInfo ? "xs" : "sm"}>+ {endTimeText+ ? t`Last run failed ${endTimeText}.`+ : t`Last run failed.`}+ </Box>+ {errorInfo ?? runInfo}+ </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>+ {runInfo}+ </Group>+ );+ case "timeout":+ return (+ <Group gap={0} data-testid="run-status">+ <Icon c="error" name="warning" mr="sm" />+ <Box mr={errorInfo ? "xs" : "sm"}>+ {endTimeText+ ? t`Last run timed out ${endTimeText}.`+ : t`Last run timed out.`}+ </Box>+ {errorInfo ?? runInfo}+ </Group>+ );+ default:+ return null;+ }+}diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatus/index.ts b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatus/index.tsnew file mode 100644index 00000000000..7613f73027f--- /dev/null+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/RunStatus/index.ts@@ -0,0 +1 @@+export * from "./RunStatus";diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/SplitSection/SplitSection.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/SplitSection/SplitSection.tsxindex 183729277b5..d6e5af761c8 100644--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/SplitSection/SplitSection.tsx+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/SplitSection/SplitSection.tsx@@ -1,4 +1,4 @@-import type { ReactNode } from "react";+import type { HTMLAttributes, ReactNode } from "react";import { Card, Group, Stack, Text, Title } from "metabase/ui";@@ -6,15 +6,16 @@ type SplitSectionProps = {label: string;description: string;children?: ReactNode;-};+} & HTMLAttributes<HTMLDivElement>;export function SplitSection({label,description,children,+ ...rest}: SplitSectionProps) {return (- <Group align="start" gap="5rem">+ <Group align="start" gap="5rem" {...rest}><Stack flex={3} py="md" gap="md" maw="15rem"><Title order={4}>{label}</Title><Text c="text-secondary">{description}</Text>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 375d978e8ec..2d7bad079d2 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@@ -4,10 +4,9 @@ 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 { Anchor, Box, Divider, Group, Stack } from "metabase/ui";import {useCancelCurrentTransformRunMutation,useRunTransformMutation,@@ -17,11 +16,10 @@ import { trackTransformTriggerManualRun } from "metabase-enterprise/transforms/aimport type { Transform, TransformTagId } from "metabase-types/api";import { RunButton } from "../../../components/RunButton";-import { RunErrorInfo } from "../../../components/RunErrorInfo";+import { RunStatus } from "../../../components/RunStatus";import { SplitSection } from "../../../components/SplitSection";import { TagMultiSelect } from "../../../components/TagMultiSelect";import { getRunListUrl } from "../../../urls";-import { parseTimestampWithTimezone } from "../../../utils";type RunSectionProps = {transform: Transform;@@ -56,118 +54,35 @@ type RunStatusSectionProps = {function RunStatusSection({ transform }: RunStatusSectionProps) {const { id, last_run } = transform;- const systemTimezone = useSetting("system-timezone");- const previousStatus = usePrevious(last_run?.status);+ const status = last_run?.status;+ const previousStatus = usePrevious(status);- if (last_run == null) {- return (- <Group gap="sm" data-testid="run-status">- <Icon c="text-secondary" name="calendar" />- <Box>{t`This transform hasn’t been run before.`}</Box>- </Group>- );- }-- const { status, end_time, message } = last_run;- const endTime =- end_time != null- ? parseTimestampWithTimezone(end_time, systemTimezone)- : null;- const endTimeText = endTime != null ? endTime.fromNow() : null;-- const runsInfo = (- <Anchor- key="link"- component={Link}- to={getRunListUrl({ transformIds: [id] })}- >- {t`See all runs`}- </Anchor>+ const runExtra = status === "succeeded" && previousStatus === "canceling" && (+ <Box+ c="text-light"+ ml="lg"+ >{t`This run succeeded before it had a chance to cancel.`}</Box>);- const errorInfo =- message != null ? (- <RunErrorInfo- message={message}- endTime={endTime ? endTime.toDate() : null}+ return (+ <Stack gap={0}>+ <RunStatus+ run={last_run ?? null}+ neverRunMessage={t`This transform hasn’t been run before.`}+ runInfo={+ <Anchor+ key="link"+ component={Link}+ to={getRunListUrl({ transformIds: [id] })}+ >+ {t`See all runs`}+ </Anchor>+ }/>- ) : null;-- switch (status) {- case "started":- return (- <Group gap="sm" data-testid="run-status">- <Icon c="text-primary" name="sync" />- <Box>{t`Run in progress…`}</Box>- </Group>- );- case "succeeded":- return (- <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} data-testid="run-status">- <Icon c="error" name="warning" mr="sm" />- <Box mr={errorInfo ? "xs" : "sm"}>- {endTimeText- ? t`Last run failed ${endTimeText}.`- : t`Last run failed.`}- </Box>- {errorInfo ?? runsInfo}- </Group>- );- case "timeout":- return (- <Group gap={0} data-testid="run-status">- <Icon c="error" name="warning" mr="sm" />- <Box mr={errorInfo ? "xs" : "sm"}>- {endTimeText- ? t`Last run timed out ${endTimeText}.`- : t`Last run timed out.`}- </Box>- {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;- }+ {runExtra}+ </Stack>+ );}type RunButtonSectionProps = {