Skip to content

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

Add purchase page for paid Metabase AI add-on (#65343)

Dennis Schridde2b76c38e1f0a
diff --git a/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj b/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj
index 068b08dc38c..7487d02ca49 100644
--- a/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj
@@ -12,6 +12,9 @@
[metabase.util.i18n :refer [deferred-tru tru]]
[metabase.util.log :as log]))
+(def ^:private requires-terms-of-service?
+ #{"metabase-ai" "metabase-ai-tiered"})
+
(def ^:private error-no-connection
(deferred-tru "Could not establish a connection to Metabase Cloud."))
(def ^:private error-cannot-purchase
@@ -26,6 +29,8 @@
(deferred-tru "Only Metabase Store users can purchase add-ons."))
(def ^:private error-terms-not-accepted
(deferred-tru "Need to accept terms of service."))
+(def ^:private error-no-quantity
+ (deferred-tru "Purchase of add-on requires quantity."))
(def ^:private response-not-hosted
{:status 400 :body error-not-hosted})
@@ -35,6 +40,8 @@
{:status 403 :body error-not-store-user})
(def ^:private response-terms-not-accepted
{:status 400 :body {:errors {:terms_of_service error-terms-not-accepted}}})
+(def ^:private response-no-quantity
+ {:status 400 :body {:errors {:quantity error-no-quantity}}})
(def ^:private response-success-empty
{:status 200 :body {}})
@@ -89,21 +96,31 @@
(api.macros/defendpoint :post "/:product-type"
"Purchase an add-on."
[{:keys [product-type]} :- [:map
- [:product-type [:enum "metabase-ai" "python-execution"]]]
+ [:product-type [:enum "metabase-ai" "metabase-ai-tiered" "python-execution"]]]
_query-params
- {:keys [terms_of_service]} :- [:map
- [:terms_of_service {:optional true} [:maybe :boolean]]]]
+ {:keys [quantity]
+ terms-of-service :terms_of_service} :- [:map
+ [:quantity {:optional true} [:maybe :int]]
+ [:terms_of_service {:optional true} [:maybe :boolean]]]]
(api/check-superuser)
(cond
(not (premium-features/is-hosted?))
response-not-hosted
- (and (= product-type "metabase-ai")
- (not terms_of_service))
+ (and (requires-terms-of-service? product-type)
+ (not terms-of-service))
response-terms-not-accepted
+ (and (= product-type "metabase-ai-tiered")
+ (not quantity))
+ response-no-quantity
+
(and (= product-type "metabase-ai")
- (not (premium-features/offer-metabase-ai?)))
+ (not (premium-features/offer-metabase-ai-trial?)))
+ response-not-eligible
+
+ (and (= product-type "metabase-ai-tiered")
+ (not (premium-features/offer-metabase-ai-paid?)))
response-not-eligible
(and (= product-type "python-execution")
@@ -116,13 +133,14 @@
:else
(try
- (let [add-on {:product-type product-type}]
+ (let [add-on (cond-> {:product-type product-type}
+ quantity (assoc :prepaid-units quantity))]
(events/publish-event! :event/cloud-add-on-purchase {:details {:add-on add-on}, :user-id api/*current-user-id*})
(hm.client/call :change-add-ons :upsert-add-ons [add-on]))
(premium-features/clear-cache!)
response-success-empty
(catch Exception e
- (log/warnf e "Error adding purchasing add-on '%s'" product-type)
+ (log/warnf e "Error purchasing add-on '%s'" product-type)
(handle-store-api-error e {400 error-cannot-purchase})))))
(def ^{:arglists '([request respond raise])} routes
diff --git a/enterprise/backend/test/metabase_enterprise/api/session_test.clj b/enterprise/backend/test/metabase_enterprise/api/session_test.clj
index 9f044a069f6..74d4650f666 100644
--- a/enterprise/backend/test/metabase_enterprise/api/session_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/api/session_test.clj
@@ -35,6 +35,7 @@
:ai-sql-generation
:no-upsell
:offer-metabase-ai
+ :offer-metabase-ai-tiered
:official-collections
:query-reference-validation
:remote-sync
@@ -80,6 +81,7 @@
:ai_sql_fixer true
:ai_sql_generation true
:offer_metabase_ai true
+ :offer_metabase_ai_tiered true
:official_collections true
:query_reference_validation true
:remote_sync true
diff --git a/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts b/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts
new file mode 100644
index 00000000000..b2048ea7f70
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts
@@ -0,0 +1,26 @@
+import type {
+ GetCloudAddOnsResponse,
+ PurchaseCloudAddOnRequest,
+} from "metabase-types/api";
+
+import { EnterpriseApi } from "./api";
+
+export const cloudAddOnApi = EnterpriseApi.injectEndpoints({
+ endpoints: (builder) => ({
+ listAddOns: builder.query<GetCloudAddOnsResponse, void>({
+ query: () => ({
+ method: "GET",
+ url: "/api/ee/cloud-add-ons/addons",
+ }),
+ }),
+ purchaseCloudAddOn: builder.mutation<void, PurchaseCloudAddOnRequest>({
+ query: ({ product_type, ...body }) => ({
+ method: "POST",
+ url: `/api/ee/cloud-add-ons/${product_type}`,
+ body,
+ }),
+ }),
+ }),
+});
+export const { useListAddOnsQuery, usePurchaseCloudAddOnMutation } =
+ cloudAddOnApi;
diff --git a/enterprise/frontend/src/metabase-enterprise/api/index.ts b/enterprise/frontend/src/metabase-enterprise/api/index.ts
index 9cdd7901919..99f4b031eca 100644
--- a/enterprise/frontend/src/metabase-enterprise/api/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/api/index.ts
@@ -2,6 +2,7 @@ export * from "./ai-entity-analysis";
export * from "./api";
export * from "./audit-info";
export * from "./billing-info";
+export * from "./cloud-add-ons";
export * from "./comment";
export * from "./content-translation";
export * from "./db-routing";
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotPurchasePage.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotPurchasePage.tsx
new file mode 100644
index 00000000000..dd96d244166
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotPurchasePage.tsx
@@ -0,0 +1,181 @@
+import { useDisclosure } from "@mantine/hooks";
+import { type ReactElement, useCallback } from "react";
+import { P, match } from "ts-pattern";
+import { t } from "ttag";
+import * as Yup from "yup";
+
+import {
+ SettingsPageWrapper,
+ SettingsSection,
+} from "metabase/admin/components/SettingsSection";
+import ExternalLink from "metabase/common/components/ExternalLink";
+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
+import {
+ Form,
+ FormCheckbox,
+ FormProvider,
+ FormSubmitButton,
+} from "metabase/forms";
+import { useSelector } from "metabase/lib/redux";
+import { getStoreUsers } from "metabase/selectors/store-users";
+import { Card, Stack, Text } from "metabase/ui";
+import { usePurchaseCloudAddOnMutation } from "metabase-enterprise/api";
+
+import { MetabotSettingUpModal } from "../MetabotSettingUpModal";
+import { handleFieldError, isFetchBaseQueryError } from "../utils";
+
+import { MetabotRadios } from "./MetabotRadios";
+import { useAddOnsBilling } from "./hooks";
+import type { IMetabotPurchaseFormFields } from "./types";
+
+export function MetabotPurchasePage(): ReactElement {
+ const { isStoreUser, anyStoreUserEmailAddress } = useSelector(getStoreUsers);
+
+ const { isLoading, error, billingPeriodMonths, tiers, defaultQuantity } =
+ useAddOnsBilling();
+ const hasData =
+ billingPeriodMonths !== undefined &&
+ defaultQuantity !== undefined &&
+ tiers.length > 0;
+
+ const [settingUpModalOpened, settingUpModalHandlers] = useDisclosure(false);
+ const [purchaseCloudAddOn] = usePurchaseCloudAddOnMutation();
+ const onSubmit = useCallback(
+ async ({ quantity, terms_of_service }: IMetabotPurchaseFormFields) => {
+ settingUpModalHandlers.open();
+ await purchaseCloudAddOn({
+ product_type: "metabase-ai-tiered",
+ quantity: parseInt(quantity, 10),
+ terms_of_service,
+ })
+ .unwrap()
+ .catch((error: unknown) => {
+ settingUpModalHandlers.close();
+ if (isFetchBaseQueryError(error)) {
+ handleFieldError<IMetabotPurchaseFormFields>(
+ error.data,
+ "terms_of_service",
+ );
+ }
+ throw error;
+ });
+ },
+ [purchaseCloudAddOn, settingUpModalHandlers],
+ );
+
+ if (error || !hasData || isLoading) {
+ return (
+ <LoadingAndErrorWrapper
+ loading={isLoading}
+ error={match({
+ isLoading,
+ hasData,
+ error,
+ })
+ .with(
+ { isLoading: false, hasData: P.any, error: P.nonNullable },
+ { isLoading: false, hasData: false, error: P.any },
+ () => t`Error fetching information about available add-ons.`,
+ )
+ .otherwise(() => null)}
+ />
+ );
+ }
+
+ const validationSchema = Yup.object({
+ quantity: Yup.string()
+ .required()
+ .test(
+ "quantity-is-int",
+ t`Quantity must be a positive integer`,
+ (v) => !!v && parseInt(v, 10) > 0,
+ ),
+ terms_of_service: Yup.boolean()
+ .required()
+ .isTrue(t`Terms of Service must be accepted`),
+ });
+
+ return (
+ <SettingsPageWrapper title={t`Metabot AI`}>
+ <Text maw="26rem">{t`Metabot helps you move faster and understand your data better. You can ask it to generate SQL, and build or explain queries.`}</Text>
+ {isStoreUser ? (
+ <SettingsSection
+ title={t`Monthly usage limit`}
+ description={
+ <Text
+ maw="35rem"
+ mt="sm"
+ >{t`Usage is measured in Metabot requests. If a chat has multiple questions, they are counted as separate Metabot requests. Usage limit applies to your whole organization.`}</Text>
+ }
+ >
+ <FormProvider
+ initialValues={{
+ quantity: `${defaultQuantity}`,
+ terms_of_service: false,
+ }}
+ onSubmit={onSubmit}
+ validationSchema={validationSchema}
+ >
+ {({ values }) => (
+ <Form>
+ <Stack gap="xl" w="100%">
+ <MetabotRadios
+ quantity={values.quantity}
+ tiers={tiers}
+ billingPeriodMonths={billingPeriodMonths}
+ />
+
+ <Stack gap="md">
+ {/* eslint-disable-next-line no-literal-metabase-strings -- This string only shows for admins. */}
+ <Text maw="35rem">{t`Additional amount for the add-on will be added to your next billing period invoice. You can cancel the add-on anytime in Metabase Store.`}</Text>
+
+ <Card
+ bg="var(--mb-color-bg-light)"
+ p={12}
+ radius="md"
+ shadow="none"
+ w="100%"
+ >
+ <FormCheckbox
+ name="terms_of_service"
+ label={
+ <Text>
+ {t`I agree with the Metabot AI add-on`}{" "}
+ <ExternalLink href="https://www.metabase.com/license/hosting">{t`Terms of Service`}</ExternalLink>
+ </Text>
+ }
+ />
+ </Card>
+
+ <FormSubmitButton
+ disabled={!values.terms_of_service}
+ label={t`Confirm purchase`}
+ failedLabel={t`Failed to purchase Metabot AI`}
+ variant="filled"
+ w="100%"
+ />
+ </Stack>
+ </Stack>
+ </Form>
+ )}
+ </FormProvider>
+ </SettingsSection>
+ ) : (
+ <Text fw="bold">
+ {
+ /* eslint-disable-next-line no-literal-metabase-strings -- This string only shows for admins. */
+ t`Please ask a Metabase Store Admin${anyStoreUserEmailAddress && ` (${anyStoreUserEmailAddress})`} of your organization to enable this for you.`
+ }
+ </Text>
+ )}
+
+ <MetabotSettingUpModal
+ opened={settingUpModalOpened}
+ onClose={() => {
+ settingUpModalHandlers.close();
+ window.location.reload();
+ }}
+ />
+ </SettingsPageWrapper>
+ );
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotPurchasePage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotPurchasePage.unit.spec.tsx
new file mode 100644
index 00000000000..91e9c085903
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotPurchasePage.unit.spec.tsx
@@ -0,0 +1,321 @@
+import userEvent from "@testing-library/user-event";
+
+import {
+ findRequests,
+ setupCurrentUserEndpoint,
+ setupPropertiesEndpoints,
+ setupStoreEEBillingEndpoint,
+ setupStoreEECloudAddOnsEndpoint,
+ setupStoreEETieredMetabotAI,
+} from "__support__/server-mocks";
+import { renderWithProviders, screen } from "__support__/ui";
+import {
+ createMockSettings,
+ createMockTokenFeatures,
+ createMockUser,
+} from "metabase-types/api/mocks";
+import { createMockSettingsState } from "metabase-types/store/mocks";
+
+import { MetabotPurchasePage } from ".";
+
+const setupRefreshableProperties = ({
+ current_user_matches_store_user,
+ has_metabot_v3 = false,
+}: {
+ current_user_matches_store_user: boolean;
+ has_metabot_v3?: boolean;
+}) => {
+ const settings = createMockSettings({
+ "token-status": {
+ status: "",
+ valid: true,
+ features: has_metabot_v3 ? ["metabot-v3"] : [],
+ "store-users": current_user_matches_store_user
+ ? [{ email: "[email protected]" }]
+ : [],
+ },
+ "token-features": createMockTokenFeatures({ metabot_v3: has_metabot_v3 }),
+ });
+ setupPropertiesEndpoints(settings);
+ return settings;
+};
+
+const setup = async ({
+ current_user_matches_store_user,
+ billing_period_months,
+ simulate_http_get_error,
+ simulate_http_post_error,
+}: {
+ current_user_matches_store_user: boolean;
+ billing_period_months: number;
+ simulate_http_get_error: boolean;
+ simulate_http_post_error: false | "error-no-quantity" | "error-no-connection";
+}) => {
+ const settings = setupRefreshableProperties({
+ current_user_matches_store_user,
+ });
+
+ const user = createMockUser({ email: "[email protected]" });
+ setupCurrentUserEndpoint(user);
+
+ setupStoreEEBillingEndpoint(billing_period_months, simulate_http_get_error);
+ setupStoreEECloudAddOnsEndpoint(
+ billing_period_months,
+ simulate_http_get_error,
+ );
+ setupStoreEETieredMetabotAI(simulate_http_post_error);
+
+ renderWithProviders(<MetabotPurchasePage />, {
+ // Calling `setupPropertiesEndpoints` above is not enough; we also need to set `storeInitialState`:
+ storeInitialState: {
+ settings: createMockSettingsState(settings),
+ currentUser: user,
+ },
+ });
+};
+
+describe("MetabotPurchasePage", () => {
+ it("shows empty state alternate text when current user is not a store user", async () => {
+ await setup({
+ current_user_matches_store_user: false,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: false,
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ expect(
+ screen.getByText(/Please ask a Metabase Store Admin/),
+ ).toBeInTheDocument();
+ });
+
+ it("shows an error message when retrieving billing or add-on information fails", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: true,
+ simulate_http_post_error: false,
+ });
+ expect(await screen.findByText(/Error fetching information/)).toBeVisible();
+ expect(
+ screen.queryByText(/Metabot helps you move faster/),
+ ).not.toBeInTheDocument();
+ expect(
+ screen.queryByText(/Please ask a Metabase Store Admin/),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows monthly tiers according to own billing period", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 1,
+ simulate_http_get_error: false,
+ simulate_http_post_error: false,
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ expect(
+ screen.queryByText(/Please ask a Metabase Store Admin/),
+ ).not.toBeInTheDocument();
+ const metabase_ai_tier1 = screen.getByRole("radio", {
+ name: /up to 1234 requests\/month/,
+ });
+ expect(metabase_ai_tier1).toBeVisible();
+ expect(metabase_ai_tier1).toHaveAccessibleName(/\$111\/month/);
+ const metabase_ai_tier2 = screen.getByRole("radio", {
+ name: /up to 2345 requests\/month/,
+ });
+ expect(metabase_ai_tier2).toBeVisible();
+ expect(metabase_ai_tier2).toHaveAccessibleName(/\$222\/month/);
+ });
+
+ it("shows yearly tiers according to own billing period", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: false,
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ expect(
+ screen.queryByText(/Please ask a Metabase Store Admin/),
+ ).not.toBeInTheDocument();
+ const metabase_ai_tier3 = screen.getByRole("radio", {
+ name: /up to 3456 requests\/month/,
+ });
+ expect(metabase_ai_tier3).toBeVisible();
+ expect(metabase_ai_tier3).toHaveAccessibleName(/\$333\/year/);
+ const metabase_ai_tier4 = screen.getByRole("radio", {
+ name: /up to 4567 requests\/month/,
+ });
+ expect(metabase_ai_tier4).toBeVisible();
+ expect(metabase_ai_tier4).toHaveAccessibleName(/\$444\/year/);
+ });
+
+ it("requires Terms of Service to be accepted", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: false,
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ expect(
+ screen.queryByText(/Please ask a Metabase Store Admin/),
+ ).not.toBeInTheDocument();
+ expect(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ ).not.toBeChecked();
+ expect(
+ screen.getByRole("button", { name: /Confirm purchase/ }),
+ ).toBeDisabled();
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+ expect(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ ).toBeChecked();
+ expect(
+ screen.getByRole("button", { name: /Confirm purchase/ }),
+ ).toBeEnabled();
+ });
+
+ it("submits a HTTP request", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: false,
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ // This add-on product tier has `is_default = true`:
+ expect(
+ screen.getByRole("radio", { name: /up to 4567 requests/ }),
+ ).toBeChecked();
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+
+ await userEvent.click(
+ screen.getByRole("button", { name: /Confirm purchase/ }),
+ );
+ expect(screen.getByRole("button", { name: /Success/ })).toBeVisible();
+
+ expect(
+ await screen.findByText(/Setting up Metabot AI, please wait/),
+ ).toBeVisible();
+ expect(
+ screen.queryByRole("button", { name: /Done/ }),
+ ).not.toBeInTheDocument();
+
+ const postRequests = await findRequests("POST");
+ const cloudAddOnsRequest = postRequests.find(({ url }) =>
+ /\/api\/ee\/cloud-add-ons\/metabase-ai-tiered$/.test(url),
+ );
+ expect(cloudAddOnsRequest).toBeTruthy();
+ expect("terms_of_service" in cloudAddOnsRequest?.body).toBeTruthy();
+ expect(cloudAddOnsRequest?.body?.quantity).toEqual(4567);
+ expect(cloudAddOnsRequest?.body?.terms_of_service).toEqual(true);
+
+ setupRefreshableProperties({
+ current_user_matches_store_user: true,
+ has_metabot_v3: true,
+ });
+ expect(await screen.findByText(/Metabot AI is ready/)).toBeVisible();
+ expect(screen.getByRole("button", { name: /Done/ })).toBeEnabled();
+ });
+
+ it("can change requested quantity", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: false,
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ await userEvent.click(
+ screen.getByRole("radio", { name: /up to 3456 requests/ }),
+ );
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+ await userEvent.click(
+ screen.getByRole("button", { name: /Confirm purchase/ }),
+ );
+ expect(
+ await screen.findByText(/Setting up Metabot AI, please wait/),
+ ).toBeVisible();
+
+ const postRequests = await findRequests("POST");
+ const cloudAddOnsRequest = postRequests.find(({ url }) =>
+ /\/api\/ee\/cloud-add-ons\/metabase-ai-tiered$/.test(url),
+ );
+ expect(cloudAddOnsRequest).toBeTruthy();
+ expect("terms_of_service" in cloudAddOnsRequest?.body).toBeTruthy();
+ expect(cloudAddOnsRequest?.body?.quantity).toEqual(3456);
+ });
+
+ it("reports validation errors", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: "error-no-quantity",
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+ await userEvent.click(
+ screen.getByRole("button", { name: /Confirm purchase/ }),
+ );
+ expect(
+ await screen.findByText(/Failed to purchase Metabot AI/),
+ ).toBeVisible();
+
+ const postRequests = await findRequests("POST");
+ const cloudAddOnsRequest = postRequests.find(({ url }) =>
+ /\/api\/ee\/cloud-add-ons\/metabase-ai-tiered$/.test(url),
+ );
+ expect(cloudAddOnsRequest).toBeTruthy();
+ });
+
+ it("reports other errors", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ billing_period_months: 12,
+ simulate_http_get_error: false,
+ simulate_http_post_error: "error-no-connection",
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+ await userEvent.click(
+ screen.getByRole("button", { name: /Confirm purchase/ }),
+ );
+ expect(
+ await screen.findByText(/Failed to purchase Metabot AI/),
+ ).toBeVisible();
+
+ const postRequests = await findRequests("POST");
+ const cloudAddOnsRequest = postRequests.find(({ url }) =>
+ /\/api\/ee\/cloud-add-ons\/metabase-ai-tiered$/.test(url),
+ );
+ expect(cloudAddOnsRequest).toBeTruthy();
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotRadios.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotRadios.tsx
new file mode 100644
index 00000000000..4117efc9705
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/MetabotRadios.tsx
@@ -0,0 +1,78 @@
+import { Fragment, type ReactElement, useState } from "react";
+import { t } from "ttag";
+
+import { FormRadioGroup } from "metabase/forms";
+import { Box, Card, Divider, Flex, Radio, Text } from "metabase/ui";
+
+import type { IMetabotRadioProps, IMetabotRadiosProps } from "./types";
+
+function MetabotRadio({
+ selected,
+ value,
+ title,
+ description,
+ price,
+}: IMetabotRadioProps): ReactElement {
+ return (
+ <Box bg={selected ? "brand-light" : undefined} p="md" w="100%">
+ <Radio
+ value={value}
+ label={
+ <Flex
+ align="flex-start"
+ direction={{ base: "column", sm: "row" }}
+ justify="space-between"
+ wrap="nowrap"
+ w="100%"
+ >
+ <Text fw="bold" miw="35%" ta="left">
+ {title}
+ </Text>
+
+ <Text ta="left">{description}</Text>
+
+ <Text fw="bold" ta={{ base: "left", sm: "right" }}>
+ {price}
+ </Text>
+ </Flex>
+ }
+ w="100%"
+ />
+ </Box>
+ );
+}
+
+export function MetabotRadios({
+ quantity,
+ tiers,
+ billingPeriodMonths,
+}: IMetabotRadiosProps): ReactElement {
+ const [selectedQuantity, setSelectedQuantity] = useState(quantity);
+ const billingPeriod = billingPeriodMonths === 1 ? t`month` : t`yearly`;
+ return (
+ <FormRadioGroup
+ defaultValue={selectedQuantity}
+ name="quantity"
+ labelElement="div"
+ onChange={(value) => setSelectedQuantity(value)}
+ w="100%"
+ >
+ <Card withBorder p={0} w="100%">
+ {tiers.map(({ id, name, quantity, price }, index) => (
+ <Fragment key={id}>
+ {index > 0 && <Divider />}
+
+ <MetabotRadio
+ selected={`${quantity}` === selectedQuantity}
+ value={`${quantity}`}
+ title={name}
+ /* time-based quota limits are always per month, not depending on the billing period: */
+ description={t`up to ${quantity} requests/month`}
+ price={`$${price}/${billingPeriod}`}
+ />
+ </Fragment>
+ ))}
+ </Card>
+ </FormRadioGroup>
+ );
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/hooks.ts b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/hooks.ts
new file mode 100644
index 00000000000..a09d7e81a3d
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/hooks.ts
@@ -0,0 +1,46 @@
+import {
+ useGetBillingInfoQuery,
+ useListAddOnsQuery,
+} from "metabase-enterprise/api";
+import type { ICloudAddOnProductTier } from "metabase-types/api";
+
+export function useAddOnsBilling(): {
+ error: unknown;
+ isLoading: boolean;
+ billingPeriodMonths: number | undefined;
+ defaultQuantity: number | undefined;
+ tiers: ICloudAddOnProductTier[];
+} {
+ const {
+ data: addOns,
+ error: addOnsError,
+ isLoading: addOnsLoading,
+ } = useListAddOnsQuery();
+
+ const {
+ data: billingInfo,
+ error: billingInfoError,
+ isLoading: billingInfoLoading,
+ } = useGetBillingInfoQuery();
+
+ const billingPeriodMonths =
+ billingInfo?.data?.billing_period_months ?? undefined;
+ const tiers =
+ addOns?.find(
+ ({ active, billing_period_months, product_type, self_service }) =>
+ active &&
+ self_service &&
+ billing_period_months === billingPeriodMonths &&
+ product_type === "metabase-ai-tiered",
+ )?.product_tiers ?? [];
+ const defaultQuantity =
+ tiers.find(({ is_default }) => is_default)?.quantity ?? tiers[0]?.quantity;
+
+ return {
+ error: addOnsError || billingInfoError,
+ isLoading: addOnsLoading || billingInfoLoading,
+ billingPeriodMonths,
+ defaultQuantity,
+ tiers,
+ };
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/index.ts b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/index.ts
new file mode 100644
index 00000000000..90f85d46529
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/index.ts
@@ -0,0 +1 @@
+export * from "./MetabotPurchasePage";
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/types.ts b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/types.ts
new file mode 100644
index 00000000000..317ab0723e3
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage/types.ts
@@ -0,0 +1,20 @@
+import type { ICloudAddOnProductTier } from "metabase-types/api";
+
+export interface IMetabotPurchaseFormFields {
+ quantity: string;
+ terms_of_service: boolean;
+}
+
+export interface IMetabotRadioProps {
+ selected?: boolean;
+ value: string;
+ title: string;
+ description: string;
+ price: string;
+}
+
+export interface IMetabotRadiosProps {
+ tiers: ICloudAddOnProductTier[];
+ quantity: string;
+ billingPeriodMonths: number;
+}
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchaseSettingUpModal.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx
similarity index 79%
rename from enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchaseSettingUpModal.tsx
rename to enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx
index 1888f413825..da2dcd90577 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchaseSettingUpModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx
@@ -15,7 +15,7 @@ import {
} from "metabase/ui";
import { hasPremiumFeature } from "metabase-enterprise/settings";
-export const MetabotPurchaseSettingUpModal = ({
+export const MetabotSettingUpModal = ({
onClose,
opened,
}: Pick<ModalProps, "opened" | "onClose">) => {
@@ -36,6 +36,7 @@ export const MetabotPurchaseSettingUpModal = ({
<Stack align="center" gap="lg" my="4.5rem">
<Box h={96} pos="relative" w={96}>
<MetabotLogo variant="cloud" alt={t`Metabot Cloud`} />
+
{isSettingUp && (
<Flex
bottom={0}
@@ -59,6 +60,7 @@ export const MetabotPurchaseSettingUpModal = ({
</Flex>
)}
</Box>
+
{isSettingUp ? (
<Box ta="center">
<Title c="text-primary" fz="lg">
@@ -69,23 +71,21 @@ export const MetabotPurchaseSettingUpModal = ({
</Text>
</Box>
) : (
- <Box ta="center">
- <Title c="text-primary" fz="lg">
- {t`Metabot AI is ready`}
- </Title>
- <Text c="text-secondary" fz="md" lh={1.43}>
- {t`Happy exploring!`}
- </Text>
- </Box>
+ <>
+ <Box ta="center">
+ <Title c="text-primary" fz="lg">
+ {t`Metabot AI is ready`}
+ </Title>
+ <Text c="text-secondary" fz="md" lh={1.43}>
+ {t`Happy exploring!`}
+ </Text>
+ </Box>
+
+ <Button variant="filled" size="md" onClick={onClose}>
+ {t`Done`}
+ </Button>
+ </>
)}
- <Button
- disabled={isSettingUp}
- variant="filled"
- size="md"
- onClick={onClose}
- >
- {t`Done`}
- </Button>
</Stack>
</Modal>
);
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotTrialPage.tsx
similarity index 67%
rename from enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage.tsx
rename to enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotTrialPage.tsx
index 9389eb9b7ea..d826ef979c5 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotTrialPage.tsx
@@ -1,5 +1,4 @@
import { useDisclosure } from "@mantine/hooks";
-import type { FetchBaseQueryError } from "@reduxjs/toolkit/query";
import { useCallback } from "react";
import { t } from "ttag";
import * as Yup from "yup";
@@ -8,11 +7,8 @@ import {
SettingsPageWrapper,
SettingsSection,
} from "metabase/admin/components/SettingsSection";
-import { getCurrentUser } from "metabase/admin/datamodel/selectors";
-import { usePurchaseCloudAddOnMutation } from "metabase/api";
import ExternalLink from "metabase/common/components/ExternalLink";
import Markdown from "metabase/common/components/Markdown";
-import { useSetting } from "metabase/common/hooks";
import {
Form,
FormCheckbox,
@@ -20,73 +16,23 @@ import {
FormSubmitButton,
} from "metabase/forms";
import { useSelector } from "metabase/lib/redux";
+import { getStoreUsers } from "metabase/selectors/store-users";
import { Divider, Flex, Group, List, Stack, Text } from "metabase/ui";
-import { MetabotPurchaseSettingUpModal } from "metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchaseSettingUpModal";
+import { usePurchaseCloudAddOnMutation } from "metabase-enterprise/api";
-// https://redux-toolkit.js.org/rtk-query/usage/error-handling
-// https://redux-toolkit.js.org/rtk-query/usage-with-typescript#type-safe-error-handling
-const isFetchBaseQueryError = (error: unknown): error is FetchBaseQueryError =>
- error instanceof Object && "status" in error && "data" in error;
+import { MetabotSettingUpModal } from "./MetabotSettingUpModal";
+import { handleFieldError, isFetchBaseQueryError } from "./utils";
-type IFieldError =
- | string
- | {
- message: string;
- }
- | {
- errors: { [key: string]: any };
- };
-
-const isFieldError = (error: unknown): error is IFieldError =>
- typeof error === "string" ||
- (error instanceof Object &&
- (("message" in error && typeof error.message === "string") ||
- ("errors" in error &&
- error.errors instanceof Object &&
- "terms_of_service" in error.errors &&
- typeof error.errors.terms_of_service === "string")));
-
-export const handleFieldError = (error: unknown) => {
- if (!isFieldError(error)) {
- return;
- }
-
- if (typeof error === "string") {
- throw { data: { errors: { terms_of_service: error } } };
- }
-
- if ("message" in error) {
- throw { data: { errors: { terms_of_service: error.message } } };
- }
-
- if ("errors" in error) {
- throw { data: error };
- }
-};
-
-const validationSchema = Yup.object({
- terms_of_service: Yup.boolean(),
-});
-
-interface MetabotPurchaseFormFields {
+interface MetabotTrialFormFields {
terms_of_service: boolean;
}
-export const MetabotPurchasePage = () => {
- const currentUser = useSelector(getCurrentUser);
- const tokenStatus = useSetting("token-status");
- const storeUserEmails =
- tokenStatus?.["store-users"]?.map(({ email }) => email.toLowerCase()) ?? [];
- const isStoreUser = storeUserEmails.includes(
- currentUser?.email.toLowerCase(),
- );
- const anyStoreUserEmailAddress =
- storeUserEmails.length > 0 ? storeUserEmails[0] : undefined;
-
+export const MetabotTrialPage = () => {
+ const { isStoreUser, anyStoreUserEmailAddress } = useSelector(getStoreUsers);
const [settingUpModalOpened, settingUpModalHandlers] = useDisclosure(false);
const [purchaseCloudAddOn] = usePurchaseCloudAddOnMutation();
const onSubmit = useCallback(
- async ({ terms_of_service }: MetabotPurchaseFormFields) => {
+ async ({ terms_of_service }: MetabotTrialFormFields) => {
settingUpModalHandlers.open();
await purchaseCloudAddOn({
product_type: "metabase-ai",
@@ -95,12 +41,24 @@ export const MetabotPurchasePage = () => {
.unwrap()
.catch((error: unknown) => {
settingUpModalHandlers.close();
- isFetchBaseQueryError(error) && handleFieldError(error.data);
+ if (isFetchBaseQueryError(error)) {
+ handleFieldError<MetabotTrialFormFields>(
+ error.data,
+ "terms_of_service",
+ );
+ }
+ throw error;
});
},
[purchaseCloudAddOn, settingUpModalHandlers],
);
+ const validationSchema = Yup.object({
+ terms_of_service: Yup.boolean()
+ .required()
+ .isTrue(t`Terms of Service must be accepted`),
+ });
+
return (
<SettingsPageWrapper title={t`Metabot AI`}>
<SettingsSection
@@ -159,6 +117,7 @@ export const MetabotPurchasePage = () => {
<FormSubmitButton
disabled={!values.terms_of_service}
label={t`Add Metabot AI`}
+ failedLabel={t`Failed to add Metabot AI`}
variant="filled"
mt="xs"
/>
@@ -180,7 +139,7 @@ export const MetabotPurchasePage = () => {
</Text>
)}
</SettingsSection>
- <MetabotPurchaseSettingUpModal
+ <MetabotSettingUpModal
opened={settingUpModalOpened}
onClose={() => {
settingUpModalHandlers.close();
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotTrialPage.unit.spec.tsx
similarity index 59%
rename from enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage.unit.spec.tsx
rename to enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotTrialPage.unit.spec.tsx
index d87f0583c1f..3961f6644f1 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotTrialPage.unit.spec.tsx
@@ -1,5 +1,6 @@
import userEvent from "@testing-library/user-event";
import fetchMock from "fetch-mock";
+import { match } from "ts-pattern";
import {
findRequests,
@@ -14,7 +15,7 @@ import {
} from "metabase-types/api/mocks";
import { createMockSettingsState } from "metabase-types/store/mocks";
-import { MetabotPurchasePage } from "./MetabotPurchasePage";
+import { MetabotTrialPage } from "./MetabotTrialPage";
const setupRefreshableProperties = ({
current_user_matches_store_user,
@@ -40,8 +41,10 @@ const setupRefreshableProperties = ({
const setup = async ({
current_user_matches_store_user,
+ simulate_http_post_error,
}: {
current_user_matches_store_user: boolean;
+ simulate_http_post_error: false | "error-no-quantity" | "error-no-connection";
}) => {
const settings = setupRefreshableProperties({
current_user_matches_store_user,
@@ -50,9 +53,23 @@ const setup = async ({
const user = createMockUser({ email: "[email protected]" });
setupCurrentUserEndpoint(user);
- fetchMock.post("path:/api/ee/cloud-add-ons/metabase-ai", 200);
+ fetchMock.post(
+ "path:/api/ee/cloud-add-ons/metabase-ai",
+ match(simulate_http_post_error)
+ .with("error-no-quantity", () => ({
+ body: { errors: { quantity: "Purchase of add-on requires quantity." } },
+ status: 403,
+ }))
+ .with("error-no-connection", () => ({
+ body: "Could not establish a connection to Metabase Cloud.",
+ status: 404,
+ }))
+ .otherwise(() => ({
+ status: 200,
+ })),
+ );
- renderWithProviders(<MetabotPurchasePage />, {
+ renderWithProviders(<MetabotTrialPage />, {
// Calling `setupPropertiesEndpoints` above is not enough; we also need to set `storeInitialState`:
storeInitialState: {
settings: createMockSettingsState(settings),
@@ -63,9 +80,12 @@ const setup = async ({
await screen.findByText(/Get a free month of Metabot/);
};
-describe("MetabotPurchasePage", () => {
+describe("MetabotTrialPage", () => {
it("shows empty state alternate text when current user is not a store user", async () => {
- await setup({ current_user_matches_store_user: false });
+ await setup({
+ current_user_matches_store_user: false,
+ simulate_http_post_error: false,
+ });
expect(screen.getByText(/Get a free month of Metabot/)).toBeInTheDocument();
expect(
screen.getByText(/Please ask a Metabase Store Admin/),
@@ -75,6 +95,7 @@ describe("MetabotPurchasePage", () => {
it("requires Terms of Service to be accepted", async () => {
await setup({
current_user_matches_store_user: true,
+ simulate_http_post_error: false,
});
expect(
screen.queryByText(/Please ask a Metabase Store Admin/),
@@ -99,6 +120,7 @@ describe("MetabotPurchasePage", () => {
it("submits a HTTP request", async () => {
await setup({
current_user_matches_store_user: true,
+ simulate_http_post_error: false,
});
await userEvent.click(
screen.getByRole("checkbox", { name: /Terms of Service/ }),
@@ -112,7 +134,9 @@ describe("MetabotPurchasePage", () => {
expect(
await screen.findByText(/Setting up Metabot AI, please wait/),
).toBeInTheDocument();
- expect(screen.getByRole("button", { name: /Done/ })).toBeDisabled();
+ expect(
+ screen.queryByRole("button", { name: /Done/ }),
+ ).not.toBeInTheDocument();
const postRequests = await findRequests("POST");
const cloudAddOnsRequest = postRequests.find(({ url }) =>
@@ -129,4 +153,50 @@ describe("MetabotPurchasePage", () => {
expect(await screen.findByText(/Metabot AI is ready/)).toBeInTheDocument();
expect(screen.getByRole("button", { name: /Done/ })).toBeEnabled();
});
+
+ it("reports validation errors", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ simulate_http_post_error: "error-no-quantity",
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+ await userEvent.click(
+ screen.getByRole("button", { name: /Add Metabot AI/ }),
+ );
+ expect(await screen.findByText(/Failed to add Metabot AI/)).toBeVisible();
+
+ const postRequests = await findRequests("POST");
+ const cloudAddOnsRequest = postRequests.find(({ url }) =>
+ /\/api\/ee\/cloud-add-ons\/metabase-ai$/.test(url),
+ );
+ expect(cloudAddOnsRequest).toBeTruthy();
+ });
+
+ it("reports other errors", async () => {
+ await setup({
+ current_user_matches_store_user: true,
+ simulate_http_post_error: "error-no-connection",
+ });
+ expect(
+ await screen.findByText(/Metabot helps you move faster/),
+ ).toBeVisible();
+ await userEvent.click(
+ screen.getByRole("checkbox", { name: /Terms of Service/ }),
+ );
+ await userEvent.click(
+ screen.getByRole("button", { name: /Add Metabot AI/ }),
+ );
+ expect(await screen.findByText(/Failed to add Metabot AI/)).toBeVisible();
+
+ const postRequests = await findRequests("POST");
+ const cloudAddOnsRequest = postRequests.find(({ url }) =>
+ /\/api\/ee\/cloud-add-ons\/metabase-ai$/.test(url),
+ );
+ expect(cloudAddOnsRequest).toBeTruthy();
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/utils.ts b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/utils.ts
index 24a4dd86b15..13021089898 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/utils.ts
@@ -1,3 +1,7 @@
+import type { FetchBaseQueryError } from "@reduxjs/toolkit/query";
+import type { FormikErrors } from "formik";
+import { P, isMatching } from "ts-pattern";
+
import { useSelector } from "metabase/lib/redux";
import { getLocation } from "metabase/selectors/routing";
@@ -6,3 +10,53 @@ export function useMetabotIdPath() {
const metabotId = Number(location?.pathname?.split("/").pop());
return Number.isNaN(metabotId) ? null : metabotId;
}
+
+// https://redux-toolkit.js.org/rtk-query/usage/error-handling
+// https://redux-toolkit.js.org/rtk-query/usage-with-typescript#type-safe-error-handling
+export const isFetchBaseQueryError = (
+ error: unknown,
+): error is FetchBaseQueryError =>
+ isMatching({ status: P.any, data: P.any }, error);
+
+type IFieldError<Values> =
+ | string
+ | {
+ message: string;
+ }
+ | {
+ errors: FormikErrors<Values>;
+ };
+
+const isFieldError = <Values>(error: unknown): error is IFieldError<Values> =>
+ isMatching(
+ P.union(
+ P.string,
+ { message: P.string },
+ { errors: P.record(P.string, P.any) },
+ ),
+ error,
+ );
+
+// If `error` is a form field error, throw a structured exception with the shape
+// `{data: {errors: FormikErrors}}` that will be caught as a validation error by
+// [[FormProvider]] in `frontend/src/metabase/forms/components/FormProvider/`.
+export const handleFieldError = <Values>(
+ error: unknown,
+ defaultField: keyof Values,
+) => {
+ if (!isFieldError<Values>(error)) {
+ return;
+ }
+
+ if (typeof error === "string") {
+ throw { data: { errors: { [defaultField]: error } } };
+ }
+
+ if ("message" in error) {
+ throw { data: { errors: { [defaultField]: error.message } } };
+ }
+
+ if ("errors" in error) {
+ throw { data: error };
+ }
+};
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx
index 55ea246f7ae..c3c44f8c945 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx
@@ -5,11 +5,12 @@ import { createAdminRouteGuard } from "metabase/admin/utils";
import { AdminSettingsLayout } from "metabase/common/components/AdminLayout/AdminSettingsLayout";
import { Route } from "metabase/hoc/Title";
import { PLUGIN_METABOT, PLUGIN_REDUCERS } from "metabase/plugins";
-import { MetabotPurchasePage } from "metabase-enterprise/metabot/components/MetabotAdmin/MetabotPurchasePage";
import { hasPremiumFeature } from "metabase-enterprise/settings";
import { Metabot } from "./components/Metabot";
import { MetabotAdminPage } from "./components/MetabotAdmin/MetabotAdminPage";
+import { MetabotPurchasePage } from "./components/MetabotAdmin/MetabotPurchasePage";
+import { MetabotTrialPage } from "./components/MetabotAdmin/MetabotTrialPage";
import { MetabotAdminAppBarButton } from "./components/MetabotAdminAppBarButton";
import { MetabotAppBarButton } from "./components/MetabotAppBarButton";
import { getMetabotQuickLinks } from "./components/MetabotQuickLinks";
@@ -64,7 +65,7 @@ export function initializePlugin() {
PLUGIN_METABOT.MetabotToggleButton = MetabotToggleButton;
PLUGIN_METABOT.MetabotAppBarButton = MetabotAppBarButton;
PLUGIN_METABOT.MetabotAdminAppBarButton = MetabotAdminAppBarButton;
- } else if (hasPremiumFeature("offer_metabase_ai")) {
+ } else if (hasPremiumFeature("offer_metabase_ai_tiered")) {
PLUGIN_METABOT.getAdminPaths = () => [
{
name: t`AI`,
@@ -79,5 +80,20 @@ export function initializePlugin() {
</Route>
</Route>
);
+ } else if (hasPremiumFeature("offer_metabase_ai")) {
+ PLUGIN_METABOT.getAdminPaths = () => [
+ {
+ name: t`AI`,
+ path: "/admin/metabot",
+ key: "metabot",
+ },
+ ];
+ PLUGIN_METABOT.getAdminRoutes = () => (
+ <Route path="metabot" component={createAdminRouteGuard("metabot")}>
+ <Route title={t`AI`} component={AdminSettingsLayout}>
+ <IndexRoute component={MetabotTrialPage} />
+ </Route>
+ </Route>
+ );
}
}
diff --git a/frontend/src/metabase-types/api/cloud-add-ons.ts b/frontend/src/metabase-types/api/cloud-add-ons.ts
index 4cd17c87974..19b887975e5 100644
--- a/frontend/src/metabase-types/api/cloud-add-ons.ts
+++ b/frontend/src/metabase-types/api/cloud-add-ons.ts
@@ -1,4 +1,5 @@
export interface PurchaseCloudAddOnRequest {
- product_type: "metabase-ai";
+ product_type: "metabase-ai" | "metabase-ai-tiered" | "python-execution";
+ quantity?: number;
terms_of_service: boolean;
}
diff --git a/frontend/src/metabase-types/api/mocks/add-ons.ts b/frontend/src/metabase-types/api/mocks/add-ons.ts
new file mode 100644
index 00000000000..b39f8a012d8
--- /dev/null
+++ b/frontend/src/metabase-types/api/mocks/add-ons.ts
@@ -0,0 +1,104 @@
+import type { ICloudAddOnProduct } from "metabase-types/api";
+
+export function createMockCloudAddOns(
+ opts?: Partial<ICloudAddOnProduct>,
+): Partial<ICloudAddOnProduct>[] {
+ const billing_period_months = opts?.billing_period_months || 1;
+
+ return [
+ {
+ // matching product type, monthly cadence:
+ active: true,
+ billing_period_months: 1,
+ product_tiers: [
+ {
+ id: 1,
+ is_default: false,
+ name: "metabase_ai_tier1",
+ price: 111,
+ quantity: 1234,
+ },
+ {
+ id: 2,
+ is_default: true,
+ name: "metabase_ai_tier2",
+ price: 222,
+ quantity: 2345,
+ },
+ ],
+ product_type: "metabase-ai-tiered",
+ self_service: true,
+ },
+ {
+ // matching product type, yearly cadence:
+ active: true,
+ billing_period_months: 12,
+ product_tiers: [
+ {
+ id: 3,
+ is_default: false,
+ name: "metabase_ai_tier3",
+ price: 333,
+ quantity: 3456,
+ },
+ {
+ id: 4,
+ is_default: true,
+ name: "metabase_ai_tier4",
+ price: 444,
+ quantity: 4567,
+ },
+ ],
+ product_type: "metabase-ai-tiered",
+ self_service: true,
+ },
+ {
+ // product matches our subscription but is inactive:
+ active: false,
+ billing_period_months,
+ product_tiers: [
+ {
+ id: 5,
+ is_default: true,
+ name: "metabase_ai_tier5",
+ price: 555,
+ quantity: 5678,
+ },
+ ],
+ product_type: "metabase-ai-tiered",
+ self_service: true,
+ },
+ {
+ // product matches our subscription but is not for self-service:
+ active: true,
+ billing_period_months,
+ product_tiers: [
+ {
+ id: 6,
+ is_default: true,
+ name: "metabase_ai_tier6",
+ price: 666,
+ quantity: 6789,
+ },
+ ],
+ product_type: "metabase-ai-tiered",
+ self_service: false,
+ },
+ {
+ // different product with the same billing period:
+ active: true,
+ billing_period_months,
+ product_tiers: [
+ {
+ id: 8,
+ name: "other_tier8",
+ price: 888,
+ quantity: 8901,
+ is_default: true,
+ },
+ ],
+ product_type: "other",
+ self_service: true,
+ },
+ ];
+}
diff --git a/frontend/src/metabase-types/api/mocks/settings.ts b/frontend/src/metabase-types/api/mocks/settings.ts
index 10debb6e24a..815eef1dce3 100644
--- a/frontend/src/metabase-types/api/mocks/settings.ts
+++ b/frontend/src/metabase-types/api/mocks/settings.ts
@@ -134,6 +134,7 @@ export const createMockTokenFeatures = (
ai_sql_fixer: false,
ai_sql_generation: false,
offer_metabase_ai: false,
+ offer_metabase_ai_tiered: false,
database_routing: false,
development_mode: false,
table_data_editing: false,
diff --git a/frontend/src/metabase-types/api/settings.ts b/frontend/src/metabase-types/api/settings.ts
index 66b0545820e..34c30c5f6b4 100644
--- a/frontend/src/metabase-types/api/settings.ts
+++ b/frontend/src/metabase-types/api/settings.ts
@@ -239,6 +239,7 @@ const tokenStatusFeatures = [
"metabot-v3",
"no-upsell",
"offer-metabase-ai",
+ "offer-metabase-ai-tiered",
"official-collections",
"query-reference-validation",
"question-error-logs",
@@ -314,6 +315,7 @@ export const tokenFeatures = [
"cache_preemptive",
"metabot_v3",
"offer_metabase_ai",
+ "offer_metabase_ai_tiered",
"ai_sql_fixer",
"ai_sql_generation",
"ai_entity_analysis",
diff --git a/frontend/src/metabase-types/api/store.ts b/frontend/src/metabase-types/api/store.ts
index 0913bf1d1d1..1e68ecff399 100644
--- a/frontend/src/metabase-types/api/store.ts
+++ b/frontend/src/metabase-types/api/store.ts
@@ -1,3 +1,5 @@
+import type { TokenFeature } from "./settings";
+
export interface StoreTokenStatus {
status?: string;
valid: boolean;
@@ -33,7 +35,43 @@ type BillingInfoFormatType =
export type BillingInfoLineItem = BillingInfoFormatType &
BillingInfoDisplayType;
+interface IBillingInfoData {
+ billing_period_months?: number | null;
+}
+
export type BillingInfo = {
version: string;
- content: BillingInfoLineItem[] | null;
+ content?: BillingInfoLineItem[] | null;
+ data?: IBillingInfoData | null;
};
+
+export interface ICloudAddOnProductTier {
+ id: number;
+ is_default: boolean;
+ name: string;
+ price: number;
+ quantity: number;
+}
+
+export interface ICloudAddOnProduct {
+ active: boolean;
+ billing_period_months: number;
+ default_base_fee: number;
+ default_included_units: number;
+ default_prepaid_units: number;
+ default_price_per_unit: number;
+ default_total_units: number;
+ deployment: string;
+ description: string | null;
+ id: number;
+ is_metered: boolean | null;
+ name: string;
+ product_tiers: ICloudAddOnProductTier[];
+ product_type: string;
+ self_service: boolean;
+ short_name: string;
+ token_features: TokenFeature[];
+ trial_days: number | null;
+}
+
+export type GetCloudAddOnsResponse = ICloudAddOnProduct[];
diff --git a/frontend/src/metabase/api/cloud-add-ons.ts b/frontend/src/metabase/api/cloud-add-ons.ts
deleted file mode 100644
index 8699522706a..00000000000
--- a/frontend/src/metabase/api/cloud-add-ons.ts
+++ /dev/null
@@ -1,17 +0,0 @@
-import type { PurchaseCloudAddOnRequest } from "metabase-types/api";
-
-import { Api } from "./api";
-
-export const cloudAddOnApi = Api.injectEndpoints({
- endpoints: (builder) => ({
- purchaseCloudAddOn: builder.mutation<void, PurchaseCloudAddOnRequest>({
- query: ({ product_type, ...body }) => ({
- method: "POST",
- url: `/api/ee/cloud-add-ons/${product_type}`,
- body,
- }),
- }),
- }),
-});
-
-export const { usePurchaseCloudAddOnMutation } = cloudAddOnApi;
diff --git a/frontend/src/metabase/api/index.ts b/frontend/src/metabase/api/index.ts
index b536bab8481..d93f667c22e 100644
--- a/frontend/src/metabase/api/index.ts
+++ b/frontend/src/metabase/api/index.ts
@@ -7,7 +7,6 @@ export * from "./bookmark";
export * from "./bug-report";
export * from "./card";
export * from "./channel";
-export * from "./cloud-add-ons";
export * from "./cloud-migration";
export * from "./collection";
export * from "./dashboard";
diff --git a/frontend/src/metabase/selectors/settings.ts b/frontend/src/metabase/selectors/settings.ts
index 451ae29cfb2..abc8a504a11 100644
--- a/frontend/src/metabase/selectors/settings.ts
+++ b/frontend/src/metabase/selectors/settings.ts
@@ -204,3 +204,6 @@ export const getIsPaidPlan = createSelector(
return tokenStatus != null && tokenStatus.valid;
},
);
+
+export const getTokenStatus = (state: State): TokenStatus | null =>
+ getSetting(state, "token-status");
diff --git a/frontend/src/metabase/selectors/store-users.ts b/frontend/src/metabase/selectors/store-users.ts
new file mode 100644
index 00000000000..30fa1a63878
--- /dev/null
+++ b/frontend/src/metabase/selectors/store-users.ts
@@ -0,0 +1,24 @@
+import { createSelector } from "@reduxjs/toolkit";
+
+import { getTokenStatus } from "metabase/selectors/settings";
+import { getUser } from "metabase/selectors/user";
+
+export const getStoreUsers = createSelector(
+ getUser,
+ getTokenStatus,
+ (
+ currentUser,
+ tokenStatus,
+ ): { isStoreUser: boolean; anyStoreUserEmailAddress?: string } => {
+ const storeUserEmails =
+ tokenStatus?.["store-users"]?.map(({ email }) => email.toLowerCase()) ??
+ [];
+ return {
+ isStoreUser:
+ !!currentUser &&
+ storeUserEmails.includes(currentUser.email.toLowerCase()),
+ anyStoreUserEmailAddress:
+ storeUserEmails.length > 0 ? storeUserEmails[0] : undefined,
+ };
+ },
+);
diff --git a/frontend/src/metabase/selectors/store-users.unit.spec.ts b/frontend/src/metabase/selectors/store-users.unit.spec.ts
new file mode 100644
index 00000000000..4d2381eb5a8
--- /dev/null
+++ b/frontend/src/metabase/selectors/store-users.unit.spec.ts
@@ -0,0 +1,65 @@
+import {
+ setupCurrentUserEndpoint,
+ setupPropertiesEndpoints,
+} from "__support__/server-mocks";
+import { getStoreUsers } from "metabase/selectors/store-users";
+import { createMockSettings, createMockUser } from "metabase-types/api/mocks";
+import {
+ createMockSettingsState,
+ createMockState,
+} from "metabase-types/store/mocks";
+
+const setupRefreshableProperties = ({
+ current_user_matches_store_user,
+}: {
+ current_user_matches_store_user: boolean;
+}) => {
+ const settings = createMockSettings({
+ "token-status": {
+ status: "",
+ valid: true,
+ features: [],
+ "store-users": current_user_matches_store_user
+ ? [{ email: "[email protected]" }]
+ : [{ email: "[email protected]" }],
+ },
+ });
+ setupPropertiesEndpoints(settings);
+ return settings;
+};
+
+const setup = async ({
+ current_user_matches_store_user,
+}: {
+ current_user_matches_store_user: boolean;
+}) => {
+ const settings = setupRefreshableProperties({
+ current_user_matches_store_user,
+ });
+
+ const user = createMockUser({ email: "[email protected]" });
+ setupCurrentUserEndpoint(user);
+
+ return createMockState({
+ settings: createMockSettingsState(settings),
+ currentUser: user,
+ });
+};
+
+describe("useStoreUsers", () => {
+ it("user is not store user", async () => {
+ const state = await setup({ current_user_matches_store_user: false });
+ expect(getStoreUsers(state)).toEqual({
+ isStoreUser: false,
+ anyStoreUserEmailAddress: "[email protected]",
+ });
+ });
+
+ it("user is store user", async () => {
+ const state = await setup({ current_user_matches_store_user: true });
+ expect(getStoreUsers(state)).toEqual({
+ isStoreUser: true,
+ anyStoreUserEmailAddress: "[email protected]",
+ });
+ });
+});
diff --git a/frontend/src/metabase/ui/components/inputs/Radio/Radio.module.css b/frontend/src/metabase/ui/components/inputs/Radio/Radio.module.css
index 70a7879bbb2..b5a5239e3de 100644
--- a/frontend/src/metabase/ui/components/inputs/Radio/Radio.module.css
+++ b/frontend/src/metabase/ui/components/inputs/Radio/Radio.module.css
@@ -46,6 +46,7 @@
.labelWrapper {
justify-content: center;
+ width: 100%;
}
.description {
diff --git a/frontend/test/__support__/server-mocks/store.ts b/frontend/test/__support__/server-mocks/store.ts
index ada1aa5b4ea..eed085585a9 100644
--- a/frontend/test/__support__/server-mocks/store.ts
+++ b/frontend/test/__support__/server-mocks/store.ts
@@ -1,7 +1,56 @@
import fetchMock from "fetch-mock";
+import { match } from "ts-pattern";
import type { StoreTokenStatus } from "metabase-types/api";
+import { createMockCloudAddOns } from "metabase-types/api/mocks/add-ons";
-export function setupStoreTokenEndpoints(tokenStatus: StoreTokenStatus) {
+export function setupStoreTokenEndpoint(tokenStatus: StoreTokenStatus) {
fetchMock.get("path:/api/premium-features/token/status", tokenStatus);
}
+
+export function setupStoreEEBillingEndpoint(
+ billing_period_months: number,
+ simulate_http_get_error: boolean = false,
+) {
+ fetchMock.get("path:/api/ee/billing", {
+ body: {
+ version: "v1",
+ data: { billing_period_months },
+ },
+ status: simulate_http_get_error ? 500 : 200,
+ });
+}
+
+export function setupStoreEECloudAddOnsEndpoint(
+ billing_period_months: number,
+ simulate_http_get_error: boolean = false,
+) {
+ fetchMock.get("path:/api/ee/cloud-add-ons/addons", {
+ body: createMockCloudAddOns({ billing_period_months }),
+ status: simulate_http_get_error ? 500 : 200,
+ });
+}
+
+export function setupStoreEETieredMetabotAI(
+ simulate_http_post_error:
+ | false
+ | "error-no-quantity"
+ | "error-no-connection" = false,
+) {
+ fetchMock.post(
+ "path:/api/ee/cloud-add-ons/metabase-ai-tiered",
+ match(simulate_http_post_error)
+ .with("error-no-quantity", () => ({
+ body: { errors: { quantity: "Purchase of add-on requires quantity." } },
+ status: 403,
+ }))
+ .with("error-no-connection", () => ({
+ // eslint-disable-next-line no-literal-metabase-strings -- Used for fetch mock only
+ body: "Could not establish a connection to Metabase Cloud.",
+ status: 404,
+ }))
+ .otherwise(() => ({
+ status: 200,
+ })),
+ );
+}
diff --git a/package.json b/package.json
index f7ce0972ca9..0c076eda726 100644
--- a/package.json
+++ b/package.json
@@ -141,7 +141,7 @@
"tether": "^1.2.0",
"tinykeys": "^3.0.0",
"tippy.js": "^6.3.7",
- "ts-pattern": "^5.1.2",
+ "ts-pattern": "^5.9.0",
"ttag": "1.7.21",
"typescript": "^5.9.2",
"underscore": "~1.13.3",
diff --git a/src/metabase/premium_features/core.clj b/src/metabase/premium_features/core.clj
index 936f99eaecb..6a67ff2a02a 100644
--- a/src/metabase/premium_features/core.clj
+++ b/src/metabase/premium_features/core.clj
@@ -81,7 +81,8 @@
has-attached-dwh?
hide-embed-branding?
is-hosted?
- offer-metabase-ai?
+ offer-metabase-ai-trial?
+ offer-metabase-ai-paid?
premium-embedding-token
site-uuid-for-premium-features-token-checks
table-data-editing?
diff --git a/src/metabase/premium_features/settings.clj b/src/metabase/premium_features/settings.clj
index 4a11261a94d..57871a0ebe3 100644
--- a/src/metabase/premium_features/settings.clj
+++ b/src/metabase/premium_features/settings.clj
@@ -263,10 +263,14 @@
"Should Metabase do AI analysis on entities?"
:ai-entity-analysis)
-(define-premium-feature ^{:added "0.55.0"} offer-metabase-ai?
- "Offer Metabase AI add-on"
+(define-premium-feature ^{:added "0.55.0"} offer-metabase-ai-trial?
+ "Should we offer a trial of the Metabase AI add-on?"
:offer-metabase-ai)
+(define-premium-feature ^{:added "0.56.0"} offer-metabase-ai-paid?
+ "Should we offer the paid Metabase AI add-on?"
+ :offer-metabase-ai-tiered)
+
(define-premium-feature ^{:added "0.56.0"} cloud-custom-smtp?
"Can Metabase have a custom smtp details separate from the default Cloud details."
:cloud-custom-smtp)
@@ -338,7 +342,8 @@
:hosting (is-hosted?)
:llm_autodescription (enable-llm-autodescription?)
:metabot_v3 (enable-metabot-v3?)
- :offer_metabase_ai (offer-metabase-ai?)
+ :offer_metabase_ai (offer-metabase-ai-trial?)
+ :offer_metabase_ai_tiered (offer-metabase-ai-paid?)
:official_collections (enable-official-collections?)
:query_reference_validation (enable-query-reference-validation?)
:remote_sync (enable-remote-sync?)
diff --git a/test/metabase/analytics/stats_test.clj b/test/metabase/analytics/stats_test.clj
index 7ddfe9e6897..40da59cdaa6 100644
--- a/test/metabase/analytics/stats_test.clj
+++ b/test/metabase/analytics/stats_test.clj
@@ -569,7 +569,8 @@
:query-reference-validation
:cloud-custom-smtp
:session-timeout-config
- :offer-metabase-ai})
+ :offer-metabase-ai
+ :offer-metabase-ai-tiered})
(deftest every-feature-is-accounted-for-test
(testing "Is every premium feature either tracked under the :features key, or intentionally excluded?"
diff --git a/yarn.lock b/yarn.lock
index cdb7c6e178b..c85c4c3d69e 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -20792,10 +20792,10 @@ ts-morph@^25.0.0:
"@ts-morph/common" "~0.26.0"
code-block-writer "^13.0.3"
-ts-pattern@^5.1.2:
- version "5.1.2"
- resolved "https://registry.yarnpkg.com/ts-pattern/-/ts-pattern-5.1.2.tgz#1b000a2978a8eb4e1c4cf401413a8625331fbb03"
- integrity sha512-u+ElKUIWnqisjpRBhv6Y89yNq7Pmz6xL0v7pTSckrVZ0+5Vf32oh/3jmxWl80rAOGcnbBa7fCyeqNdP4yXzWWg==
+ts-pattern@^5.9.0:
+ version "5.9.0"
+ resolved "https://registry.yarnpkg.com/ts-pattern/-/ts-pattern-5.9.0.tgz#f0fb5205ce0b0c59af72beba62fee7612a61cea4"
+ integrity sha512-6s5V71mX8qBUmlgbrfL33xDUwO0fq48rxAu2LBE11WBeGdpCPOsXksQbZJHvHwhrd3QjUusd3mAOM5Gg0mFBLg==
tsconfig-paths@^3.15.0:
version "3.15.0"