Skip to content

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

fix: enabling metabase ai requires multiple clicks (#72974)

Maksym Yakubych4af8ee417399
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabaseAIProviderSetup.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabaseAIProviderSetup.tsx
index 26b0c16db6b..27a21898c23 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabaseAIProviderSetup.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabaseAIProviderSetup.tsx
@@ -92,10 +92,11 @@ export function MetabaseAIProviderSetup() {
await metabaseManagedAiPurchase.purchaseMetabaseManagedAi(
hasAcceptedTerms,
);
+ await handleConnect();
} catch {
setIsSettingUpModalOpen(false);
}
- }, [hasAcceptedTerms, metabaseManagedAiPurchase]);
+ }, [handleConnect, hasAcceptedTerms, metabaseManagedAiPurchase]);
const onConnect = match({
hasAcceptedTerms,
@@ -287,9 +288,10 @@ export function MetabaseAIProviderSetup() {
<MetabotSettingUpModal
isSavingConfiguration={
- isSettingUpModalOpen && updateMetabotSettingsResult.isLoading
+ isSettingUpModalOpen &&
+ (updateMetabotSettingsResult.isLoading ||
+ metabaseManagedAiPurchase.isLoading)
}
- onActivated={handleConnect}
opened={isSettingUpModalOpen}
onClose={() => setIsSettingUpModalOpen(false)}
/>
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx
index 557b64e66cf..5cf47ed2cd5 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotSettingUpModal.tsx
@@ -19,19 +19,16 @@ import { METABASE_MANAGED_AI_FEATURE } from "../../constants";
export function MetabotSettingUpModal({
isSavingConfiguration = false,
- onActivated,
onClose,
opened,
}: Pick<ModalProps, "opened" | "onClose"> & {
isSavingConfiguration?: boolean;
- onActivated?: () => void | Promise<void>;
}) {
const isSettingUp =
isSavingConfiguration || !hasPremiumFeature(METABASE_MANAGED_AI_FEATURE);
useTokenRefreshUntil(METABASE_MANAGED_AI_FEATURE, {
intervalMs: 1000,
- onSatisfied: onActivated,
skip: !opened || !isSettingUp,
});
diff --git a/frontend/src/metabase/api/utils/settings.ts b/frontend/src/metabase/api/utils/settings.ts
index 53e1a78c052..39204446b81 100644
--- a/frontend/src/metabase/api/utils/settings.ts
+++ b/frontend/src/metabase/api/utils/settings.ts
@@ -28,10 +28,14 @@ export const useAdminSetting = <SettingName extends EnterpriseSettingKey>(
const {
data: settings,
isLoading: settingsLoading,
+ isFetching: settingsFetching,
...apiProps
} = useGetSettingsQuery();
- const { data: settingsDetails, isLoading: detailsLoading } =
- useGetAdminSettingsDetailsQuery();
+ const {
+ data: settingsDetails,
+ isLoading: detailsLoading,
+ isFetching: detailsFetching,
+ } = useGetAdminSettingsDetailsQuery();
const [updateSetting, updateSettingResult] = useUpdateSettingMutation();
const [updateSettings, updateSettingsResult] = useUpdateSettingsMutation();
@@ -107,6 +111,7 @@ export const useAdminSetting = <SettingName extends EnterpriseSettingKey>(
updateSettingResult,
updateSettingsResult,
isLoading: settingsLoading || detailsLoading,
+ isFetching: settingsFetching || detailsFetching,
...apiProps,
};
};
diff --git a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx
index 66cd9e6b8e1..a1feeac948d 100644
--- a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx
@@ -177,9 +177,11 @@ export function MetabotSetupInner({
const offerMetabaseAiManaged = PLUGIN_METABOT.isEnabled;
const [sendToast] = useToast();
- const { value: savedProviderValue, settingDetails } = useAdminSetting(
- "llm-metabot-provider",
- );
+ const {
+ value: savedProviderValue,
+ settingDetails,
+ isFetching: isMetabotProviderLoading,
+ } = useAdminSetting("llm-metabot-provider");
const isEnvSetting =
!!settingDetails &&
!!settingDetails.is_env_setting &&
@@ -304,7 +306,11 @@ export function MetabotSetupInner({
};
const isLoading =
- isConnecting || isDisconnecting || updateSettingsResult.isLoading;
+ isConnecting ||
+ isDisconnecting ||
+ updateSettingsResult.isLoading ||
+ isMetabotProviderLoading;
+
const [isConnectButtonEnabled, setIsConnectButtonEnabled] = useState(false);
return (
diff --git a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.unit.spec.tsx
index 40a190a6894..17003e6ba38 100644
--- a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.unit.spec.tsx
@@ -11,6 +11,7 @@ import {
import { mockSettings } from "__support__/settings";
import { act, renderWithProviders, screen, waitFor } from "__support__/ui";
import { reinitialize } from "metabase/plugins";
+import { defer } from "metabase/utils/promise";
import type {
MetabotProvider,
MetabotSettingsResponse,
@@ -120,9 +121,11 @@ type SetupOptions = {
tokenStatusFeatures?: TokenStatusFeature[];
refreshedTokenStatusFeatures?: TokenStatusFeature[];
purchaseCloudAddOnResponse?: number | { status: number; body: unknown };
+ deferPurchaseCloudAddOnResponse?: boolean;
removeCloudAddOnResponse?: number | { status: number; body: unknown };
apiKeyValues?: Partial<Record<MetabotProvider, string | null>>;
pauseUpdateResponse?: boolean;
+ deferMetabotSettingsUpdateResponse?: boolean;
settingUpdateResponse?: number | { status: number; body?: unknown };
responses?: Partial<Record<MetabotProvider, MetabotSettingsApiResponse>>;
updateResponse?: MetabotSettingsResponse;
@@ -146,9 +149,11 @@ async function setup({
tokenStatusFeatures = [],
refreshedTokenStatusFeatures = tokenStatusFeatures,
purchaseCloudAddOnResponse = 200,
+ deferPurchaseCloudAddOnResponse = false,
removeCloudAddOnResponse = 200,
apiKeyValues,
pauseUpdateResponse = false,
+ deferMetabotSettingsUpdateResponse = false,
settingUpdateResponse = 204,
responses,
updateResponse = {
@@ -160,6 +165,9 @@ async function setup({
fetchMock.removeRoutes();
fetchMock.clearHistory();
+ const purchaseCloudAddOnDeferred = defer<void>();
+ const updateMetabotSettingsDeferred = defer<void>();
+
const mergedApiKeyValues: Record<MetabotApiKeyProvider, string | null> = {
anthropic: "**********45",
openai: null,
@@ -238,7 +246,12 @@ async function setup({
billingPeriodMonths: metabaseBillingPeriodMonths,
metabasePricePerUnit,
metabotUsageQuota: metabotUsageQuotas?.[0] ?? null,
- purchaseCloudAddOnResponse,
+ purchaseCloudAddOnResponse: deferPurchaseCloudAddOnResponse
+ ? async () => {
+ await purchaseCloudAddOnDeferred.promise;
+ return purchaseCloudAddOnResponse;
+ }
+ : purchaseCloudAddOnResponse,
removeCloudAddOnResponse,
});
@@ -272,6 +285,12 @@ async function setup({
return new Promise(() => undefined);
}
+ if (deferMetabotSettingsUpdateResponse) {
+ return updateMetabotSettingsDeferred.promise.then(() =>
+ handleMetabotSettingsUpdate(call),
+ );
+ }
+
return handleMetabotSettingsUpdate(call);
});
@@ -378,6 +397,10 @@ async function setup({
return {
...view,
+ resolvePurchaseCloudAddOnResponse: () =>
+ purchaseCloudAddOnDeferred.resolve(),
+ resolveMetabotSettingsUpdateResponse: () =>
+ updateMetabotSettingsDeferred.resolve(),
};
}
@@ -757,25 +780,33 @@ describe("MetabotSetup", () => {
);
});
- it("polls until the Metabase provider feature is enabled, then saves the default Metabase model", async () => {
+ it("waits for the purchase and settings save before showing Metabase AI as ready", async () => {
+ let resolvePurchaseCloudAddOnResponse = () => {};
+ let resolveMetabotSettingsUpdateResponse = () => {};
+
try {
jest.useFakeTimers({ advanceTimers: true });
const user = userEvent.setup({
advanceTimers: jest.advanceTimersByTime,
});
- await setup({
+ ({
+ resolvePurchaseCloudAddOnResponse,
+ resolveMetabotSettingsUpdateResponse,
+ } = await setup({
isHosted: true,
savedProviderValue: "metabase/anthropic/claude-sonnet-4-6",
isConfigured: false,
isStoreUser: true,
tokenStatusFeatures: [],
refreshedTokenStatusFeatures: ["metabase-ai-managed"],
+ deferPurchaseCloudAddOnResponse: true,
+ deferMetabotSettingsUpdateResponse: true,
updateResponse: {
value: "metabase/anthropic/claude-sonnet-4-6",
models: DEFAULT_RESPONSES.metabase.models,
},
- });
+ }));
await selectProvider("Metabase");
const termsCheckbox = await screen.findByRole("checkbox", {
@@ -798,6 +829,10 @@ describe("MetabotSetup", () => {
expect(
await screen.findByText("Setting up Metabot AI, please wait"),
).toBeInTheDocument();
+ expect(screen.queryByText("Metabot AI is ready")).not.toBeInTheDocument();
+ expect(
+ screen.queryByText("Current billing cycle"),
+ ).not.toBeInTheDocument();
await waitFor(() => {
expect(
@@ -818,10 +853,17 @@ describe("MetabotSetup", () => {
JSON.stringify({ terms_of_service: true }),
);
- await Promise.resolve();
+ expect(
+ fetchMock.callHistory
+ .calls("path:/api/metabot/settings")
+ .some(
+ (call) =>
+ call.request?.method === "PUT" || call.options?.method === "PUT",
+ ),
+ ).toBe(false);
act(() => {
- jest.advanceTimersByTime(11 * 1000);
+ jest.advanceTimersByTime(1000);
});
await waitFor(() => {
@@ -832,6 +874,24 @@ describe("MetabotSetup", () => {
).toBe(true);
});
+ expect(
+ screen.getByText("Setting up Metabot AI, please wait"),
+ ).toBeInTheDocument();
+ expect(screen.queryByText("Metabot AI is ready")).not.toBeInTheDocument();
+ expect(
+ fetchMock.callHistory
+ .calls("path:/api/metabot/settings")
+ .some(
+ (call) =>
+ call.request?.method === "PUT" || call.options?.method === "PUT",
+ ),
+ ).toBe(false);
+
+ await act(async () => {
+ resolvePurchaseCloudAddOnResponse();
+ await Promise.resolve();
+ });
+
await waitFor(() => {
expect(
fetchMock.callHistory
@@ -845,8 +905,23 @@ describe("MetabotSetup", () => {
});
expect(
- await screen.findByText("Metabot AI is ready"),
+ screen.getByText("Setting up Metabot AI, please wait"),
).toBeInTheDocument();
+ expect(screen.queryByText("Metabot AI is ready")).not.toBeInTheDocument();
+ expect(
+ screen.queryByText("Current billing cycle"),
+ ).not.toBeInTheDocument();
+
+ await act(async () => {
+ resolveMetabotSettingsUpdateResponse();
+ await Promise.resolve();
+ });
+
+ expect(
+ await screen.findByRole("button", { name: "Done" }),
+ ).toBeInTheDocument();
+ expect(screen.getByText("Metabot AI is ready")).toBeInTheDocument();
+ expect(screen.getByText("Current billing cycle")).toBeInTheDocument();
expect(screen.queryByLabelText("Model")).not.toBeInTheDocument();
expect(
screen.queryByRole("button", { name: "Connect" }),
@@ -865,7 +940,25 @@ describe("MetabotSetup", () => {
expect(settingsRequest?.options?.body).toBe(
JSON.stringify({ provider: "metabase", model: "" }),
);
+
+ const callHistory = fetchMock.callHistory.calls();
+ const [purchaseRequest] = fetchMock.callHistory.calls(
+ "path:/api/ee/cloud-add-ons/metabase-ai-managed",
+ {
+ method: "POST",
+ },
+ );
+
+ if (!settingsRequest || !purchaseRequest) {
+ throw new Error("Expected purchase and settings requests to exist");
+ }
+
+ expect(callHistory.indexOf(purchaseRequest)).toBeLessThan(
+ callHistory.indexOf(settingsRequest),
+ );
} finally {
+ resolvePurchaseCloudAddOnResponse();
+ resolveMetabotSettingsUpdateResponse();
jest.useRealTimers();
}
});
diff --git a/frontend/test/__support__/server-mocks/metabot.ts b/frontend/test/__support__/server-mocks/metabot.ts
index edccc5ab809..9264fdccca2 100644
--- a/frontend/test/__support__/server-mocks/metabot.ts
+++ b/frontend/test/__support__/server-mocks/metabot.ts
@@ -1,4 +1,7 @@
-import fetchMock, { type UserRouteConfig } from "fetch-mock";
+import fetchMock, {
+ type RouteResponse,
+ type UserRouteConfig,
+} from "fetch-mock";
import type {
MetabotGroupLimit,
@@ -170,7 +173,7 @@ type SetupMetabaseManagedAiEndpointsOptions = {
free_tokens?: number | null;
updated_at: string | null;
} | null;
- purchaseCloudAddOnResponse?: number | { status: number; body: unknown };
+ purchaseCloudAddOnResponse?: RouteResponse;
removeCloudAddOnResponse?: number | { status: number; body: unknown };
};