Skip to content

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

UXW-2481 Add a button in the Library to publish a table (#66947)

Brad Andersoncc29923e524d
diff --git a/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts
index 805f2ba8e20..bbe94f5c15f 100644
--- a/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-studio-library.cy.spec.ts
@@ -103,4 +103,36 @@ describe("scenarios > data studio > library", () => {
H.entityPickerModalItem(1, "Data").click();
H.entityPickerModalItem(2, "Orders").should("exist");
});
+
+ describe("+New button", () => {
+ it("should allow you to publish a table", () => {
+ H.createLibrary();
+ H.DataStudio.Library.visit();
+
+ cy.log("Publish a table from the 'New' menu");
+ H.DataStudio.Library.newButton().click();
+ H.popover().findByText("Publish a table").click();
+
+ cy.log("Select a table and click 'Publish'");
+ H.entityPickerModalItem(3, "Orders").click();
+ H.entityPickerModal().button("Publish").click();
+
+ cy.log("Verify the table is published");
+ H.DataStudio.Tables.overviewPage().should("exist");
+ H.DataStudio.Tables.header().findByDisplayValue("Orders").should("exist");
+ H.DataStudio.breadcrumbs().findByRole("link", { name: "Data" }).click();
+ H.DataStudio.Library.tableItem("Orders").should("exist");
+
+ cy.log(
+ "Verify tables in the entity picker are disabled if already published",
+ );
+ H.DataStudio.Library.newButton().click();
+ H.popover().findByText("Publish a table").click();
+ H.entityPickerModalItem(3, "Orders").should("have.attr", "data-disabled");
+ H.entityPickerModalItem(3, "People").should(
+ "not.have.attr",
+ "data-disabled",
+ );
+ });
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.tsx
index 36cf7074a8a..24635bc1b2d 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.tsx
@@ -1,30 +1,46 @@
import { useState } from "react";
+import { push } from "react-router-redux";
import { t } from "ttag";
import { ForwardRefLink } from "metabase/common/components/Link";
-import { useSelector } from "metabase/lib/redux";
+import { useDispatch, useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
import { PLUGIN_SNIPPET_FOLDERS } from "metabase/plugins";
import {
canUserCreateNativeQueries,
canUserCreateQueries,
+ getUserIsAdmin,
} from "metabase/selectors/user";
import { Button, FixedSizeIcon, Icon, Menu } from "metabase/ui";
import type { CollectionId } from "metabase-types/api";
+import { PublishTableModal } from "./PublishTableModal";
+
export const CreateMenu = ({
metricCollectionId,
}: {
metricCollectionId?: CollectionId;
}) => {
- const [creatingSnippetFolder, setCreatingSnippetFolder] = useState(false);
+ const dispatch = useDispatch();
+ const [modal, setModal] = useState<"snippet-folder" | "publish-table">();
+ const closeModal = () => setModal(undefined);
+ const isAdmin = useSelector(getUserIsAdmin);
const hasNativeWrite = useSelector(canUserCreateNativeQueries);
const hasDataAccess = useSelector(canUserCreateQueries);
const canCreateMetric = hasDataAccess && metricCollectionId;
const menuItems = [
+ isAdmin && (
+ <Menu.Item
+ key="publish-table"
+ leftSection={<FixedSizeIcon name="publish" />}
+ onClick={() => setModal("publish-table")}
+ >
+ {t`Publish a table`}
+ </Menu.Item>
+ ),
canCreateMetric && (
<Menu.Item
key="metric"
@@ -52,7 +68,7 @@ export const CreateMenu = ({
<Menu.Item
key="snippet-folder"
leftSection={<FixedSizeIcon name="folder" />}
- onClick={() => setCreatingSnippetFolder(true)}
+ onClick={() => setModal("snippet-folder")}
>
{t`New snippet folder`}
</Menu.Item>
@@ -72,13 +88,18 @@ export const CreateMenu = ({
<Menu.Dropdown>{menuItems}</Menu.Dropdown>
</Menu>
<PLUGIN_SNIPPET_FOLDERS.CollectionFormModal
- opened={creatingSnippetFolder}
+ opened={modal === "snippet-folder"}
collection={{
name: "",
description: null,
}}
- onClose={() => setCreatingSnippetFolder(false)}
- onSaved={() => setCreatingSnippetFolder(false)}
+ onClose={closeModal}
+ onSaved={closeModal}
+ />
+ <PublishTableModal
+ opened={modal === "publish-table"}
+ onClose={closeModal}
+ onPublished={(table) => dispatch(push(Urls.dataStudioTable(table.id)))}
/>
</>
);
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.unit.spec.tsx
index 94e8d4afcd9..29e3eb7fa92 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/CreateMenu.unit.spec.tsx
@@ -7,21 +7,19 @@ import {
createMockTokenFeatures,
createMockUser,
} from "metabase-types/api/mocks";
-import type { UserPermissions } from "metabase-types/api/user";
+import type { User } from "metabase-types/api/user";
import { createMockState } from "metabase-types/store/mocks/state";
import { CreateMenu } from "./CreateMenu";
-const setup = ({ permissions }: { permissions?: UserPermissions } = {}) => {
+const setup = ({ user }: { user?: Partial<User> } = {}) => {
const state = createMockState({
settings: mockSettings({
"token-features": createMockTokenFeatures({
snippet_collections: true,
}),
}),
- currentUser: createMockUser({
- permissions,
- }),
+ currentUser: createMockUser(user),
});
setupEnterprisePlugins();
return renderWithProviders(<CreateMenu metricCollectionId={1} />, {
@@ -38,7 +36,7 @@ describe("CreateMenu", () => {
});
it("does not render snippet menu items if user only has query builder access", async () => {
- setup({ permissions: { can_create_queries: true } });
+ setup({ user: { permissions: { can_create_queries: true } } });
await userEvent.click(screen.getByRole("button", { name: /New/ }));
@@ -49,9 +47,12 @@ describe("CreateMenu", () => {
it("renders all options when user has full permissions", async () => {
setup({
- permissions: {
- can_create_queries: true,
- can_create_native_queries: true,
+ user: {
+ is_superuser: true,
+ permissions: {
+ can_create_queries: true,
+ can_create_native_queries: true,
+ },
},
});
@@ -59,6 +60,11 @@ describe("CreateMenu", () => {
expect(
screen.getAllByRole("menuitem").map((item) => item.textContent),
- ).toEqual(["Metric", "New snippet", "New snippet folder"]);
+ ).toEqual([
+ "Publish a table",
+ "Metric",
+ "New snippet",
+ "New snippet folder",
+ ]);
});
});
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/PublishTableModal.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/PublishTableModal.tsx
new file mode 100644
index 00000000000..04cc765e96b
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/app/pages/LibrarySectionLayout/PublishTableModal.tsx
@@ -0,0 +1,84 @@
+import { useState } from "react";
+import { t } from "ttag";
+
+import { EntityPickerModal } from "metabase/common/components/EntityPicker/components/EntityPickerModal/EntityPickerModal";
+import {
+ TablePicker,
+ type TablePickerItem,
+ type TablePickerStatePath,
+} from "metabase/common/components/Pickers/TablePicker";
+import { useMetadataToasts } from "metabase/metadata/hooks/useMetadataToasts";
+import { Box } from "metabase/ui";
+import { usePublishTablesMutation } from "metabase-enterprise/api/table";
+import { trackDataStudioTablePublished } from "metabase-enterprise/data-studio/analytics";
+
+interface PublishTableModalProps {
+ opened: boolean;
+ onClose: () => void;
+ onPublished: (table: TablePickerItem) => void;
+}
+
+export function PublishTableModal({
+ opened,
+ onClose,
+ onPublished,
+}: PublishTableModalProps) {
+ const [tablesPath, setTablesPath] = useState<TablePickerStatePath>();
+ const { sendSuccessToast } = useMetadataToasts();
+ const [publishTables] = usePublishTablesMutation();
+ const [item, setItem] = useState<TablePickerItem | null>(null);
+
+ const onConfirm = async () => {
+ if (!item) {
+ return;
+ }
+ await publishTables({ table_ids: [item.id] }).unwrap(); // unwrap() allows EntityPicker's error handling to take over
+ onClose();
+ sendSuccessToast(t`Published`);
+ trackDataStudioTablePublished(item.id);
+ onPublished(item);
+ };
+
+ if (!opened) {
+ return null;
+ }
+
+ return (
+ <EntityPickerModal
+ title={t`Select a table to publish`}
+ searchModels={["table"]}
+ canSelectItem={item?.model === "table"}
+ options={{
+ hasRecents: false,
+ hasConfirmButtons: true,
+ confirmButtonText: t`Publish`,
+ }}
+ tabs={[
+ {
+ id: "tables-tab",
+ displayName: t`Tables`,
+ models: ["table"],
+ folderModels: ["database", "schema"],
+ icon: "table",
+ render: ({ onItemSelect }) => (
+ <Box h="100%" style={{ overflow: "auto" }}>
+ <TablePicker
+ path={tablesPath}
+ value={undefined}
+ onItemSelect={onItemSelect}
+ onPathChange={setTablesPath}
+ shouldDisableItem={(item) =>
+ item.model === "table" && !!item.is_published
+ }
+ />
+ </Box>
+ ),
+ },
+ ]}
+ onItemSelect={setItem}
+ onClose={onClose}
+ onConfirm={onConfirm}
+ selectedItem={item}
+ />
+ );
+}
diff --git a/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/ButtonBar.tsx b/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/ButtonBar.tsx
index 009ba13cf34..f1ce4d232ef 100644
--- a/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/ButtonBar.tsx
+++ b/frontend/src/metabase/common/components/EntityPicker/components/EntityPickerModal/ButtonBar.tsx
@@ -20,6 +20,7 @@ export const ButtonBar = ({
cancelButtonText?: string;
}) => {
const [error, setError] = useState<string | null>(null);
+ const [loading, setLoading] = useState(false);
useEffect(() => {
const handleKeyPress = (e: KeyboardEvent) => {
@@ -61,13 +62,15 @@ export const ButtonBar = ({
onClick={async () => {
try {
setError(null);
+ setLoading(true);
await onConfirm();
} catch (e: any) {
console.error(e);
setError(getErrorMessage(e));
}
+ setLoading(false);
}}
- disabled={!canConfirm}
+ disabled={!canConfirm || loading}
data-testid="entity-picker-select-button"
>
{confirmButtonText ?? t`Select`}
diff --git a/frontend/src/metabase/common/components/Pickers/TablePicker/TableList.tsx b/frontend/src/metabase/common/components/Pickers/TablePicker/TableList.tsx
index 5b52fb0dbf4..0b7083df263 100644
--- a/frontend/src/metabase/common/components/Pickers/TablePicker/TableList.tsx
+++ b/frontend/src/metabase/common/components/Pickers/TablePicker/TableList.tsx
@@ -34,6 +34,7 @@ export const TableList = ({
name: table.display_name,
database: { id: table.db_id },
database_id: table.db_id,
+ is_published: table.is_published,
}));
}, [tables]);
diff --git a/frontend/src/metabase/common/components/Pickers/TablePicker/types.ts b/frontend/src/metabase/common/components/Pickers/TablePicker/types.ts
index c3f422aaf47..b3d37e652cf 100644
--- a/frontend/src/metabase/common/components/Pickers/TablePicker/types.ts
+++ b/frontend/src/metabase/common/components/Pickers/TablePicker/types.ts
@@ -23,6 +23,7 @@ export type TableItem = {
name: string;
model: "table";
database_id?: DatabaseId;
+ is_published?: boolean;
};
export type TablePickerValue = {