Skip to content

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

Add Tenants Upsell (#74188)

Gabriel Moreno4540c63a1202
diff --git a/frontend/src/metabase-types/api/mocks/settings.ts b/frontend/src/metabase-types/api/mocks/settings.ts
index f71648868c0..81255967302 100644
--- a/frontend/src/metabase-types/api/mocks/settings.ts
+++ b/frontend/src/metabase-types/api/mocks/settings.ts
@@ -421,6 +421,7 @@ export const createMockSettings = (
"last-acknowledged-version": "v1",
"last-used-native-database-id": 1,
"embedding-homepage": "hidden",
+ "setup-embedding-autoenabled": false,
"setup-license-active-at-setup": false,
"embedding-hub-test-embed-snippet-created": false,
"embedding-hub-production-embed-snippet-created": false,
diff --git a/frontend/src/metabase-types/api/settings.ts b/frontend/src/metabase-types/api/settings.ts
index 7308ba06893..59fa78a329e 100644
--- a/frontend/src/metabase-types/api/settings.ts
+++ b/frontend/src/metabase-types/api/settings.ts
@@ -518,6 +518,7 @@ interface AdminSettings {
"system-timezone"?: string;
"embedding-homepage": EmbeddingHomepageStatus;
"setup-license-active-at-setup": boolean;
+ "setup-embedding-autoenabled": boolean;
"embedding-hub-test-embed-snippet-created": boolean;
"embedding-hub-production-embed-snippet-created": boolean;
"embedding-hub-sso-auth-manual-tested": boolean;
diff --git a/frontend/src/metabase/admin/people/components/PeopleNav.tsx b/frontend/src/metabase/admin/people/components/PeopleNav.tsx
index f601203aa8f..3a9a2a5e800 100644
--- a/frontend/src/metabase/admin/people/components/PeopleNav.tsx
+++ b/frontend/src/metabase/admin/people/components/PeopleNav.tsx
@@ -5,8 +5,12 @@ import {
type AdminNavItemProps,
AdminNavWrapper,
} from "metabase/admin/components/AdminNav";
-import { shouldNudgeToPro } from "metabase/admin/people/selectors";
+import {
+ shouldNudgeToPro,
+ shouldShowTenantsUpsell,
+} from "metabase/admin/people/selectors";
import { UpsellSSO } from "metabase/admin/upsells";
+import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";
import { useSetting } from "metabase/common/hooks";
import { useSelector } from "metabase/redux";
import { getLocation } from "metabase/selectors/routing";
@@ -15,6 +19,9 @@ import { Divider, Stack } from "metabase/ui";
export function PeopleNav() {
const shouldNudge = useSelector(shouldNudgeToPro) as boolean;
const isUsingTenants = useSetting("use-tenants");
+ const showTenantsUpsell = useSelector(shouldShowTenantsUpsell);
+ const showTenantsUpsellNav = showTenantsUpsell && !isUsingTenants;
+ const tenantUpsellGem = showTenantsUpsellNav ? <UpsellGem /> : undefined;
return (
<AdminNavWrapper justify="space-between" aria-label="people-nav">
@@ -54,6 +61,18 @@ export function PeopleNav() {
/>
</>
)}
+ {showTenantsUpsellNav && (
+ <>
+ <Divider my="sm" />
+ <PeopleNavItem
+ path="/admin/people/tenants"
+ data-testid="nav-item-tenants"
+ label={t`Tenants`}
+ icon="globe"
+ rightSection={tenantUpsellGem}
+ />
+ </>
+ )}
</Stack>
{shouldNudge && <UpsellSSO location="people-groups-settings" />}
</AdminNavWrapper>
diff --git a/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.tsx b/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.tsx
index 762fd143154..d530258ca33 100644
--- a/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.tsx
+++ b/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.tsx
@@ -1,10 +1,22 @@
import { AdminSettingsLayout } from "metabase/admin/components/AdminLayout/AdminSettingsLayout";
+import { shouldShowTenantsUpsell } from "metabase/admin/people/selectors";
+import { useSelector } from "metabase/redux";
+import { getLocation } from "metabase/selectors/routing";
import { PeopleNav } from "../../components/PeopleNav";
export const AdminPeopleApp = ({ children }: { children: React.ReactNode }) => {
+ const location = useSelector(getLocation);
+ const showTenantsUpsell = useSelector(shouldShowTenantsUpsell);
+ const isTenantsRoute = location?.pathname.startsWith("/admin/people/tenants");
+ const isFullWidth = showTenantsUpsell && isTenantsRoute;
+
return (
- <AdminSettingsLayout sidebar={<PeopleNav />} maw="80rem">
+ <AdminSettingsLayout
+ sidebar={<PeopleNav />}
+ maw="80rem"
+ fullWidth={isFullWidth}
+ >
{children}
</AdminSettingsLayout>
);
diff --git a/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.unit.spec.tsx b/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.unit.spec.tsx
index 5c3654f8fa5..7ea4b4bfe64 100644
--- a/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.unit.spec.tsx
+++ b/frontend/src/metabase/admin/people/containers/AdminPeopleApp/AdminPeopleApp.unit.spec.tsx
@@ -1,10 +1,17 @@
-import { Route } from "react-router";
+import { IndexRoute, Route } from "react-router";
-import { renderWithProviders, screen } from "__support__/ui";
+import { renderWithProviders, screen, within } from "__support__/ui";
+import { UpsellTenants } from "metabase/admin/upsells/UpsellTenants";
+import { createTenantsRouteGuard } from "metabase/admin/utils";
import {
+ createMockAdminAppState,
+ createMockAdminState,
+ createMockLocation,
+ createMockRoutingState,
createMockSettingsState,
createMockState,
} from "metabase/redux/store/mocks";
+import type { EmbeddingHomepageStatus } from "metabase-types/api";
import {
createMockTokenFeatures,
createMockUser,
@@ -17,6 +24,9 @@ interface SetupOpts {
ssoEnabled?: boolean;
isSuperUser?: boolean;
useTenants?: boolean;
+ setupEmbeddingAutoenabled?: boolean;
+ embeddingHomepage?: "hidden" | "visible" | "dismissed";
+ hasTenantsFeature?: boolean;
}
const setup = async (inputSetupOpts?: Partial<SetupOpts>) => {
@@ -25,6 +35,9 @@ const setup = async (inputSetupOpts?: Partial<SetupOpts>) => {
ssoEnabled: false,
isSuperUser: true,
useTenants: false,
+ setupEmbeddingAutoenabled: false,
+ embeddingHomepage: "hidden",
+ hasTenantsFeature: false,
};
const setupOpts = Object.assign(defaultSetupOpts, inputSetupOpts ?? {});
@@ -34,9 +47,13 @@ const setup = async (inputSetupOpts?: Partial<SetupOpts>) => {
}),
settings: createMockSettingsState({
"active-users-count": setupOpts.activeUsersCount,
+ "embedding-homepage":
+ setupOpts.embeddingHomepage as EmbeddingHomepageStatus,
+ "setup-embedding-autoenabled": setupOpts.setupEmbeddingAutoenabled,
"use-tenants": setupOpts.useTenants,
"token-features": createMockTokenFeatures({
sso_saml: setupOpts.ssoEnabled,
+ tenants: setupOpts.hasTenantsFeature,
}),
}),
});
@@ -50,13 +67,53 @@ const setup = async (inputSetupOpts?: Partial<SetupOpts>) => {
);
};
+const setupTenantRoute = async (initialRoute: string) => {
+ const state = createMockState({
+ admin: createMockAdminState({
+ app: createMockAdminAppState({
+ paths: [{ key: "people", name: "People", path: "/admin/people" }],
+ }),
+ }),
+ currentUser: createMockUser({
+ is_superuser: true,
+ }),
+ routing: createMockRoutingState({
+ locationBeforeTransitions: createMockLocation({
+ pathname: initialRoute,
+ }),
+ }),
+ settings: createMockSettingsState({
+ "setup-embedding-autoenabled": true,
+ "use-tenants": false,
+ "token-features": createMockTokenFeatures({
+ tenants: false,
+ }),
+ }),
+ });
+
+ renderWithProviders(
+ <Route path="/admin/people" component={AdminPeopleApp}>
+ <Route path="tenants" component={createTenantsRouteGuard()}>
+ <Route path="groups" component={UpsellTenants} />
+ <Route path="people" component={UpsellTenants} />
+ <IndexRoute component={UpsellTenants} />
+ </Route>
+ </Route>,
+ {
+ initialRoute,
+ storeInitialState: state,
+ withRouter: true,
+ },
+ );
+};
+
describe("AdminPeopleApp", () => {
describe("sidebar", () => {
it("should render only internal people and groups links if tenants is disabled", async () => {
await setup();
- assertNavLink("People", "/admin/people");
- assertNavLink("Groups", "/admin/people/groups");
+ await assertNavLink("People", "/admin/people");
+ await assertNavLink("Groups", "/admin/people/groups");
expect(screen.queryByText("Tenants")).not.toBeInTheDocument();
expect(screen.queryByText("Tenant users")).not.toBeInTheDocument();
});
@@ -64,10 +121,42 @@ describe("AdminPeopleApp", () => {
it("should render both internal and external people links if tenants is enabled", async () => {
await setup({ useTenants: true });
- assertNavLink("Internal users", "/admin/people");
- assertNavLink("Internal groups", "/admin/people/groups");
- assertNavLink("Tenants", "/admin/people/tenants");
- assertNavLink("Tenant users", "/admin/people/tenants/people");
+ await assertNavLink("Internal users", "/admin/people");
+ await assertNavLink("Internal groups", "/admin/people/groups");
+ await assertNavLink("Tenants", "/admin/people/tenants");
+ await assertNavLink("Tenant users", "/admin/people/tenants/people");
+ });
+
+ it("should render a tenant upsell link for embedding setup instances without tenants", async () => {
+ await setup({ setupEmbeddingAutoenabled: true });
+
+ const tenantsLink = await assertNavLink(
+ "Tenants",
+ "/admin/people/tenants",
+ );
+
+ expect(within(tenantsLink).getByTestId("upsell-gem")).toBeInTheDocument();
+ });
+
+ it("should render tenant upsell links when only the legacy embedding homepage signal is present", async () => {
+ await setup({ embeddingHomepage: "visible" });
+
+ const tenantsLink = await assertNavLink(
+ "Tenants",
+ "/admin/people/tenants",
+ );
+
+ expect(within(tenantsLink).getByTestId("upsell-gem")).toBeInTheDocument();
+ });
+ });
+
+ describe("tenant upsell routes", () => {
+ it("should render the tenant upsell on /admin/people/tenants", async () => {
+ await setupTenantRoute("/admin/people/tenants");
+
+ expect(
+ await screen.findByText("Manage customer-facing analytics at scale"),
+ ).toBeInTheDocument();
});
});
@@ -103,7 +192,12 @@ describe("AdminPeopleApp", () => {
});
async function assertNavLink(linkText: string, linkHref: string) {
- const link = await screen.findByText(linkText);
+ const linkLabel = await screen.findByText(linkText);
+ const link =
+ linkLabel.closest("a") ?? document.querySelector(`a[href="${linkHref}"]`);
+
expect(link).toBeInTheDocument();
expect(link).toHaveAttribute("href", linkHref);
+
+ return link as HTMLElement;
}
diff --git a/frontend/src/metabase/admin/people/selectors.ts b/frontend/src/metabase/admin/people/selectors.ts
index c95f83dba11..2d0496bc57b 100644
--- a/frontend/src/metabase/admin/people/selectors.ts
+++ b/frontend/src/metabase/admin/people/selectors.ts
@@ -23,3 +23,17 @@ export const shouldNudgeToPro = createSelector(
);
},
);
+
+export const shouldShowTenantsUpsell = createSelector(
+ (state) => getSetting(state, "setup-embedding-autoenabled"),
+ (state) => getSetting(state, "embedding-homepage"),
+ (state) => getSetting(state, "token-features"),
+ (wasEmbeddingAutoenabled, embeddingHomepage, tokenFeatures) => {
+ // Older web setup flows only persisted this broader embedding interest
+ // signal, while the SDK CLI already persisted setup-embedding-autoenabled.
+ const hasEmbeddingSetupSignal =
+ Boolean(wasEmbeddingAutoenabled) || embeddingHomepage === "visible";
+
+ return hasEmbeddingSetupSignal && !tokenFeatures?.tenants;
+ },
+);
diff --git a/frontend/src/metabase/admin/routes.tsx b/frontend/src/metabase/admin/routes.tsx
index 3f06f9dbc40..ecac8be9bb1 100644
--- a/frontend/src/metabase/admin/routes.tsx
+++ b/frontend/src/metabase/admin/routes.tsx
@@ -75,6 +75,7 @@ import { getSettingsRoutes } from "./settingsRoutes";
import { ToolsApp } from "./tools/components/ToolsApp";
import { ToolsUpsell } from "./tools/components/ToolsUpsell";
import { getTasksRoutes } from "./tools/routes";
+import { UpsellTenants } from "./upsells/UpsellTenants";
import {
RedirectToAllowedSettings,
createAdminRouteGuard,
@@ -159,7 +160,13 @@ export const getRoutes = (
{/* Tenants */}
<Route path="tenants" component={createTenantsRouteGuard()}>
- {PLUGIN_TENANTS.tenantsRoutes}
+ {PLUGIN_TENANTS.tenantsRoutes ?? (
+ <>
+ <IndexRoute component={UpsellTenants} />
+ <Route path="groups" component={UpsellTenants} />
+ <Route path="people" component={UpsellTenants} />
+ </>
+ )}
</Route>
<Route path="" component={PeopleListingApp}>
diff --git a/frontend/src/metabase/admin/upsells/UpsellTenants.tsx b/frontend/src/metabase/admin/upsells/UpsellTenants.tsx
new file mode 100644
index 00000000000..0061f0912c1
--- /dev/null
+++ b/frontend/src/metabase/admin/upsells/UpsellTenants.tsx
@@ -0,0 +1,42 @@
+import { t } from "ttag";
+
+import { DottedBackground } from "metabase/common/components/upsells/components/DottedBackground";
+import { LineDecorator } from "metabase/common/components/upsells/components/LineDecorator";
+import { useUpgradeAction } from "metabase/common/components/upsells/components/UpgradeModal";
+import { UpsellCardContent } from "metabase/common/components/upsells/components/UpsellCardContent";
+import { UPGRADE_URL } from "metabase/common/components/upsells/constants";
+import { useHasTokenFeature } from "metabase/common/hooks";
+import { Stack } from "metabase/ui";
+
+export const UpsellTenants = () => {
+ const hasTenants = useHasTokenFeature("tenants");
+ const campaign = "tenants";
+ const location = "people-tenants";
+ const { onClick: upgradeOnClick, url: upgradeUrl } = useUpgradeAction({
+ url: UPGRADE_URL,
+ campaign,
+ location,
+ });
+
+ if (hasTenants) {
+ return null;
+ }
+
+ return (
+ <DottedBackground px="3.5rem" pb="2rem">
+ <Stack align="center" p={40}>
+ <LineDecorator>
+ <UpsellCardContent
+ campaign={campaign}
+ location={location}
+ title={t`Manage customer-facing analytics at scale`}
+ description={t`Group your customers into tenants, reuse the same dashboards and permissions, and keep each tenant's data isolated.`}
+ upgradeOnClick={upgradeOnClick}
+ upgradeUrl={upgradeUrl}
+ image="app/assets/img/upsell-tenants.png"
+ />
+ </LineDecorator>
+ </Stack>
+ </DottedBackground>
+ );
+};
diff --git a/frontend/src/metabase/admin/upsells/index.ts b/frontend/src/metabase/admin/upsells/index.ts
index d5cd578eaeb..316c7e846fd 100644
--- a/frontend/src/metabase/admin/upsells/index.ts
+++ b/frontend/src/metabase/admin/upsells/index.ts
@@ -9,6 +9,7 @@ export * from "./UpsellPerformanceTools";
export * from "./UpsellPermissions";
export * from "./UpsellRemoteSync";
export * from "./UpsellSSO";
+export * from "./UpsellTenants";
export * from "./UpsellUploads";
export * from "./UpsellWhitelabel";
export { UpsellDevInstances } from "./UpsellDevInstances";
diff --git a/frontend/src/metabase/admin/utils.ts b/frontend/src/metabase/admin/utils.ts
index 40fa2ed195a..b38691524d4 100644
--- a/frontend/src/metabase/admin/utils.ts
+++ b/frontend/src/metabase/admin/utils.ts
@@ -3,6 +3,7 @@ import { push, replace, routerActions } from "react-router-redux";
import { connectedReduxRedirect } from "redux-auth-wrapper/history3/redirect";
import { getAdminPaths } from "metabase/admin/app/selectors";
+import { shouldShowTenantsUpsell } from "metabase/admin/people/selectors";
import { connect, metabaseReduxContext } from "metabase/redux";
import type { State } from "metabase/redux/store";
import type { AdminPath } from "metabase/redux/store/admin";
@@ -60,7 +61,7 @@ export const createTenantsRouteGuard = () => {
allowRedirectBack: false,
authenticatedSelector: (state) =>
getAdminPaths(state)?.find((path) => path.key === "people") != null &&
- getSetting(state, "use-tenants"),
+ (getSetting(state, "use-tenants") || shouldShowTenantsUpsell(state)),
redirectAction: routerActions.replace,
context: metabaseReduxContext,
});
diff --git a/frontend/src/metabase/setup/actions.ts b/frontend/src/metabase/setup/actions.ts
index c369af561c9..ed179029b51 100644
--- a/frontend/src/metabase/setup/actions.ts
+++ b/frontend/src/metabase/setup/actions.ts
@@ -233,6 +233,10 @@ export const setEmbeddingHomepageFlags = createAsyncThunk(
settingsToChange["embedding-homepage"] = "visible";
}
+ if (interestedInEmbedding) {
+ settingsToChange["setup-embedding-autoenabled"] = true;
+ }
+
settingsToChange["setup-license-active-at-setup"] = isLicenseActive;
dispatch(updateSettings(settingsToChange));
diff --git a/frontend/src/metabase/setup/tests/common.unit.spec.tsx b/frontend/src/metabase/setup/tests/common.unit.spec.tsx
index 2eed773622f..12eb244bf0b 100644
--- a/frontend/src/metabase/setup/tests/common.unit.spec.tsx
+++ b/frontend/src/metabase/setup/tests/common.unit.spec.tsx
@@ -136,6 +136,7 @@ describe("setup (OSS)", () => {
expect(await getLastSettingsPutPayload()).toEqual({
"embedding-homepage": "visible",
+ "setup-embedding-autoenabled": true,
"setup-license-active-at-setup": false,
});
});
@@ -181,6 +182,7 @@ describe("setup (OSS)", () => {
expect(flags).toEqual({
"embedding-homepage": "visible",
+ "setup-embedding-autoenabled": true,
"setup-license-active-at-setup": false,
});
});
diff --git a/frontend/src/metabase/setup/tests/premium-pro-cloud.unit.spec.tsx b/frontend/src/metabase/setup/tests/premium-pro-cloud.unit.spec.tsx
index aa1b1934cb2..db7d48f5375 100644
--- a/frontend/src/metabase/setup/tests/premium-pro-cloud.unit.spec.tsx
+++ b/frontend/src/metabase/setup/tests/premium-pro-cloud.unit.spec.tsx
@@ -62,6 +62,7 @@ describe("setup (EE build, `hosting` and `embedding` features to simulate pro on
expect(await getLastSettingsPutPayload()).toEqual({
"embedding-homepage": "visible",
+ "setup-embedding-autoenabled": true,
"setup-license-active-at-setup": true,
});
});
diff --git a/frontend/src/metabase/setup/tests/premium-pro-selfhosted.unit.spec.tsx b/frontend/src/metabase/setup/tests/premium-pro-selfhosted.unit.spec.tsx
index 20e874f680c..2739edaf8b5 100644
--- a/frontend/src/metabase/setup/tests/premium-pro-selfhosted.unit.spec.tsx
+++ b/frontend/src/metabase/setup/tests/premium-pro-selfhosted.unit.spec.tsx
@@ -64,6 +64,7 @@ describe("setup (EE build, `embedding` feature but no `hosting` to simulate pro
expect(await getLastSettingsPutPayload()).toEqual({
"embedding-homepage": "visible",
+ "setup-embedding-autoenabled": true,
"setup-license-active-at-setup": true,
});
});
diff --git a/frontend/src/metabase/setup/tests/premium-starter-cloud.unit.spec.tsx b/frontend/src/metabase/setup/tests/premium-starter-cloud.unit.spec.tsx
index 40e9fa808ce..b8a99bcc364 100644
--- a/frontend/src/metabase/setup/tests/premium-starter-cloud.unit.spec.tsx
+++ b/frontend/src/metabase/setup/tests/premium-starter-cloud.unit.spec.tsx
@@ -61,6 +61,7 @@ describe("setup (EE build, only `hosting` feature to simulate starter plan on cl
expect(await getLastSettingsPutPayload()).toEqual({
"embedding-homepage": "visible",
+ "setup-embedding-autoenabled": true,
"setup-license-active-at-setup": false,
});
});
diff --git a/resources/frontend_client/app/assets/img/upsell-tenants.png b/resources/frontend_client/app/assets/img/upsell-tenants.png
new file mode 100644
index 00000000000..e5599aa4585
Binary files /dev/null and b/resources/frontend_client/app/assets/img/upsell-tenants.png differ