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
import { useEffect } from "react";
import { t } from "ttag";
import { SdkActionIcon } from "embedding-sdk-bundle/components/private/SdkQuestion/components/util/SdkActionIcon/SdkActionIcon";
import { useSdkQuestionContext } from "embedding-sdk-bundle/components/private/SdkQuestion/context";
import { useQuestionAlertModalContext } from "embedding-sdk-bundle/components/private/notifications/context/QuestionAlertModalProvider";
import { useSdkSelector } from "embedding-sdk-bundle/store";
import { getIsGuestEmbed } from "embedding-sdk-bundle/store/selectors";
import { useHasEmailSetup } from "metabase/common/hooks";
import { canManageSubscriptions as canManageSubscriptionsSelector } from "metabase/current-user";
import { isDataApp } from "metabase/embedding-sdk/config";
import type { QuestionAlertsButtonProps } from "metabase/plugins";
import { isInstanceAnalyticsCollection } from "metabase-enterprise/collections/utils";
/**
* @internal Do not import this component directly, use either SDK or EAJS EE plugins instead.
*/
export const QuestionAlertsButton = (props: QuestionAlertsButtonProps) => {
const { withAlerts, question } = useSdkQuestionContext();
const canManageSubscriptions = useSdkSelector(canManageSubscriptionsSelector);
const isGuestEmbed = useSdkSelector(getIsGuestEmbed);
const { toggle: toggleModal, close: closeModal } =
useQuestionAlertModalContext();
const isSaved = question?.isSaved();
const isModel = question?.type() === "model";
const isAnalytics = isInstanceAnalyticsCollection(question?.collection());
// A data app renders a UI; an alert is scheduled email delivered later, out of band. It is
// deliberately not part of the data-app surface, so the affordance never appears rather
// than appearing and failing on the (unscoped) /api/notification routes behind it.
const isDataAppEmbed = isDataApp();
// Skip the pulse/form_input request in guest embed mode (EMB-1525),
// as the endpoint does not exist for guest embeds.
const hasEmailSetup = useHasEmailSetup({
skip: isGuestEmbed || isDataAppEmbed,
});
const shouldRenderAlertsButton =
hasEmailSetup &&
!isGuestEmbed &&
!isDataAppEmbed &&
withAlerts &&
isSaved &&
canManageSubscriptions &&
!isModel &&
!isAnalytics;
useEffect(() => {
if (!shouldRenderAlertsButton) {
closeModal();
}
return closeModal;
}, [closeModal, shouldRenderAlertsButton]);
/**
* Use the same logic as in the core app. But we don't need `isAdmin` because it's already included in `canManageSubscriptions`.
* @see {@link https://github.com/metabase/metabase/blob/363baef1d937078ecc1efe9710cbe883f830c819/frontend/src/metabase/query_builder/components/view/ViewHeader/components/QuestionActions/QuestionMoreActionsMenu/QuestionMoreActionsMenu.tsx#L131}
*/
if (shouldRenderAlertsButton) {
return (
<SdkActionIcon
tooltip={t`Alerts`}
icon="alert"
onClick={toggleModal}
{...props}
/>
);
}
return null;
};