Skip to content

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

Add a tooltip message if model persistence is unsupported for a database (#67566)

Phoomparin Manoa7d35f1baf1b
diff --git a/enterprise/frontend/src/metabase-enterprise/model_persistence/components/ModelCacheControl/ModelCacheControl.tsx b/enterprise/frontend/src/metabase-enterprise/model_persistence/components/ModelCacheControl/ModelCacheControl.tsx
index 2d09494b9eb..89ecf4816a8 100644
--- a/enterprise/frontend/src/metabase-enterprise/model_persistence/components/ModelCacheControl/ModelCacheControl.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/model_persistence/components/ModelCacheControl/ModelCacheControl.tsx
@@ -1,5 +1,6 @@
import { t } from "ttag";
+import { hasFeature } from "metabase/admin/databases/utils";
import {
skipToken,
useGetDatabaseQuery,
@@ -11,6 +12,30 @@ import { Switch, Tooltip } from "metabase/ui";
import type Question from "metabase-lib/v1/Question";
import type { ModelCacheRefreshStatus } from "metabase-types/api";
+function getTooltipLabel({
+ userCanPersist,
+ isModelPersistenceSupported,
+ isModelPersistenceEnabled,
+}: {
+ userCanPersist: boolean;
+ isModelPersistenceSupported: boolean;
+ isModelPersistenceEnabled: boolean;
+}): string | null {
+ if (!userCanPersist) {
+ return t`You don't have permission to modify model persistence`;
+ }
+
+ if (!isModelPersistenceSupported) {
+ return t`Model persistence is not supported for this database`;
+ }
+
+ if (!isModelPersistenceEnabled) {
+ return t`Model persistence is disabled for this database`;
+ }
+
+ return null;
+}
+
export function ModelCacheToggle({
persistedModel,
model,
@@ -37,13 +62,20 @@ export function ModelCacheToggle({
const isPersisted = persistedModel && persistedModel.state !== "off";
const modelId = model.id();
const userCanPersist = model.canManageDB();
- const canPersistDatabase = database?.settings?.["persist-models-enabled"];
+ const isModelPersistenceEnabled =
+ database?.settings?.["persist-models-enabled"] ?? false;
+
+ const isModelPersistenceSupported = database
+ ? hasFeature(database, "persist-models")
+ : false;
- if (!canPersistDatabase || !userCanPersist) {
- const tooltipLabel = !canPersistDatabase
- ? t`Model persistence is disabled for this database`
- : t`You don't have permission to modify model persistence`;
+ const tooltipLabel = getTooltipLabel({
+ userCanPersist,
+ isModelPersistenceSupported,
+ isModelPersistenceEnabled,
+ });
+ if (tooltipLabel) {
return (
<Tooltip label={tooltipLabel}>
{/* need this div so that disabled input doesn't swallow pointer events */}
diff --git a/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/enterprise.unit.spec.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/enterprise.unit.spec.tsx
index 89e5e1e4343..1ece236aae2 100644
--- a/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/enterprise.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/enterprise.unit.spec.tsx
@@ -1,3 +1,5 @@
+import userEvent from "@testing-library/user-event";
+
import { screen } from "__support__/ui";
import type { TokenFeatures } from "metabase-types/api";
import {
@@ -80,5 +82,45 @@ describe("QuestionSettingsSidebar", () => {
"true",
);
});
+
+ it("should show 'not supported' message when database driver doesn't support persistence", async () => {
+ await setupEnterprise(
+ {
+ card: model,
+ dbHasModelPersistence: false,
+ dbSupportsModelPersistence: false,
+ },
+ { cache_granular_controls: true },
+ );
+
+ const toggle = await screen.findByText("Persist model data");
+ expect(toggle).toHaveAttribute("data-disabled", "true");
+
+ await userEvent.hover(toggle);
+
+ expect(await screen.findByRole("tooltip")).toHaveTextContent(
+ "Model persistence is not supported for this database",
+ );
+ });
+
+ it("should show 'disabled' message when database supports but has persistence disabled", async () => {
+ await setupEnterprise(
+ {
+ card: model,
+ dbHasModelPersistence: false,
+ dbSupportsModelPersistence: true,
+ },
+ { cache_granular_controls: true },
+ );
+
+ const toggle = await screen.findByText("Persist model data");
+ expect(toggle).toHaveAttribute("data-disabled", "true");
+
+ await userEvent.hover(toggle);
+
+ expect(await screen.findByRole("tooltip")).toHaveTextContent(
+ "Model persistence is disabled for this database",
+ );
+ });
});
});
diff --git a/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/setup.tsx b/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/setup.tsx
index a102ab2988d..3d2c116e6ef 100644
--- a/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/setup.tsx
+++ b/frontend/src/metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar/tests/setup.tsx
@@ -14,6 +14,7 @@ import { checkNotNull } from "metabase/lib/types";
import { getMetadata } from "metabase/selectors/metadata";
import type { Card, Settings } from "metabase-types/api";
import {
+ COMMON_DATABASE_FEATURES,
createMockCard,
createMockSettings,
createMockTokenFeatures,
@@ -30,6 +31,7 @@ export interface SetupOpts {
settings?: Settings;
enterprisePlugins?: Parameters<typeof setupEnterpriseOnlyPlugin>[0][];
dbHasModelPersistence?: boolean;
+ dbSupportsModelPersistence?: boolean;
}
export const setup = async ({
@@ -37,6 +39,7 @@ export const setup = async ({
settings = createMockSettings(),
enterprisePlugins,
dbHasModelPersistence = true,
+ dbSupportsModelPersistence = true,
}: SetupOpts) => {
const currentUser = createMockUser();
setupCardEndpoints(card);
@@ -50,9 +53,12 @@ export const setup = async ({
setupDatabaseEndpoints(
createSampleDatabase({
- settings: {
- "persist-models-enabled": dbHasModelPersistence,
- },
+ settings: { "persist-models-enabled": dbHasModelPersistence },
+ features: dbSupportsModelPersistence
+ ? COMMON_DATABASE_FEATURES
+ : COMMON_DATABASE_FEATURES.filter(
+ (feature) => feature !== "persist-models",
+ ),
}),
);