Skip to content

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

Keep the segment retire action closed until its table loads (#82471)

Romeo Van Snick8d67bf7e3d94
diff --git a/frontend/src/metabase/admin/datamodel/components/SegmentItem.tsx b/frontend/src/metabase/admin/datamodel/components/SegmentItem.tsx
index ae787a6feb7..e16fa90ebef 100644
--- a/frontend/src/metabase/admin/datamodel/components/SegmentItem.tsx
+++ b/frontend/src/metabase/admin/datamodel/components/SegmentItem.tsx
@@ -1,6 +1,9 @@
+import { useGetTableQuery } from "metabase/api";
import { Link } from "metabase/common/components/Link";
import { modelIconMap } from "metabase/common/utils/icon";
import { TableBreadcrumbs } from "metabase/metadata/components";
+import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";
+import { useSelector } from "metabase/redux";
import { Box, Flex, Group, Icon } from "metabase/ui";
import * as Urls from "metabase/urls";
import type { Segment } from "metabase-types/api";
@@ -11,12 +14,19 @@ import S from "./SegmentItem.module.css";
interface Props {
segment: Segment;
onRetire?: () => void;
- readOnly?: boolean;
}
-export const SegmentItem = ({ segment, onRetire, readOnly }: Props) => {
+export const SegmentItem = ({ segment, onRetire }: Props) => {
const canEdit = !!onRetire;
const segmentIcon = modelIconMap.segment;
+ const isRemoteSyncReadOnly = useSelector(
+ PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly,
+ );
+ const { data: table } = useGetTableQuery({ id: segment.table_id });
+ // Treat a table that has not loaded as published, so the write actions stay
+ // closed until the answer is known.
+ const isTablePublished = table?.is_published ?? true;
+ const readOnly = isRemoteSyncReadOnly && isTablePublished;
return (
<tr>
diff --git a/frontend/src/metabase/admin/datamodel/components/SegmentItem.unit.spec.tsx b/frontend/src/metabase/admin/datamodel/components/SegmentItem.unit.spec.tsx
new file mode 100644
index 00000000000..e5304ffbf59
--- /dev/null
+++ b/frontend/src/metabase/admin/datamodel/components/SegmentItem.unit.spec.tsx
@@ -0,0 +1,117 @@
+import userEvent from "@testing-library/user-event";
+import fetchMock from "fetch-mock";
+
+import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
+import {
+ setupSchemaEndpoints,
+ setupTableEndpoints,
+} from "__support__/server-mocks";
+import { mockSettings } from "__support__/settings";
+import { createMockState } from "__support__/state";
+import { renderWithProviders, screen } from "__support__/ui";
+import type { EnterpriseSettings } from "metabase-types/api";
+import {
+ createMockDatabase,
+ createMockSegment,
+ createMockTable,
+ createMockTokenFeatures,
+} from "metabase-types/api/mocks";
+
+import { SegmentItem } from "./SegmentItem";
+
+type SetupOpts = {
+ isTablePublished?: boolean;
+ isTablePending?: boolean;
+ remoteSyncType?: EnterpriseSettings["remote-sync-type"];
+};
+
+const setup = ({
+ isTablePublished,
+ isTablePending = false,
+ remoteSyncType,
+}: SetupOpts) => {
+ const database = createMockDatabase();
+ const table = createMockTable({ is_published: isTablePublished });
+ const segment = createMockSegment({ name: "Discounted", table_id: table.id });
+
+ setupSchemaEndpoints(database);
+ // The global afterEach flushes outstanding requests, so a pending response
+ // has to stay resolvable.
+ let resolveTable = () => {};
+ if (isTablePending) {
+ fetchMock.get(
+ `path:/api/table/${table.id}`,
+ new Promise((resolve) => {
+ resolveTable = () => resolve(table);
+ }),
+ );
+ } else {
+ setupTableEndpoints(table);
+ }
+
+ const state = createMockState({
+ settings: mockSettings({
+ "token-features": createMockTokenFeatures({ remote_sync: true }),
+ "remote-sync-type": remoteSyncType,
+ "remote-sync-enabled": !!remoteSyncType,
+ }),
+ });
+
+ setupEnterpriseOnlyPlugin("remote_sync");
+
+ renderWithProviders(
+ <table>
+ <tbody>
+ <SegmentItem segment={segment} onRetire={jest.fn()} />
+ </tbody>
+ </table>,
+ { storeInitialState: state },
+ );
+
+ return { resolveTable };
+};
+
+const openActionMenu = async () => {
+ await userEvent.click(screen.getByRole("button"));
+};
+
+describe("SegmentItem", () => {
+ it("offers the write actions when remote sync is not read-only", async () => {
+ setup({ isTablePublished: true });
+ await openActionMenu();
+
+ expect(await screen.findByText("Retire Segment")).toBeInTheDocument();
+ expect(screen.getByText("Edit Segment")).toBeInTheDocument();
+ });
+
+ it("offers the write actions for an unpublished table in read-only remote sync", async () => {
+ setup({ isTablePublished: false, remoteSyncType: "read-only" });
+ await openActionMenu();
+
+ expect(await screen.findByText("Retire Segment")).toBeInTheDocument();
+ expect(screen.getByText("Edit Segment")).toBeInTheDocument();
+ });
+
+ it("hides the write actions for a published table in read-only remote sync", async () => {
+ setup({ isTablePublished: true, remoteSyncType: "read-only" });
+ await openActionMenu();
+
+ expect(await screen.findByText("Revision History")).toBeInTheDocument();
+ expect(screen.queryByText("Retire Segment")).not.toBeInTheDocument();
+ expect(screen.queryByText("Edit Segment")).not.toBeInTheDocument();
+ });
+
+ it("hides the write actions while the table is still loading", async () => {
+ const { resolveTable } = setup({
+ isTablePending: true,
+ remoteSyncType: "read-only",
+ });
+ await openActionMenu();
+
+ expect(await screen.findByText("Revision History")).toBeInTheDocument();
+ expect(screen.queryByText("Retire Segment")).not.toBeInTheDocument();
+ expect(screen.queryByText("Edit Segment")).not.toBeInTheDocument();
+
+ resolveTable();
+ });
+});
diff --git a/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx b/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx
index d8544a2c94c..0be5c201ac9 100644
--- a/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx
+++ b/frontend/src/metabase/admin/datamodel/containers/SegmentListApp.tsx
@@ -12,8 +12,6 @@ import { trackSegmentCreateStarted } from "metabase/common/data-studio/analytics
import AdminS from "metabase/css/admin.module.css";
import CS from "metabase/css/core/index.css";
import { getUserIsAdmin } from "metabase/current-user";
-import { getShallowTables } from "metabase/metadata-store";
-import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";
import { useSelector } from "metabase/redux";
import { useLocation } from "metabase/router";
import { Button } from "metabase/ui";
@@ -27,10 +25,6 @@ interface Props {
function SegmentListAppInner({ segments, tableSelector }: Props) {
const isAdmin = useSelector(getUserIsAdmin);
- const isRemoteSyncReadOnly = useSelector(
- PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly,
- );
- const tables = useSelector(getShallowTables);
const archive = useSetArchive();
const trackSegmentCreateClick = () => {
trackSegmentCreateStarted("admin_datamodel_segments");
@@ -70,9 +64,6 @@ function SegmentListAppInner({ segments, tableSelector }: Props) {
<SegmentItem
key={segment.id}
segment={segment}
- readOnly={
- tables[segment.table_id]?.is_published && isRemoteSyncReadOnly
- }
onRetire={
isAdmin
? () => archive({ id: segment.id, model: "segment" }, true)