Skip to content

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

Hide existing metrics from the metric mini picker (#78054)

Andersona492c1091b04
diff --git a/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js b/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js
index cf59857b09a..5e69518c80f 100644
--- a/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js
+++ b/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js
@@ -380,7 +380,8 @@ describe("scenarios > metrics > editing", () => {
H.startNewMetric();
H.MetricPage.queryEditor().should("be.visible");
cy.intercept("POST", "/api/dataset/query_metadata").as("metadata");
- H.miniPicker().within(() => {
+ H.miniPickerBrowseAll().click();
+ H.entityPickerModal().within(() => {
cy.findByText("Our analytics").click();
cy.findByText(ORDERS_SCALAR_METRIC.name).click();
});
diff --git a/frontend/src/metabase/querying/notebook/components/DataStep/DataStep.tsx b/frontend/src/metabase/querying/notebook/components/DataStep/DataStep.tsx
index e89000c40e1..95c16d4475e 100644
--- a/frontend/src/metabase/querying/notebook/components/DataStep/DataStep.tsx
+++ b/frontend/src/metabase/querying/notebook/components/DataStep/DataStep.tsx
@@ -66,6 +66,7 @@ export const DataStep = ({
title={t`Pick your starting data`}
canChangeDatabase
hasMetrics
+ hasMetricsInMiniPicker={!isMetric}
isOpened={isOpened}
setIsOpened={setIsOpened}
isDisabled={readOnly}
diff --git a/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx b/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx
index 01414660b98..ffa502fd567 100644
--- a/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx
+++ b/frontend/src/metabase/querying/notebook/components/DataStep/tests/common.unit.spec.tsx
@@ -13,6 +13,7 @@ import {
} from "metabase-lib/test-helpers";
import Question from "metabase-lib/v1/Question";
import type { CardType, IconName } from "metabase-types/api";
+import { createMockSearchResult } from "metabase-types/api/mocks";
import {
ORDERS_ID,
SAMPLE_DB_ID,
@@ -347,6 +348,25 @@ describe("DataStep", () => {
});
describe("metrics", () => {
+ it("should hide metrics from the mini picker", async () => {
+ const step = createMockNotebookStep({
+ question: DEFAULT_QUESTION.setType("metric"),
+ });
+ const existingMetric = createMockSearchResult({
+ name: "Existing metric",
+ model: "metric",
+ });
+ await setup({ step, searchItems: [existingMetric] });
+
+ await userEvent.click(screen.getByText("Orders"));
+ await userEvent.type(
+ screen.getByPlaceholderText(/search for tables and more/i),
+ "Existing metric",
+ );
+
+ expect(screen.queryByText("Existing metric")).not.toBeInTheDocument();
+ });
+
it("should automatically aggregate by count for metrics", async () => {
const step = createMockNotebookStep({
question: DEFAULT_QUESTION.setType("metric"),
diff --git a/frontend/src/metabase/querying/notebook/components/DataStep/tests/setup.tsx b/frontend/src/metabase/querying/notebook/components/DataStep/tests/setup.tsx
index 979003b292e..4406b16c3a3 100644
--- a/frontend/src/metabase/querying/notebook/components/DataStep/tests/setup.tsx
+++ b/frontend/src/metabase/querying/notebook/components/DataStep/tests/setup.tsx
@@ -9,6 +9,7 @@ import { renderWithProviders, waitForLoaderToBeRemoved } from "__support__/ui";
import { ROOT_COLLECTION } from "metabase/common/collections/constants";
import * as Lib from "metabase-lib";
import { columnFinder } from "metabase-lib/test-helpers";
+import type { SearchResult } from "metabase-types/api";
import {
createMockCollection,
createMockModelResult,
@@ -25,12 +26,14 @@ export interface SetupOpts {
readOnly?: boolean;
isEmbeddingSdk?: boolean;
enterprisePlugins?: Parameters<typeof setupEnterpriseOnlyPlugin>[0][];
+ searchItems?: SearchResult[];
}
export const setup = async ({
step = createMockNotebookStep(),
readOnly = false,
isEmbeddingSdk = false,
enterprisePlugins,
+ searchItems = [],
}: SetupOpts = {}) => {
if (enterprisePlugins) {
enterprisePlugins.forEach((plugin) => {
@@ -55,7 +58,7 @@ export const setup = async ({
}),
]);
} else {
- setupSearchEndpoints([]);
+ setupSearchEndpoints(searchItems);
}
renderWithProviders(
diff --git a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/NotebookDataPicker.tsx b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/NotebookDataPicker.tsx
index 8b4a89e89d5..a85547134d9 100644
--- a/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/NotebookDataPicker.tsx
+++ b/frontend/src/metabase/querying/notebook/components/NotebookDataPicker/NotebookDataPicker.tsx
@@ -42,6 +42,7 @@ export interface NotebookDataPickerProps {
placeholder?: string;
canChangeDatabase: boolean;
hasMetrics: boolean;
+ hasMetricsInMiniPicker?: boolean;
isDisabled: boolean;
isOpened: boolean;
setIsOpened: (isOpened: boolean) => void;
@@ -63,6 +64,7 @@ export function NotebookDataPicker({
placeholder = title,
canChangeDatabase,
hasMetrics,
+ hasMetricsInMiniPicker,
isDisabled,
isOpened,
setIsOpened,
@@ -131,6 +133,7 @@ export function NotebookDataPicker({
placeholder={placeholder}
canChangeDatabase={canChangeDatabase}
hasMetrics={hasMetrics}
+ hasMetricsInMiniPicker={hasMetricsInMiniPicker}
isOpened={isOpened}
setIsOpened={setIsOpened}
isDisabled={isDisabled}
@@ -153,6 +156,7 @@ type ModernDataPickerProps = {
setIsOpened: (isOpened: boolean) => void;
canChangeDatabase: boolean;
hasMetrics: boolean;
+ hasMetricsInMiniPicker?: boolean;
isDisabled: boolean;
onChange: (tableId: TableId) => void;
shouldDisableItem?: (item: OmniPickerItem) => boolean;
@@ -169,6 +173,7 @@ function ModernDataPicker({
setIsOpened,
canChangeDatabase,
hasMetrics,
+ hasMetricsInMiniPicker = hasMetrics,
isDisabled,
onChange,
shouldDisableItem,
@@ -177,7 +182,11 @@ function ModernDataPicker({
}: ModernDataPickerProps) {
const context = useNotebookContext();
const getItemTooltip = context.dataPickerOptions?.getItemTooltip;
- const modelList = getModelFilterList(context, hasMetrics);
+ const modalModelList = getModelFilterList(context, hasMetrics);
+ const miniPickerModelList = getModelFilterList(
+ context,
+ hasMetrics && hasMetricsInMiniPicker,
+ );
const databaseId = Lib.databaseID(query) ?? undefined;
@@ -227,7 +236,7 @@ function ModernDataPicker({
opened={isOpened && !isBrowsing}
onClose={() => setIsOpened(false)}
// minipicker doesn't support picking a database
- models={modelList.filter((model) => model !== "database")}
+ models={miniPickerModelList.filter((model) => model !== "database")}
searchQuery={dataSourceSearchQuery}
onBrowseAll={() => setIsBrowsing(true)}
trapFocus={focusPicker}
@@ -252,7 +261,7 @@ function ModernDataPicker({
title={title}
value={tableValue ?? defaultDbValue}
onlyDatabaseId={canChangeDatabase ? undefined : databaseId}
- models={modelList}
+ models={modalModelList}
onChange={onChange}
onClose={() => {
setIsBrowsing(false);