Skip to content

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

Highlight metric About tab and sidebar bookmark on slugged metric pages (#83664)

Anderson6f0a75baccc8
diff --git a/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx b/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx
index 386fa8b0a37..8a2b1960e70 100644
--- a/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx
+++ b/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.tsx
@@ -49,10 +49,11 @@ function getTabs(
hasDimensions: boolean,
canSeeDependencies: boolean,
): PillTab[] {
+ const aboutUrl = urls.about(card.id);
const tabs: PillTab[] = [
{
label: t`About`,
- to: urls.about(card.id),
+ to: aboutUrl,
},
];
@@ -89,5 +90,16 @@ function getTabs(
to: urls.history(card.id),
});
- return tabs;
+ return tabs.map((tab) => ({
+ ...tab,
+ isSelected: (pathname) => stripMetricSlug(pathname, aboutUrl) === tab.to,
+ }));
+}
+
+function stripMetricSlug(pathname: string, metricUrl: string): string {
+ if (!pathname.startsWith(`${metricUrl}-`)) {
+ return pathname;
+ }
+
+ return `${metricUrl}${pathname.slice(metricUrl.length).replace(/^-[^/]+/, "")}`;
}
diff --git a/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx b/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx
index edc1406ab7d..de200bf0395 100644
--- a/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx
+++ b/frontend/src/metabase/metrics/components/MetricHeader/MetricTabs/MetricTabs.unit.spec.tsx
@@ -22,7 +22,7 @@ import { createSampleDatabase } from "metabase-types/api/mocks/presets";
import { MetricTabs } from "./MetricTabs";
const urls: MetricUrls = {
- about: (id) => `/metric/${id}/about`,
+ about: (id) => `/metric/${id}`,
overview: (id) => `/metric/${id}/overview`,
query: (id) => `/metric/${id}/query`,
dimensions: (id) => `/metric/${id}/dimensions`,
@@ -48,11 +48,13 @@ describe("MetricTabs", () => {
hasDimensions = true,
hasDataPermissions = true,
role = "consumer",
+ initialRoute = "/",
}: {
card?: Partial<Card>;
hasDimensions?: boolean;
hasDataPermissions?: boolean;
role?: "admin" | "analyst" | "consumer";
+ initialRoute?: string;
} = {}) {
const card = createMockCard({
type: "metric",
@@ -85,6 +87,7 @@ describe("MetricTabs", () => {
<Route path="*" element={<MetricTabs card={card} urls={urls} />} />,
{
withRouter: true,
+ initialRoute,
storeInitialState: state,
},
);
@@ -150,6 +153,41 @@ describe("MetricTabs", () => {
});
});
+ it.each([
+ ["About", "/metric/9-revenue"],
+ ["Overview", "/metric/9-revenue/overview"],
+ ["Definition", "/metric/9-revenue/query"],
+ ["Dimensions", "/metric/9-revenue/dimensions"],
+ ["History", "/metric/9-revenue/history"],
+ ["Dependencies", "/metric/9-revenue/dependencies"],
+ ])(
+ "marks %s as the current tab for a slugged metric URL (#83344)",
+ async (label, initialRoute) => {
+ setup({ card: { id: 9 }, initialRoute, role: "admin" });
+
+ expect(await screen.findByRole("link", { name: label })).toHaveAttribute(
+ "aria-current",
+ "page",
+ );
+ expect(
+ screen
+ .getAllByRole("link")
+ .filter((link) => link.getAttribute("aria-current") === "page"),
+ ).toHaveLength(1);
+ },
+ );
+
+ it.each(["/metric/9-revenue/query", "/metric/90-revenue"])(
+ "does not mark About as current at %s (#83344)",
+ async (initialRoute) => {
+ setup({ card: { id: 9 }, initialRoute });
+
+ expect(
+ await screen.findByRole("link", { name: "About" }),
+ ).not.toHaveAttribute("aria-current");
+ },
+ );
+
describe("Dependencies tab (role-gated)", () => {
it("shows for admins", async () => {
setup({ role: "admin" });
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx
index f89561f64db..7bd64972cd3 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx
+++ b/frontend/src/metabase/nav/containers/MainNavbar/MainNavbar.tsx
@@ -138,9 +138,10 @@ function maybeGetQuestionId(
{ location, params }: MainNavbarOwnProps,
) {
const { pathname } = location;
- const canFetchQuestion =
+ const canFetchCard =
isQuestionPath(pathname) || isModelPath(pathname) || isMetricPath(pathname);
- return canFetchQuestion ? Urls.extractEntityId(params.slug) : null;
+ const cardId = isMetricPath(pathname) ? params.cardId : params.slug;
+ return canFetchCard ? Urls.extractEntityId(cardId) : null;
}
function maybeGetCollectionId(
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/getSelectedItems.ts b/frontend/src/metabase/nav/containers/MainNavbar/getSelectedItems.ts
index ba234be5b7f..986a6fe610a 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/getSelectedItems.ts
+++ b/frontend/src/metabase/nav/containers/MainNavbar/getSelectedItems.ts
@@ -111,7 +111,12 @@ export function getSelectedItems({
},
];
}
- if ((isQuestionPath(pathname) || isModelPath(pathname)) && question) {
+ if (
+ (isQuestionPath(pathname) ||
+ isModelPath(pathname) ||
+ isMetricPath(pathname)) &&
+ question
+ ) {
return [
{
id: question.id(),
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/tests/common.unit.spec.tsx b/frontend/src/metabase/nav/containers/MainNavbar/tests/common.unit.spec.tsx
index 7d5a4fb3675..b2e308a4b2c 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/tests/common.unit.spec.tsx
+++ b/frontend/src/metabase/nav/containers/MainNavbar/tests/common.unit.spec.tsx
@@ -5,6 +5,7 @@ import { ROOT_COLLECTION } from "metabase/common/collections/constants";
import { dayjs } from "metabase/dayjs";
import * as Urls from "metabase/urls";
import {
+ createMockBookmark,
createMockCard,
createMockDashboard,
createMockModelResult,
@@ -190,6 +191,61 @@ describe("nav > containers > MainNavbar", () => {
});
});
+ describe("bookmarks", () => {
+ it.each([
+ { route: "/metric/:cardId", pathname: "/metric/9-revenue" },
+ {
+ route: "/metric/:cardId/query",
+ pathname: "/metric/9-revenue/query",
+ },
+ ])(
+ "highlights a metric bookmark on $pathname",
+ async ({ route, pathname }) => {
+ const card = createMockCard({ id: 9, name: "Revenue", type: "metric" });
+ const bookmark = createMockBookmark({
+ id: "card-9",
+ item_id: card.id,
+ type: "card",
+ card_type: "metric",
+ name: card.name,
+ });
+
+ await setup({
+ bookmarks: [bookmark],
+ openQuestionCard: card,
+ route,
+ pathname,
+ });
+
+ expect(
+ screen.getByRole("listitem", { name: "Revenue" }),
+ ).toHaveAttribute("aria-selected", "true");
+ },
+ );
+
+ it("highlights a question bookmark on the question page", async () => {
+ const card = createMockCard({ id: 37, name: "Question" });
+ const bookmark = createMockBookmark({
+ id: "card-37",
+ item_id: card.id,
+ type: "card",
+ card_type: "question",
+ name: card.name,
+ });
+
+ await setup({
+ bookmarks: [bookmark],
+ openQuestionCard: card,
+ route: "/question/:slug",
+ pathname: "/question/37-question",
+ });
+
+ expect(
+ screen.getByRole("listitem", { name: "Question" }),
+ ).toHaveAttribute("aria-selected", "true");
+ });
+ });
+
describe("collection tree", () => {
it("should show collections", async () => {
const {
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/tests/setup.tsx b/frontend/src/metabase/nav/containers/MainNavbar/tests/setup.tsx
index db98983ddd4..f40d5da9996 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/tests/setup.tsx
+++ b/frontend/src/metabase/nav/containers/MainNavbar/tests/setup.tsx
@@ -28,6 +28,7 @@ import type { DashboardState, StoreDashboard } from "metabase/redux/store";
import { Route, useLocation, useParams } from "metabase/router";
import * as iframeUtils from "metabase/utils/iframe";
import type {
+ Bookmark,
Card,
Dashboard,
DashboardId,
@@ -60,6 +61,7 @@ export type SetupOpts = {
withAdditionalDatabase?: boolean;
isUploadEnabled?: boolean;
openQuestionCard?: Card;
+ bookmarks?: Bookmark[];
openDashboard?: Dashboard;
models?: ModelResult[];
canCurateRootCollection?: boolean;
@@ -100,6 +102,7 @@ export async function setup({
hasDataAccess = true,
openDashboard,
openQuestionCard,
+ bookmarks = [],
models = [],
isUploadEnabled = false,
withAdditionalDatabase = true,
@@ -177,7 +180,7 @@ export async function setup({
settingValue: {},
});
- fetchMock.get("path:/api/bookmark", []);
+ fetchMock.get("path:/api/bookmark", bookmarks);
if (openQuestionCard) {
setupCardsEndpoints([openQuestionCard]);
diff --git a/frontend/src/metabase/nav/containers/MainNavbar/types.ts b/frontend/src/metabase/nav/containers/MainNavbar/types.ts
index 7f541bf6d39..7786cfc1598 100644
--- a/frontend/src/metabase/nav/containers/MainNavbar/types.ts
+++ b/frontend/src/metabase/nav/containers/MainNavbar/types.ts
@@ -6,6 +6,7 @@ export interface MainNavbarOwnProps {
location: Location;
params: {
slug?: string;
+ cardId?: string;
pageId?: string;
};
dashboard?: StoreDashboard;