The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Add only published filter to data studio table picker (#76521)
Nick Fitzpatrickeec1d1b0d5f3
diff --git a/frontend/src/metabase-types/api/table.ts b/frontend/src/metabase-types/api/table.tsindex 99775e4436f..5d99a56e0c8 100644--- a/frontend/src/metabase-types/api/table.ts+++ b/frontend/src/metabase-types/api/table.ts@@ -123,6 +123,7 @@ export interface TableListQuery {"owner-email"?: string | null;"unused-only"?: boolean | null;"orphan-only"?: boolean;+ "published-only"?: boolean | null;}export interface ForeignKey {diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/FilterPopover.tsx b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/FilterPopover.tsxindex b9662e3d74f..6bd1e83e7a9 100644--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/FilterPopover.tsx+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/FilterPopover.tsx@@ -16,10 +16,11 @@ import type { FilterState } from "../types";interface Props {filters: FilterState;+ isLibraryEnabled: boolean;onSubmit: (filters: FilterState) => void;}-export function FilterPopover({ filters, onSubmit }: Props) {+export function FilterPopover({ filters, isLibraryEnabled, onSubmit }: Props) {const [form, setForm] = useState(filters);const handleReset = () => {@@ -30,6 +31,7 @@ export function FilterPopover({ filters, onSubmit }: Props) {ownerEmail: null,ownerUserId: null,unusedOnly: null,+ publishedOnly: null,});};@@ -94,6 +96,16 @@ export function FilterPopover({ filters, onSubmit }: Props) {}/>+ {isLibraryEnabled && (+ <Checkbox+ label={t`Published tables only`}+ checked={form.publishedOnly === true}+ onChange={(e) =>+ setForm((form) => ({ ...form, publishedOnly: e.target.checked }))+ }+ />+ )}+<Group justify="space-between" wrap="nowrap"><Button flex={1} onClick={handleReset}>{t`Clear filters`}</Button>diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/SearchNew.tsx b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/SearchNew.tsxindex 9ba5c6f293a..fa0862f5535 100644--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/SearchNew.tsx+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/SearchNew.tsx@@ -121,6 +121,7 @@ export function SearchNew({"owner-email": filters.ownerEmail ?? undefined,"orphan-only": filters.ownerUserId === "unknown" ? true : undefined,"unused-only": filters.unusedOnly === true ? true : undefined,+ "published-only": filters.publishedOnly === true ? true : undefined,});const { data: databases, isLoading: isLoadingDatabases } =useListDatabasesQuery();diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.tsx b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.tsxindex a47132c34fd..7c550f6dec3 100644--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.tsx+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.tsx@@ -55,6 +55,7 @@ export function TablePicker({ownerEmail: null,ownerUserId: null,unusedOnly: null,+ publishedOnly: null,});const [isOpen, { toggle, close }] = useDisclosure();const filtersCount = getFiltersCount(filters);@@ -133,6 +134,7 @@ export function TablePicker({<Popover.Dropdown><FilterPopoverfilters={filters}+ isLibraryEnabled={isLibraryEnabled}onSubmit={(newFilters) => {setFilters(newFilters);close();diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsxindex 8c86ed26c35..c058629b032 100644--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx@@ -1,12 +1,15 @@import userEvent from "@testing-library/user-event";+import fetchMock from "fetch-mock";import { Route } from "react-router";+import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";import {setupDatabasesEndpoints,setupTableSearchEndpoint,setupUserKeyValueEndpoints,setupUsersEndpoints,} from "__support__/server-mocks";+import { mockSettings } from "__support__/settings";import {mockGetBoundingClientRect,renderWithProviders,@@ -14,11 +17,13 @@ import {waitFor,} from "__support__/ui";import { SelectionProvider } from "metabase/data-studio/data-model/pages/DataModel/contexts/SelectionContext";-import type { Database, User } from "metabase-types/api";+import { createMockState } from "metabase/redux/store/mocks";+import type { Database, TokenFeatures, User } from "metabase-types/api";import {createMockDatabase,createMockSchema,createMockTable,+ createMockTokenFeatures,createMockUser,} from "metabase-types/api/mocks";@@ -147,9 +152,11 @@ const currentUser: User = createMockUser({function setup({path = {},databases = MOCK_DATABASES,+ tokenFeatures = {},}: {path?: TreePath;databases?: Database[];+ tokenFeatures?: Partial<TokenFeatures>;} = {}) {setupDatabasesEndpoints(databases);setupTableSearchEndpoint(@@ -164,6 +171,16 @@ function setup({value: false,});+ const state = createMockState({+ settings: mockSettings({+ "token-features": createMockTokenFeatures(tokenFeatures),+ }),+ });++ if (tokenFeatures.library) {+ setupEnterpriseOnlyPlugin("library");+ }+const onChange = jest.fn();const setOnUpdateCallback = jest.fn();const params = {};@@ -182,7 +199,7 @@ function setup({</SelectionProvider>)}/>,- { withRouter: true },+ { withRouter: true, storeInitialState: state },);return { onChange };}@@ -562,6 +579,46 @@ describe("TablePicker", () => {expect(item(GRAULT)).not.toBeInTheDocument();});});++ describe("Published tables filter", () => {+ it("is hidden when the Library is not enabled", async () => {+ setup();+ await waitLoading();++ await userEvent.click(screen.getByRole("button", { name: "Filter" }));++ expect(+ await screen.findByTestId("table-picker-filter"),+ ).toBeInTheDocument();+ expect(+ screen.queryByLabelText("Published tables only"),+ ).not.toBeInTheDocument();+ });++ it("sends published-only=true when enabled, checked, and applied", async () => {+ setup({ tokenFeatures: { library: true } });+ await waitLoading();++ // Enter search mode first so the table-search endpoint matches the request+ await userEvent.type(searchInput(), "o");+ await waitLoading();++ await userEvent.click(screen.getByRole("button", { name: "Filter" }));+ await userEvent.click(+ await screen.findByLabelText("Published tables only"),+ );+ await userEvent.click(screen.getByRole("button", { name: "Apply" }));+ await waitLoading();++ await waitFor(() => {+ const calls = fetchMock.callHistory.calls("path:/api/table");+ const lastCall = calls.at(-1);+ expect(lastCall).toBeDefined();+ const url = new URL(lastCall!.url);+ expect(url.searchParams.get("published-only")).toBe("true");+ });+ });+ });});function searchInput() {diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/types.ts b/frontend/src/metabase/data-studio/data-model/components/TablePicker/types.tsindex 6714101f7a9..b7997afac87 100644--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/types.ts+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/types.ts@@ -88,6 +88,7 @@ export interface FilterState {ownerEmail: string | null;ownerUserId: UserId | "unknown" | null;unusedOnly: boolean | null;+ publishedOnly: boolean | null;}export function isDatabaseNode(node: TreeNode): node is DatabaseNode {diff --git a/frontend/src/metabase/data-studio/data-model/components/TablePicker/utils.ts b/frontend/src/metabase/data-studio/data-model/components/TablePicker/utils.tsindex 8756faeab45..b679470d9be 100644--- a/frontend/src/metabase/data-studio/data-model/components/TablePicker/utils.ts+++ b/frontend/src/metabase/data-studio/data-model/components/TablePicker/utils.ts@@ -135,6 +135,7 @@ export function getFiltersCount(filters: FilterState): number {filters.dataLayer != null,filters.ownerEmail != null || filters.ownerUserId != null,filters.unusedOnly === true,+ filters.publishedOnly === true,].filter(Boolean).length;}diff --git a/src/metabase/warehouse_schema_rest/api/table.clj b/src/metabase/warehouse_schema_rest/api/table.cljindex e139afd5ff6..597d5346a2d 100644--- a/src/metabase/warehouse_schema_rest/api/table.clj+++ b/src/metabase/warehouse_schema_rest/api/table.clj@@ -73,7 +73,7 @@- `can-write=true` - filter to only tables the user can edit metadata for"[_{:keys [term visibility-type data-layer data-source owner-user-id owner-email orphan-only unused-only- can-query can-write include-transform-targets]}+ published-only can-query can-write include-transform-targets]}:- [:map[:term {:optional true} :string][:visibility-type {:optional true} :string]@@ -83,6 +83,7 @@[:owner-email {:optional true} :string][:orphan-only {:optional true} [:maybe ms/BooleanValue]][:unused-only {:optional true} [:maybe ms/BooleanValue]]+ [:published-only {:optional true} [:maybe ms/BooleanValue]][:can-query {:optional true} [:maybe ms/BooleanValue]][:can-write {:optional true} [:maybe ms/BooleanValue]][:include-transform-targets {:optional true} [:maybe ms/BooleanValue]]]]@@ -110,6 +111,7 @@owner-user-id (conj [:= :owner_user_id owner-user-id])owner-email (conj [:= :owner_email owner-email])orphan-only (conj [:and [:= :owner_email nil] [:= :owner_user_id nil]])+ published-only (conj [:= :is_published true])(and unused-only (premium-features/has-feature? :dependencies))(conj [:not-exists {:select [:*]:from [[:dependency :d]]diff --git a/test/metabase/warehouse_schema_rest/api/table_test.clj b/test/metabase/warehouse_schema_rest/api/table_test.cljindex 9b5145d942d..ec83d0a8ff7 100644--- a/test/metabase/warehouse_schema_rest/api/table_test.clj+++ b/test/metabase/warehouse_schema_rest/api/table_test.clj@@ -1361,6 +1361,37 @@(map :id)set))))))))+(deftest published-only-filter-test+ (testing "GET /api/table?published-only=true"+ (testing "filters tables that are not published"+ (mt/with-temp [:model/Database {db-id :id} {}+ :model/Table {table-1-id :id} {:db_id db-id+ :name "table_1"+ :active true+ :is_published true}+ :model/Table {table-2-id :id} {:db_id db-id+ :name "table_2"+ :active true+ :is_published false}]+ (testing "both tables returned without filter"+ (is (= #{table-1-id table-2-id}+ (->> (mt/user-http-request :crowberto :get 200 "table")+ (filter #(= (:db_id %) db-id))+ (map :id)+ set))))+ (testing "both tables returned with published-only=false"+ (is (= #{table-1-id table-2-id}+ (->> (mt/user-http-request :crowberto :get 200 "table" :published-only false)+ (filter #(= (:db_id %) db-id))+ (map :id)+ set))))+ (testing "only table-1 is returned with published-only=true"+ (is (= #{table-1-id}+ (->> (mt/user-http-request :crowberto :get 200 "table" :published-only true)+ (filter #(= (:db_id %) db-id))+ (map :id)+ set))))))))+(deftest no-fks-for-missing-tables-test(testing "Check that we don't return foreign keys for missing/inactive tables"(mt/with-temp-test-data