Skip to content

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

Remove pulse entity (#73561)

Romeo Van Snick5d2643e00fe5
diff --git a/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx b/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx
index 86a79483b5e..98895b56ec4 100644
--- a/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx
+++ b/frontend/src/metabase/account/notifications/containers/NotificationsApp/NotificationsApp.tsx
@@ -2,15 +2,17 @@ import type { JSX, ReactNode } from "react";
import { useMemo } from "react";
import type { NotificationListItem } from "metabase/account/notifications/types";
-import { skipToken, useListNotificationsQuery } from "metabase/api";
-import { Pulses } from "metabase/entities/pulses";
+import {
+ skipToken,
+ useListNotificationsQuery,
+ useListSubscriptionsQuery,
+} from "metabase/api";
import { useDispatch, useSelector } from "metabase/redux";
import {
canManageSubscriptions as canManageSubscriptionsSelector,
getUser,
} from "metabase/selectors/user";
import { parseTimestamp } from "metabase/utils/time-dayjs";
-import type { DashboardSubscription } from "metabase-types/api";
import {
navigateToArchive,
@@ -20,12 +22,10 @@ import {
import { NotificationList } from "../../components/NotificationList";
interface NotificationsAppProps {
- pulses: DashboardSubscription[];
children?: ReactNode;
}
-const NotificationsAppInner = ({
- pulses,
+export const NotificationsApp = ({
children,
}: NotificationsAppProps): JSX.Element | null => {
const user = useSelector(getUser);
@@ -33,6 +33,10 @@ const NotificationsAppInner = ({
const dispatch = useDispatch();
+ const { data: pulses = [] } = useListSubscriptionsQuery({
+ creator_or_recipient: true,
+ });
+
const { data: questionNotifications = [] } = useListNotificationsQuery(
user
? {
@@ -84,9 +88,3 @@ const NotificationsAppInner = ({
</NotificationList>
);
};
-
-export const NotificationsApp = Pulses.loadList({
- // Load all pulses the current user is a creator or recipient of
- query: () => ({ creator_or_recipient: true }),
- reload: true,
-})(NotificationsAppInner);
diff --git a/frontend/src/metabase/api/subscription.ts b/frontend/src/metabase/api/subscription.ts
index 4b912de5f0d..38ab004217a 100644
--- a/frontend/src/metabase/api/subscription.ts
+++ b/frontend/src/metabase/api/subscription.ts
@@ -1,4 +1,3 @@
-import { PulseSchema } from "metabase/schema";
import type {
ChannelApiResponse,
CreateSubscriptionRequest,
@@ -16,7 +15,6 @@ import {
provideSubscriptionListTags,
provideSubscriptionTags,
} from "./tags";
-import { hydrateLegacyEntities } from "./utils/hydrate-legacy-entities";
export const subscriptionApi = Api.injectEndpoints({
endpoints: (builder) => ({
@@ -31,7 +29,6 @@ export const subscriptionApi = Api.injectEndpoints({
}),
providesTags: (subscriptions = []) =>
provideSubscriptionListTags(subscriptions),
- onQueryStarted: hydrateLegacyEntities([PulseSchema]),
}),
getSubscription: builder.query<DashboardSubscription, number>({
query: (id) => ({
@@ -40,7 +37,6 @@ export const subscriptionApi = Api.injectEndpoints({
}),
providesTags: (subscription) =>
subscription ? provideSubscriptionTags(subscription) : [],
- onQueryStarted: hydrateLegacyEntities(PulseSchema),
}),
createSubscription: builder.mutation<
DashboardSubscription,
diff --git a/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx b/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx
index 32f59e3d97c..36512161556 100644
--- a/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardSubscriptionsSidebar/DashboardSubscriptionsSidebar.tsx
@@ -1,12 +1,12 @@
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import _ from "underscore";
+import { skipToken, useListSubscriptionsQuery } from "metabase/api";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import type { ScheduleChangeProp } from "metabase/common/components/SchedulePicker";
import { Sidebar } from "metabase/common/components/Sidebar";
import { useSetArchive } from "metabase/common/hooks";
import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
-import { Pulses } from "metabase/entities/pulses";
import {
cancelEditingPulse,
fetchPulseFormInput,
@@ -116,7 +116,7 @@ const getEditingPulseWithDefaults = (
const mapStateToProps = (state: State, props: { dashboard: Dashboard }) => ({
isAdmin: getUserIsAdmin(state),
pulse: getEditingPulseWithDefaults(state, props),
- formInput: getPulseFormInput(state),
+ formInput: getPulseFormInput(state) as ChannelApiResponse,
user: getUser(state),
});
@@ -153,7 +153,7 @@ interface DashboardSubscriptionsSidebarInnerProps {
initialCollectionId?: number;
isAdmin?: boolean;
pulse: DraftDashboardSubscription;
- saveEditingPulse: () => Promise<DashboardSubscription>;
+ saveEditingPulse: () => Promise<unknown>;
testPulse: (pulse: DraftDashboardSubscription) => Promise<unknown>;
updateEditingPulse: (pulse: DraftDashboardSubscription) => void;
cancelEditingPulse: () => void;
@@ -615,20 +615,20 @@ function AddEditEmailSidebarWithHooks({
);
}
-const DashboardSubscriptionsSidebarConnected = _.compose(
- Pulses.loadList({
- query: (_state: State, { dashboard }: { dashboard: Dashboard }) => ({
- dashboard_id: dashboard.id,
- }),
- loadingAndErrorWrapper: false,
- }),
- connect(mapStateToProps, mapDispatchToProps),
+const DashboardSubscriptionsSidebarConnected = connect(
+ mapStateToProps,
+ mapDispatchToProps,
)(DashboardSubscriptionsSidebarInner);
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default function DashboardSubscriptionsSidebar() {
const { dashboard, setSharing } = useDashboardContext();
+ const { data: pulses, isFetching: isSubscriptionListLoading } =
+ useListSubscriptionsQuery(
+ dashboard ? { dashboard_id: dashboard.id } : skipToken,
+ );
+
if (!dashboard) {
return null;
}
@@ -636,6 +636,8 @@ export default function DashboardSubscriptionsSidebar() {
return (
<DashboardSubscriptionsSidebarConnected
dashboard={dashboard}
+ pulses={pulses}
+ loading={isSubscriptionListLoading}
onCancel={() => setSharing(false)}
/>
);
diff --git a/frontend/src/metabase/entities/index.ts b/frontend/src/metabase/entities/index.ts
index ccb3c6382d9..ac0e10c54eb 100644
--- a/frontend/src/metabase/entities/index.ts
+++ b/frontend/src/metabase/entities/index.ts
@@ -72,7 +72,6 @@ export { Actions as actions } from "./actions/actions";
export { Collections as collections } from "./collections";
export { SnippetCollections as snippetCollections } from "./snippet-collections";
export { Dashboards as dashboards } from "./dashboards";
-export { Pulses as pulses } from "./pulses";
export { Questions as questions } from "./questions";
export { Timelines as timelines } from "./timelines";
diff --git a/frontend/src/metabase/entities/pulses.js b/frontend/src/metabase/entities/pulses.js
deleted file mode 100644
index 59bf60cee54..00000000000
--- a/frontend/src/metabase/entities/pulses.js
+++ /dev/null
@@ -1,63 +0,0 @@
-import {
- subscriptionApi,
- useGetSubscriptionQuery,
- useListSubscriptionsQuery,
-} from "metabase/api";
-import { getCollectionType } from "metabase/entities/collections/utils";
-
-import { createEntity, entityCompatibleQuery } from "./utils";
-
-/**
- * @deprecated use "metabase/api" instead
- */
-export const Pulses = createEntity({
- name: "pulses",
- nameOne: "pulse",
- path: "/api/pulse",
-
- rtk: () => ({
- getUseGetQuery: () => ({
- useGetQuery,
- }),
- useListQuery: useListSubscriptionsQuery,
- }),
-
- api: {
- list: (entityQuery, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- subscriptionApi.endpoints.listSubscriptions,
- ),
- get: (entityQuery, options, dispatch) =>
- entityCompatibleQuery(
- entityQuery.id,
- dispatch,
- subscriptionApi.endpoints.getSubscription,
- ),
- create: (entityQuery, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- subscriptionApi.endpoints.createSubscription,
- ),
- update: (entityQuery, dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- subscriptionApi.endpoints.updateSubscription,
- ),
- delete: () => {
- throw new TypeError("Pulses.api.delete is not supported");
- },
- },
-
- getAnalyticsMetadata([object], { action }, getState) {
- const type = object && getCollectionType(object.collection_id, getState());
- return type && `collection=${type}`;
- },
-});
-
-const useGetQuery = ({ id }, options) => {
- return useGetSubscriptionQuery(id, options);
-};
diff --git a/frontend/src/metabase/entities/search.js b/frontend/src/metabase/entities/search.js
index 794a551a52f..dc97e22f22b 100644
--- a/frontend/src/metabase/entities/search.js
+++ b/frontend/src/metabase/entities/search.js
@@ -15,7 +15,6 @@ import { Actions } from "./actions";
import { Bookmarks } from "./bookmarks";
import { Collections } from "./collections";
import { Dashboards } from "./dashboards";
-import { Pulses } from "./pulses";
import { Questions } from "./questions";
import { Segments } from "./segments";
import { SnippetCollections } from "./snippet-collections";
@@ -132,7 +131,6 @@ export const Search = createEntity({
Bookmarks.actionShouldInvalidateLists(action) ||
Collections.actionShouldInvalidateLists(action) ||
Dashboards.actionShouldInvalidateLists(action) ||
- Pulses.actionShouldInvalidateLists(action) ||
Questions.actionShouldInvalidateLists(action) ||
Segments.actionShouldInvalidateLists(action) ||
Snippets.actionShouldInvalidateLists(action) ||
diff --git a/frontend/src/metabase/notifications/pulse/actions.ts b/frontend/src/metabase/notifications/pulse/actions.ts
index 29b2c27df63..7a689e4a983 100644
--- a/frontend/src/metabase/notifications/pulse/actions.ts
+++ b/frontend/src/metabase/notifications/pulse/actions.ts
@@ -2,13 +2,16 @@ import { createAction } from "redux-actions";
import { t } from "ttag";
import { getActionErrorMessage } from "metabase/actions/utils";
-import { Pulses } from "metabase/entities/pulses";
+import { subscriptionApi } from "metabase/api";
import { createThunkAction } from "metabase/redux";
+import type { DraftDashboardSubscription } from "metabase/redux/store";
import { addUndo } from "metabase/redux/undo";
import { PulseApi } from "metabase/services";
import type {
ChannelApiResponse,
+ CreateSubscriptionRequest,
DashboardSubscription,
+ UpdateSubscriptionRequest,
} from "metabase-types/api";
import { getEditingPulse } from "./selectors";
@@ -24,8 +27,9 @@ export const FETCH_PULSE_FORM_INPUT = "FETCH_PULSE_FORM_INPUT";
export const FETCH_PULSE_LIST_BY_DASHBOARD_ID =
"FETCH_PULSE_LIST_BY_DASHBOARD_ID";
-export const updateEditingPulse =
- createAction<DashboardSubscription>(UPDATE_EDITING_PULSE);
+export const updateEditingPulse = createAction<
+ DashboardSubscription | DraftDashboardSubscription
+>(UPDATE_EDITING_PULSE);
export const cancelEditingPulse = createAction(CANCEL_EDITING_PULSE);
export const saveEditingPulse = createThunkAction(
@@ -37,13 +41,17 @@ export const saveEditingPulse = createThunkAction(
try {
if (isEdit) {
- return Pulses.HACK_getObjectFromAction(
- await dispatch(Pulses.actions.update(editingPulse)),
- );
+ return await dispatch(
+ subscriptionApi.endpoints.updateSubscription.initiate(
+ editingPulse as unknown as UpdateSubscriptionRequest,
+ ),
+ ).unwrap();
} else {
- return Pulses.HACK_getObjectFromAction(
- await dispatch(Pulses.actions.create(editingPulse)),
- );
+ return await dispatch(
+ subscriptionApi.endpoints.createSubscription.initiate(
+ editingPulse as unknown as CreateSubscriptionRequest,
+ ),
+ ).unwrap();
}
} catch (error) {
const errorMessage = getActionErrorMessage(error);
@@ -66,7 +74,7 @@ export const saveEditingPulse = createThunkAction(
export const testPulse = createThunkAction(
TEST_PULSE,
- function (pulse: DashboardSubscription) {
+ function (pulse: DashboardSubscription | DraftDashboardSubscription) {
return async function () {
return await PulseApi.test(pulse);
};
diff --git a/frontend/src/metabase/schema.js b/frontend/src/metabase/schema.js
index be3b2332ef8..d97649fb74c 100644
--- a/frontend/src/metabase/schema.js
+++ b/frontend/src/metabase/schema.js
@@ -13,7 +13,6 @@ export const CacheConfigSchema = new schema.Entity("cacheConfigs");
export const BookmarkSchema = new schema.Entity("bookmarks");
export const DocumentSchema = new schema.Entity("documents");
export const DashboardSchema = new schema.Entity("dashboards");
-export const PulseSchema = new schema.Entity("pulses");
export const CollectionSchema = new schema.Entity("collections");
export const GroupSchema = new schema.Entity("groups");
@@ -132,7 +131,6 @@ export const ENTITIES_SCHEMA_MAP = {
cacheConfigs: CacheConfigSchema,
bookmarks: BookmarkSchema,
dashboards: DashboardSchema,
- pulses: PulseSchema,
collections: CollectionSchema,
segments: SegmentSchema,
measures: MeasureSchema,