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 no writable databases state to transforms pages (#72880)
Nick Fitzpatrick280c1fc21a5d
diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.tsindex 3144fca254b..3e67e5653fe 100644--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts@@ -32,7 +32,7 @@ const TARGET_SCHEMA = "Schema A";const TARGET_SCHEMA_2 = "Schema B";const CUSTOM_SCHEMA = "custom_schema";-describe("scenarios > admin > transforms", () => {+describe("scenarios > admin > transforms", { tags: ["@external"] }, () => {beforeEach(() => {H.restore("postgres-writable");H.resetTestTable({ type: "postgres", table: "many_schemas" });@@ -3780,26 +3780,15 @@ describe("scenarios > admin > transforms", () => {H.expectNoBadSnowplowEvents();});- it("should not pick the only database when it is disabled in SQL editor", () => {- cy.log("create a new transform");- visitTransformListPage();- cy.button("Create a transform").click();- H.popover().findByText("SQL query").click();-- cy.findByTestId("gui-builder-data")- .findByText("Select a database")- .should("be.visible");- });-- it("should not pick the only database when it is disabled in Python editor", () => {+ it("should show a message when no supported databases are available", () => {cy.log("create a new transform");visitTransformListPage();- cy.button("Create a transform").click();- H.popover().findByText("Python script").click();-- cy.findByTestId("python-transform-top-bar")- .findByText("Select a database")- .should("be.visible");+ cy.findByRole("heading", {+ name: "To use transforms, you need a writable database connection",+ }).should("exist");+ cy.findByRole("link", { name: "View your database connections" }).should(+ "exist",+ );});});@@ -4175,13 +4164,13 @@ function checkSortingOrder(transformNames: string[]) {describe("scenarios > data studio > transforms > permissions > oss", () => {beforeEach(() => {- H.restore();+ H.restore("postgres-writable");cy.signInAsAdmin();});it("should be able to enable transforms in OSS without upsell gem icon",- { tags: "@OSS" },+ { tags: ["@OSS", "@external"] },() => {cy.log("ensure that transform permissions are not shown");cy.visit(`/admin/permissions/data/group/${ALL_USERS_GROUP_ID}`);@@ -4240,62 +4229,70 @@ describe("scenarios > data studio > transforms > permissions > oss", () => {);});-describe("scenarios > data studio > transforms > permissions > pro-self-hosted", () => {- beforeEach(() => {- H.restore();- cy.signInAsAdmin();- });+describe(+ "scenarios > data studio > transforms > permissions > pro-self-hosted",+ { tags: ["@external"] },+ () => {+ beforeEach(() => {+ H.restore("postgres-writable");+ cy.signInAsAdmin();+ });- it("should have transforms available in self-hosted pro without upsell gem icon", () => {- H.activateToken("pro-self-hosted").then(() => {- cy.log("ensure that transform permissions are not shown");- cy.visit(`/admin/permissions/data/group/${ALL_USERS_GROUP_ID}`);+ it("should have transforms available in self-hosted pro without upsell gem icon", () => {+ H.activateToken("pro-self-hosted").then(() => {+ cy.log("ensure that transform permissions are not shown");+ cy.visit(`/admin/permissions/data/group/${ALL_USERS_GROUP_ID}`);- //Check that a known header is present- cy.findByRole("columnheader", { name: "Database name" }).should(- "be.visible",- );- //Ensure transform permissions are not displayed- cy.findByRole("columnheader", { name: /Transforms/ }).should("not.exist");+ //Check that a known header is present+ cy.findByRole("columnheader", { name: "Database name" }).should(+ "be.visible",+ );+ //Ensure transform permissions are not displayed+ cy.findByRole("columnheader", { name: /Transforms/ }).should(+ "not.exist",+ );- cy.log("Visit data studio page");- cy.visit("/data-studio");- H.DataStudio.nav().should("be.visible");+ cy.log("Visit data studio page");+ cy.visit("/data-studio");+ H.DataStudio.nav().should("be.visible");- cy.log("Verify Transforms menu item is visible");- H.DataStudio.nav().findByText("Transforms").should("be.visible");+ cy.log("Verify Transforms menu item is visible");+ H.DataStudio.nav().findByText("Transforms").should("be.visible");- cy.log("Verify no upsell gem icon is displayed in Transforms menu item");- H.DataStudio.nav()- .findByText("Transforms")- .closest("a")- .within(() => {- cy.findByTestId("upsell-gem").should("not.exist");- });+ cy.log(+ "Verify no upsell gem icon is displayed in Transforms menu item",+ );+ H.DataStudio.nav()+ .findByText("Transforms")+ .closest("a")+ .within(() => {+ cy.findByTestId("upsell-gem").should("not.exist");+ });- cy.log("Verify transforms page is accessible");- H.DataStudio.nav().findByText("Transforms").click();- H.DataStudio.Transforms.enableTransformPage()- .findByRole("button", { name: "Enable transforms" })- .click();- H.DataStudio.Transforms.list().should("be.visible");+ cy.log("Verify transforms page is accessible");+ H.DataStudio.nav().findByText("Transforms").click();+ H.DataStudio.Transforms.enableTransformPage()+ .findByRole("button", { name: "Enable transforms" })+ .click();+ H.DataStudio.Transforms.list().should("be.visible");- cy.log("Verify can create transforms in pro-self-hosted");- cy.button("Create a transform").should("be.visible");+ cy.log("Verify can create transforms in pro-self-hosted");+ cy.button("Create a transform").should("be.visible");- cy.log("transform permissions should now be visible");- H.goToAdmin();- H.appBar().findByRole("link", { name: "Permissions" }).click();- cy.findByRole("menuitem", { name: "All Users" }).click();+ cy.log("transform permissions should now be visible");+ H.goToAdmin();+ H.appBar().findByRole("link", { name: "Permissions" }).click();+ cy.findByRole("menuitem", { name: "All Users" }).click();- //Check that a known header is present- cy.findByRole("columnheader", { name: "Database name" }).should(- "be.visible",- );- //Ensure transform permissions are displayed- cy.findByRole("columnheader", { name: /Transforms/ })- .scrollIntoView()- .should("be.visible");+ //Check that a known header is present+ cy.findByRole("columnheader", { name: "Database name" }).should(+ "be.visible",+ );+ //Ensure transform permissions are displayed+ cy.findByRole("columnheader", { name: /Transforms/ })+ .scrollIntoView()+ .should("be.visible");+ });});- });-});+ },+);diff --git a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.tsx b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.tsxindex 7ed41d2bf3b..0644241cbe6 100644--- a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.tsx+++ b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.tsx@@ -1,11 +1,14 @@import type { ReactNode } from "react";import { t } from "ttag";+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";import { useSetting } from "metabase/common/hooks";import { usePageTitle } from "metabase/hooks/use-page-title";import { PLUGIN_TRANSFORMS } from "metabase/plugins";import { useSelector } from "metabase/redux";+import { useTransformSupportedDbs } from "metabase/transforms/hooks/use-transform-supported-dbs";import { EnableTransformsPage } from "metabase/transforms/pages/EnableTransformsPage/EnableTransformsPage";+import { NoWritableDatabasesEmptyState } from "metabase/transforms/pages/NoWritableDatabasesEmptyState";import { getShouldShowTransformsUpsell } from "metabase/transforms/selectors";import { SectionLayout } from "../../components/SectionLayout";@@ -21,6 +24,8 @@ export function TransformsSectionLayout({const shouldShowUpsell = useSelector(getShouldShowTransformsUpsell);const isTransformsEnabled = useSetting("transforms-enabled");const isHosted = useSetting("is-hosted?");+ const { transformsDatabases, isLoadingDatabases, databasesError } =+ useTransformSupportedDbs();if (shouldShowUpsell) {return <PLUGIN_TRANSFORMS.TransformsUpsellPage />;@@ -28,5 +33,23 @@ export function TransformsSectionLayout({return <EnableTransformsPage />;}- return <SectionLayout>{children}</SectionLayout>;+ if (!isLoadingDatabases && transformsDatabases?.length === 0) {+ return (+ <SectionLayout>+ <NoWritableDatabasesEmptyState />+ </SectionLayout>+ );+ }++ return (+ <SectionLayout>+ <LoadingAndErrorWrapper+ loading={isLoadingDatabases}+ error={databasesError}+ noWrapper+ >+ {children}+ </LoadingAndErrorWrapper>+ </SectionLayout>+ );}diff --git a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsx b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsxindex de752a390a0..c835a42fca3 100644--- a/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsx+++ b/frontend/src/metabase/data-studio/app/pages/TransformsSectionLayout/TransformsSectionLayout.unit.spec.tsx@@ -1,3 +1,6 @@+import fetchMock from "fetch-mock";+import { Route } from "react-router";+import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";import {setupDatabaseListEndpoint,@@ -9,7 +12,10 @@ import {import { mockSettings } from "__support__/settings";import { renderWithProviders, screen } from "__support__/ui";import { createMockState } from "metabase/redux/store/mocks";+import type { Database } from "metabase-types/api";import {+ COMMON_DATABASE_FEATURES,+ createMockDatabase,createMockSettings,createMockTokenFeatures,createMockUser,@@ -17,6 +23,12 @@ import {import { TransformsSectionLayout } from "./TransformsSectionLayout";+const createTransformSupportedDatabase = (opts?: Partial<Database>) =>+ createMockDatabase({+ features: [...COMMON_DATABASE_FEATURES, "transforms/table"],+ ...opts,+ });+jest.mock("metabase/nav/components/AppSwitcher", () => ({AppSwitcher: () => "App Switcher",}));@@ -27,14 +39,25 @@ const setup = ({transformsEnabled = false,isAdmin = false,isStoreUser = false,+ canAccessDbDetails = false,+ databases = [],+ databasesError = false,}: {isHosted?: boolean;hasTransformFeature?: boolean;transformsEnabled?: boolean;isAdmin?: boolean;isStoreUser?: boolean;+ canAccessDbDetails?: boolean;+ databases?: Database[];+ databasesError?: boolean;} = {}) => {setupUserMetabotPermissionsEndpoint();+ if (databasesError) {+ fetchMock.get("path:/api/database", 500);+ } else {+ setupDatabaseListEndpoint(databases);+ }const storeUserEmail = "[email protected]";const currentUser = createMockUser({ is_superuser: isAdmin });@@ -58,20 +81,33 @@ const setup = ({});const settings = mockSettings(settingsValues);- setupDatabaseListEndpoint([]);setupPropertiesEndpoints(settingsValues);if (isHosted || hasTransformFeature) {setupEnterpriseOnlyPlugin("transforms");}+ const path = "/transforms";+renderWithProviders(- <TransformsSectionLayout>List of transforms</TransformsSectionLayout>,+ <Route+ path={path}+ component={() => (+ <TransformsSectionLayout>+ <div>List of transforms</div>+ </TransformsSectionLayout>+ )}+ />,{storeInitialState: createMockState({settings,- currentUser,+ currentUser: createMockUser({+ is_superuser: isAdmin,+ permissions: { can_access_db_details: canAccessDbDetails },+ }),}),+ withRouter: true,+ initialRoute: path,},);};@@ -90,9 +126,12 @@ describe("TransformSectionLayout", () => {await screen.findByRole("button", { name: "Enable transforms" }),).toBeInTheDocument();});- it("should show allow you into transforms if transforms are enabled", async () => {+ it("should show allow you into transforms if transforms are enabled and writable databases exist", async () => {setup({transformsEnabled: true,+ databases: [+ createTransformSupportedDatabase({ transforms_permissions: "write" }),+ ],});await assertInApp();@@ -106,7 +145,13 @@ describe("TransformSectionLayout", () => {});it("Should only allow you into transforms if you transforms are enabled", async () => {- setup({ hasTransformFeature: true, transformsEnabled: true });+ setup({+ hasTransformFeature: true,+ transformsEnabled: true,+ databases: [+ createTransformSupportedDatabase({ transforms_permissions: "write" }),+ ],+ });await assertInApp();});});@@ -128,10 +173,112 @@ describe("TransformSectionLayout", () => {});it("should show you the app if the instance is hosted and the transform feature is present", async () => {- setup({ isHosted: true, hasTransformFeature: true });+ setup({+ isHosted: true,+ hasTransformFeature: true,+ databases: [+ createTransformSupportedDatabase({ transforms_permissions: "write" }),+ ],+ });await assertInApp();});});++ describe("No writable databases", () => {+ it("should show empty state when no databases are writable or supported", async () => {+ setup({+ transformsEnabled: true,+ databases: [+ createMockDatabase({ id: 1, transforms_permissions: "none" }),+ createMockDatabase({+ id: 2,+ transforms_permissions: "write",+ is_sample: true,+ }),+ createMockDatabase({+ id: 3,+ transforms_permissions: "write",+ router_database_id: 99,+ }),+ createMockDatabase({+ id: 4,+ transforms_permissions: "write",+ is_audit: true,+ }),+ ],+ });++ await assertNoWritableDatabasesEmptyState();+ });++ it("should show empty state when transforms are enabled and the database list is empty", async () => {+ setup({+ transformsEnabled: true,+ databases: [],+ });++ await assertNoWritableDatabasesEmptyState();+ });++ it("should show the 'View your database connections' button linking to admin databases for admin users", async () => {+ setup({+ transformsEnabled: true,+ isAdmin: true,+ databases: [],+ });++ await assertNoWritableDatabasesEmptyState();+ const link = screen.getByRole("link", {+ name: "View your database connections",+ });+ expect(link).toHaveAttribute("href", "/admin/databases");+ });++ it("should show the 'View your database connections' button for users with manage database permission", async () => {+ setup({+ transformsEnabled: true,+ isAdmin: false,+ canAccessDbDetails: true,+ databases: [],+ });++ await assertNoWritableDatabasesEmptyState();+ expect(+ screen.getByRole("link", {+ name: "View your database connections",+ }),+ ).toBeInTheDocument();+ });++ it("should not show the 'View your database connections' button for non-admin users without manage database permission", async () => {+ setup({+ transformsEnabled: true,+ isAdmin: false,+ databases: [],+ });++ await assertNoWritableDatabasesEmptyState();+ expect(+ screen.queryByRole("link", {+ name: "View your database connections",+ }),+ ).not.toBeInTheDocument();+ });++ it("should show an error UI (not the empty state) when the databases request fails", async () => {+ setup({+ transformsEnabled: true,+ databasesError: true,+ });++ expect(await screen.findByText(/error/i)).toBeInTheDocument();+ expect(+ screen.queryByText(+ "To use transforms, you need a writable database connection",+ ),+ ).not.toBeInTheDocument();+ });+ });});const assertInApp = async () =>@@ -140,3 +287,10 @@ const assertEnableScreen = async () =>expect(await screen.findByText("Customize and clean up your data"),).toBeInTheDocument();++const assertNoWritableDatabasesEmptyState = async () =>+ expect(+ await screen.findByText(+ "To use transforms, you need a writable database connection",+ ),+ ).toBeInTheDocument();diff --git a/frontend/src/metabase/transforms/hooks/use-transform-supported-dbs.ts b/frontend/src/metabase/transforms/hooks/use-transform-supported-dbs.tsnew file mode 100644index 00000000000..8af0061a273--- /dev/null+++ b/frontend/src/metabase/transforms/hooks/use-transform-supported-dbs.ts@@ -0,0 +1,23 @@+import { useMemo } from "react";++import { useListDatabasesQuery } from "metabase/api/database";++import { doesDatabaseSupportTransforms } from "../utils";++export const useTransformSupportedDbs = () => {+ const {+ data: databases,+ isLoading: isLoadingDatabases,+ error: databasesError,+ } = useListDatabasesQuery();++ const transformsDatabases = useMemo(() => {+ return databases?.data.filter((d) => doesDatabaseSupportTransforms(d));+ }, [databases]);++ return {+ transformsDatabases,+ isLoadingDatabases,+ databasesError,+ };+};diff --git a/frontend/src/metabase/transforms/pages/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsx b/frontend/src/metabase/transforms/pages/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsxnew file mode 100644index 00000000000..f16f6cae34b--- /dev/null+++ b/frontend/src/metabase/transforms/pages/NoWritableDatabasesEmptyState/NoWritableDatabasesEmptyState.tsx@@ -0,0 +1,46 @@+import { Link } from "react-router";+import { t } from "ttag";++import { DataStudioBreadcrumbs } from "metabase/data-studio/common/components/DataStudioBreadcrumbs";+import { PageContainer } from "metabase/data-studio/common/components/PageContainer";+import { PaneHeader } from "metabase/data-studio/common/components/PaneHeader";+import { useSelector } from "metabase/redux";+import { getUser, getUserIsAdmin } from "metabase/selectors/user";+import { Button, Center, Icon, Stack, Text, Title } from "metabase/ui";+import * as Urls from "metabase/urls";++export function NoWritableDatabasesEmptyState() {+ const isAdmin = useSelector(getUserIsAdmin);+ const user = useSelector(getUser);+ const canAccessDatabases =+ isAdmin || user?.permissions?.can_access_db_details;++ return (+ <PageContainer data-testid="no-writable-databases-empty-state">+ <PaneHeader+ breadcrumbs={+ <DataStudioBreadcrumbs>{t`Transforms`}</DataStudioBreadcrumbs>+ }+ />+ <Center flex={1}>+ <Stack align="center" maw="30rem" gap="md">+ <Icon name="database" size={48} c="text-tertiary" />+ <Title+ order={3}+ ta="center"+ >{t`To use transforms, you need a writable database connection`}</Title>+ <Text ta="center" c="text-secondary">+ {t`None of your connected databases have a writable connection. Either edit the connection on the database you want to enable transforms on, or connect to a different database.`}+ </Text>+ {canAccessDatabases && (+ <Button+ component={Link}+ to={Urls.viewDatabases()}+ variant="filled"+ >{t`View your database connections`}</Button>+ )}+ </Stack>+ </Center>+ </PageContainer>+ );+}diff --git a/frontend/src/metabase/transforms/pages/NoWritableDatabasesEmptyState/index.ts b/frontend/src/metabase/transforms/pages/NoWritableDatabasesEmptyState/index.tsnew file mode 100644index 00000000000..1e77379163a--- /dev/null+++ b/frontend/src/metabase/transforms/pages/NoWritableDatabasesEmptyState/index.ts@@ -0,0 +1 @@+export { NoWritableDatabasesEmptyState } from "./NoWritableDatabasesEmptyState";