Skip to content

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

Fix notifications violations (#75075)

Frasera5f3bdb2e2d5
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 203c8f0727f..3ee69ad6c26 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -98,6 +98,7 @@ const elements = [
createElement({ type: "shared", name: "metrics-viewer" }),
createElement({ type: "feature", name: "models" }),
createElement({ type: "shared", name: "new" }),
+ createElement({ type: "shared", name: "notifications" }),
createElement({ type: "shared", name: "palette" }),
createElement({ type: "shared", name: "parameters" }),
createElement({ type: "shared", name: "pulse" }),
diff --git a/frontend/src/metabase/admin/tools/notifications/ChangeOwnerModal/ChangeOwnerModal.tsx b/frontend/src/metabase/admin/tools/notifications/ChangeOwnerModal/ChangeOwnerModal.tsx
index 461bbbc1ed2..6d0b5833746 100644
--- a/frontend/src/metabase/admin/tools/notifications/ChangeOwnerModal/ChangeOwnerModal.tsx
+++ b/frontend/src/metabase/admin/tools/notifications/ChangeOwnerModal/ChangeOwnerModal.tsx
@@ -1,11 +1,13 @@
import { useState } from "react";
import { t } from "ttag";
+import {
+ type UserOption,
+ UserPicker,
+} from "metabase/common/components/UserPicker";
import { Button, Flex, Modal } from "metabase/ui";
import type { AdminNotification, UserId } from "metabase-types/api";
-import { type UserOption, UserPicker } from "../UserPicker";
-
type Props = {
opened: boolean;
notifications: AdminNotification[];
diff --git a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
index 233fc46226e..c30960e63fb 100644
--- a/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
+++ b/frontend/src/metabase/admin/tools/notifications/NotificationDetailSidebar/NotificationDetailSidebar.tsx
@@ -108,7 +108,6 @@ export const NotificationDetailSidebar = ({
<CreateOrEditQuestionAlertModal
editingNotification={notification}
question={question}
- skipUrlUpdate
onAlertUpdated={() => setIsEditModalOpen(false)}
onClose={() => setIsEditModalOpen(false)}
/>
diff --git a/frontend/src/metabase/admin/tools/notifications/UserPicker/UserPicker.tsx b/frontend/src/metabase/common/components/UserPicker/UserPicker.tsx
similarity index 100%
rename from frontend/src/metabase/admin/tools/notifications/UserPicker/UserPicker.tsx
rename to frontend/src/metabase/common/components/UserPicker/UserPicker.tsx
diff --git a/frontend/src/metabase/admin/tools/notifications/UserPicker/UserPicker.unit.spec.tsx b/frontend/src/metabase/common/components/UserPicker/UserPicker.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/admin/tools/notifications/UserPicker/UserPicker.unit.spec.tsx
rename to frontend/src/metabase/common/components/UserPicker/UserPicker.unit.spec.tsx
diff --git a/frontend/src/metabase/admin/tools/notifications/UserPicker/index.ts b/frontend/src/metabase/common/components/UserPicker/index.ts
similarity index 100%
rename from frontend/src/metabase/admin/tools/notifications/UserPicker/index.ts
rename to frontend/src/metabase/common/components/UserPicker/index.ts
diff --git a/frontend/src/metabase/admin/tools/notifications/UserPicker/types.ts b/frontend/src/metabase/common/components/UserPicker/types.ts
similarity index 100%
rename from frontend/src/metabase/admin/tools/notifications/UserPicker/types.ts
rename to frontend/src/metabase/common/components/UserPicker/types.ts
diff --git a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx
index 6114ec18961..edbdd644817 100644
--- a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx
+++ b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.tsx
@@ -21,11 +21,6 @@ import {
getHasConfiguredAnyChannel,
getHasConfiguredEmailOrSlackChannel,
} from "metabase/pulse";
-import { updateUrl } from "metabase/query_builder/actions/url";
-import {
- getQuestion,
- getVisualizationSettings,
-} from "metabase/query_builder/selectors";
import { useDispatch, useSelector } from "metabase/redux";
import { addUndo } from "metabase/redux/undo";
import {
@@ -45,7 +40,6 @@ 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,
@@ -57,6 +51,7 @@ import type {
ScheduleType,
UpdateAlertNotificationRequest,
UserId,
+ VisualizationSettings,
} from "metabase-types/api";
import { ChannelSetupModal } from "../ChannelSetupModal";
@@ -99,9 +94,16 @@ const ALERT_SCHEDULE_OPTIONS: ScheduleType[] = [
"cron",
];
-type CreateOrEditQuestionAlertModalWithQuestionProps = {
+type CreateOrEditQuestionAlertModalProps = {
onClose: () => void;
- skipUrlUpdate?: boolean;
+ question: Question;
+ /**
+ * The question's effective visualization settings, when the host has them
+ * (e.g. the query builder, where they may include unsaved changes). When
+ * omitted, goal-based trigger detection falls back to the question's saved
+ * settings (see getAlertType).
+ */
+ visualizationSettings?: VisualizationSettings;
} & (
| {
editingNotification?: undefined;
@@ -115,52 +117,15 @@ type CreateOrEditQuestionAlertModalWithQuestionProps = {
}
);
-type CreateOrEditQuestionAlertModalProps =
- CreateOrEditQuestionAlertModalWithQuestionProps & {
- question: Question;
- };
-
-export const CreateOrEditQuestionAlertModalWithQuestion = ({
- editingNotification,
- onAlertCreated,
- onAlertUpdated,
- onClose,
- skipUrlUpdate,
-}: CreateOrEditQuestionAlertModalWithQuestionProps) => {
- const question = checkNotNull(useSelector(getQuestion));
-
- if (editingNotification) {
- return (
- <CreateOrEditQuestionAlertModal
- question={question}
- editingNotification={editingNotification}
- onAlertUpdated={onAlertUpdated}
- onClose={onClose}
- skipUrlUpdate={skipUrlUpdate}
- />
- );
- } else {
- return (
- <CreateOrEditQuestionAlertModal
- question={question}
- onAlertCreated={onAlertCreated}
- onClose={onClose}
- skipUrlUpdate={skipUrlUpdate}
- />
- );
- }
-};
-
export const CreateOrEditQuestionAlertModal = ({
editingNotification,
onAlertCreated,
onAlertUpdated,
onClose,
question,
- skipUrlUpdate,
+ visualizationSettings,
}: CreateOrEditQuestionAlertModalProps) => {
const dispatch = useDispatch();
- const visualizationSettings = useSelector(getVisualizationSettings);
const user = useSelector(getUser);
const userCanAccessSettings = useSelector(canAccessSettings);
const isAdmin = useSelector(getUserIsAdmin);
@@ -271,10 +236,6 @@ export const CreateOrEditQuestionAlertModal = ({
} else {
onAlertCreated();
}
-
- if (!skipUrlUpdate) {
- await dispatch(updateUrl(question, { dirty: false }));
- }
}
};
diff --git a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx
index 44ef705a2d0..be0945ded09 100644
--- a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx
+++ b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal.unit.spec.tsx
@@ -11,8 +11,10 @@ import { setupWebhookChannelsEndpoint } from "__support__/server-mocks/channel";
import { mockSettings } from "__support__/settings";
import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
-import { CreateOrEditQuestionAlertModalWithQuestion } from "metabase/notifications/modals";
-import { createMockQueryBuilderState } from "metabase/redux/store/mocks";
+import { CreateOrEditQuestionAlertModal } from "metabase/notifications/modals";
+import { createMockState } from "metabase/redux/store/mocks";
+import { getMetadata } from "metabase/selectors/metadata";
+import { checkNotNull } from "metabase/utils/types";
import type {
ChannelApiResponse,
Notification,
@@ -46,7 +48,7 @@ const expectNotConfigured = async (channel: string) =>
within(await configuredAlerts()).queryByText(channel),
).not.toBeInTheDocument();
-describe("CreateOrEditQuestionAlertModalWithQuestion", () => {
+describe("CreateOrEditQuestionAlertModal", () => {
it("should show 'When this question has results' for question cards", async () => {
setup({ isAdmin: true });
@@ -597,23 +599,30 @@ function setup({
can_access_subscription: false,
};
}
- const storeConfig = {
- storeInitialState: {
- currentUser,
- qb: createMockQueryBuilderState({
- card: mockCard,
- }),
- entities: createMockEntitiesState({
- databases: [createSampleDatabase()],
- questions: [mockCard],
- }),
- settings,
- },
- };
+ const storeInitialState = createMockState({
+ currentUser,
+ entities: createMockEntitiesState({
+ databases: [createSampleDatabase()],
+ questions: [mockCard],
+ }),
+ settings,
+ });
+ const storeConfig = { storeInitialState };
+
+ const metadata = getMetadata(storeInitialState);
+ // The modal takes `question` as a prop. In production it comes from the `getQuestion` selector
+ // which composes metrics and models into runnable ad-hoc questions.
+ // Matching that behavior here.
+ const savedQuestion = checkNotNull(metadata.question(mockCard.id));
+ const question =
+ cardType === "metric" || cardType === "model"
+ ? savedQuestion.composeQuestion()
+ : savedQuestion;
if (editingNotification) {
renderWithProviders(
- <CreateOrEditQuestionAlertModalWithQuestion
+ <CreateOrEditQuestionAlertModal
+ question={question}
editingNotification={editingNotification}
onAlertUpdated={onAlertUpdatedMock}
onClose={jest.fn()}
@@ -624,7 +633,8 @@ function setup({
}
renderWithProviders(
- <CreateOrEditQuestionAlertModalWithQuestion
+ <CreateOrEditQuestionAlertModal
+ question={question}
onAlertCreated={onAlertCreatedMock}
onClose={jest.fn()}
/>,
diff --git a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/components/NotificationOwner/NotificationOwner.tsx b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/components/NotificationOwner/NotificationOwner.tsx
index 45137c55c34..2ef60de6dd8 100644
--- a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/components/NotificationOwner/NotificationOwner.tsx
+++ b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/components/NotificationOwner/NotificationOwner.tsx
@@ -1,8 +1,10 @@
import { useState } from "react";
import { t } from "ttag";
-import type { UserOption } from "metabase/admin/tools/notifications/UserPicker";
-import { UserPicker } from "metabase/admin/tools/notifications/UserPicker";
+import {
+ type UserOption,
+ UserPicker,
+} from "metabase/common/components/UserPicker";
import { Flex, Text } from "metabase/ui";
import { getUserLabel } from "metabase/utils/user";
import type {
diff --git a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/index.ts b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/index.ts
index eaf190d9906..53735d1def2 100644
--- a/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/index.ts
+++ b/frontend/src/metabase/notifications/modals/CreateOrEditQuestionAlertModal/index.ts
@@ -1,5 +1,2 @@
-export {
- CreateOrEditQuestionAlertModal,
- CreateOrEditQuestionAlertModalWithQuestion,
-} from "./CreateOrEditQuestionAlertModal";
+export { CreateOrEditQuestionAlertModal } from "./CreateOrEditQuestionAlertModal";
export { AlertModalSettingsBlock } from "./components/AlertModalSettingsBlock/AlertModalSettingsBlock";
diff --git a/frontend/src/metabase/notifications/modals/QuestionAlertListModal/QuestionAlertListModal.tsx b/frontend/src/metabase/notifications/modals/QuestionAlertListModal/QuestionAlertListModal.tsx
index 0ee52d300f5..d5d2894dada 100644
--- a/frontend/src/metabase/notifications/modals/QuestionAlertListModal/QuestionAlertListModal.tsx
+++ b/frontend/src/metabase/notifications/modals/QuestionAlertListModal/QuestionAlertListModal.tsx
@@ -11,7 +11,7 @@ import { useToast } from "metabase/common/hooks/use-toast";
import { DeleteAlertConfirmModal } from "metabase/notifications/modals/DeleteAlertConfirmModal";
import { UnsubscribeConfirmModal } from "metabase/notifications/modals/UnsubscribeConfirmModal";
import type Question from "metabase-lib/v1/Question";
-import type { Notification } from "metabase-types/api";
+import type { Notification, VisualizationSettings } from "metabase-types/api";
import { CreateOrEditQuestionAlertModal } from "../CreateOrEditQuestionAlertModal";
@@ -26,10 +26,16 @@ type AlertModalMode =
export const QuestionAlertListModal = ({
question,
+ visualizationSettings,
onClose,
+ onAlertCreated,
+ onAlertUpdated,
}: {
question: Question;
+ visualizationSettings?: VisualizationSettings;
onClose: () => void;
+ onAlertCreated?: () => void;
+ onAlertUpdated?: () => void;
}) => {
const [editingItem, setEditingItem] = useState<Notification | null>(null);
@@ -148,14 +154,21 @@ export const QuestionAlertListModal = ({
{(activeModal === "create-modal" || activeModal === "update-modal") && (
<CreateOrEditQuestionAlertModal
question={question}
+ visualizationSettings={visualizationSettings}
editingNotification={
activeModal === "update-modal" && editingItem
? editingItem
: undefined
}
onClose={handleInternalModalClose}
- onAlertCreated={handleInternalModalClose}
- onAlertUpdated={handleInternalModalClose}
+ onAlertCreated={() => {
+ onAlertCreated?.();
+ handleInternalModalClose();
+ }}
+ onAlertUpdated={() => {
+ onAlertUpdated?.();
+ handleInternalModalClose();
+ }}
/>
)}
diff --git a/frontend/src/metabase/notifications/modals/index.ts b/frontend/src/metabase/notifications/modals/index.ts
index 8f8489affd2..8de81c6ddea 100644
--- a/frontend/src/metabase/notifications/modals/index.ts
+++ b/frontend/src/metabase/notifications/modals/index.ts
@@ -1,5 +1,2 @@
-export {
- CreateOrEditQuestionAlertModal,
- CreateOrEditQuestionAlertModalWithQuestion,
-} from "./CreateOrEditQuestionAlertModal";
+export { CreateOrEditQuestionAlertModal } from "./CreateOrEditQuestionAlertModal";
export { QuestionAlertListModal } from "./QuestionAlertListModal";
diff --git a/frontend/src/metabase/notifications/utils.ts b/frontend/src/metabase/notifications/utils.ts
index 65354f5cf2e..042b8929fba 100644
--- a/frontend/src/metabase/notifications/utils.ts
+++ b/frontend/src/metabase/notifications/utils.ts
@@ -258,7 +258,7 @@ function hasProperGoalForAlert({
visualizationSettings,
}: {
question: Question | undefined;
- visualizationSettings: VisualizationSettings;
+ visualizationSettings?: VisualizationSettings;
}): boolean {
if (!question) {
return false;
@@ -281,7 +281,7 @@ export function getAlertTriggerOptions({
visualizationSettings,
}: {
question: Question | undefined;
- visualizationSettings: VisualizationSettings;
+ visualizationSettings?: VisualizationSettings;
}): NotificationCardSendCondition[] {
const hasValidGoal = hasProperGoalForAlert({
question,
diff --git a/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx b/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
index 52698d20630..4e9e00d6e80 100644
--- a/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
+++ b/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
@@ -13,10 +13,14 @@ import { type ToastArgs, useToast } from "metabase/common/hooks";
import { QuestionEmbedWidget } from "metabase/embedding/components/QuestionEmbedWidget";
import { QuestionAlertListModal } from "metabase/notifications/modals";
import { setArchivedQuestion } from "metabase/query_builder/actions";
+import { updateUrl } from "metabase/query_builder/actions/url";
import { ImpossibleToCreateModelModal } from "metabase/query_builder/components/ImpossibleToCreateModelModal";
import { NewDatasetModal } from "metabase/query_builder/components/NewDatasetModal";
import { PreviewQueryModal } from "metabase/query_builder/components/view/PreviewQueryModal";
-import { getQuestionWithoutComposing } from "metabase/query_builder/selectors";
+import {
+ getQuestionWithoutComposing,
+ getVisualizationSettings,
+} from "metabase/query_builder/selectors";
import { MODAL_TYPES, type QueryModalType } from "metabase/querying/constants";
import { ArchiveCardModal } from "metabase/questions/components/ArchiveCardModal";
import { MoveCardModal } from "metabase/questions/components/MoveCardModal";
@@ -70,6 +74,11 @@ export function QueryModals({
const initialCollectionId = useGetDefaultCollectionId();
const underlyingQuestion = useSelector(getQuestionWithoutComposing);
+ const visualizationSettings = useSelector(getVisualizationSettings);
+
+ const handleAlertCreatedOrUpdated = useCallback(() => {
+ dispatch(updateUrl(question, { dirty: false }));
+ }, [dispatch, question]);
const handleSaveAndClose = useCallback(
async (question: Question) => {
@@ -209,7 +218,13 @@ export function QueryModals({
);
case MODAL_TYPES.CREATE_ALERT:
return (
- <QuestionAlertListModal question={question} onClose={onCloseModal} />
+ <QuestionAlertListModal
+ question={question}
+ visualizationSettings={visualizationSettings}
+ onAlertCreated={handleAlertCreatedOrUpdated}
+ onAlertUpdated={handleAlertCreatedOrUpdated}
+ onClose={onCloseModal}
+ />
);
case MODAL_TYPES.SAVE_QUESTION_BEFORE_EMBED:
return (
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
index e7d16efb6df..4e8b4739002 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationResult.jsx
@@ -8,7 +8,7 @@ import { ErrorMessage } from "metabase/common/components/ErrorMessage";
import ButtonsS from "metabase/css/components/buttons.module.css";
import CS from "metabase/css/core/index.css";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import { CreateOrEditQuestionAlertModalWithQuestion } from "metabase/notifications/modals/CreateOrEditQuestionAlertModal/CreateOrEditQuestionAlertModal";
+import { CreateOrEditQuestionAlertModal } from "metabase/notifications/modals/CreateOrEditQuestionAlertModal";
import { ALERT_TYPE_ROWS, getAlertType } from "metabase/notifications/utils";
import { resetRowZoom, zoomInRow } from "metabase/query_builder/actions";
import {
@@ -146,7 +146,8 @@ class VisualizationResultInner extends Component {
}
/>
{showCreateAlertModal && (
- <CreateOrEditQuestionAlertModalWithQuestion
+ <CreateOrEditQuestionAlertModal
+ question={question}
onClose={this.onCloseCreateAlertModal}
onAlertCreated={this.onCloseCreateAlertModal}
/>