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
GDGT-2339 Frontend crashes when notification payload is null (#75107)
Kamil Mielnik81cc40f6693b
diff --git a/frontend/src/metabase-types/api/notification.ts b/frontend/src/metabase-types/api/notification.tsindex 04c864e8916..43cc3526f57 100644--- a/frontend/src/metabase-types/api/notification.ts+++ b/frontend/src/metabase-types/api/notification.ts@@ -14,21 +14,24 @@ export type NotificationCardSendCondition =| "has_result";type NotificationCardPayload = {+ card_id: CardId;+ card?: Card; // hydrated on the BE+ send_once: boolean;+ send_condition: NotificationCardSendCondition;++ id?: number;+ created_at?: string;+ updated_at?: string;+};++type NotificationCardData = {payload_type: "notification/card";- payload: {- card_id: CardId;- card?: Card; // hydrated on the BE- send_once: boolean;- send_condition: NotificationCardSendCondition;-- id?: number;- created_at?: string;- updated_at?: string;- };+ // payload can be null when it's deleted from the database+ payload: NotificationCardPayload | null;payload_id?: number;};-type NotificationPayload = NotificationCardPayload; // will be populated with more variants later on+type NotificationData = NotificationCardData; // will be populated with more variants later onexport type NotificationRecipientUser = {type: "notification-recipient/user";@@ -131,14 +134,14 @@ export interface ListNotificationsRequest extends PaginationRequest {permission_group_id?: number;}-export type CreateAlertNotificationRequest = NotificationCardPayload & {+export type CreateAlertNotificationRequest = NotificationCardData & {handlers: NotificationHandler[];subscriptions: NotificationCronSubscription[];};export type CreateNotificationRequest = CreateAlertNotificationRequest; // will be populated with more variants later on-export type UpdateAlertNotificationRequest = NotificationCardPayload & {+export type UpdateAlertNotificationRequest = NotificationCardData & {id: NotificationId;active: boolean;handlers: NotificationHandler[];@@ -148,7 +151,7 @@ export type UpdateAlertNotificationRequest = NotificationCardPayload & {export type UpdateNotificationRequest = UpdateAlertNotificationRequest; // will be populated with more variants later on-export type Notification = NotificationPayload & {+export type Notification = NotificationData & {id: NotificationId;active: boolean;diff --git a/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.tsx b/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.tsxindex f573b843935..6aca4b03935 100644--- a/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.tsx+++ b/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.tsx@@ -34,10 +34,12 @@ export const NotificationCard = ({const { item } = listItem;const hasArchive = canArchive(listItem.item, user);- const entityLink = Urls.card({- id: item.payload.card_id,- card_id: item.payload.card_id,- });+ const entityLink = item.payload+ ? Urls.card({+ id: item.payload.card_id,+ card_id: item.payload.card_id,+ })+ : undefined;const enabledChannelsMap = getNotificationEnabledChannelsMap(item);@@ -61,9 +63,13 @@ export const NotificationCard = ({bg="background-primary"><Box flex="1 1 auto">- <Link variant="brandBold" to={entityLink}>- {formatTitle(listItem)}- </Link>+ {entityLink ? (+ <Link variant="brandBold" to={entityLink}>+ {formatTitle(listItem)}+ </Link>+ ) : (+ formatTitle(listItem)+ )}<Flex wrap="wrap" mt="xs"><Textcomponent="span"diff --git a/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.unit.spec.tsx b/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.unit.spec.tsxindex 8588a701367..534414a7dcc 100644--- a/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.unit.spec.tsx+++ b/frontend/src/metabase/account/notifications/components/NotificationCard/NotificationCard.unit.spec.tsx@@ -276,4 +276,21 @@ describe("NotificationCard", () => {expect(onUnsubscribe).not.toHaveBeenCalled();expect(onArchive).toHaveBeenCalledWith(alert);});++ it("should not crash when the payload is null (metabase#73073)", () => {+ const alert = getQuestionAlertItem({ payload: null });+ const user = createMockUser();++ renderWithTheme(+ <NotificationCard+ isEditable+ listItem={alert}+ user={user}+ onArchive={jest.fn()}+ onUnsubscribe={jest.fn()}+ />,+ );++ expect(screen.getByTestId("notification-alert-item")).toBeInTheDocument();+ });});diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/DetailsSection.tsx b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/DetailsSection.tsxindex fe03cce94ad..27a20d00bee 100644--- a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/DetailsSection.tsx+++ b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/DetailsSection.tsx@@ -17,8 +17,8 @@ export const DetailsSection = ({slackChannelCount,httpHandler,}: DetailsSectionProps) => {- const cardId = notification.payload.card_id;- const cardName = notification.payload.card?.name;+ const cardId = notification.payload?.card_id;+ const cardName = notification.payload?.card?.name;const channelSummary = formatChannelSummary({emailRecipientCount,slackChannelCount,diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsxindex 7fd2f06cd0d..233fc46226e 100644--- a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx+++ b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx@@ -42,9 +42,9 @@ export const NotificationDetailSidebar = ({const dispatch = useDispatch();const metadata = useSelector(getMetadata);- const cardId = notification?.payload.card_id;+ const cardId = notification?.payload?.card_id;const { currentData: card, isFetching: isCardLoading } = useGetCardQuery(- cardId !== undefined ? { id: cardId } : skipToken,+ cardId != null ? { id: cardId } : skipToken,);useEffect(() => {diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarBody.tsx b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarBody.tsxindex 5542c2b40e3..cb652d4bd63 100644--- a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarBody.tsx+++ b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarBody.tsx@@ -41,7 +41,7 @@ export const SidebarBody = ({const emailRecipientCount = emailHandler?.recipients.length ?? 0;const slackChannelCount = slackHandler?.recipients.length ?? 0;- const cardId = notification.payload.card_id;+ const cardId = notification.payload?.card_id;return (<Stack gap="xl">diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsxindex 04eabb8bea4..727940df026 100644--- a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx+++ b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/SidebarHeader.tsx@@ -37,7 +37,7 @@ export const SidebarHeader = ({onDelete,onEdit,}: SidebarHeaderProps) => {- const cardName = notification?.payload.card?.name ?? t`Untitled question`;+ const cardName = notification?.payload?.card?.name ?? t`Untitled question`;const dispatch = useDispatch();const handleCopyLink = async () => {diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/types.ts b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/types.tsindex 5a476433393..43bcc63a374 100644--- a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/types.ts+++ b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/types.ts@@ -49,7 +49,7 @@ export type NotificationRunSummaryLogProps = {title: string;runs: (NotificationRunSummary | NotificationTickSendEntry)[] | undefined;isLoading: boolean;- cardId: CardId;+ cardId?: CardId;onViewAllClick: () => void;};diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationsTable/NotificationsTable.tsx b/frontend/src/metabase/admin/tools/notifications/NotificationsTable/NotificationsTable.tsxindex f57358de4f2..d4b5bff479c 100644--- a/frontend/src/metabase/admin/tools/notifications/NotificationsTable/NotificationsTable.tsx+++ b/frontend/src/metabase/admin/tools/notifications/NotificationsTable/NotificationsTable.tsx@@ -131,8 +131,8 @@ export const NotificationsTable = ({accessorFn: (notification) => notification.payload?.card?.name ?? "",cell: ({ row }) => {const card = row.original.payload?.card;- const cardId = row.original.payload.card_id;- const name = card?.name ?? `#${cardId}`;+ const cardId = row.original.payload?.card_id;+ const name = card?.name ?? (cardId ? `#${cardId}` : t`Unknown`);return <Ellipsified tooltip={name}>{name}</Ellipsified>;},},diff --git a/frontend/src/metabase/admin/tools/notifications/analytics.ts b/frontend/src/metabase/admin/tools/notifications/analytics.tsindex 68a0a8e540f..190d99032a9 100644--- a/frontend/src/metabase/admin/tools/notifications/analytics.ts+++ b/frontend/src/metabase/admin/tools/notifications/analytics.ts@@ -1,5 +1,5 @@import { trackSimpleEvent } from "metabase/analytics";-import type { NotificationId } from "metabase-types/api";+import type { CardId, NotificationId } from "metabase-types/api";import type { NotificationsTab } from "./NotificationsAdminPage/types";@@ -72,7 +72,7 @@ export const trackAlertsManagementOwnerChanged = (};export const trackAlertsManagementRunHistoryViewAllClicked = (- cardId: number,+ cardId: CardId | undefined,runType: "check" | "send",) => {trackSimpleEvent({diff --git a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsxindex 92a2f1b723b..6114ec18961 100644--- a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx+++ b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx@@ -45,6 +45,7 @@ import {rem,} from "metabase/ui";import { getResponseErrorMessage } from "metabase/utils/errors";+import { checkNotNull } from "metabase/utils/types";import type Question from "metabase-lib/v1/Question";import type {AdminNotification,@@ -116,7 +117,7 @@ type CreateOrEditQuestionAlertModalWithQuestionProps = {type CreateOrEditQuestionAlertModalProps =CreateOrEditQuestionAlertModalWithQuestionProps & {- question?: Question;+ question: Question;};export const CreateOrEditQuestionAlertModalWithQuestion = ({@@ -126,7 +127,7 @@ export const CreateOrEditQuestionAlertModalWithQuestion = ({onClose,skipUrlUpdate,}: CreateOrEditQuestionAlertModalWithQuestionProps) => {- const question = useSelector(getQuestion);+ const question = checkNotNull(useSelector(getQuestion));if (editingNotification) {return (@@ -168,7 +169,7 @@ export const CreateOrEditQuestionAlertModal = ({CreateAlertNotificationRequest | UpdateAlertNotificationRequest | null>(null);- const questionId = question?.id();+ const questionId = question.id();const isEditMode = !!editingNotification;const subscription = notification?.subscriptions[0];@@ -374,17 +375,19 @@ export const CreateOrEditQuestionAlertModal = ({<Selectdata-testid="alert-goal-select"data={triggerOptions}- value={notification.payload.send_condition}+ value={notification.payload?.send_condition}w={276}- onChange={(value) =>+ onChange={(value) => {setNotification({...notification,payload: {...notification.payload,- send_condition: value as NotificationCardSendCondition,+ card_id: notification.payload?.card_id ?? questionId,+ send_condition: value,+ send_once: false,},- })- }+ });+ }}/>)}</Flex>@@ -443,16 +446,20 @@ export const CreateOrEditQuestionAlertModal = ({}}labelPosition="right"size="sm"- checked={notification.payload.send_once}- onChange={(e) =>+ checked={notification.payload?.send_once}+ onChange={(event) => {setNotification({...notification,payload: {...notification.payload,- send_once: e.target.checked,+ card_id: notification.payload?.card_id ?? questionId,+ send_condition:+ notification.payload?.send_condition ??+ triggerOptions[0].value,+ send_once: event.target.checked,},- })- }+ });+ }}/></AlertModalSettingsBlock></Stack>diff --git a/frontend/src/metabase/notifications/modals/QuestionAlertListModal/AlertListItem.tsx b/frontend/src/metabase/notifications/modals/QuestionAlertListModal/AlertListItem.tsxindex f7c92cbcdf0..2f73f333f04 100644--- a/frontend/src/metabase/notifications/modals/QuestionAlertListModal/AlertListItem.tsx+++ b/frontend/src/metabase/notifications/modals/QuestionAlertListModal/AlertListItem.tsx@@ -78,7 +78,7 @@ export const AlertListItem = ({onClick={handleEdit}><Text className={S.itemTitle} size="md" lineClamp={1} fw="bold">- {formatTitle(alert.payload.send_condition)}+ {formatTitle(alert.payload?.send_condition)}</Text><Group gap="xs" align="center" c="text-secondary">{subscription && (@@ -143,7 +143,7 @@ export const AlertListItem = ({);};-const formatTitle = (sendCondition: NotificationCardSendCondition): string => {+const formatTitle = (sendCondition?: NotificationCardSendCondition): string => {switch (sendCondition) {case "has_result":return t`Alert when this has results`;@@ -151,6 +151,8 @@ const formatTitle = (sendCondition: NotificationCardSendCondition): string => {return t`Alert when this reaches a goal`;case "goal_below":return t`Alert when this goes below a goal`;+ default:+ return t`Unknown alert`;}};diff --git a/frontend/src/metabase/notifications/utils.ts b/frontend/src/metabase/notifications/utils.tsindex f5d0997cc37..65354f5cf2e 100644--- a/frontend/src/metabase/notifications/utils.ts+++ b/frontend/src/metabase/notifications/utils.ts@@ -149,7 +149,7 @@ export const formatTitle = ({ item, type }: NotificationListItem) => {case "pulse":return item.name;case "question-notification":- return item.payload.card?.name || t`Alert`;+ return item.payload?.card?.name || t`Alert`;}};diff --git a/frontend/src/metabase/urls/admin.ts b/frontend/src/metabase/urls/admin.tsindex 9be2668cbd4..0af27fc9a17 100644--- a/frontend/src/metabase/urls/admin.ts+++ b/frontend/src/metabase/urls/admin.ts@@ -193,15 +193,17 @@ export function adminToolsTaskRunDetails(runId: number) {export function adminToolsTasksRunsFor(opts: {runType: TaskRunType;entityType: TaskRunEntityType;- entityId: number;+ entityId?: number;startedAt?: TaskRunDateFilterOption;includeToday?: boolean;}) {const params: Record<string, string> = {"run-type": opts.runType,"entity-type": opts.entityType,- "entity-id": String(opts.entityId),};+ if (opts.entityId) {+ params["entity-id"] = String(opts.entityId);+ }if (opts.startedAt) {params["started-at"] = opts.startedAt;}