Skip to content

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

Add tooltip explaining Managed/Unmanaged index source (#79455)

Egor Grushineadf23cd60b0
diff --git a/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.tsx b/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.tsx
index fe318c892b4..1d43d35dd93 100644
--- a/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.tsx
@@ -4,6 +4,8 @@ import { t } from "ttag";
import { useListUsersQuery } from "metabase/api";
import { ListEmptyState } from "metabase/common/components/ListEmptyState";
+import { useSelector } from "metabase/redux";
+import { getApplicationName } from "metabase/selectors/whitelabel";
import { useSetting } from "metabase/settings";
import type { TreeTableColumnDef } from "metabase/ui";
import { TreeTable, useTreeTableInstance } from "metabase/ui";
@@ -32,6 +34,7 @@ export function TransformIndexTable({
onDelete,
}: TransformIndexTableProps) {
const systemTimezone = useSetting("system-timezone");
+ const applicationName = useSelector(getApplicationName);
const { data: usersResponse } = useListUsersQuery();
const [sorting, setSorting] = useState<SortingState>(DEFAULT_SORTING);
@@ -64,9 +67,10 @@ export function TransformIndexTable({
getColumns({
systemTimezone,
kindLabels,
+ applicationName,
actions: readOnly ? undefined : { onEdit, onDelete },
}),
- [systemTimezone, kindLabels, readOnly, onEdit, onDelete],
+ [systemTimezone, kindLabels, applicationName, readOnly, onEdit, onDelete],
);
const handleRowClick = useCallback(
diff --git a/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.unit.spec.tsx b/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.unit.spec.tsx
index ec53712cb6e..f1a9ea12537 100644
--- a/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.unit.spec.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/TransformIndexTable.unit.spec.tsx
@@ -4,7 +4,6 @@ import { setupUsersEndpoints } from "__support__/server-mocks";
import {
getIcon,
mockGetBoundingClientRect,
- queryIcon,
renderWithProviders,
screen,
waitForLoaderToBeRemoved,
@@ -112,22 +111,42 @@ describe("TransformIndexTable", () => {
expect(within(table).getAllByText("distkey")).toHaveLength(2);
});
- it("labels metabase-managed indexes as 'Managed'", async () => {
+ it("labels metabase-managed indexes as 'Managed' with an explanation tooltip", async () => {
setup({
- indexes: [createMockTableIndexEntry({ metabase_managed: true })],
+ indexes: [
+ createMockTableIndexEntry({
+ metabase_managed: true,
+ request: createMockTableIndexRequest({ status: "succeeded" }),
+ }),
+ ],
});
await waitForLoaderToBeRemoved();
expect(screen.getByText("Managed")).toBeInTheDocument();
+ await userEvent.hover(getIcon("info_outline"));
+ expect(
+ await screen.findByText(
+ "This index was created by Metabase and is reapplied each time the transform runs",
+ ),
+ ).toBeInTheDocument();
});
- it("labels non-managed indexes as 'Unmanaged'", async () => {
+ it("labels non-managed indexes as 'Unmanaged' with an explanation tooltip", async () => {
setup({
- indexes: [createMockTableIndexEntry({ metabase_managed: false })],
+ indexes: [
+ createMockTableIndexEntry({
+ metabase_managed: false,
+ request: undefined,
+ }),
+ ],
});
await waitForLoaderToBeRemoved();
expect(screen.getByText("Unmanaged")).toBeInTheDocument();
+ await userEvent.hover(getIcon("info_outline"));
+ expect(
+ await screen.findByText("This index was created outside of Metabase"),
+ ).toBeInTheDocument();
});
it("formats the request status", async () => {
@@ -166,7 +185,8 @@ describe("TransformIndexTable", () => {
await waitForLoaderToBeRemoved();
expect(screen.getByText("Pending")).toBeInTheDocument();
- await userEvent.hover(getIcon("info_outline"));
+ const [, statusIcon] = screen.getAllByLabelText("info_outline icon");
+ await userEvent.hover(statusIcon);
expect(
await screen.findByText(
"Changes will be applied the next time the transform runs",
@@ -188,7 +208,7 @@ describe("TransformIndexTable", () => {
await waitForLoaderToBeRemoved();
expect(screen.getByText("Succeeded")).toBeInTheDocument();
- expect(queryIcon("info_outline")).not.toBeInTheDocument();
+ expect(screen.getAllByLabelText("info_outline icon")).toHaveLength(1);
});
it("resolves the last modified by user name", async () => {
diff --git a/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/columns.tsx b/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/columns.tsx
index a9770d49ae6..b87757d3559 100644
--- a/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/columns.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformIndexesPage/TransformIndexTable/columns.tsx
@@ -1,15 +1,8 @@
-import { t } from "ttag";
+import { c, t } from "ttag";
import { parseTimestampWithTimezone } from "metabase/transforms/utils";
import type { TreeTableColumnDef } from "metabase/ui";
-import {
- Ellipsified,
- FixedSizeIcon,
- Flex,
- Group,
- Icon,
- Tooltip,
-} from "metabase/ui";
+import { Ellipsified, FixedSizeIcon, Flex, Group, Tooltip } from "metabase/ui";
import { EMPTY_CELL_PLACEHOLDER } from "metabase/utils/constants";
import type { TableIndexEntry } from "metabase-types/api";
@@ -27,12 +20,14 @@ type Actions = {
type ColumnsProps = {
systemTimezone: string | undefined;
kindLabels: Map<string, string>;
+ applicationName: string;
actions: Actions | undefined;
};
export function getColumns({
systemTimezone,
kindLabels,
+ applicationName,
actions,
}: ColumnsProps): TreeTableColumnDef<IndexRow>[] {
const columns: TreeTableColumnDef<IndexRow>[] = [
@@ -78,10 +73,26 @@ export function getColumns({
id: "source",
header: t`Source`,
width: "auto",
+ maxAutoWidth: 240,
enableSorting: true,
accessorFn: (index) =>
index.metabase_managed ? t`Managed` : t`Unmanaged`,
- cell: ({ getValue }) => <Ellipsified>{String(getValue())}</Ellipsified>,
+ cell: ({ row, getValue }) => (
+ <Group gap="sm" wrap="nowrap" miw={0}>
+ <Ellipsified>{String(getValue())}</Ellipsified>
+ <Tooltip
+ label={
+ row.original.metabase_managed
+ ? c("{0} is the application name")
+ .t`This index was created by ${applicationName} and is reapplied each time the transform runs`
+ : c("{0} is the application name")
+ .t`This index was created outside of ${applicationName}`
+ }
+ >
+ <FixedSizeIcon name="info_outline" c="text-secondary" />
+ </Tooltip>
+ </Group>
+ ),
},
{
id: "status",
@@ -97,14 +108,14 @@ export function getColumns({
<Ellipsified>{String(getValue())}</Ellipsified>
{errorMessage != null && (
<Tooltip label={errorMessage}>
- <Icon name="info_outline" c="text-secondary" />
+ <FixedSizeIcon name="info_outline" c="text-secondary" />
</Tooltip>
)}
{isPendingStatus(request?.status) && (
<Tooltip
label={t`Changes will be applied the next time the transform runs`}
>
- <Icon name="info_outline" c="text-secondary" />
+ <FixedSizeIcon name="info_outline" c="text-secondary" />
</Tooltip>
)}
</Group>