Skip to content

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

Move entities `setTimeline` object action to RTK -based hooks (#73507)

Romeo Van Snickd9e29e920c11
diff --git a/frontend/src/metabase/entities/timeline-events.js b/frontend/src/metabase/entities/timeline-events.js
index 67bae5c0d7f..ee73f945b7e 100644
--- a/frontend/src/metabase/entities/timeline-events.js
+++ b/frontend/src/metabase/entities/timeline-events.js
@@ -1,9 +1,7 @@
-import { t } from "ttag";
-
import { timelineEventApi, useGetTimelineEventQuery } from "metabase/api";
import { TimelineEventSchema } from "metabase/schema";
-import { createEntity, entityCompatibleQuery, undo } from "./utils";
+import { createEntity, entityCompatibleQuery } from "./utils";
/**
* @deprecated use "metabase/api" instead
@@ -49,16 +47,6 @@ export const TimelineEvents = createEntity({
timelineEventApi.endpoints.deleteTimelineEvent,
),
},
-
- objectActions: {
- setTimeline: ({ id }, timeline, opts) => {
- return TimelineEvents.actions.update(
- { id },
- { timeline_id: timeline.id },
- undo(opts, t`event`, t`moved`),
- );
- },
- },
});
const useGetQuery = ({ id }, options) => {
diff --git a/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx b/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx
index 54f628d675b..c211bd5e83f 100644
--- a/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx
+++ b/frontend/src/metabase/timelines/collections/containers/MoveEventModal/MoveEventModal.tsx
@@ -4,16 +4,19 @@ import _ from "underscore";
import { Collections } from "metabase/entities/collections";
import { TimelineEvents } from "metabase/entities/timeline-events";
import { Timelines } from "metabase/entities/timelines";
-import { connect } from "metabase/redux";
+import { useDispatch } from "metabase/redux";
import type { State } from "metabase/redux/store";
-import MoveEventModal from "metabase/timelines/common/components/MoveEventModal";
+import MoveEventModal, {
+ type MoveEventModalProps,
+} from "metabase/timelines/common/components/MoveEventModal";
+import { useSetTimeline } from "metabase/timelines/common/hooks";
import * as Urls from "metabase/urls";
import type { Timeline, TimelineEvent } from "metabase-types/api";
import LoadingAndErrorWrapper from "../../components/LoadingAndErrorWrapper";
import type { ModalParams } from "../../types";
-interface MoveEventModalProps {
+interface OwnProps {
params: ModalParams;
}
@@ -23,33 +26,39 @@ const timelinesProps = {
};
const timelineEventProps = {
- id: (state: State, props: MoveEventModalProps) =>
+ id: (state: State, props: OwnProps) =>
Urls.extractEntityId(props.params.timelineEventId),
entityAlias: "event",
LoadingAndErrorWrapper,
};
const collectionProps = {
- id: (state: State, props: MoveEventModalProps) =>
+ id: (state: State, props: OwnProps) =>
Urls.extractCollectionId(props.params.slug),
LoadingAndErrorWrapper,
};
-const mapDispatchToProps = (dispatch: any) => ({
- onSubmit: async (
+function MoveEventModalContainer(props: Omit<MoveEventModalProps, "onSubmit">) {
+ const setTimeline = useSetTimeline();
+ const dispatch = useDispatch();
+ const handleSubmit = async (
event: TimelineEvent,
- newTimeline: Timeline,
- oldTimeline: Timeline,
+ newTimeline?: Timeline,
+ oldTimeline?: Timeline,
) => {
- await dispatch(TimelineEvents.actions.setTimeline(event, newTimeline));
- dispatch(push(Urls.timelineInCollection(oldTimeline)));
- },
-});
+ if (newTimeline) {
+ await setTimeline(event, newTimeline);
+ }
+ if (oldTimeline) {
+ dispatch(push(Urls.timelineInCollection(oldTimeline)));
+ }
+ };
+ return <MoveEventModal {...props} onSubmit={handleSubmit} />;
+}
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.loadList(timelinesProps),
TimelineEvents.load(timelineEventProps),
Collections.load(collectionProps),
- connect(null, mapDispatchToProps),
-)(MoveEventModal);
+)(MoveEventModalContainer);
diff --git a/frontend/src/metabase/timelines/common/components/MoveEventModal/index.ts b/frontend/src/metabase/timelines/common/components/MoveEventModal/index.ts
index e295ecfd867..3ae0e604d69 100644
--- a/frontend/src/metabase/timelines/common/components/MoveEventModal/index.ts
+++ b/frontend/src/metabase/timelines/common/components/MoveEventModal/index.ts
@@ -1,2 +1,3 @@
// eslint-disable-next-line import/no-default-export -- deprecated usage
export { default } from "./MoveEventModal";
+export type { MoveEventModalProps } from "./MoveEventModal";
diff --git a/frontend/src/metabase/timelines/common/hooks/index.ts b/frontend/src/metabase/timelines/common/hooks/index.ts
new file mode 100644
index 00000000000..6c4a8681419
--- /dev/null
+++ b/frontend/src/metabase/timelines/common/hooks/index.ts
@@ -0,0 +1 @@
+export * from "./use-set-timeline";
diff --git a/frontend/src/metabase/timelines/common/hooks/use-set-timeline.ts b/frontend/src/metabase/timelines/common/hooks/use-set-timeline.ts
new file mode 100644
index 00000000000..d426ce01a07
--- /dev/null
+++ b/frontend/src/metabase/timelines/common/hooks/use-set-timeline.ts
@@ -0,0 +1,40 @@
+import { useCallback } from "react";
+import { t } from "ttag";
+
+import { useUpdateTimelineEventMutation } from "metabase/api";
+import { useDispatch } from "metabase/redux";
+import { addUndo } from "metabase/redux/undo";
+import type { Timeline, TimelineEvent } from "metabase-types/api";
+
+export function useSetTimeline() {
+ const dispatch = useDispatch();
+ const [updateTimelineEvent] = useUpdateTimelineEventMutation();
+
+ return useCallback(
+ async (
+ event: Pick<TimelineEvent, "id" | "timeline_id">,
+ timeline: Pick<Timeline, "id">,
+ ) => {
+ const previousTimelineId = event.timeline_id;
+ await updateTimelineEvent({
+ id: event.id,
+ timeline_id: timeline.id,
+ }).unwrap();
+
+ dispatch(
+ addUndo({
+ subject: t`event`,
+ verb: t`moved`,
+ actions: [
+ () =>
+ updateTimelineEvent({
+ id: event.id,
+ timeline_id: previousTimelineId,
+ }),
+ ],
+ }),
+ );
+ },
+ [dispatch, updateTimelineEvent],
+ );
+}
diff --git a/frontend/src/metabase/timelines/questions/containers/MoveEventModal/MoveEventModal.tsx b/frontend/src/metabase/timelines/questions/containers/MoveEventModal/MoveEventModal.tsx
index 2f1f97557fa..e2240202113 100644
--- a/frontend/src/metabase/timelines/questions/containers/MoveEventModal/MoveEventModal.tsx
+++ b/frontend/src/metabase/timelines/questions/containers/MoveEventModal/MoveEventModal.tsx
@@ -3,12 +3,14 @@ import _ from "underscore";
import { Collections, ROOT_COLLECTION } from "metabase/entities/collections";
import { TimelineEvents } from "metabase/entities/timeline-events";
import { Timelines } from "metabase/entities/timelines";
-import { connect } from "metabase/redux";
import type { State } from "metabase/redux/store";
-import MoveEventModal from "metabase/timelines/common/components/MoveEventModal";
+import MoveEventModal, {
+ type MoveEventModalProps,
+} from "metabase/timelines/common/components/MoveEventModal";
+import { useSetTimeline } from "metabase/timelines/common/hooks";
import type { Timeline, TimelineEvent } from "metabase-types/api";
-interface MoveEventModalProps {
+interface OwnProps {
eventId: number;
collectionId?: number;
onClose?: () => void;
@@ -19,37 +21,37 @@ const timelinesProps = {
};
const timelineEventProps = {
- id: (state: State, props: MoveEventModalProps) => props.eventId,
+ id: (state: State, props: OwnProps) => props.eventId,
entityAlias: "event",
};
const collectionProps = {
- id: (state: State, props: MoveEventModalProps) => {
+ id: (state: State, props: OwnProps) => {
return props.collectionId ?? ROOT_COLLECTION.id;
},
};
-const mapStateToProps = (state: State, { onClose }: MoveEventModalProps) => ({
- onSubmitSuccess: onClose,
- onCancel: onClose,
-});
-
-const mapDispatchToProps = (dispatch: any) => ({
- onSubmit: async (
- event: TimelineEvent,
- newTimeline: Timeline,
- oldTimeline: Timeline,
- onClose?: () => void,
- ) => {
- await dispatch(TimelineEvents.actions.setTimeline(event, newTimeline));
- onClose?.();
- },
-});
+type ContainerProps = Omit<MoveEventModalProps, "onSubmit" | "onSubmitSuccess">;
+
+function MoveEventModalContainer(props: ContainerProps) {
+ const setTimeline = useSetTimeline();
+ const handleSubmit = async (event: TimelineEvent, newTimeline?: Timeline) => {
+ if (newTimeline) {
+ await setTimeline(event, newTimeline);
+ }
+ };
+ return (
+ <MoveEventModal
+ {...props}
+ onSubmit={handleSubmit}
+ onSubmitSuccess={props.onClose}
+ />
+ );
+}
// eslint-disable-next-line import/no-default-export -- deprecated usage
export default _.compose(
Timelines.loadList(timelinesProps),
TimelineEvents.load(timelineEventProps),
Collections.load(collectionProps),
- connect(mapStateToProps, mapDispatchToProps),
-)(MoveEventModal);
+)(MoveEventModalContainer);