Skip to content

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

Build data apps into the entity picker with a `hasDataApps` option, instead of custom folders (#85348)

Timofey Kachalov0a34a97ceb26
diff --git a/enterprise/frontend/src/metabase-enterprise/data-apps/index.tsx b/enterprise/frontend/src/metabase-enterprise/data-apps/index.tsx
index e2124a0b9e9..0fe6b57135f 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-apps/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-apps/index.tsx
@@ -1,10 +1,15 @@
import { PLUGIN_DATA_APPS } from "metabase/plugins";
+import { useListDataAppsQuery } from "metabase-enterprise/api";
import { hasPremiumFeature } from "metabase-enterprise/settings";
import { getDataStudioDataAppRoutes } from "./data-studio/routes";
import { getRoutes, registerDataAppsPagePrefetch } from "./host/routes";
import { DataAppsNavbarSection } from "./navbar/DataAppsNavbarSection";
+function useDataApps({ skip }: { skip: boolean }) {
+ return useListDataAppsQuery(undefined, { skip });
+}
+
/**
* Initialize data-apps plugin features, gated on the `data-apps` token feature.
*/
@@ -14,6 +19,7 @@ export function initializePlugin() {
PLUGIN_DATA_APPS.getRoutes = getRoutes;
PLUGIN_DATA_APPS.getDataStudioRoutes = getDataStudioDataAppRoutes;
PLUGIN_DATA_APPS.MainNavbarSection = DataAppsNavbarSection;
+ PLUGIN_DATA_APPS.useDataApps = useDataApps;
registerDataAppsPagePrefetch();
}
}
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.tsx
index 385f31b1f5e..3a410512332 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.tsx
@@ -2,15 +2,11 @@ import { useMemo } from "react";
import { t } from "ttag";
import {
- type EntityPickerCustomFolder,
EntityPickerModal,
type OmniPickerItem,
} from "metabase/common/components/Pickers";
-import { useDataApps } from "metabase-enterprise/dependencies/hooks/use-data-apps";
import type { DependencyEntry, DependencyNode } from "metabase-types/api";
-import { getNodeIconWithType } from "../../../../utils";
-
import {
ENTITY_PICKER_OPTIONS,
ENTRY_PICKER_MODELS,
@@ -32,30 +28,6 @@ export function EntryPickerModal({
return value != null ? getEntryPickerItem(value) : undefined;
}, [value]);
- const { data: dataApps = [], isLoading: isLoadingDataApps } = useDataApps();
-
- // data apps aren't collection items, so the picker can't list them itself
- const customFolders = useMemo(
- (): EntityPickerCustomFolder[] =>
- dataApps.length > 0
- ? [
- {
- id: "data-apps",
- name: t`Data apps`,
- items: dataApps.map((dataApp) => ({
- id: dataApp.id,
- name: dataApp.display_name,
- icon: getNodeIconWithType("data-app"),
- isSelected:
- value?.type === "data-app" && value.id === dataApp.id,
- onSelect: () => onChange({ id: dataApp.id, type: "data-app" }),
- })),
- },
- ]
- : [],
- [dataApps, value, onChange],
- );
-
const handleItemSelect = (item: OmniPickerItem) => {
const value = getEntryPickerValue(item);
if (value != null) {
@@ -67,8 +39,6 @@ export function EntryPickerModal({
<EntityPickerModal
title={t`Pick an item to see its dependencies`}
models={ENTRY_PICKER_MODELS}
- customFolders={customFolders}
- isLoadingCustomFolders={isLoadingDataApps}
value={selectedItem}
options={ENTITY_PICKER_OPTIONS}
recentsContext={RECENTS_CONTEXT}
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.unit.spec.tsx
index 44100d80fb0..14e276adf4a 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/EntryPickerModal.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
+import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
import {
setupCollectionByIdEndpoint,
setupCollectionItemsEndpoint,
@@ -19,6 +20,7 @@ import {
screen,
waitFor,
} from "__support__/ui";
+import { reinitialize } from "metabase/plugins";
import { defer } from "metabase/utils/promise";
import { EnterpriseApi } from "metabase-enterprise/api";
import { listTag } from "metabase-enterprise/api/tags";
@@ -47,13 +49,13 @@ const PERSONAL_COLLECTION = createMockCollection({
type SetupOpts = {
dataApps?: DataApp[];
- hasDataApps?: boolean;
+ hasDataAppsFeature?: boolean;
value?: DependencyNode | null;
};
function setup({
dataApps = [OWLS],
- hasDataApps = true,
+ hasDataAppsFeature = true,
value = null,
}: SetupOpts = {}) {
mockGetBoundingClientRect();
@@ -71,23 +73,28 @@ function setup({
collectionItems: [],
});
+ const state = createMockState({
+ settings: mockSettings({
+ "token-features": createMockTokenFeatures({
+ "data-apps": hasDataAppsFeature,
+ }),
+ }),
+ });
+ setupEnterpriseOnlyPlugin("data-apps");
+
const onChange = jest.fn<void, [DependencyEntry]>();
const { store } = renderWithProviders(
<EntryPickerModal value={value} onChange={onChange} onClose={jest.fn()} />,
- {
- storeInitialState: createMockState({
- settings: mockSettings({
- "token-features": createMockTokenFeatures({
- "data-apps": hasDataApps,
- }),
- }),
- }),
- },
+ { storeInitialState: state },
);
return { onChange, store };
}
describe("EntryPickerModal", () => {
+ afterEach(() => {
+ reinitialize();
+ });
+
it("picks a data app from the Data apps folder as the entry", async () => {
const { onChange } = setup();
@@ -97,33 +104,7 @@ describe("EntryPickerModal", () => {
expect(onChange).toHaveBeenCalledWith({ id: 8, type: "data-app" });
});
- it("opens on the data app whose graph is shown, selected", async () => {
- const HERONS = createMockDataApp({
- id: 9,
- name: "herons",
- display_name: "Herons",
- });
- setup({
- dataApps: [OWLS, HERONS],
- value: createMockDataAppDependencyNode({ id: OWLS.id }),
- });
-
- await waitFor(() => {
- expect(screen.getByRole("link", { name: /Owls/ })).toHaveAttribute(
- "data-active",
- "true",
- );
- });
- expect(screen.getByRole("link", { name: /Data apps/ })).toHaveAttribute(
- "data-active",
- "true",
- );
- expect(screen.getByRole("link", { name: /Herons/ })).not.toHaveAttribute(
- "data-active",
- );
- });
-
- it("shows no folder until the app list loads, then opens on the data app", async () => {
+ it("shows the root list only after the app list loads, then opens on the data app", async () => {
const appsResponse = defer<DataApp[]>();
fetchMock.get("path:/api/ee/apps", () => appsResponse.promise);
setup({ value: createMockDataAppDependencyNode({ id: OWLS.id }) });
@@ -176,20 +157,8 @@ describe("EntryPickerModal", () => {
);
});
- it("has no Data apps folder when the user has no data apps", async () => {
- setup({ dataApps: [] });
-
- await screen.findByText("Our analytics");
- await waitFor(() => {
- expect(
- fetchMock.callHistory.called("path:/api/ee/apps", { method: "GET" }),
- ).toBe(true);
- });
- expect(screen.queryByText("Data apps")).not.toBeInTheDocument();
- });
-
it("has no Data apps folder without the data apps feature", async () => {
- setup({ hasDataApps: false });
+ setup({ hasDataAppsFeature: false });
await screen.findByText("Our analytics");
expect(screen.queryByText("Data apps")).not.toBeInTheDocument();
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/constants.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/constants.ts
index 4343820c787..3eb70d5d301 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/constants.ts
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/constants.ts
@@ -8,9 +8,10 @@ export const RECENTS_CONTEXT: RecentContexts[] = ["selections"];
export const ENTITY_PICKER_OPTIONS = {
hasDatabases: true,
+ hasDataApps: true,
hasConfirmButtons: false,
hasRecents: true,
-};
+} satisfies EntityPickerOptions;
export const QUESTION_PICKER_OPTIONS: EntityPickerOptions = {
hasRootCollection: true,
@@ -31,4 +32,5 @@ export const ENTRY_PICKER_MODELS: EntityPickerProps["models"] = [
"transform",
"snippet",
"action",
+ "data-app",
];
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.ts
index c7132bbc866..5f6b3ab657c 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.ts
@@ -1,6 +1,7 @@
import type {
OmniPickerCollectionItem,
OmniPickerCollectionItemValue,
+ OmniPickerDataAppValue,
OmniPickerItem,
OmniPickerQuestionItem,
OmniPickerTableItem,
@@ -122,6 +123,15 @@ export function getActionPickerItem(
};
}
+export function getDataAppPickerItem(
+ node: DependencyNode,
+): OmniPickerDataAppValue | undefined {
+ if (node.type !== "data-app") {
+ return;
+ }
+ return { id: node.id, model: "data-app" };
+}
+
export function getEntryPickerItem(
node: DependencyNode,
): OmniPickerValue | undefined {
@@ -133,7 +143,8 @@ export function getEntryPickerItem(
getMetricPickerItem(node) ??
getDashboardPickerItem(node) ??
getSnippetPickerItem(node) ??
- getActionPickerItem(node)
+ getActionPickerItem(node) ??
+ getDataAppPickerItem(node)
);
}
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.unit.spec.ts
index 4ca78063210..b94a3e2f2fc 100644
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/dependencies/components/DependencyGraph/GraphEntryInput/EntryPickerModal/utils.unit.spec.ts
@@ -3,6 +3,7 @@ import {
createMockActionDependencyNode,
createMockActionDependencyNodeData,
createMockCollection,
+ createMockDataAppDependencyNode,
createMockSnippetDependencyNode,
} from "metabase-types/api/mocks";
@@ -42,6 +43,12 @@ describe("getEntryPickerItem", () => {
});
});
+ it("should select a data app", () => {
+ expect(
+ getEntryPickerItem(createMockDataAppDependencyNode({ id: 8 })),
+ ).toEqual({ id: 8, model: "data-app" });
+ });
+
it("should select an action of a model in the regular namespace", () => {
const node = createMockActionDependencyNode({
id: 5,
@@ -59,6 +66,7 @@ describe("getEntryPickerValue", () => {
it.each<{ item: OmniPickerItem; type: string }>([
{ item: { id: 3, model: "snippet", name: "Snippet" }, type: "snippet" },
{ item: { id: 4, model: "action", name: "Action" }, type: "action" },
+ { item: { id: 8, model: "data-app", name: "Owls" }, type: "data-app" },
])("should open the graph for a picked $type", ({ item, type }) => {
expect(getEntryPickerValue(item)).toEqual({ id: item.id, type });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/hooks/use-data-apps/index.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/hooks/use-data-apps/index.ts
deleted file mode 100644
index 0fb4ac66ae3..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/hooks/use-data-apps/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { useDataApps } from "./use-data-apps";
diff --git a/enterprise/frontend/src/metabase-enterprise/dependencies/hooks/use-data-apps/use-data-apps.ts b/enterprise/frontend/src/metabase-enterprise/dependencies/hooks/use-data-apps/use-data-apps.ts
deleted file mode 100644
index 8f59b4e0572..00000000000
--- a/enterprise/frontend/src/metabase-enterprise/dependencies/hooks/use-data-apps/use-data-apps.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { useHasTokenFeature } from "metabase/common/hooks";
-import { useListDataAppsQuery } from "metabase-enterprise/api";
-
-/**
- * The data apps the user can read. Without the data apps feature, or with `skip`, it sends no
- * request; `hasDataApps` says whether the instance has the feature.
- */
-export function useDataApps({ skip = false }: { skip?: boolean } = {}) {
- const hasDataApps = useHasTokenFeature("data-apps");
- const query = useListDataAppsQuery(undefined, { skip: skip || !hasDataApps });
- return { ...query, hasDataApps };
-}
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/utils/utils.ts b/enterprise/frontend/src/metabase-enterprise/tenants/utils/utils.ts
index a8e0a3121e1..7083adb75e6 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/utils/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/utils/utils.ts
@@ -3,7 +3,7 @@ import { t } from "ttag";
import {
type OmniPickerCollectionItem,
type OmniPickerItem,
- isInDbTree,
+ isInCollectionTree,
} from "metabase/common/components/Pickers";
import type {
Collection,
@@ -51,7 +51,7 @@ export const canPlaceEntityInCollection = ({
if (!entityType) {
return true;
}
- if (isInDbTree(collection)) {
+ if (!isInCollectionTree(collection)) {
return false;
}
diff --git a/frontend/src/metabase/common/collections/containers/FormCollectionAndDashboardPicker/FormCollectionAndDashboardPicker.tsx b/frontend/src/metabase/common/collections/containers/FormCollectionAndDashboardPicker/FormCollectionAndDashboardPicker.tsx
index 05338a7efad..56ed4ddce31 100644
--- a/frontend/src/metabase/common/collections/containers/FormCollectionAndDashboardPicker/FormCollectionAndDashboardPicker.tsx
+++ b/frontend/src/metabase/common/collections/containers/FormCollectionAndDashboardPicker/FormCollectionAndDashboardPicker.tsx
@@ -27,7 +27,7 @@ import type {
} from "metabase/common/components/Pickers";
import {
CollectionPickerModal,
- isInDbTree,
+ isInCollectionTree,
} from "metabase/common/components/Pickers";
import { SnippetCollectionName } from "metabase/common/components/SnippetCollectionName";
import { useUniqueId } from "metabase/common/hooks/use-unique-id";
@@ -193,7 +193,9 @@ export function FormCollectionAndDashboardPicker({
const handleChange = useCallback(
async (item: OmniPickerItem) => {
const { id, model } = item;
- const collection_id = isInDbTree(item) ? undefined : item.collection?.id;
+ const collection_id = isInCollectionTree(item)
+ ? item.collection?.id
+ : undefined;
collectionIdHelpers.setValue(
canonicalCollectionId(model === "dashboard" ? collection_id : id),
diff --git a/frontend/src/metabase/common/components/Pickers/AddToDashSelectDashModal/AddToDashSelectDashModal.tsx b/frontend/src/metabase/common/components/Pickers/AddToDashSelectDashModal/AddToDashSelectDashModal.tsx
index 093d04d75fe..667cc7292fb 100644
--- a/frontend/src/metabase/common/components/Pickers/AddToDashSelectDashModal/AddToDashSelectDashModal.tsx
+++ b/frontend/src/metabase/common/components/Pickers/AddToDashSelectDashModal/AddToDashSelectDashModal.tsx
@@ -10,7 +10,7 @@ import * as Urls from "metabase/urls";
import type { Card, Dashboard } from "metabase-types/api";
import { DashboardPickerModal } from "../DashboardPicker";
-import { type OmniPickerItem, isInDbTree } from "../EntityPicker";
+import { type OmniPickerItem, isInCollectionTree } from "../EntityPicker";
import { getCollectionType } from "../EntityPicker/utils";
import { isInPersonalCollection } from "./utils";
@@ -87,7 +87,7 @@ export const AddToDashSelectDashModal = ({
const shouldDisable = useCallback(
(item: OmniPickerItem) => {
- if (isInDbTree(item)) {
+ if (!isInCollectionTree(item)) {
return true;
}
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/CustomFolderItemList.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/CustomFolderItemList.tsx
deleted file mode 100644
index 2bcbdccb333..00000000000
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/CustomFolderItemList.tsx
+++ /dev/null
@@ -1,38 +0,0 @@
-import { VirtualizedList } from "metabase/common/components/VirtualizedList";
-import { useTranslateContent } from "metabase/content-translation/hooks";
-
-import type { EntityPickerCustomFolder } from "../../types";
-
-import { PickerColumn, PickerItemRow } from "./PickerItemRow";
-
-export const CustomFolderItemList = ({
- folder,
-}: {
- folder: EntityPickerCustomFolder;
-}) => {
- const tc = useTranslateContent();
-
- return (
- <VirtualizedList
- Wrapper={PickerColumn}
- scrollTo={folder.items.findIndex((item) => item.isSelected)}
- estimatedItemSize={37}
- >
- {folder.items.map((item) => (
- <PickerItemRow
- key={item.id}
- label={tc(item.name)}
- icon={{
- name: item.icon,
- c: item.isSelected ? "text-primary-inverse" : "core-brand",
- }}
- isSelected={Boolean(item.isSelected)}
- // a custom folder is a root folder, so its items are the last column
- isCurrentLevel
- containerProps={{ pb: "xxs" }}
- onClick={item.onSelect}
- />
- ))}
- </VirtualizedList>
- );
-};
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/DataAppItemList.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/DataAppItemList.tsx
new file mode 100644
index 00000000000..67b136ff16f
--- /dev/null
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/DataAppItemList.tsx
@@ -0,0 +1,26 @@
+import { useMemo } from "react";
+
+import { PLUGIN_DATA_APPS } from "metabase/plugins";
+
+import { getDataAppItem } from "../../hooks/utils";
+
+import { ItemList } from "./ItemList";
+
+export function DataAppItemList({ pathIndex }: { pathIndex: number }) {
+ const {
+ data: dataApps,
+ isLoading,
+ error,
+ } = PLUGIN_DATA_APPS.useDataApps({ skip: false });
+
+ const items = useMemo(() => dataApps?.map(getDataAppItem), [dataApps]);
+
+ return (
+ <ItemList
+ items={items}
+ isLoading={isLoading}
+ error={error}
+ pathIndex={pathIndex}
+ />
+ );
+}
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx
index 7084c55a2b6..75dbad191ea 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemList.tsx
@@ -1,23 +1,38 @@
+import type React from "react";
import { useMemo } from "react";
+import { EntityIcon } from "metabase/common/components/EntityIcon";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { VirtualizedList } from "metabase/common/components/VirtualizedList";
import { useTranslateContent } from "metabase/content-translation/hooks";
import { getIsTenantUser } from "metabase/current-user";
import { PLUGIN_MODERATION } from "metabase/plugins";
import { useSelector } from "metabase/redux";
-import { type BoxProps, Flex, type NavLinkProps } from "metabase/ui";
+import {
+ Box,
+ type BoxProps,
+ Flex,
+ Icon,
+ NavLink,
+ type NavLinkProps,
+ Tooltip,
+} from "metabase/ui";
import { useOmniPickerContext } from "../../context";
import type { OmniPickerItem } from "../../types";
-import {
- findCustomFolder,
- isSelectedItem,
- useGetEntityPickerIcon,
-} from "../../utils";
+import { isSelectedItem, useGetEntityPickerIcon } from "../../utils";
import { ItemListLoader } from "../ItemListLoader";
-import { PickerColumn, PickerItemRow } from "./PickerItemRow";
+const PickerColumn = ({
+ children,
+ ...props
+}: {
+ children: React.ReactNode;
+}) => (
+ <Box p="1rem" {...props}>
+ {children}
+ </Box>
+);
interface ItemListProps {
pathIndex: number;
@@ -40,7 +55,6 @@ export function ItemList({
const {
path,
setPath,
- customFolders,
isHiddenItem,
isDisabledItem,
isFolderItem,
@@ -52,13 +66,7 @@ export function ItemList({
const filteredItems = useMemo(() => {
return items ? items.filter((i) => !isHiddenItem(i)) : items;
}, [items, isHiddenItem]);
- // A custom folder's selected item isn't in the path, so the folder's own column is a parent level.
- const selectedCustomFolder = selectedItem
- ? findCustomFolder(customFolders, selectedItem)
- : undefined;
- const isCurrentLevel =
- path.length - 2 === pathIndex &&
- !selectedCustomFolder?.items.some((item) => item.isSelected);
+ const isCurrentLevel = path.length - 2 === pathIndex;
const isTenantUser = useSelector(getIsTenantUser);
const getEntityPickerIcon = useGetEntityPickerIcon();
@@ -92,43 +100,69 @@ export function ItemList({
>
{filteredItems.map((item: OmniPickerItem, index) => {
const isSelected = index === activeItemIndex;
+ const icon = getEntityPickerIcon(item, {
+ isSelected: isSelected && isCurrentLevel,
+ isTenantUser,
+ });
+ const isDisabled = isDisabledItem(item);
+ const tooltip = options.getItemTooltip?.(item);
return (
- <PickerItemRow
+ <Box
+ data-testid="picker-item"
key={`${item.model}-${item.id}`}
- label={
- <Flex align="center">
- {tc(item.name)}{" "}
- <PLUGIN_MODERATION.ModerationStatusIcon
- status={"moderated_status" in item && item.moderated_status}
- filled
- size={14}
- ml="0.5rem"
- />
- </Flex>
- }
- icon={getEntityPickerIcon(item, {
- isSelected: isSelected && isCurrentLevel,
- isTenantUser,
- })}
- isSelected={isSelected}
- isCurrentLevel={isCurrentLevel}
- isFolder={isFolderItem(item)}
- isDisabled={isDisabledItem(item)}
- tooltip={options.getItemTooltip?.(item)}
- containerProps={containerProps}
- navLinkProps={navLinkProps?.(isSelected)}
- onClick={() => {
- setPath((prevPath) => [
- ...prevPath.slice(0, pathIndex + 1),
- item,
- ]);
+ {...containerProps}
+ >
+ <Tooltip label={tooltip} disabled={!tooltip} position="right">
+ <NavLink
+ w={"auto"}
+ disabled={isDisabled}
+ style={
+ isDisabled && tooltip ? { pointerEvents: "all" } : undefined
+ }
+ rightSection={
+ isFolderItem(item) ? (
+ <Icon name="chevronright" size={10} />
+ ) : null
+ }
+ mb={0}
+ label={
+ <Flex align="center">
+ {tc(item.name)}{" "}
+ <PLUGIN_MODERATION.ModerationStatusIcon
+ status={
+ "moderated_status" in item && item.moderated_status
+ }
+ filled
+ size={14}
+ ml="0.5rem"
+ />
+ </Flex>
+ }
+ active={isSelected}
+ leftSection={<EntityIcon {...icon} />}
+ onClick={(e: React.MouseEvent) => {
+ e.preventDefault(); // prevent form submission
+ e.stopPropagation(); // prevent parent onClick
+
+ if (isDisabled) {
+ return;
+ }
+
+ setPath((prevPath) => [
+ ...prevPath.slice(0, pathIndex + 1),
+ item,
+ ]);
- if (!options?.hasConfirmButtons && isSelectableItem(item)) {
- onChange(item);
- }
- }}
- />
+ if (!options?.hasConfirmButtons && isSelectableItem(item)) {
+ onChange(item);
+ }
+ }}
+ variant={isCurrentLevel ? "primary" : "secondary"}
+ {...navLinkProps?.(isSelected)}
+ />
+ </Tooltip>
+ </Box>
);
})}
</VirtualizedList>
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemListRouter.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemListRouter.tsx
index 1139dfaf81e..a0ee471f328 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemListRouter.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/ItemListRouter.tsx
@@ -6,12 +6,11 @@ import {
} from "metabase/common/components/Pickers";
import { PLUGIN_TENANTS } from "metabase/plugins";
-import { useOmniPickerContext } from "../../context";
-import { findCustomFolder } from "../../utils";
+import { DATA_APPS_ROOT_ID } from "../../constants";
import { CollectionItemList } from "./CollectionItemList";
-import { CustomFolderItemList } from "./CustomFolderItemList";
import { DashboardItemList } from "./DashboardItemList";
+import { DataAppItemList } from "./DataAppItemList";
import { DbItemList } from "./DbItemList";
import { PersonalCollectionsItemList } from "./PersonalCollectionItemList";
import { RecentsItemList } from "./RecentsItemList";
@@ -35,8 +34,6 @@ export const ItemListRouter = ({
pathIndex: number;
isLoading?: boolean;
}) => {
- const { customFolders } = useOmniPickerContext();
-
if (isLoading) {
return <ItemListLoader />;
}
@@ -46,11 +43,6 @@ export const ItemListRouter = ({
return null;
}
- const customFolder = findCustomFolder(customFolders, parentItem);
- if (customFolder) {
- return <CustomFolderItemList folder={customFolder} />;
- }
-
if (parentItem.model === "collection") {
if (parentItem.id === PERSONAL_COLLECTIONS.id) {
return <PersonalCollectionsItemList pathIndex={pathIndex} />;
@@ -64,6 +56,10 @@ export const ItemListRouter = ({
return <RecentsItemList />;
}
+ if (parentItem.id === DATA_APPS_ROOT_ID) {
+ return <DataAppItemList pathIndex={pathIndex} />;
+ }
+
if (
parentItem.id === "root" &&
parentItem.namespace === PLUGIN_TENANTS.TENANT_SPECIFIC_NAMESPACE
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/PickerItemRow.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/PickerItemRow.tsx
deleted file mode 100644
index f96926704e3..00000000000
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/PickerItemRow.tsx
+++ /dev/null
@@ -1,79 +0,0 @@
-import type React from "react";
-
-import { EntityIcon } from "metabase/common/components/EntityIcon";
-import type { IconData } from "metabase/common/utils/icon";
-import {
- Box,
- type BoxProps,
- Icon,
- NavLink,
- type NavLinkProps,
- Tooltip,
-} from "metabase/ui";
-import type { ColorName } from "metabase/ui/colors/types";
-
-export const PickerColumn = ({
- children,
- ...props
-}: {
- children: React.ReactNode;
-}) => (
- <Box p="1rem" {...props}>
- {children}
- </Box>
-);
-
-type PickerItemRowProps = {
- label: React.ReactNode;
- icon: IconData & { c?: ColorName };
- isSelected: boolean;
- isCurrentLevel: boolean;
- isFolder?: boolean;
- isDisabled?: boolean;
- tooltip?: string;
- containerProps?: BoxProps;
- navLinkProps?: NavLinkProps;
- onClick: () => void;
-};
-
-export function PickerItemRow({
- label,
- icon,
- isSelected,
- isCurrentLevel,
- isFolder = false,
- isDisabled = false,
- tooltip,
- containerProps,
- navLinkProps,
- onClick,
-}: PickerItemRowProps) {
- return (
- <Box data-testid="picker-item" {...containerProps}>
- <Tooltip label={tooltip} disabled={!tooltip} position="right">
- <NavLink
- w={"auto"}
- disabled={isDisabled}
- style={isDisabled && tooltip ? { pointerEvents: "all" } : undefined}
- rightSection={
- isFolder ? <Icon name="chevronright" size={10} /> : null
- }
- mb={0}
- label={label}
- active={isSelected}
- leftSection={<EntityIcon {...icon} />}
- onClick={(e: React.MouseEvent) => {
- e.preventDefault(); // prevent form submission
- e.stopPropagation(); // prevent parent onClick
-
- if (!isDisabled) {
- onClick();
- }
- }}
- variant={isCurrentLevel ? "primary" : "secondary"}
- {...navLinkProps}
- />
- </Tooltip>
- </Box>
- );
-}
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx
index d6d33cd830b..46c0254692d 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResults.tsx
@@ -6,7 +6,6 @@ import { EntityIcon } from "metabase/common/components/EntityIcon";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { VirtualizedList } from "metabase/common/components/VirtualizedList";
import { NoObjectError } from "metabase/common/components/errors/NoObjectError";
-import type { IconData } from "metabase/common/utils/icon";
import { useGetIcon } from "metabase/hooks/use-icon";
import { PLUGIN_LIBRARY, PLUGIN_MODERATION } from "metabase/plugins";
import {
@@ -20,8 +19,6 @@ import {
} from "metabase/ui";
import type {
- EntityPickerCustomFolder,
- EntityPickerCustomItem,
OmniPickerItem,
OmniPickerMeasureItem,
OmniPickerTableItem,
@@ -32,22 +29,16 @@ import {
useCurrentSearchScope,
useGetLastCollection,
} from "../../hooks/use-current-search-scope";
+import { getDataAppsRootItem } from "../../hooks/utils";
import { isSelectedItem, useGetEntityPickerIcon } from "../../utils";
-export type CustomSearchResult = {
- folder: EntityPickerCustomFolder;
- item: EntityPickerCustomItem;
-};
-
export const SearchResults = ({
searchResults,
- customResults = [],
isLoading,
error,
onClick,
}: {
searchResults: OmniPickerItem[];
- customResults?: CustomSearchResult[];
isLoading?: boolean;
error?: unknown;
onClick?: (item: OmniPickerItem, index: number) => void;
@@ -73,7 +64,7 @@ export const SearchResults = ({
);
}
- if (searchResults.length === 0 && customResults.length === 0) {
+ if (searchResults.length === 0) {
return (
<EmptyState
title={t`We didn't find anything`}
@@ -82,42 +73,6 @@ export const SearchResults = ({
);
}
- const customRows = customResults.map(({ folder, item }) => (
- <Box
- key={`custom-${folder.id}-${item.id}`}
- pb="xxs"
- px="sm"
- data-testid="result-item"
- >
- <NavLink
- w={"auto"}
- mb={0}
- label={<Ellipsified maw="21rem">{item.name}</Ellipsified>}
- rightSection={
- <LocationLabel
- icon={{ name: "folder" }}
- text={folder.name}
- isSelected={Boolean(item.isSelected)}
- />
- }
- active={item.isSelected}
- leftSection={
- <EntityIcon
- name={item.icon}
- c={item.isSelected ? "text-primary-inverse" : "core-brand"}
- size="1rem"
- />
- }
- onClick={(e: React.MouseEvent) => {
- e.preventDefault(); // prevent form submission
- e.stopPropagation(); // prevent parent onClick
- item.onSelect();
- }}
- variant="primary"
- />
- </Box>
- ));
-
return (
<VirtualizedList
Wrapper={({ children, ...props }) => (
@@ -127,68 +82,64 @@ export const SearchResults = ({
)}
estimatedItemSize={66}
>
- {customRows.concat(
- searchResults.map((item, index) => {
- const isSelected = isSelectedItem(item, selectedItem);
- const isSelectable = isSelectableItem(item);
-
- return (
- <Box
- key={`${item.model}-${item.id}`}
- pb="xxs"
- px="sm"
- data-testid="result-item"
- data-model-type={item.model}
- >
- <NavLink
- w={"auto"}
- disabled={isDisabledItem(item) || !isSelectable}
- rightSection={
- <LocationInfo item={item} isSelected={isSelected} />
- }
- mb={0}
- label={
- <Flex align="center">
- <Ellipsified maw="21rem">{item.name} </Ellipsified>
- <PLUGIN_MODERATION.ModerationStatusIcon
- status={
- "moderated_status" in item && item.moderated_status
- }
- filled
- size={14}
- ml="0.5rem"
- />
- </Flex>
- }
- active={isSelected}
- leftSection={
- <EntityIcon
- {...getEntityPickerIcon(item, { isSelected })}
- size="1rem"
+ {searchResults?.map((item, index) => {
+ const isSelected = isSelectedItem(item, selectedItem);
+ const isSelectable = isSelectableItem(item);
+
+ return (
+ <Box
+ key={`${item.model}-${item.id}`}
+ pb="xxs"
+ px="sm"
+ data-testid="result-item"
+ data-model-type={item.model}
+ >
+ <NavLink
+ w={"auto"}
+ disabled={isDisabledItem(item) || !isSelectable}
+ rightSection={
+ <LocationInfo item={item} isSelected={isSelected} />
+ }
+ mb={0}
+ label={
+ <Flex align="center">
+ <Ellipsified maw="21rem">{item.name} </Ellipsified>
+ <PLUGIN_MODERATION.ModerationStatusIcon
+ status={"moderated_status" in item && item.moderated_status}
+ filled
+ size={14}
+ ml="0.5rem"
/>
+ </Flex>
+ }
+ active={isSelected}
+ leftSection={
+ <EntityIcon
+ {...getEntityPickerIcon(item, { isSelected })}
+ size="1rem"
+ />
+ }
+ onClick={(e: React.MouseEvent) => {
+ e.preventDefault(); // prevent form submission
+ e.stopPropagation(); // prevent parent onClick
+
+ if (onClick) {
+ onClick(item, index);
}
- onClick={(e: React.MouseEvent) => {
- e.preventDefault(); // prevent form submission
- e.stopPropagation(); // prevent parent onClick
-
- if (onClick) {
- onClick(item, index);
- }
- if (isSelectable) {
- setPath((prevPath) => [...prevPath.slice(0, 1), item]);
+ if (isSelectable) {
+ setPath((prevPath) => [...prevPath.slice(0, 1), item]);
- if (!options?.hasConfirmButtons) {
- onChange(item);
- }
+ if (!options?.hasConfirmButtons) {
+ onChange(item);
}
- }}
- variant="primary"
- />
- </Box>
- );
- }),
- )}
+ }
+ }}
+ variant="primary"
+ />
+ </Box>
+ );
+ })}
</VirtualizedList>
);
};
@@ -215,6 +166,10 @@ const getItemText = (item: OmniPickerItem) => {
return "";
}
+ if (item.model === "data-app") {
+ return getDataAppsRootItem().name;
+ }
+
if (isMeasure(item)) {
return item.table_display_name ?? item.table_name;
}
@@ -260,32 +215,20 @@ const LocationInfo = ({
}
return (
- <LocationLabel icon={iconProps} text={itemText} isSelected={isSelected} />
+ <Flex gap="xxs" align="center">
+ {iconProps && <Icon {...iconProps} size={12} />}
+ <Text
+ size="sm"
+ c={isSelected ? "text-secondary-inverse" : "text-secondary"}
+ >
+ <Ellipsified maw="12rem" data-testid="picker-item-location">
+ {itemText}
+ </Ellipsified>
+ </Text>
+ </Flex>
);
};
-const LocationLabel = ({
- icon,
- text,
- isSelected,
-}: {
- icon: IconData | null;
- text: string;
- isSelected: boolean;
-}) => (
- <Flex gap="xxs" align="center">
- {icon && <Icon {...icon} size={12} />}
- <Text
- size="sm"
- c={isSelected ? "text-secondary-inverse" : "text-secondary"}
- >
- <Ellipsified maw="12rem" data-testid="picker-item-location">
- {text}
- </Ellipsified>
- </Text>
- </Flex>
-);
-
export function SearchScopeSelector() {
const { setSearchScope, options: pickerOptions } = useOmniPickerContext();
const searchScope = useCurrentSearchScope();
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResultsItemList.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResultsItemList.tsx
index aeafb18b962..f26121b72d9 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResultsItemList.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/ItemLists/SearchResultsItemList.tsx
@@ -15,12 +15,9 @@ import {
import { useOmniPickerContext } from "../../context";
import { useCurrentSearchScope } from "../../hooks/use-current-search-scope";
import type { OmniPickerItem } from "../../types";
+import { shouldShowDataApps } from "../../utils";
-import {
- type CustomSearchResult,
- SearchResults,
- SearchScopeSelector,
-} from "./SearchResults";
+import { SearchResults, SearchScopeSelector } from "./SearchResults";
const makeIntoPickerItem = (
item: SearchResult,
@@ -107,35 +104,28 @@ const useApiSearch = ({
export const SearchResultsItemList = () => {
const {
models,
+ options,
searchQuery,
- customFolders,
isHiddenItem,
isDisabledItem,
isSelectableItem,
searchParams,
} = useOmniPickerContext();
- const searchScope = useCurrentSearchScope();
- const customResults = useMemo((): CustomSearchResult[] => {
- const query = searchQuery?.toLowerCase() ?? "";
- // Custom items are in no collection or database, so a search scoped to one leaves them out.
- const isUnscoped = searchScope === null || searchScope === "all";
- if (query.length === 0 || !isUnscoped) {
- return [];
- }
- return (customFolders ?? []).flatMap((folder) =>
- folder.items
- .filter((item) => item.name.toLowerCase().includes(query))
- .map((item) => ({ folder, item })),
- );
- }, [customFolders, searchQuery, searchScope]);
+ const searchableModels = useMemo(
+ () =>
+ shouldShowDataApps({ options, models })
+ ? models
+ : models.filter((model) => model !== "data-app"),
+ [options, models],
+ );
const {
data: results,
error,
isFetching,
} = useApiSearch({
- models,
+ models: searchableModels,
searchQuery,
searchParams,
});
@@ -174,7 +164,6 @@ export const SearchResultsItemList = () => {
<SearchScopeSelector />
<SearchResults
searchResults={filteredResults}
- customResults={customResults}
isLoading={isFetching}
error={error}
onClick={onClick}
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/EntityPickerModal.unit.spec.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/EntityPickerModal.unit.spec.tsx
index 64577f7545d..43b41452a9c 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/EntityPickerModal.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/EntityPickerModal.unit.spec.tsx
@@ -1,10 +1,14 @@
import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
import { findRequests } from "__support__/server-mocks";
import { screen, waitFor, within } from "__support__/ui";
+import { reinitialize } from "metabase/plugins";
import {
createMockCollection,
createMockCollectionItem,
+ createMockDataApp,
+ createMockSearchResult,
} from "metabase-types/api/mocks";
import type { OmniPickerItem } from "../../types";
@@ -166,6 +170,7 @@ const libraryPickerSetup = {
describe("EntityPickerModal", () => {
afterEach(() => {
jest.restoreAllMocks();
+ reinitialize();
});
describe("Default Behavior", () => {
@@ -1079,157 +1084,122 @@ describe("EntityPickerModal", () => {
});
});
- describe("Custom folders", () => {
- it("lists a caller's folder at the root and picks its items through their own handler", async () => {
- const onSelectOwls = jest.fn();
- const { onChange } = await setup({
- customFolders: [
- {
- id: "birds",
- name: "Birds",
- items: [
- { id: 1, name: "Owls", icon: "app", onSelect: onSelectOwls },
- { id: 2, name: "Herons", icon: "app", onSelect: jest.fn() },
- ],
- },
- ],
- });
+ describe("Data apps", () => {
+ const OWLS = createMockDataApp({
+ id: 8,
+ name: "owls",
+ display_name: "Owls",
+ });
+ const HERONS = createMockDataApp({
+ id: 9,
+ name: "herons",
+ display_name: "Herons",
+ });
+ const options = { hasDataApps: true, hasConfirmButtons: false };
+ const models: OmniPickerItem["model"][] = ["card", "data-app"];
- await userEvent.click(await screen.findByText("Birds"));
+ it("lists the user's data apps in a Data apps folder", async () => {
+ await setup({ options, models, dataApps: [OWLS, HERONS] });
+
+ await userEvent.click(await screen.findByText("Data apps"));
+
+ await expectVisibleItem("Owls");
await expectVisibleItem("Herons");
+ const dataAppList = screen.getByTestId("item-picker-level-1");
+ expect(within(dataAppList).getAllByRole("link")).toHaveLength(2);
+ });
+
+ it("picks a data app", async () => {
+ const { onChange } = await setup({ options, models, dataApps: [OWLS] });
+
+ await userEvent.click(await screen.findByText("Data apps"));
await userEvent.click(await screen.findByText("Owls"));
- expect(onSelectOwls).toHaveBeenCalledTimes(1);
- expect(onChange).not.toHaveBeenCalled();
+ expect(onChange).toHaveBeenCalledTimes(1);
+ expect(onChange).toHaveBeenCalledWith({
+ model: "data-app",
+ id: OWLS.id,
+ name: "Owls",
+ });
});
- it("opens on the folder of a caller's selected item, with the item selected", async () => {
- await setup({
- customFolders: [
- {
- id: "birds",
- name: "Birds",
- items: [
- { id: 1, name: "Owls", icon: "app", onSelect: jest.fn() },
- {
- id: 2,
- name: "Herons",
- icon: "app",
- isSelected: true,
- onSelect: jest.fn(),
- },
- ],
- },
- ],
+ it("doesn't pick the Data apps folder when the picker also picks collections", async () => {
+ const { onChange } = await setup({
+ options,
+ models: ["collection", "data-app"],
+ dataApps: [OWLS],
});
- await expectActiveItem("Herons");
- await expectActiveItem("Birds");
- await expectInactiveItem("Owls");
+ await userEvent.click(await screen.findByText("Data apps"));
+
+ await expectVisibleItem("Owls");
+ expect(onChange).not.toHaveBeenCalled();
});
- it("lists a caller's folder above the personal collections", async () => {
- const personalCollection = createMockCollection({
- id: 1,
- name: "Bobby Tables's Personal Collection",
- personal_owner_id: 1,
- location: "/",
- });
+ it("lists the Data apps folder after the other root items", async () => {
+ await setup({ options, models, dataApps: [OWLS] });
+
+ await expectVisibleItem("Data apps");
+ const rootItems = within(
+ screen.getByTestId("item-picker-level-0"),
+ ).getAllByRole("link");
+ expect(rootItems.map((item) => item.textContent?.trim())).toEqual([
+ "Recent items",
+ "Our analytics",
+ "Data apps",
+ ]);
+ });
+
+ it("opens on the data app given as the value", async () => {
await setup({
- isAdmin: true,
- options: { hasRecents: false, hasDatabases: false },
- additionalCollections: [personalCollection],
- additionalCollectionItemEndpoints: [
- { collection: personalCollection, collectionItems: [] },
- ],
- customFolders: [{ id: "birds", name: "Birds", items: [] }],
+ options,
+ models,
+ dataApps: [OWLS, HERONS],
+ value: { model: "data-app", id: HERONS.id },
});
- const rootList = await screen.findByTestId("item-picker-level-0");
- await waitFor(() => {
- expect(
- within(rootList)
- .getAllByRole("link")
- .map((item) => item.textContent?.trim()),
- ).toEqual([
- "SQL Snippets",
- "Our analytics",
- "Birds",
- "Bobby Tables's Personal Collection",
- "All personal collections",
- ]);
- });
+ await expectActiveItem("Data apps");
+ await expectActiveItem("Herons");
+ await expectInactiveItem("Owls");
});
- it("draws the folder of a caller's selected item as a parent of the selection", async () => {
+ it("opens on the data app when the app list arrives after the rest of the picker", async () => {
await setup({
- customFolders: [
- {
- id: "birds",
- name: "Birds",
- items: [
- { id: 1, name: "Owls", icon: "app", onSelect: jest.fn() },
- {
- id: 2,
- name: "Herons",
- icon: "app",
- isSelected: true,
- onSelect: jest.fn(),
- },
- ],
- },
- ],
+ options,
+ models,
+ dataApps: [OWLS, HERONS],
+ dataAppsDelayMs: 300,
+ value: { model: "data-app", id: HERONS.id },
});
+ await expectActiveItem("Data apps");
await expectActiveItem("Herons");
- const activeItems = screen
- .getAllByRole("link")
- .filter((link) => link.getAttribute("data-active") === "true")
- .map((link) => ({
- name: link.textContent?.trim(),
- variant: link.getAttribute("data-variant"),
- }));
- expect(activeItems).toEqual([
- { name: "Birds", variant: "secondary" },
- { name: "Herons", variant: "primary" },
- ]);
});
- it("keeps a built-in folder's own items when a caller's folder has the same id", async () => {
+ it("opens on no data app without the hasDataApps option", async () => {
await setup({
- customFolders: [
- {
- id: "root",
- name: "Birds",
- items: [{ id: 1, name: "Owls", icon: "app", onSelect: jest.fn() }],
- },
- ],
+ options: { hasConfirmButtons: false },
+ models,
+ dataApps: [OWLS],
+ value: { model: "data-app", id: OWLS.id },
});
- await userEvent.click(
- await screen.findByRole("link", { name: /Our analytics/ }),
- );
-
- await waitFor(() => {
- expect(
- within(screen.getByTestId("item-picker-level-1"))
- .getAllByRole("link")
- .map((item) => item.textContent?.trim()),
- ).toEqual(["First Collection", "Second Collection"]);
- });
+ await expectVisibleItem("Our analytics");
+ expect(screen.queryByText("Owls")).not.toBeInTheDocument();
+ expect(fetchMock.callHistory.called("path:/api/ee/apps")).toBe(false);
});
- it("finds a caller's item by its name in the search", async () => {
- await setup({
- customFolders: [
- {
- id: "birds",
- name: "Birds",
- items: [
- { id: 1, name: "Owls", icon: "app", onSelect: jest.fn() },
- { id: 2, name: "Herons", icon: "app", onSelect: jest.fn() },
- ],
- },
+ it("finds a data app in search, located in the Data apps folder", async () => {
+ const { onChange } = await setup({
+ options,
+ models,
+ dataApps: [OWLS],
+ searchResults: [
+ createMockSearchResult({
+ model: "data-app",
+ id: OWLS.id,
+ name: "Owls",
+ }),
],
});
@@ -1238,44 +1208,92 @@ describe("EntityPickerModal", () => {
"Owls",
{ delay: 50 },
);
- await expectActiveItem('Search results for "Owls"');
- await expectVisibleItem("Search Result Card 3");
-
- const searchList = screen.getByTestId("item-picker-level-1");
+ const result = await screen.findByTestId("result-item");
expect(
- within(searchList).getByRole("link", { name: /Owls/ }),
- ).toBeVisible();
- expect(
- within(searchList).queryByRole("link", { name: /Herons/ }),
- ).not.toBeInTheDocument();
+ within(result).getByTestId("picker-item-location"),
+ ).toHaveTextContent("Data apps");
+ const searches = (await findRequests("GET")).filter((request) =>
+ request.url.includes("/api/search"),
+ );
+ expect(searches.at(-1)?.url).toContain("models=data-app");
+
+ await userEvent.click(within(result).getByText("Owls"));
+ expect(onChange).toHaveBeenCalledTimes(1);
+ expect(onChange).toHaveBeenCalledWith(
+ expect.objectContaining({ model: "data-app", id: OWLS.id }),
+ );
});
- it("leaves a caller's items out of a search scoped to a collection", async () => {
+ it("doesn't search data apps without the hasDataApps option", async () => {
await setup({
- customFolders: [
- {
- id: "birds",
- name: "Birds",
- items: [{ id: 1, name: "Owls", icon: "app", onSelect: jest.fn() }],
- },
+ options: { hasConfirmButtons: false },
+ models,
+ dataApps: [OWLS],
+ searchResults: [
+ createMockSearchResult({
+ model: "data-app",
+ id: OWLS.id,
+ name: "Owls",
+ }),
+ createMockSearchResult({
+ model: "card",
+ id: 1,
+ name: "Owl sightings",
+ }),
],
});
- await userEvent.click(await screen.findByText("Our analytics"));
- await userEvent.click(await screen.findByText("First Collection"));
await userEvent.type(
await screen.findByPlaceholderText("Search…"),
- "Owls",
+ "Owl",
{ delay: 50 },
);
- await expectActiveItem('Search results for "Owls"');
- await expectVisibleItem("Search Result Card 3");
+ await expectVisibleItem("Owl sightings");
+ expect(screen.queryByText("Owls")).not.toBeInTheDocument();
+ const searches = (await findRequests("GET")).filter((request) =>
+ request.url.includes("/api/search"),
+ );
+ expect(searches.at(-1)?.url).not.toContain("models=data-app");
+ });
- expect(
- within(screen.getByTestId("item-picker-level-1")).queryByRole("link", {
- name: /Owls/,
- }),
- ).not.toBeInTheDocument();
+ it("has no Data apps folder without the hasDataApps option", async () => {
+ await setup({
+ options: { hasConfirmButtons: false },
+ models,
+ dataApps: [OWLS],
+ });
+
+ await expectVisibleItem("Our analytics");
+ expect(screen.queryByText("Data apps")).not.toBeInTheDocument();
+ expect(fetchMock.callHistory.called("path:/api/ee/apps")).toBe(false);
+ });
+
+ it("has no Data apps folder when the picker doesn't pick data apps", async () => {
+ await setup({ options, models: ["card"], dataApps: [OWLS] });
+
+ await expectVisibleItem("Our analytics");
+ expect(screen.queryByText("Data apps")).not.toBeInTheDocument();
+ });
+
+ it("has no Data apps folder when the picker picks collections but not data apps", async () => {
+ await setup({
+ options,
+ models: ["card", "collection"],
+ dataApps: [OWLS],
+ });
+
+ await expectVisibleItem("Our analytics");
+ expect(screen.queryByText("Data apps")).not.toBeInTheDocument();
+ });
+
+ it("has no Data apps folder when the user has no data apps", async () => {
+ await setup({ options, models, dataApps: [] });
+
+ await expectVisibleItem("Our analytics");
+ await waitFor(() => {
+ expect(fetchMock.callHistory.called("path:/api/ee/apps")).toBe(true);
+ });
+ expect(screen.queryByText("Data apps")).not.toBeInTheDocument();
});
});
});
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/setup.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/setup.tsx
index 9fa50efd9a8..f8c5b4d2b34 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/setup.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/components/test/setup.tsx
@@ -6,8 +6,10 @@ import {
setupCollectionItemsEndpoint,
setupCollectionsEndpoints,
setupDatabasesEndpoints,
+ setupListDataAppsEndpoint,
setupRecentViewsAndSelectionsEndpoints,
setupRootCollectionItemsEndpoint,
+ setupSearchEndpoints,
} from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
@@ -20,6 +22,7 @@ import { ROOT_COLLECTION } from "metabase/common/collections/constants";
import type {
Collection,
CollectionItem,
+ DataApp,
Database,
LibraryCollection,
RecentItem,
@@ -35,7 +38,6 @@ import {
createMockSearchResults,
createMockTable,
createMockTokenFeatures,
- createMockUser,
} from "metabase-types/api/mocks";
import {
@@ -357,7 +359,9 @@ export type SetupOpts = Partial<EntityPickerModalProps> & {
}>;
libraryCollection?: Collection;
libraryCollectionItems?: CollectionItem[];
- isAdmin?: boolean;
+ /** The data apps the user can read; turns on the data apps feature. */
+ dataApps?: DataApp[];
+ dataAppsDelayMs?: number;
};
export const setup = async ({
@@ -366,7 +370,9 @@ export const setup = async ({
databases,
libraryCollection,
libraryCollectionItems,
- isAdmin = false,
+ dataApps,
+ dataAppsDelayMs,
+ searchResults,
...rest
}: SetupOpts = {}) => {
process.env.OVERSCAN = "20"; // for VirtualizedList overscan
@@ -382,18 +388,27 @@ export const setup = async ({
? createMockLibraryCollectionItem(libraryCollection)
: undefined;
- const state = createMockState({
- currentUser: createMockUser({ is_superuser: isAdmin }),
- ...(libraryCollectionItem && {
- settings: mockSettings({
- "token-features": createMockTokenFeatures({ library: true }),
- }),
- }),
- });
+ const hasLibrary = libraryCollectionItem !== undefined;
+ const hasDataAppsFeature = dataApps !== undefined;
+ const state =
+ hasLibrary || hasDataAppsFeature
+ ? createMockState({
+ settings: mockSettings({
+ "token-features": createMockTokenFeatures({
+ library: hasLibrary,
+ "data-apps": hasDataAppsFeature,
+ }),
+ }),
+ })
+ : undefined;
- if (libraryCollectionItem) {
+ if (hasLibrary) {
setupEnterpriseOnlyPlugin("library");
}
+ if (dataApps) {
+ setupEnterpriseOnlyPlugin("data-apps");
+ setupListDataAppsEndpoint(dataApps, dataAppsDelayMs);
+ }
fetchMock.get(
"path:/api/ee/library",
libraryCollectionItem ?? {
@@ -453,7 +468,11 @@ export const setup = async ({
setupCollectionItemsEndpoint(endpoint);
}
- fetchMock.get("path:/api/search", mockSearchResults);
+ if (searchResults) {
+ setupSearchEndpoints(searchResults);
+ } else {
+ fetchMock.get("path:/api/search", mockSearchResults);
+ }
fetchMock.get("path:/api/user/recipients", { data: [] });
const onChange = jest.fn();
const onClose = jest.fn();
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/constants.ts b/frontend/src/metabase/common/components/Pickers/EntityPicker/constants.ts
index 7d035716a3e..c2b9d0417b3 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/constants.ts
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/constants.ts
@@ -3,3 +3,5 @@
* searches.
*/
export const SEARCH_DEBOUNCE_MS = 300;
+
+export const DATA_APPS_ROOT_ID = "data-apps";
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/context.tsx b/frontend/src/metabase/common/components/Pickers/EntityPicker/context.tsx
index 2f25b5ebf79..892e2810ec2 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/context.tsx
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/context.tsx
@@ -9,7 +9,11 @@ import type {
OmniPickerItem,
SearchScope,
} from "./types";
-import { getItemFunctions, getNamespacesFromModels } from "./utils";
+import {
+ getItemFunctions,
+ getNamespacesFromModels,
+ shouldShowDataApps,
+} from "./utils";
export const OmniPickerContext = createContext<
OmniPickerContextValue | undefined
@@ -29,11 +33,10 @@ export const EntityPickerProvider = ({
const [path, setPath, { isLoadingPath }] = useGetPathFromValue({
value: value.value,
- customFolders: value.customFolders,
- isLoadingCustomFolders: value.isLoadingCustomFolders,
options: value.options,
namespaces,
models: getValidCollectionItemModels(value.models),
+ showsDataApps: shouldShowDataApps(value),
});
const [previousPath, setPreviousPath] = useState<OmniPickerItem[]>([]);
@@ -44,7 +47,6 @@ export const EntityPickerProvider = ({
() =>
getItemFunctions({
models: value.models,
- customFolders: value.customFolders,
isFolderItem: value.isFolderItem,
isHiddenItem: value.isHiddenItem,
isDisabledItem: value.isDisabledItem,
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-path-from-value.ts b/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-path-from-value.ts
index 487f8966abc..00f5020a29a 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-path-from-value.ts
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-path-from-value.ts
@@ -18,17 +18,17 @@ import {
getCollectionItemsOptions,
} from "metabase/common/components/Pickers/utils";
import { useGetPersonalCollection } from "metabase/common/hooks/use-get-personal-collection";
-import { PLUGIN_LIBRARY } from "metabase/plugins";
+import { PLUGIN_DATA_APPS, PLUGIN_LIBRARY } from "metabase/plugins";
import { type DispatchFn, useDispatch } from "metabase/redux";
import type {
Collection,
CollectionNamespace,
+ DataApp,
LibraryCollection,
SchemaName,
} from "metabase-types/api";
import type {
- EntityPickerCustomFolder,
EntityPickerOptions,
OmniPickerCollectionItem,
OmniPickerCollectionItemValue,
@@ -37,9 +37,13 @@ import type {
OmniPickerTableValue,
OmniPickerValue,
} from "../types";
-import { getCustomFolderItem } from "../utils";
-import { getRootCollectionItem, personalCollectionsRoot } from "./utils";
+import {
+ getDataAppItem,
+ getDataAppsRootItem,
+ getRootCollectionItem,
+ personalCollectionsRoot,
+} from "./utils";
const getDefaultPath = async ({
options,
@@ -94,18 +98,16 @@ const getDefaultPath = async ({
export function useGetPathFromValue({
value,
- customFolders,
- isLoadingCustomFolders = false,
options,
namespaces,
models,
+ showsDataApps = false,
}: {
value?: OmniPickerValue;
- customFolders?: EntityPickerCustomFolder[];
- isLoadingCustomFolders?: boolean;
options: EntityPickerOptions;
namespaces: CollectionNamespace[];
models: OmniPickerCollectionItem["model"][];
+ showsDataApps?: boolean;
}) {
const [path, setPath] = useState<OmniPickerItem[]>([]);
const [isLoadingPath, setIsLoadingPath] = useState(false);
@@ -118,28 +120,24 @@ export function useGetPathFromValue({
const { data: personalCollection, isLoading: isLoadingPersonalCollection } =
useGetPersonalCollection();
+ const { data: dataApps, isLoading: isLoadingDataApps } =
+ PLUGIN_DATA_APPS.useDataApps({
+ skip: !showsDataApps || value?.model !== "data-app",
+ });
+
+ // `dataApps` isn't a dependency: a refetch of the list must not move the user out of the folder
+ // they opened.
useDeepCompareEffect(() => {
if (
isLoadingLibraryCollection ||
isLoadingPersonalCollection ||
- isLoadingCustomFolders
+ isLoadingDataApps
) {
return;
}
setIsLoadingPath(true);
- // Not a dependency: once the picker has opened, a change to the custom folders must not replace
- // the folder the user is in.
- const selectedCustomFolder = customFolders?.find((folder) =>
- folder.items.some((item) => item.isSelected),
- );
- if (!value && selectedCustomFolder) {
- setPath([getCustomFolderItem(selectedCustomFolder)]);
- setIsLoadingPath(false);
- return;
- }
-
if (!value) {
getDefaultPath({
options,
@@ -159,6 +157,7 @@ export function useGetPathFromValue({
dispatch,
libraryCollection,
personalCollection,
+ dataApps,
models,
}).then((newPath) => {
setPath(newPath);
@@ -170,7 +169,7 @@ export function useGetPathFromValue({
libraryCollection,
isLoadingLibraryCollection,
isLoadingPersonalCollection,
- isLoadingCustomFolders,
+ isLoadingDataApps,
]);
return [path, setPath, { isLoadingPath }] as const;
@@ -187,12 +186,14 @@ async function getPathFromValue({
dispatch,
libraryCollection,
personalCollection,
+ dataApps,
models,
}: {
value: OmniPickerValue;
dispatch: DispatchFn;
libraryCollection?: LibraryCollection;
personalCollection?: Collection;
+ dataApps?: DataApp[];
models: OmniPickerCollectionItem["model"][];
}): Promise<OmniPickerItem[]> {
if (value.id === "databases") {
@@ -203,6 +204,11 @@ async function getPathFromValue({
return [getFakeRecentsCollection()];
}
+ if (value.model === "data-app") {
+ const dataApp = dataApps?.find((dataApp) => dataApp.id === value.id);
+ return dataApp ? [getDataAppsRootItem(), getDataAppItem(dataApp)] : [];
+ }
+
if (!isInDbPath(value)) {
return getCollectionPathFromValue({
value,
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-root-items.ts b/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-root-items.ts
index be97a48c7ee..64cf6f7830a 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-root-items.ts
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/use-get-root-items.ts
@@ -1,4 +1,4 @@
-import { useMemo, useState } from "react";
+import { useState } from "react";
import { useDeepCompareEffect } from "react-use";
import { t } from "ttag";
@@ -14,7 +14,11 @@ import {
useHasTokenFeature,
} from "metabase/common/hooks";
import { getUser, getUserIsAdmin } from "metabase/current-user";
-import { PLUGIN_LIBRARY, PLUGIN_TENANTS } from "metabase/plugins";
+import {
+ PLUGIN_DATA_APPS,
+ PLUGIN_LIBRARY,
+ PLUGIN_TENANTS,
+} from "metabase/plugins";
import { type DispatchFn, useDispatch, useSelector } from "metabase/redux";
import { useSetting } from "metabase/settings";
import { mergeLazily } from "metabase/utils/merge-lazily";
@@ -31,9 +35,9 @@ import type {
OmniPickerCollectionItem,
OmniPickerItem,
} from "../types";
-import { getCustomFolderItem } from "../utils";
+import { shouldShowDataApps } from "../utils";
-import { getRootCollectionItem } from "./utils";
+import { getDataAppsRootItem, getRootCollectionItem } from "./utils";
const personalCollectionsRoot: OmniPickerCollectionItem = mergeLazily(
PERSONAL_COLLECTIONS,
@@ -50,14 +54,7 @@ const personalCollectionsRoot: OmniPickerCollectionItem = mergeLazily(
* This will generate a list of the top level items for the entity picker
*/
export const useRootItems = () => {
- const {
- options,
- models,
- searchQuery,
- namespaces,
- customFolders,
- isLoadingCustomFolders = false,
- } = useOmniPickerContext();
+ const { options, models, searchQuery, namespaces } = useOmniPickerContext();
const isAdmin = useSelector(getUserIsAdmin);
const hasTenants = useSetting("use-tenants");
const transformsEnabled = useHasTokenFeature("transforms-basic");
@@ -66,6 +63,10 @@ export const useRootItems = () => {
const { data: databaseData, isLoading: isLoadingDatabases } =
useListDatabasesQuery(undefined, { skip: !options.hasDatabases });
const tenantsEnabled = useSetting("use-tenants");
+ const showsDataApps = shouldShowDataApps({ options, models });
+ const { data: dataApps, isLoading: isLoadingDataApps } =
+ PLUGIN_DATA_APPS.useDataApps({ skip: !showsDataApps });
+ const hasDataAppsFolder = showsDataApps && (dataApps?.length ?? 0) > 0;
const currentUser = useSelector(getUser);
const [isLoadingCollections, setIsLoadingCollections] = useState(false);
@@ -91,13 +92,6 @@ export const useRootItems = () => {
);
const totalPersonalCollectionItems = personalCollectionItems?.total ?? 0;
- // Folders without their items: the effect below deep-compares its deps, and callers may pass new
- // item handlers on any render.
- const customRootItems = useMemo(
- () => (customFolders ?? []).map(getCustomFolderItem),
- [customFolders],
- );
-
useDeepCompareEffect(() => {
const databases = databaseData?.data ?? [];
setIsLoadingCollections(true);
@@ -107,6 +101,7 @@ export const useRootItems = () => {
isAdmin,
options,
databases,
+ hasDataAppsFolder,
totalPersonalCollectionItems,
libraryCollection,
namespaces,
@@ -115,7 +110,6 @@ export const useRootItems = () => {
transformsEnabled,
currentUser,
hasTenants,
- customRootItems,
dispatch,
})
.then((rootItems) => {
@@ -130,6 +124,7 @@ export const useRootItems = () => {
isAdmin,
options,
databaseData?.data,
+ hasDataAppsFolder,
totalPersonalCollectionItems,
libraryCollection,
namespaces,
@@ -138,17 +133,16 @@ export const useRootItems = () => {
transformsEnabled,
currentUser,
hasTenants,
- customRootItems,
setIsLoadingCollections,
dispatch,
]);
const isLoading =
isLoadingDatabases ||
+ isLoadingDataApps ||
isLoadingCollections ||
isLoadingPersonalCollection ||
- isLoadingPersonalCollectionItems ||
- isLoadingCustomFolders;
+ isLoadingPersonalCollectionItems;
return { items: rootItems, isLoading };
};
@@ -159,6 +153,7 @@ async function getRootItems({
isAdmin,
options,
databases,
+ hasDataAppsFolder,
totalPersonalCollectionItems,
libraryCollection,
namespaces,
@@ -167,7 +162,6 @@ async function getRootItems({
transformsEnabled,
currentUser,
hasTenants,
- customRootItems,
dispatch,
}: {
searchQuery?: string;
@@ -175,6 +169,7 @@ async function getRootItems({
isAdmin: boolean;
options: EntityPickerOptions;
databases: Database[];
+ hasDataAppsFolder: boolean;
totalPersonalCollectionItems: number;
libraryCollection?: OmniPickerItem;
namespaces: CollectionNamespace[];
@@ -183,7 +178,6 @@ async function getRootItems({
transformsEnabled: boolean;
currentUser: User | null;
hasTenants: boolean;
- customRootItems: OmniPickerCollectionItem[];
dispatch: DispatchFn;
}): Promise<OmniPickerCollectionItem[]> {
const collectionItems: OmniPickerCollectionItem[] = [];
@@ -321,8 +315,6 @@ async function getRootItems({
}
}
- collectionItems.push(...customRootItems);
-
if (
options?.hasPersonalCollections &&
namespaces.includes(null) &&
@@ -348,5 +340,10 @@ async function getRootItems({
});
}
}
+
+ if (hasDataAppsFolder) {
+ collectionItems.push(getDataAppsRootItem());
+ }
+
return collectionItems;
}
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/utils.ts b/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/utils.ts
index dab1287f27e..4f615f3ca5e 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/utils.ts
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/hooks/utils.ts
@@ -6,9 +6,10 @@ import { allCollectionModels } from "metabase/common/components/Pickers/utils";
import { PLUGIN_TENANTS } from "metabase/plugins";
import type { DispatchFn } from "metabase/redux";
import { mergeLazily } from "metabase/utils/merge-lazily";
-import type { CollectionNamespace } from "metabase-types/api";
+import type { CollectionNamespace, DataApp } from "metabase-types/api";
-import type { OmniPickerCollectionItem } from "../types";
+import { DATA_APPS_ROOT_ID } from "../constants";
+import type { OmniPickerCollectionItem, OmniPickerDataAppItem } from "../types";
const getTransformsRootCollectionItem = ({
namespace,
@@ -29,6 +30,20 @@ const getTransformsRootCollectionItem = ({
return null;
};
+export const getDataAppsRootItem = (): OmniPickerCollectionItem => ({
+ model: "collection",
+ id: DATA_APPS_ROOT_ID,
+ name: t`Data apps`,
+ location: "/",
+ can_write: false,
+});
+
+export const getDataAppItem = (dataApp: DataApp): OmniPickerDataAppItem => ({
+ model: "data-app",
+ id: dataApp.id,
+ name: dataApp.display_name,
+});
+
export const getOurAnalytics = (): OmniPickerCollectionItem => ({
model: "collection",
id: "root",
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/types.ts b/frontend/src/metabase/common/components/Pickers/EntityPicker/types.ts
index 3816735f7a4..0afd3fed1aa 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/types.ts
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/types.ts
@@ -8,8 +8,8 @@ import type {
CollectionNamespace,
CollectionType,
DashboardId,
+ DataAppId,
DatabaseId,
- IconName,
Measure,
MeasureId,
NativeQuerySnippet,
@@ -25,6 +25,7 @@ export type EntityPickerOptions = {
hasSearch?: boolean;
hasRecents?: boolean;
hasDatabases?: boolean;
+ hasDataApps?: boolean;
hasLibrary?: boolean;
hasRootCollection?: boolean;
hasPersonalCollections?: boolean; // other users personal collections
@@ -48,38 +49,11 @@ export type PickerItemFunctions = {
isSelectableItem: (item: OmniPickerItem) => boolean;
};
-/**
- * A root folder a caller adds for things the picker doesn't know. Its `id` must be unique among the
- * caller's folders. A search that isn't scoped to a collection lists its matching items; recent
- * items never do. Picking one of its items calls that item's `onSelect` right away, instead of
- * `onChange`, also when the picker has confirm buttons.
- */
-export type EntityPickerCustomFolder = {
- id: string;
- name: string;
- items: EntityPickerCustomItem[];
-};
-
-export type EntityPickerCustomItem = {
- id: string | number;
- name: string;
- icon: IconName;
- /**
- * Shows the item as selected. When the picker has no `value`, it opens on the first folder that
- * has a selected item.
- */
- isSelected?: boolean;
- onSelect: () => void;
-};
-
export type EntityPickerProps = {
onChange: (value: OmniPickerItem) => void;
onClose: () => void;
models: OmniPickerItem["model"][];
namespaces?: CollectionNamespace[];
- customFolders?: EntityPickerCustomFolder[];
- /** While true, the picker waits for `customFolders` before it chooses the folder to open. */
- isLoadingCustomFolders?: boolean;
options: EntityPickerOptions;
searchParams?: Partial<SearchRequest>;
value?: OmniPickerValue;
@@ -192,6 +166,12 @@ export type OmniPickerSnippetItem = Pick<NativeQuerySnippet, "id" | "name"> & {
model: "snippet";
};
+export type OmniPickerDataAppItem = {
+ model: "data-app";
+ id: DataAppId;
+ name: string;
+};
+
export enum OmniPickerFolderModel {
Database = "database",
Schema = "schema",
@@ -206,7 +186,7 @@ export type DbTreeItem =
| OmniPickerTableItem
| OmniPickerMeasureItem;
-export const isInDbTree = (item: OmniPickerItem): item is DbTreeItem => {
+const isInDbTree = (item: OmniPickerItem): item is DbTreeItem => {
return (
item.model === "database" ||
item.model === "schema" ||
@@ -215,13 +195,19 @@ export const isInDbTree = (item: OmniPickerItem): item is DbTreeItem => {
);
};
+export const isInCollectionTree = (
+ item: OmniPickerItem,
+): item is OmniPickerCollectionItem =>
+ !isInDbTree(item) && item.model !== "data-app";
+
// this includes all possible item types that can be shown in the mini picker
export type OmniPickerItem =
| OmniPickerCollectionItem
| OmniPickerSchemaItem
| OmniPickerTableItem
| OmniPickerDatabaseItem
- | OmniPickerMeasureItem;
+ | OmniPickerMeasureItem
+ | OmniPickerDataAppItem;
export type OmniPickerDbValue = Pick<DbTreeItem, "model" | "id">;
export type OmniPickerTableValue = Pick<OmniPickerTableItem, "model" | "id">;
@@ -229,8 +215,15 @@ export type OmniPickerCollectionItemValue = Pick<
OmniPickerCollectionItem,
"model" | "id" | "namespace"
>;
+export type OmniPickerDataAppValue = Pick<
+ OmniPickerDataAppItem,
+ "model" | "id"
+>;
-export type OmniPickerValue = OmniPickerDbValue | OmniPickerCollectionItemValue;
+export type OmniPickerValue =
+ | OmniPickerDbValue
+ | OmniPickerCollectionItemValue
+ | OmniPickerDataAppValue;
// this is only the intermediate/folder types that cannot ultimately be picked
export type OmniPickerFolderItem =
diff --git a/frontend/src/metabase/common/components/Pickers/EntityPicker/utils.ts b/frontend/src/metabase/common/components/Pickers/EntityPicker/utils.ts
index 6b99a935ce2..22f87d39392 100644
--- a/frontend/src/metabase/common/components/Pickers/EntityPicker/utils.ts
+++ b/frontend/src/metabase/common/components/Pickers/EntityPicker/utils.ts
@@ -6,8 +6,8 @@ import type { ColorName } from "metabase/ui/colors/types";
import type { CollectionNamespace, CollectionType } from "metabase-types/api";
import { isObject } from "metabase-types/guards";
+import { DATA_APPS_ROOT_ID } from "./constants";
import {
- type EntityPickerCustomFolder,
type EntityPickerProps,
type OmniPickerCollectionItem,
type OmniPickerFolderItem,
@@ -77,27 +77,14 @@ export const isSelectedItem = (
);
};
-// Built-in root folders have ids such as "root" and "recents", which a caller's folder id must not
-// take over.
-const CUSTOM_FOLDER_ID_PREFIX = "custom-folder:";
-
-export const getCustomFolderItem = (
- folder: EntityPickerCustomFolder,
-): OmniPickerCollectionItem => ({
- id: `${CUSTOM_FOLDER_ID_PREFIX}${folder.id}`,
- model: "collection",
- name: folder.name,
- location: "/",
- can_write: false,
-});
-
-export const findCustomFolder = (
- customFolders: EntityPickerCustomFolder[] = [],
- item: OmniPickerItem,
-): EntityPickerCustomFolder | undefined =>
- item.model === "collection"
- ? customFolders.find((folder) => getCustomFolderItem(folder).id === item.id)
- : undefined;
+const isDataAppsRootItem = (item: OmniPickerItem): boolean =>
+ item.model === "collection" && item.id === DATA_APPS_ROOT_ID;
+
+export const shouldShowDataApps = ({
+ options,
+ models,
+}: Pick<EntityPickerProps, "options" | "models">): boolean =>
+ options.hasDataApps === true && models.includes("data-app");
const isValidItem = (item: unknown): item is OmniPickerItem => {
return (
@@ -117,28 +104,20 @@ const isValidItem = (item: unknown): item is OmniPickerItem => {
export function getItemFunctions({
models,
- customFolders = [],
isFolderItem,
isHiddenItem,
isDisabledItem,
isSelectableItem,
}: {
models: EntityPickerProps["models"];
- customFolders?: EntityPickerProps["customFolders"];
} & Partial<PickerItemFunctions>): PickerItemFunctions {
const modelSet = new Set(models);
- const isCustomFolder = (item: OmniPickerItem) =>
- findCustomFolder(customFolders, item) !== undefined;
const isFolderBase = (item: OmniPickerItem | unknown) => {
if (!isValidItem(item)) {
return false;
}
- if (isCustomFolder(item)) {
- return true;
- }
-
if (
item.model === OmniPickerFolderModel.Database ||
item.model === OmniPickerFolderModel.Schema
@@ -155,6 +134,10 @@ export function getItemFunctions({
return true;
}
+ if (isDataAppsRootItem(item)) {
+ return modelSet.has("data-app");
+ }
+
if (item.model === OmniPickerFolderModel.Collection) {
if (!("here" in item) && !("below" in item)) {
return false;
@@ -194,7 +177,7 @@ export function getItemFunctions({
// selectable should be narrower than hidden or disabled because
// intermediate items should not be disabled, but can't ultimately be selected
const isSelectableBase = (item: OmniPickerItem) => {
- if (!isValidItem(item) || isCustomFolder(item)) {
+ if (!isValidItem(item) || isDataAppsRootItem(item)) {
return false;
}
diff --git a/frontend/src/metabase/common/components/Pickers/MoveModal/MoveModal.tsx b/frontend/src/metabase/common/components/Pickers/MoveModal/MoveModal.tsx
index 3352f94f40a..f00073e4917 100644
--- a/frontend/src/metabase/common/components/Pickers/MoveModal/MoveModal.tsx
+++ b/frontend/src/metabase/common/components/Pickers/MoveModal/MoveModal.tsx
@@ -14,7 +14,7 @@ import {
} from "metabase/common/collections/utils";
import {
EntityPickerModal,
- isInDbTree,
+ isInCollectionTree,
} from "metabase/common/components/Pickers";
import { isItemInCollectionOrItsDescendants } from "metabase/common/components/Pickers/utils";
import { PLUGIN_LIBRARY, PLUGIN_TENANTS } from "metabase/plugins";
@@ -58,7 +58,7 @@ export const MoveModal = ({
return false;
}
- if (isInDbTree(item)) {
+ if (!isInCollectionTree(item)) {
return true;
}
@@ -81,8 +81,8 @@ export const MoveModal = ({
}
if (
- !isInDbTree(item) &&
- !isInDbTree(movingItem) &&
+ isInCollectionTree(item) &&
+ isInCollectionTree(movingItem) &&
item.namespace &&
movingItem.namespace
) {
@@ -101,7 +101,7 @@ export const MoveModal = ({
const canSelectItem = useCallback(
(item: OmniPickerItem): boolean => {
- if (isInDbTree(item)) {
+ if (!isInCollectionTree(item)) {
return false;
}
@@ -246,7 +246,7 @@ export const BulkMoveModal = ({
const shouldDisableItem = useCallback(
(item: OmniPickerItem): boolean => {
- if (isInDbTree(item)) {
+ if (!isInCollectionTree(item)) {
return true;
}
@@ -284,7 +284,7 @@ export const BulkMoveModal = ({
const canSelectItem = useCallback(
(item: OmniPickerItem): boolean => {
- if (isInDbTree(item)) {
+ if (!isInCollectionTree(item)) {
return false;
}
if (shouldDisableItem(item)) {
diff --git a/frontend/src/metabase/dashboard/components/DashboardGrid.tsx b/frontend/src/metabase/dashboard/components/DashboardGrid.tsx
index 64ff9b89a83..91d121e0fdc 100644
--- a/frontend/src/metabase/dashboard/components/DashboardGrid.tsx
+++ b/frontend/src/metabase/dashboard/components/DashboardGrid.tsx
@@ -9,7 +9,7 @@ import { ExplicitSize } from "metabase/common/components/ExplicitSize";
import {
type OmniPickerItem,
type OmniPickerQuestionItem,
- isInDbTree,
+ isInCollectionTree,
} from "metabase/common/components/Pickers";
import {
QuestionPickerModal,
@@ -392,7 +392,7 @@ class DashboardGridInner extends Component<
const shouldDisableItem = (item: OmniPickerItem) => {
// don't allow adding items that are already saved in a different dashboard
// proably only applicable to search and recents
- if (!isInDbTree(item) && item.dashboard_id) {
+ if (isInCollectionTree(item) && item.dashboard_id) {
if (item.dashboard_id !== dashboard.id) {
return true;
}
diff --git a/frontend/src/metabase/dashboard/visualizations/DashCardPlaceholder.tsx b/frontend/src/metabase/dashboard/visualizations/DashCardPlaceholder.tsx
index 6c38cd56b43..803adae8c8c 100644
--- a/frontend/src/metabase/dashboard/visualizations/DashCardPlaceholder.tsx
+++ b/frontend/src/metabase/dashboard/visualizations/DashCardPlaceholder.tsx
@@ -4,7 +4,7 @@ import { t } from "ttag";
import type { OmniPickerItem } from "metabase/common/components/Pickers";
import {
QuestionPickerModal,
- isInDbTree,
+ isInCollectionTree,
} from "metabase/common/components/Pickers";
import { replaceCard } from "metabase/dashboard/actions";
import { useDispatch } from "metabase/redux";
@@ -47,7 +47,7 @@ function DashCardPlaceholderInner({
const shouldDisableItem = (item: OmniPickerItem) => {
// don't allow adding items that are already saved in a different dashboard
// proably only applicable to search and recents
- if (!isInDbTree(item) && item.dashboard_id) {
+ if (isInCollectionTree(item) && item.dashboard_id) {
if (item.dashboard_id !== dashboard.id) {
return true;
}
diff --git a/frontend/src/metabase/plugins/oss/data-apps.ts b/frontend/src/metabase/plugins/oss/data-apps.ts
index 4794b31c15e..b6a7457c5c0 100644
--- a/frontend/src/metabase/plugins/oss/data-apps.ts
+++ b/frontend/src/metabase/plugins/oss/data-apps.ts
@@ -1,6 +1,7 @@
import type { ComponentType, ReactNode } from "react";
import { PluginPlaceholder } from "metabase/plugins/components/PluginPlaceholder";
+import type { DataApp } from "metabase-types/api";
import { definePluginSlot } from "../slot";
@@ -9,6 +10,15 @@ export type DataAppsPlugin = {
getRoutes: () => ReactNode | null;
getDataStudioRoutes: (IsAdmin: ComponentType) => ReactNode | null;
MainNavbarSection: ComponentType<{ onItemSelect: () => void }>;
+ /**
+ * The data apps the user can read. `data` is undefined until the list loads, and always without the data apps
+ * feature. With `skip`, or without the feature, it sends no request.
+ */
+ useDataApps: (options: { skip: boolean }) => {
+ data?: DataApp[];
+ isLoading: boolean;
+ error?: unknown;
+ };
};
const getDefaultPluginDataApps = (): DataAppsPlugin => ({
@@ -16,6 +26,7 @@ const getDefaultPluginDataApps = (): DataAppsPlugin => ({
getRoutes: () => null,
getDataStudioRoutes: () => null,
MainNavbarSection: PluginPlaceholder,
+ useDataApps: () => ({ data: undefined, isLoading: false }),
});
export const PLUGIN_DATA_APPS: DataAppsPlugin = definePluginSlot(
diff --git a/frontend/test/__support__/enterprise-typed.ts b/frontend/test/__support__/enterprise-typed.ts
index 4a2edde8f9d..180d24ed059 100644
--- a/frontend/test/__support__/enterprise-typed.ts
+++ b/frontend/test/__support__/enterprise-typed.ts
@@ -45,6 +45,7 @@ export const ENTERPRISE_PLUGIN_NAME_MAPPING = {
semantic_search: "metabase-enterprise/semantic_search",
database_replication: "metabase-enterprise/database_replication",
library: "metabase-enterprise/data-studio/library",
+ "data-apps": "metabase-enterprise/data-apps",
caching: "metabase-enterprise/caching",
group_managers: "metabase-enterprise/group_managers",
collections: "metabase-enterprise/collections",
diff --git a/frontend/test/__support__/server-mocks/data-app.ts b/frontend/test/__support__/server-mocks/data-app.ts
index 0845286c21b..20925fe1bd8 100644
--- a/frontend/test/__support__/server-mocks/data-app.ts
+++ b/frontend/test/__support__/server-mocks/data-app.ts
@@ -8,8 +8,8 @@ import type {
GroupId,
} from "metabase-types/api";
-export function setupListDataAppsEndpoint(apps: DataApp[]) {
- fetchMock.get("path:/api/ee/apps", apps);
+export function setupListDataAppsEndpoint(apps: DataApp[], delay?: number) {
+ fetchMock.get("path:/api/ee/apps", apps, { delay });
}
export function setupListDataAppsEndpointWithError(error: string) {