Skip to content

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

fix: hide editing toggle for unsupported engines (#67564)

Jakub Chodorowiczafef9ac2ae46
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx
index 8c91bbee4dd..572ba4c93af 100644
--- a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.tsx
@@ -8,6 +8,7 @@ import {
} from "metabase/admin/databases/components/DatabaseFeatureComponents";
import { DatabaseInfoSection } from "metabase/admin/databases/components/DatabaseInfoSection";
import Toggle from "metabase/common/components/Toggle";
+import { ALLOWED_ENGINES_FOR_TABLE_EDITING } from "metabase/databases/constants";
import { trackSimpleEvent } from "metabase/lib/analytics";
import { getResponseErrorMessage } from "metabase/lib/errors";
import { Box, Flex } from "metabase/ui";
@@ -27,13 +28,13 @@ enum DisabledReasonKey {
MissingDriverFeature = "driver-feature-missing",
NoWriteableTable = "permissions/no-writable-table",
SyncInProgress = "database-metadata/sync-in-progress",
- DatabaseEmtpy = "database-metadata/not-populated",
+ DatabaseEmpty = "database-metadata/not-populated",
}
const VISIBLE_REASONS: string[] = [
DisabledReasonKey.NoWriteableTable,
DisabledReasonKey.SyncInProgress,
- DisabledReasonKey.DatabaseEmtpy,
+ DisabledReasonKey.DatabaseEmpty,
];
export function AdminDatabaseTableEditingSection({
@@ -69,6 +70,11 @@ export function AdminDatabaseTableEditingSection({
}
};
+ // Only Postgres and MySQL support table data editing
+ const allowedToEnableTableEditing =
+ database.engine &&
+ ALLOWED_ENGINES_FOR_TABLE_EDITING.includes(database.engine);
+
const dataEditingSetting =
settingsAvailable?.[DATABASE_TABLE_EDITING_SETTING];
@@ -83,7 +89,11 @@ export function AdminDatabaseTableEditingSection({
const shouldShowSection =
!firstDisabledReason || VISIBLE_REASONS.includes(firstDisabledReason.key);
- if (!dataEditingSetting || !shouldShowSection) {
+ if (
+ !dataEditingSetting ||
+ !shouldShowSection ||
+ !allowedToEnableTableEditing
+ ) {
return null;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.unit.spec.tsx
index c825593e3a1..d3e19424318 100644
--- a/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/table-editing/admin/AdminDatabaseTableEditingSection.unit.spec.tsx
@@ -6,16 +6,18 @@ import { DATABASE_TABLE_EDITING_SETTING } from "../settings";
import { AdminDatabaseTableEditingSection } from "./AdminDatabaseTableEditingSection";
-const setup = (
- setting: DatabaseLocalSettingAvailability = { enabled: true },
-) => {
- const mockDatabase = createMockDatabase();
+const setup = (options: {
+ driverSetting?: DatabaseLocalSettingAvailability;
+ engine?: string;
+}) => {
+ const { driverSetting = { enabled: true }, engine = "h2" } = options;
+ const mockDatabase = createMockDatabase({ engine });
return renderWithProviders(
<AdminDatabaseTableEditingSection
database={mockDatabase}
settingsAvailable={{
- [DATABASE_TABLE_EDITING_SETTING]: setting,
+ [DATABASE_TABLE_EDITING_SETTING]: driverSetting,
}}
updateDatabase={() => Promise.resolve()}
/>,
@@ -23,24 +25,35 @@ const setup = (
};
describe("AdminDatabaseTableEditingSection", () => {
- it("should render for supported engines", () => {
- setup({
- enabled: true,
- });
+ it.each(["postgres", "mysql"])(
+ "should render for supported engine: %s",
+ (engine) => {
+ setup({ engine });
+ expect(
+ screen.getByTestId("database-table-editing-section"),
+ ).toBeInTheDocument();
+ },
+ );
+
+ it("should hide section for unsupported engines", () => {
+ setup({ engine: "h2" });
expect(
- screen.getByTestId("database-table-editing-section"),
- ).toBeInTheDocument();
+ screen.queryByTestId("database-table-editing-section"),
+ ).not.toBeInTheDocument();
});
it("should render disabled toggle for specific disabled reasons", () => {
setup({
- enabled: false,
- reasons: [
- {
- key: "permissions/no-writable-table",
- message: "Database connection is read-only",
- },
- ],
+ driverSetting: {
+ enabled: false,
+ reasons: [
+ {
+ key: "permissions/no-writable-table",
+ message: "Database connection is read-only",
+ },
+ ],
+ },
+ engine: "postgres",
});
expect(
@@ -55,13 +68,16 @@ describe("AdminDatabaseTableEditingSection", () => {
it("should hide section for other disabled reasons", () => {
setup({
- enabled: false,
- reasons: [
- {
- key: "driver-feature-missing",
- message: "The driver does not support table editing",
- },
- ],
+ driverSetting: {
+ enabled: false,
+ reasons: [
+ {
+ key: "driver-feature-missing",
+ message: "The driver does not support table editing",
+ },
+ ],
+ },
+ engine: "mysql",
});
expect(
diff --git a/frontend/src/metabase/databases/constants.tsx b/frontend/src/metabase/databases/constants.tsx
index 5c8649631ad..5dba657a2b9 100644
--- a/frontend/src/metabase/databases/constants.tsx
+++ b/frontend/src/metabase/databases/constants.tsx
@@ -39,6 +39,12 @@ export const ELEVATED_ENGINES = [
"snowflake",
];
+// Although some drivers like MongoDB or H2 have table editing capabilities,
+// they were not thoroughly tested and verified.
+// We want to, for now at least, allow users to turn on table editing
+// just for PostgreSQL and MySQL databases.
+export const ALLOWED_ENGINES_FOR_TABLE_EDITING = ["postgres", "mysql"];
+
export const ENGINE_LOGO: Record<string, string> = {
athena: "athena.svg",
bigquery: "bigquery.svg",