Skip to content

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

Move Explore button into the chart card (UXW-4237) (#74810)

Andrei Chernykhed8e23b76f3e
diff --git a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
index c23efc306d2..d95f145e9e4 100644
--- a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
@@ -255,7 +255,7 @@ describe("scenarios > data studio > library > metrics", () => {
.should("be.visible");
});
- it("should view metric in the metrics explorer view via more menu", () => {
+ it("should view metric in the metrics explorer view via the Explore button", () => {
cy.log("Navigate to Data Studio Library");
cy.visit("/data-studio/library");
@@ -269,8 +269,7 @@ describe("scenarios > data studio > library > metrics", () => {
.findByDisplayValue("Trusted Orders Metric")
.should("be.visible");
- cy.log("Verify View link opens in new tab");
- H.DataStudio.Metrics.moreMenu().click();
+ cy.log("Verify the Explore button points to the metrics explorer");
H.DataStudio.Metrics.exploreLink()
.should("have.attr", "href")
.and("match", /\/explore\?metricId=\d+/);
diff --git a/e2e/test/scenarios/metrics/metric-page.cy.spec.ts b/e2e/test/scenarios/metrics/metric-page.cy.spec.ts
index 1a4644b8a62..535d0f03a01 100644
--- a/e2e/test/scenarios/metrics/metric-page.cy.spec.ts
+++ b/e2e/test/scenarios/metrics/metric-page.cy.spec.ts
@@ -68,9 +68,7 @@ describe("scenarios > metrics > metric page", () => {
});
cy.log("explore link");
- H.MetricPage.header()
- .findByText("Explore")
- .closest("a")
+ H.MetricPage.exploreLink()
.should("have.attr", "href")
.and("include", "/explore");
diff --git a/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx b/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx
index 83e232ed6d4..2e1ca09fbd7 100644
--- a/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx
+++ b/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.tsx
@@ -8,10 +8,8 @@ import {
useListBookmarksQuery,
useListNotificationsQuery,
} from "metabase/api";
-import { ForwardRefLink } from "metabase/common/components/Link";
import { AddToDashSelectDashModal } from "metabase/common/components/Pickers/AddToDashSelectDashModal";
import { canAccessDataStudio as canAccessDataStudioSelector } from "metabase/data-studio/selectors";
-import { isNumericMetric } from "metabase/metrics/utils/validation";
import { QuestionAlertListModal } from "metabase/notifications/modals/QuestionAlertListModal";
import {
PLUGIN_AUDIT,
@@ -26,7 +24,7 @@ import { useDispatch, useSelector } from "metabase/redux";
import { openUrl } from "metabase/redux/app";
import { getMetadata } from "metabase/selectors/metadata";
import { canManageSubscriptions as canManageSubscriptionsSelector } from "metabase/selectors/user";
-import { ActionIcon, Button, Group, Icon, Menu } from "metabase/ui";
+import { ActionIcon, Icon, Menu } from "metabase/ui";
import * as Urls from "metabase/urls";
import * as Lib from "metabase-lib";
import Question from "metabase-lib/v1/Question";
@@ -120,123 +118,111 @@ function MetricToolbarButtons({
PLUGIN_CACHING.hasQuestionCacheSection(new Question(card));
return (
- <Group wrap="nowrap" gap="sm">
- {isNumericMetric(card) && (
- <Button
- component={ForwardRefLink}
- to={Urls.exploreMetric(card.id)}
- leftSection={<Icon name="external" />}
- data-testid="explore-link"
+ <Menu position="bottom-end">
+ <Menu.Target>
+ <ActionIcon
+ variant="default"
+ size="lg"
+ className={S.moreOptionsButton}
+ aria-label={t`More options`}
>
- {t`Explore`}
- </Button>
- )}
- <Menu position="bottom-end">
- <Menu.Target>
- <ActionIcon
- variant="default"
- size="lg"
- className={S.moreOptionsButton}
- aria-label={t`More options`}
+ <Icon name="ellipsis" />
+ </ActionIcon>
+ </Menu.Target>
+ <Menu.Dropdown>
+ <Menu.Item
+ leftSection={
+ <Icon name={isBookmarked ? "bookmark_filled" : "bookmark"} />
+ }
+ onClick={() =>
+ isBookmarked
+ ? deleteBookmark({ id: card.id, type: "card" })
+ : createBookmark({ id: card.id, type: "card" })
+ }
+ >
+ {isBookmarked ? t`Remove from bookmarks` : t`Bookmark`}
+ </Menu.Item>
+ {moderationMenuItems}
+ {card.can_write && (
+ <Menu.Item
+ leftSection={<Icon name="move" />}
+ onClick={() => onOpenModal("move")}
>
- <Icon name="ellipsis" />
- </ActionIcon>
- </Menu.Target>
- <Menu.Dropdown>
+ {c("A verb, not a noun").t`Move`}
+ </Menu.Item>
+ )}
+ {queryInfo.isEditable && (
<Menu.Item
- leftSection={
- <Icon name={isBookmarked ? "bookmark_filled" : "bookmark"} />
- }
- onClick={() =>
- isBookmarked
- ? deleteBookmark({ id: card.id, type: "card" })
- : createBookmark({ id: card.id, type: "card" })
- }
+ leftSection={<Icon name="clone" />}
+ onClick={() => onOpenModal("copy")}
>
- {isBookmarked ? t`Remove from bookmarks` : t`Bookmark`}
+ {c("A verb, not a noun").t`Duplicate`}
</Menu.Item>
- {moderationMenuItems}
- {card.can_write && (
- <Menu.Item
- leftSection={<Icon name="move" />}
- onClick={() => onOpenModal("move")}
- >
- {c("A verb, not a noun").t`Move`}
- </Menu.Item>
- )}
- {queryInfo.isEditable && (
- <Menu.Item
- leftSection={<Icon name="clone" />}
- onClick={() => onOpenModal("copy")}
- >
- {c("A verb, not a noun").t`Duplicate`}
- </Menu.Item>
- )}
+ )}
- <Menu.Divider role="separator" />
+ <Menu.Divider role="separator" />
+ <Menu.Item
+ leftSection={<Icon name="add_to_dash" />}
+ onClick={() => onOpenModal("add-to-dashboard")}
+ >
+ {t`Add to a dashboard`}
+ </Menu.Item>
+ {canManageSubscriptions && (
<Menu.Item
- leftSection={<Icon name="add_to_dash" />}
- onClick={() => onOpenModal("add-to-dashboard")}
+ leftSection={<Icon name="alert" />}
+ disabled={isNotificationsLoading}
+ onClick={() => onOpenModal("alert")}
>
- {t`Add to a dashboard`}
+ {questionNotifications?.length
+ ? t`Edit alerts`
+ : t`Create an alert`}
</Menu.Item>
- {canManageSubscriptions && (
+ )}
+
+ {isCacheableQuestion && (
+ <>
+ <Menu.Divider role="separator" />
<Menu.Item
- leftSection={<Icon name="alert" />}
- disabled={isNotificationsLoading}
- onClick={() => onOpenModal("alert")}
+ leftSection={<Icon name="sync" />}
+ onClick={() => onOpenModal("caching")}
>
- {questionNotifications?.length
- ? t`Edit alerts`
- : t`Create an alert`}
+ {t`Caching`}
</Menu.Item>
- )}
+ </>
+ )}
- {isCacheableQuestion && (
- <>
- <Menu.Divider role="separator" />
- <Menu.Item
- leftSection={<Icon name="sync" />}
- onClick={() => onOpenModal("caching")}
- >
- {t`Caching`}
- </Menu.Item>
- </>
- )}
+ {(PLUGIN_AUDIT.isEnabled || showDataStudioLink) && (
+ <Menu.Divider role="separator" />
+ )}
- {(PLUGIN_AUDIT.isEnabled || showDataStudioLink) && (
- <Menu.Divider role="separator" />
- )}
+ {showDataStudioLink && (
+ <Menu.Item
+ leftSection={<Icon name="grid_bordered" />}
+ onClick={() => dispatch(openUrl(Urls.dataStudioMetric(card.id)))}
+ >
+ {t`Open in Data Studio`}
+ </Menu.Item>
+ )}
+ <PLUGIN_AUDIT.InsightsMenuItem
+ card={card}
+ label={t`Metric usage analytics`}
+ iconName="pie_slice"
+ />
- {showDataStudioLink && (
+ {card.can_write && (
+ <>
+ <Menu.Divider role="separator" />
<Menu.Item
- leftSection={<Icon name="grid_bordered" />}
- onClick={() => dispatch(openUrl(Urls.dataStudioMetric(card.id)))}
+ leftSection={<Icon name="trash" />}
+ onClick={() => onOpenModal("archive")}
>
- {t`Open in Data Studio`}
+ {t`Move to trash`}
</Menu.Item>
- )}
- <PLUGIN_AUDIT.InsightsMenuItem
- card={card}
- label={t`Metric usage analytics`}
- iconName="pie_slice"
- />
-
- {card.can_write && (
- <>
- <Menu.Divider role="separator" />
- <Menu.Item
- leftSection={<Icon name="trash" />}
- onClick={() => onOpenModal("archive")}
- >
- {t`Move to trash`}
- </Menu.Item>
- </>
- )}
- </Menu.Dropdown>
- </Menu>
- </Group>
+ </>
+ )}
+ </Menu.Dropdown>
+ </Menu>
);
}
diff --git a/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.unit.spec.tsx b/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.unit.spec.tsx
index 5075a9610b5..b7d24a3bc44 100644
--- a/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.unit.spec.tsx
+++ b/frontend/src/metabase/metrics/components/MetricHeader/MetricToolbar/MetricToolbar.unit.spec.tsx
@@ -255,4 +255,12 @@ describe("MetricToolbar", () => {
).toBeInTheDocument();
});
});
+
+ describe("Explore button", () => {
+ it("should not render an Explore button in the toolbar", () => {
+ setup({ canWrite: true });
+
+ expect(screen.queryByTestId("explore-link")).not.toBeInTheDocument();
+ });
+ });
});
diff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/ExploreMetricButton.tsx b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/ExploreMetricButton.tsx
new file mode 100644
index 00000000000..739afea9d04
--- /dev/null
+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/ExploreMetricButton.tsx
@@ -0,0 +1,25 @@
+import { t } from "ttag";
+
+import { ForwardRefLink } from "metabase/common/components/Link";
+import { Button, Icon } from "metabase/ui";
+import * as Urls from "metabase/urls";
+import type { CardId } from "metabase-types/api";
+
+interface ExploreMetricButtonProps {
+ cardId: CardId;
+}
+
+export function ExploreMetricButton({ cardId }: ExploreMetricButtonProps) {
+ return (
+ <Button
+ component={ForwardRefLink}
+ to={Urls.exploreMetric(cardId)}
+ variant="default"
+ size="xs"
+ leftSection={<Icon name="click" />}
+ data-testid="explore-link"
+ >
+ {t`Explore`}
+ </Button>
+ );
+}
diff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.module.css b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.module.css
index 618a8d95ee4..6fb31e28a1e 100644
--- a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.module.css
+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.module.css
@@ -5,13 +5,14 @@
.chartContainer {
display: flex;
flex-direction: column;
- cursor: pointer;
- transition: box-shadow 200ms ease;
- border-radius: var(--default-border-radius) 0 0 var(--default-border-radius);
+ position: relative;
+}
- &:hover {
- box-shadow: var(--mantine-shadow-md);
- }
+.exploreButtonOverlay {
+ position: absolute;
+ top: var(--mantine-spacing-xl);
+ right: var(--mantine-spacing-xl);
+ z-index: 1;
}
.descriptionSection {
@@ -29,6 +30,7 @@
border-top-left-radius: var(--default-border-radius);
border-bottom-left-radius: var(--default-border-radius);
overflow: hidden;
+ /* keeps the embedded visualization non-interactive (no tooltips/hover) */
pointer-events: none;
}
diff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx
index 7acffb88a0f..c15529e6648 100644
--- a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx
+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.tsx
@@ -1,11 +1,9 @@
-import { useCallback, useMemo } from "react";
-import { push } from "react-router-redux";
+import { useMemo } from "react";
import { OverviewVisualization } from "metabase/data-studio/common/components/OverviewVisualization";
import { useMetricDefinition } from "metabase/metrics/common/hooks";
-import { useDispatch } from "metabase/redux";
+import { isNumericMetric } from "metabase/metrics/utils/validation";
import { Box, Flex, Stack } from "metabase/ui";
-import * as Urls from "metabase/urls";
import * as LibMetric from "metabase-lib/metric";
import type { Card } from "metabase-types/api";
@@ -13,6 +11,7 @@ import type { MetricUrls } from "../../../types";
import { AboutVisualization } from "./AboutVisualization";
import { DescriptionSection } from "./DescriptionSection";
+import { ExploreMetricButton } from "./ExploreMetricButton";
import S from "./MetricAbout.module.css";
interface MetricAboutProps {
@@ -22,7 +21,6 @@ interface MetricAboutProps {
export function MetricAbout({ card, urls }: MetricAboutProps) {
const { definition } = useMetricDefinition(card.id ?? null);
- const dispatch = useDispatch();
const hasTimeDimension = useMemo(
() =>
@@ -34,20 +32,14 @@ export function MetricAbout({ card, urls }: MetricAboutProps) {
[definition],
);
- const handleChartClick = useCallback(() => {
- if (card.id != null) {
- dispatch(push(Urls.exploreMetric(card.id)));
- }
- }, [dispatch, card.id]);
-
return (
<Flex className={S.root} flex={1}>
- <Box
- className={S.chartContainer}
- flex={1}
- mah={700}
- onClick={handleChartClick}
- >
+ <Box className={S.chartContainer} flex={1} mah={700}>
+ {isNumericMetric(card) && (
+ <Box className={S.exploreButtonOverlay}>
+ <ExploreMetricButton cardId={card.id} />
+ </Box>
+ )}
{hasTimeDimension ? (
<AboutVisualization card={card} />
) : (
diff --git a/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsx b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsx
new file mode 100644
index 00000000000..3eef4e1e25f
--- /dev/null
+++ b/frontend/src/metabase/metrics/pages/MetricAboutPage/MetricAbout/MetricAbout.unit.spec.tsx
@@ -0,0 +1,116 @@
+import { Route } from "react-router";
+
+import {
+ setupCardEndpoints,
+ setupCardQueryEndpoints,
+ setupCardQueryMetadataEndpoint,
+ setupDatabaseEndpoints,
+ setupMetricEndpoint,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen } from "__support__/ui";
+import { createMockState } from "metabase/redux/store/mocks";
+import type { Card, Field } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockCardQueryMetadata,
+ createMockDataset,
+ createMockDatasetData,
+ createMockField,
+ createMockMetric,
+ createMockNumericColumn,
+} from "metabase-types/api/mocks";
+import {
+ ORDERS_ID,
+ SAMPLE_DB_ID,
+ createSampleDatabase,
+} from "metabase-types/api/mocks/presets";
+
+import { MetricAbout } from "./MetricAbout";
+
+const SAMPLE_DB = createSampleDatabase();
+
+const mockUrls = {
+ about: (id: number) => `/metric/${id}`,
+ overview: (id: number) => `/metric/${id}/overview`,
+ query: (id: number) => `/metric/${id}/query`,
+ dependencies: (id: number) => `/metric/${id}/dependencies`,
+ caching: (id: number) => `/metric/${id}/caching`,
+ history: (id: number) => `/metric/${id}/history`,
+};
+
+function makeMetricCard(resultMetadata: Field[]): Card {
+ return createMockCard({
+ id: 42,
+ type: "metric",
+ database_id: SAMPLE_DB_ID,
+ table_id: ORDERS_ID,
+ result_metadata: resultMetadata,
+ dataset_query: {
+ type: "query",
+ database: SAMPLE_DB_ID,
+ query: {
+ "source-table": ORDERS_ID,
+ aggregation: [["count"]],
+ },
+ },
+ });
+}
+
+function setup(card: Card) {
+ setupDatabaseEndpoints(SAMPLE_DB);
+ setupCardEndpoints(card);
+ setupCardQueryMetadataEndpoint(
+ card,
+ createMockCardQueryMetadata({ databases: [SAMPLE_DB] }),
+ );
+ setupCardQueryEndpoints(
+ card,
+ createMockDataset({
+ data: createMockDatasetData({
+ cols: [createMockNumericColumn({ name: "count" })],
+ rows: [],
+ }),
+ }),
+ );
+ setupMetricEndpoint(createMockMetric({ id: card.id, name: card.name }));
+
+ renderWithProviders(
+ <Route
+ path="/"
+ component={() => <MetricAbout card={card} urls={mockUrls} />}
+ />,
+ {
+ storeInitialState: createMockState(),
+ withRouter: true,
+ initialRoute: "/",
+ },
+ );
+}
+
+describe("MetricAbout", () => {
+ it("renders the Explore button on the chart card for numeric metrics", async () => {
+ setup(
+ makeMetricCard([
+ createMockField({ name: "count", base_type: "type/Integer" }),
+ ]),
+ );
+
+ expect(await screen.findByTestId("explore-link")).toHaveAttribute(
+ "href",
+ "/explore?metricId=42",
+ );
+ });
+
+ it("does not render the Explore button when the metric has no summable column", async () => {
+ setup(
+ makeMetricCard([
+ createMockField({ name: "category", base_type: "type/Text" }),
+ ]),
+ );
+
+ // Wait for the description section to render so the negative assertion
+ // isn't trivially true (the page hasn't loaded yet).
+ expect(await screen.findByText("Source table")).toBeInTheDocument();
+ expect(screen.queryByTestId("explore-link")).not.toBeInTheDocument();
+ });
+});