Skip to content

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

Fix commenting on a chart without a timeline selected in explorations (#80378)

Kevin Kelleher5e5b74028779
diff --git a/frontend/src/metabase-types/api/comments.ts b/frontend/src/metabase-types/api/comments.ts
index 0949345b7c6..f85d1eca763 100644
--- a/frontend/src/metabase-types/api/comments.ts
+++ b/frontend/src/metabase-types/api/comments.ts
@@ -1,4 +1,5 @@
import type { DocumentContent } from "./document";
+import type { TimelineId } from "./timeline";
import type { BaseUser, User, UserId } from "./user";
export type CommentId = number;
@@ -7,7 +8,10 @@ export type CommentEntityType = "document" | "exploration";
export type EntityId = string | number;
-export type CommentContext = Record<string, unknown>;
+export interface CommentContext {
+ timeline_id?: TimelineId;
+ [key: string]: unknown;
+}
export interface Comment {
id: CommentId;
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.tsx b/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.tsx
index 5ecae5dff98..d8db844dad0 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.tsx
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.tsx
@@ -227,7 +227,7 @@ export function ActionToolbar({
parent_comment_id: null,
content,
context: {
- timeline_id: selectedTimelineId,
+ timeline_id: selectedTimelineId ?? undefined,
},
});
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.unit.spec.tsx b/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.unit.spec.tsx
index 3145685fb07..7e8a789108c 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.unit.spec.tsx
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/ActionToolbar.unit.spec.tsx
@@ -309,6 +309,42 @@ describe("ActionToolbar", () => {
});
});
+ it("omits timeline_id from comment context when no timeline is selected", async () => {
+ fetchMock.post(
+ "path:/api/comment",
+ createMockComment({
+ target_type: "exploration",
+ target_id: EXPLORATION_ID,
+ child_target_id: String(PAGE_ID),
+ }),
+ );
+
+ setup({ timelines: [releases, incidents] });
+
+ await openCommentEditor();
+ await userEvent.click(
+ screen.getByRole("button", { name: "Submit comment" }),
+ );
+
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.calls("path:/api/comment", { method: "POST" }),
+ ).toHaveLength(1);
+ });
+
+ const lastCall = fetchMock.callHistory.lastCall("path:/api/comment", {
+ method: "POST",
+ });
+ expect(await lastCall?.request?.json()).toEqual({
+ target_id: EXPLORATION_ID,
+ target_type: "exploration",
+ child_target_id: String(PAGE_ID),
+ parent_comment_id: null,
+ content: mockCommentContent,
+ context: {},
+ });
+ });
+
it("shows a toast when comment submission fails", async () => {
fetchMock.post("path:/api/comment", 500);
diff --git a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx
index 451989fd45c..aa7e19721c0 100644
--- a/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx
+++ b/frontend/src/metabase/explorations/components/ExplorationVisualization/ExplorationGroupVisualization.tsx
@@ -457,7 +457,7 @@ function ExplorationGroupVisualizationChart({
pageId={String(page.id)}
onClose={onCloseCommentsSidebar}
context={{
- timeline_id: selectedTimelineId,
+ timeline_id: selectedTimelineId ?? undefined,
}}
renderCommentTags={renderCommentTags}
/>