Skip to content

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

GDGT-1275 make refetching for bulk metadata editing (#66543)

Egor Grushinc9222983eeaa
diff --git a/e2e/test/scenarios/data-studio/data-model/data-studio-bulk-table.cy.spec.ts b/e2e/test/scenarios/data-studio/data-model/data-studio-bulk-table.cy.spec.ts
index a1fb543b23d..36cdd4ab259 100644
--- a/e2e/test/scenarios/data-studio/data-model/data-studio-bulk-table.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-model/data-studio-bulk-table.cy.spec.ts
@@ -173,6 +173,92 @@ describe("bulk table operations", () => {
.should("have.text", "Bobby Tables");
});
+ describe(
+ "several databases with several schemas at once (GDGT-1275)",
+ { tags: ["@external"] },
+ () => {
+ beforeEach(() => {
+ H.restore("postgres-writable");
+ H.activateToken("bleeding-edge");
+ H.createLibrary();
+ cy.signInAsAdmin();
+ H.resetTestTable({ type: "postgres", table: "multi_schema" });
+ H.resyncDatabase({ dbId: WRITABLE_DB_ID });
+ H.DataModel.visitDataStudio();
+ });
+
+ it("should change metadata and see that is changed for all selected tables without filters", () => {
+ cy.log("change the owner and check the owner column");
+
+ TablePicker.getDatabase("Writable Postgres12").click();
+ TablePicker.getDatabase("Sample Database").click();
+ TablePicker.getSchema("Domestic").click();
+ TablePicker.getTable("Accounts").find('input[type="checkbox"]').check();
+ TablePicker.getTable("Animals").find('input[type="checkbox"]').check();
+ H.selectHasValue("Owner", "").click();
+ H.selectDropdown().contains("Bobby Tables").click();
+
+ ["Accounts", "Animals"].forEach((tableName) => {
+ TablePicker.getTable(tableName)
+ .findByTestId("table-owner")
+ .should("have.text", "Bobby Tables");
+ });
+
+ cy.log("publish and check publish state column");
+
+ TablePicker.getTable("Accounts").find('input[type="checkbox"]').check();
+ TablePicker.getTable("Animals").find('input[type="checkbox"]').check();
+ cy.findByRole("button", { name: /Publish/ }).click();
+ H.modal().findByText("Publish these tables").click();
+ cy.wait("@publishTables");
+
+ ["Accounts", "Animals"].forEach((tableName) => {
+ TablePicker.getTable(tableName)
+ .findByTestId("table-published")
+ .findByLabelText("Published")
+ .should("be.visible");
+ });
+ });
+
+ it("should change metadata and see that is changed for all selected tables with filters", () => {
+ TablePicker.getSearchInput().type("a");
+ cy.log("change the owner and check the owner column");
+ TablePicker.getTable("Accounts").find('input[type="checkbox"]').check();
+ TablePicker.getTable("Animals").find('input[type="checkbox"]').check();
+ H.selectHasValue("Owner", "").click();
+ H.selectDropdown().contains("Bobby Tables").click();
+
+ ["Accounts", "Animals"].forEach((tableName) => {
+ TablePicker.getTable(tableName)
+ .findByTestId("table-owner")
+ .should("have.text", "Bobby Tables");
+ });
+
+ cy.log("publish and check publish state column");
+
+ /**
+ * we need to wait a little until TableAttributesEditBulk component is destroyed (see enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/SearchNew.tsx:153)
+ * Otherwise, the button will be found, but it will be immediately removed.
+ * And then we have to reselect because when there is a filter rows are unselected after a change
+ */
+ cy.findByRole("button", { name: /Publish/ }).should("not.exist");
+
+ TablePicker.getTable("Accounts").find('input[type="checkbox"]').check();
+ TablePicker.getTable("Animals").find('input[type="checkbox"]').check();
+ cy.findByRole("button", { name: /Publish/ }).click();
+ H.modal().findByText("Publish these tables").click();
+ cy.wait("@publishTables");
+
+ ["Accounts", "Animals"].forEach((tableName) => {
+ TablePicker.getTable(tableName)
+ .findByTestId("table-published")
+ .findByLabelText("Published")
+ .should("be.visible");
+ });
+ });
+ },
+ );
+
it("allows to edit attributes for db", { tags: ["@external"] }, () => {
H.restore("postgres-writable");
H.activateToken("bleeding-edge");
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.tsx
index 904a849128b..d5837ab22d8 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.tsx
@@ -30,6 +30,7 @@ interface TablePickerProps {
path: TreePath;
className?: string;
onChange: (path: TreePath, options?: ChangeOptions) => void;
+ setOnUpdateCallback: (callback: (() => void) | null) => void;
}
export function TablePicker({
@@ -37,6 +38,7 @@ export function TablePicker({
path,
className,
onChange,
+ setOnUpdateCallback,
}: TablePickerProps) {
const { resetSelection } = useSelection();
const [query, setQuery] = useState("");
@@ -130,7 +132,11 @@ export function TablePicker({
<Box mih={0} flex="1 1 auto">
{deferredQuery === "" && filtersCount === 0 ? (
- <Tree path={path} onChange={onChange} />
+ <Tree
+ path={path}
+ onChange={onChange}
+ setOnUpdateCallback={setOnUpdateCallback}
+ />
) : (
<SearchNew query={deferredQuery} params={params} filters={filters} />
)}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx
index 9478bb8c4e2..8c8043274c7 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/TablePicker.unit.spec.tsx
@@ -166,6 +166,7 @@ function setup({
});
const onChange = jest.fn();
+ const setOnUpdateCallback = jest.fn();
const params = {};
renderWithProviders(
@@ -177,6 +178,7 @@ function setup({
initialValue={path}
onChange={onChange}
params={params}
+ setOnUpdateCallback={setOnUpdateCallback}
/>
</SelectionProvider>
)}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/Tree.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/Tree.tsx
index 38a538c8b4f..b9b09b82cbe 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/Tree.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/components/Tree.tsx
@@ -1,4 +1,4 @@
-import { useEffect } from "react";
+import { useCallback, useEffect, useMemo } from "react";
import { t } from "ttag";
import type { TableId } from "metabase-types/api";
@@ -41,9 +41,10 @@ import { TablePickerResults } from "./Results";
interface Props {
path: TreePath;
onChange: (path: TreePath, options?: ChangeOptions) => void;
+ setOnUpdateCallback: (callback: (() => void) | null) => void;
}
-export function Tree({ path, onChange }: Props) {
+export function Tree({ path, onChange, setOnUpdateCallback }: Props) {
const {
selectedTables,
setSelectedTables,
@@ -54,18 +55,47 @@ export function Tree({ path, onChange }: Props) {
} = useSelection();
const { databaseId, schemaName } = path;
const { isExpanded, toggle } = useExpandedState(path);
- const { tree, reload } = useTableLoader(path);
+ const { tree, reload } = useTableLoader();
+
+ /**
+ * onUpdateCallback depends on the items, and they are changing very often.
+ * We don't want to re-register it each time items changed.
+ * Otherwise, it causes an infinity loop.
+ */
+ const items = useMemo(
+ () =>
+ flatten(tree, {
+ isExpanded,
+ addLoadingNodes: true,
+ canFlattenSingleSchema: true,
+ selection: {
+ tables: selectedTables,
+ schemas: selectedSchemas,
+ databases: selectedDatabases,
+ },
+ }),
+ [tree, isExpanded, selectedTables, selectedSchemas, selectedDatabases],
+ );
- const items = flatten(tree, {
- isExpanded,
- addLoadingNodes: true,
- canFlattenSingleSchema: true,
- selection: {
- tables: selectedTables,
- schemas: selectedSchemas,
- databases: selectedDatabases,
- },
- });
+ /**
+ * Initial loading of all databases, schemas, tables for the current path
+ */
+ useEffect(() => {
+ reload(path);
+ }, [reload, path]);
+
+ const refetchSelectedTables = useCallback(() => {
+ const selectedTableNodes = items
+ .filter((item) => isTableNode(item))
+ .filter((tableNode) => selectedTables.has(tableNode.value.tableId));
+
+ selectedTableNodes.forEach((tableNode) => reload(tableNode.value));
+ }, [items, reload, selectedTables]);
+
+ useEffect(() => {
+ setOnUpdateCallback(() => refetchSelectedTables);
+ return () => setOnUpdateCallback(null);
+ }, [refetchSelectedTables, setOnUpdateCallback]);
useEffect(() => {
const expandedDatabases = items.filter(
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/hooks/useTableLoader.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/hooks/useTableLoader.ts
index 3b48a6f23e5..911d2cf5659 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/hooks/useTableLoader.ts
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/hooks/useTableLoader.ts
@@ -1,5 +1,5 @@
import { useCallback, useRef, useState } from "react";
-import { useDeepCompareEffect, useLatest } from "react-use";
+import { useLatest } from "react-use";
import _ from "underscore";
import {
@@ -21,7 +21,7 @@ import type {
import { merge, node, rootNode, toKey } from "../utils";
/**
- * For the currently view path, fetches the database, schema and table (or any subset that applies to the path).
+ * Provides a function that fetches for a specific path the database, schema and table (or any subset that applies to the path).
*
* This state is managed at the top-level so we can generate a flat list of all nodes in the tree,
* which makes virtualization possible.
@@ -31,7 +31,7 @@ import { merge, node, rootNode, toKey } from "../utils";
*
* This works by fetching the data and then recursively merging the results into the tree of data that was already fetched.
*/
-export function useTableLoader(path: TreePath) {
+export function useTableLoader() {
const [fetchDatabases, databases] = useLazyListDatabasesQuery();
const [fetchSchemas, schemas] = useLazyListDatabaseSchemasQuery();
const [fetchTables, tables] = useLazyListDatabaseSchemaTablesQuery();
@@ -197,16 +197,5 @@ export function useTableLoader(path: TreePath) {
[getDatabases, getSchemas, getTables],
);
- useDeepCompareEffect(() => {
- load(path);
- }, [
- load,
- path,
- // When a table is modified, e.g. we change display_name with PUT /api/table/:id
- // we need to manually call the lazy RTK hooks, so that the the updated table
- // is refetched here. We detect this modification with tables.isFetching.
- tables.isFetching,
- ]);
-
return { tree, reload: load };
}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/wrappers.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/wrappers.tsx
index 5c0b5e00ff3..02dc5639c87 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/wrappers.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TablePicker/wrappers.tsx
@@ -11,9 +11,14 @@ import type { TreePath } from "./types";
type Props = TreePath & {
params: RouteParams;
+ setOnUpdateCallback: (callback: (() => void) | null) => void;
};
-export function RouterTablePicker({ params, ...props }: Props) {
+export function RouterTablePicker({
+ params,
+ setOnUpdateCallback,
+ ...props
+}: Props) {
const dispatch = useDispatch();
const [value, setValue] = useState(props);
const {
@@ -55,17 +60,26 @@ export function RouterTablePicker({ params, ...props }: Props) {
});
}, [propDatabaseId, propSchemaName, propTableId]);
- return <TablePicker path={value} onChange={onChange} params={params} />;
+ return (
+ <TablePicker
+ path={value}
+ onChange={onChange}
+ params={params}
+ setOnUpdateCallback={setOnUpdateCallback}
+ />
+ );
}
export function UncontrolledTablePicker({
initialValue,
onChange,
params,
+ setOnUpdateCallback,
}: {
initialValue: TreePath;
onChange?: (path: TreePath) => void;
params: RouteParams;
+ setOnUpdateCallback: (callback: (() => void) | null) => void;
}) {
const [value, setValue] = useState(initialValue);
const handleChange = useCallback(
@@ -75,5 +89,12 @@ export function UncontrolledTablePicker({
},
[onChange],
);
- return <TablePicker path={value} onChange={handleChange} params={params} />;
+ return (
+ <TablePicker
+ path={value}
+ onChange={handleChange}
+ params={params}
+ setOnUpdateCallback={setOnUpdateCallback}
+ />
+ );
}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.tsx
index 9cf4b80fba0..bd4e08aaa43 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.tsx
@@ -27,12 +27,14 @@ import { TableSectionGroup } from "./TableSectionGroup";
type TableAttributesEditBulkProps = {
hasLibrary: boolean;
+ onUpdate: () => void;
};
type TableModalType = "library" | "publish" | "unpublish" | "sync";
export function TableAttributesEditBulk({
hasLibrary,
+ onUpdate,
}: TableAttributesEditBulkProps) {
const {
selectedDatabases,
@@ -104,12 +106,18 @@ export function TableAttributesEditBulk({
if (entityType) {
setEntityType(entityType);
}
+ onUpdate();
};
const handleCloseModal = () => {
setModalType(undefined);
};
+ const handleSuccessCloseModal = () => {
+ onUpdate();
+ handleCloseModal();
+ };
+
useEffect(() => {
setDataLayer(null);
setDataSource(null);
@@ -263,7 +271,7 @@ export function TableAttributesEditBulk({
databaseIds={Array.from(selectedDatabases)}
schemaIds={Array.from(selectedSchemas)}
tableIds={Array.from(selectedTables)}
- onPublish={handleCloseModal}
+ onPublish={handleSuccessCloseModal}
onClose={handleCloseModal}
/>
@@ -272,7 +280,7 @@ export function TableAttributesEditBulk({
databaseIds={Array.from(selectedDatabases)}
schemaIds={Array.from(selectedSchemas)}
tableIds={Array.from(selectedTables)}
- onUnpublish={handleCloseModal}
+ onUnpublish={handleSuccessCloseModal}
onClose={handleCloseModal}
/>
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.unit.spec.tsx
index b60d059cca7..0591996b30c 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditBulk.unit.spec.tsx
@@ -1,6 +1,7 @@
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
import { useEffect, useState } from "react";
+import _ from "underscore";
import {
setupTableEndpoints,
@@ -55,7 +56,7 @@ function TestWrapper({
return (
<SelectionProvider>
- <TableAttributesEditBulk hasLibrary />
+ <TableAttributesEditBulk hasLibrary onUpdate={_.noop} />
<SelectionController
initialTables={initialTables}
onSelectionChange={() => setSelectionChanged(true)}
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/pages/DataModel/DataModel.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/pages/DataModel/DataModel.tsx
index d5f710333cf..304b6edf91d 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/pages/DataModel/DataModel.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/pages/DataModel/DataModel.tsx
@@ -108,6 +108,10 @@ function DataModelContent({ params }: Props) {
// TODO Alex P 12/05/2025 Fix the endpoint to return sensible data
const hasLibrary = libraryCollection != null && "name" in libraryCollection;
+ const [onUpdateCallback, setOnUpdateCallback] = useState<(() => void) | null>(
+ null,
+ );
+
useWindowEvent(
"keydown",
(event) => {
@@ -167,6 +171,7 @@ function DataModelContent({ params }: Props) {
schemaName={schemaName}
tableId={navigationTableId}
params={params}
+ setOnUpdateCallback={setOnUpdateCallback}
/>
</Stack>
@@ -194,7 +199,10 @@ function DataModelContent({ params }: Props) {
maw={COLUMN_CONFIG.table.max}
miw={COLUMN_CONFIG.table.min}
>
- <TableAttributesEditBulk hasLibrary={hasLibrary} />
+ <TableAttributesEditBulk
+ hasLibrary={hasLibrary}
+ onUpdate={() => onUpdateCallback?.()}
+ />
</Stack>
)}