Skip to content

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

fix: cancel managed ai add-on when disconnecting (#72782)

Maksym Yakubych1a5ba0a0a414
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 b759c2c7f02..60993881468 100644
--- a/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/cloud_add_ons/api.clj
@@ -19,6 +19,8 @@
(deferred-tru "Could not establish a connection to Metabase Cloud."))
(def ^:private error-cannot-purchase
(deferred-tru "Could not purchase this add-on."))
+(def ^:private error-cannot-remove
+ (deferred-tru "Could not remove this add-on."))
(def ^:private error-unexpected
(deferred-tru "Unexpected error"))
(def ^:private error-not-hosted
@@ -45,6 +47,18 @@
(def ^:private response-success-empty
{:status 200 :body {}})
+(def ^:private cloud-add-on-product-types
+ [:enum
+ "metabase-ai"
+ "metabase-ai-tiered"
+ "metabase-ai-managed"
+ "python-execution"
+ "transforms"
+ "transforms-basic"
+ "transforms-advanced"
+ "transforms-basic-metered"
+ "transforms-advanced-metered"])
+
(defn- handle-store-api-error
"Handle exceptions from Store API calls and return appropriate error response."
[exception & [extra-status-mappings]]
@@ -108,7 +122,7 @@
(api.macros/defendpoint :post "/:product-type"
"Purchase an add-on."
[{:keys [product-type]} :- [:map
- [:product-type [:enum "metabase-ai" "metabase-ai-tiered" "metabase-ai-managed" "python-execution" "transforms" "transforms-basic" "transforms-advanced" "transforms-basic-metered" "transforms-advanced-metered"]]]
+ [:product-type cloud-add-on-product-types]]
_query-params
{:keys [quantity]
terms-of-service :terms_of_service} :- [:map
@@ -151,6 +165,26 @@
(log/warnf e "Error purchasing add-on '%s'" product-type)
(handle-store-api-error e {400 error-cannot-purchase})))))
+(api.macros/defendpoint :delete "/:product-type" :- [:map
+ [:status :int]
+ [:body :any]]
+ "Remove an add-on."
+ [{:keys [product-type]} :- [:map
+ [:product-type cloud-add-on-product-types]]]
+ (api/check-superuser)
+ (cond
+ (not (premium-features/is-hosted?))
+ response-not-hosted
+
+ :else
+ (try
+ (hm.client/call :change-add-ons :remove-add-ons [{:product-type product-type}])
+ (premium-features/clear-cache!)
+ response-success-empty
+ (catch Exception e
+ (log/warnf e "Error removing add-on '%s'" product-type)
+ (handle-store-api-error e {400 error-cannot-remove})))))
+
(def ^{:arglists '([request respond raise])} routes
"`/api/ee/cloud-add-ons` routes."
(api/+check-superuser
diff --git a/enterprise/backend/test/metabase_enterprise/cloud_add_ons/api_test.clj b/enterprise/backend/test/metabase_enterprise/cloud_add_ons/api_test.clj
index 1e578d55968..e9ba9c4459a 100644
--- a/enterprise/backend/test/metabase_enterprise/cloud_add_ons/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/cloud_add_ons/api_test.clj
@@ -99,6 +99,45 @@
(is (=? {}
(mt/user-http-request user :post 200 (str "ee/cloud-add-ons/" product-type) {}))))))))))
+(deftest ^:sequential delete-product-type-test
+ (testing "DELETE /api/ee/cloud-add-ons/metabase-ai-managed"
+ (testing "requires superuser"
+ (mt/with-premium-features #{}
+ (is (=? "You don't have permissions to do that."
+ (mt/user-http-request :rasta :delete 403 "ee/cloud-add-ons/metabase-ai-managed")))))
+ (testing "requires token feature 'hosting'"
+ (mt/with-premium-features #{}
+ (is (=? "Can only access Store API for Metabase Cloud instances."
+ (mt/user-http-request :crowberto :delete 400 "ee/cloud-add-ons/metabase-ai-managed")))))
+ (testing "when conditions are met"
+ (mt/with-premium-features #{:hosting}
+ (doseq [[status-code error-message] {404 "Could not establish a connection to Metabase Cloud."
+ 403 "Could not establish a connection to Metabase Cloud."
+ 401 "Could not establish a connection to Metabase Cloud."
+ 400 "Could not remove this add-on."}]
+ (testing (format "passes through HTTP status %d from Store API" status-code)
+ (with-redefs [hm.client/call (fn [& _] (throw (ex-info "TEST" {:status status-code})))]
+ (is (=? error-message
+ (mt/user-http-request :crowberto :delete status-code "ee/cloud-add-ons/metabase-ai-managed"))))))
+ (testing "responds with HTTP status 500 for other errors from Store API"
+ (with-redefs [hm.client/call (fn [& _] (throw (ex-info "TEST" {})))]
+ (is (=? "Unexpected error"
+ (mt/user-http-request :crowberto :delete 500 "ee/cloud-add-ons/metabase-ai-managed")))))
+ (testing "succeeds"
+ (let [{store-api-proxy :proxy store-api-calls :calls} (semantic.tu/spy (constantly nil))
+ {clear-token-cache-proxy :proxy clear-token-cache-calls :calls} (semantic.tu/spy premium-features/clear-cache!)]
+ (with-redefs [hm.client/call store-api-proxy
+ premium-features/clear-cache! clear-token-cache-proxy]
+ (is (=? {}
+ (mt/user-http-request :crowberto :delete 200 "ee/cloud-add-ons/metabase-ai-managed")))
+ (is (= [{:args [:change-add-ons
+ :remove-add-ons
+ [{:product-type "metabase-ai-managed"}]]
+ :ret nil}]
+ @store-api-calls))
+ (is (not-empty @clear-token-cache-calls)
+ "Token cache was cleared"))))))))
+
(deftest ^:sequential get-plans-test
(testing "GET /api/ee/cloud-add-ons/plans"
(testing "requires superuser"
diff --git a/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts b/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts
index b2048ea7f70..18a016f3113 100644
--- a/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts
+++ b/enterprise/frontend/src/metabase-enterprise/api/cloud-add-ons.ts
@@ -1,6 +1,7 @@
import type {
GetCloudAddOnsResponse,
PurchaseCloudAddOnRequest,
+ RemoveCloudAddOnRequest,
} from "metabase-types/api";
import { EnterpriseApi } from "./api";
@@ -20,7 +21,16 @@ export const cloudAddOnApi = EnterpriseApi.injectEndpoints({
body,
}),
}),
+ removeCloudAddOn: builder.mutation<void, RemoveCloudAddOnRequest>({
+ query: ({ product_type }) => ({
+ method: "DELETE",
+ url: `/api/ee/cloud-add-ons/${product_type}`,
+ }),
+ }),
}),
});
-export const { useListAddOnsQuery, usePurchaseCloudAddOnMutation } =
- cloudAddOnApi;
+export const {
+ useListAddOnsQuery,
+ usePurchaseCloudAddOnMutation,
+ useRemoveCloudAddOnMutation,
+} = cloudAddOnApi;
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 58a4cb2b641..1fa555b00d7 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabaseAIProviderSetup.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabaseAIProviderSetup.tsx
@@ -23,11 +23,15 @@ import {
} from "metabase/ui";
import { formatNumber } from "metabase/utils/formatting";
import { useSelector } from "metabase/utils/redux";
+import {
+ useGetMetabotUsageQuery,
+ useRemoveCloudAddOnMutation,
+} from "metabase-enterprise/api";
import { hasPremiumFeature } from "metabase-enterprise/settings";
-import { useGetMetabotUsageQuery } from "../../../api";
import {
METABASE_MANAGED_AI_FEATURE,
+ METABASE_MANAGED_AI_PRODUCT_TYPE,
METABASE_MANAGED_AI_TERMS_URL,
METABOT_V3_FEATURE,
OFFER_METABASE_MANAGED_AI_FEATURE,
@@ -70,6 +74,8 @@ export function MetabaseAIProviderSetup() {
);
const metabaseManagedAiPurchase = usePurchaseMetabaseManagedAi();
+ const [removeCloudAddOn, removeCloudAddOnResult] =
+ useRemoveCloudAddOnMutation();
const [hasAcceptedTerms, setHasAcceptedTerms] = useState(false);
const [isSettingUpModalOpen, setIsSettingUpModalOpen] = useState(false);
@@ -103,7 +109,17 @@ export function MetabaseAIProviderSetup() {
.with({ isStoreUser: false }, () => null)
.otherwise(() => handleMetabasePurchase);
- const { isLoading } = useMetabotSetupContext(onConnect);
+ const onDisconnect = useCallback(async () => {
+ if (!hasMetabaseManagedAiProviderFeature) {
+ return;
+ }
+
+ await removeCloudAddOn({
+ product_type: METABASE_MANAGED_AI_PRODUCT_TYPE,
+ }).unwrap();
+ }, [hasMetabaseManagedAiProviderFeature, removeCloudAddOn]);
+
+ const { isLoading } = useMetabotSetupContext(onConnect, onDisconnect);
const metabaseManagedAiPurchaseError = metabaseManagedAiPurchase.error
? getErrorMessage(
@@ -119,6 +135,13 @@ export function MetabaseAIProviderSetup() {
)
: undefined;
+ const removeMetabaseManagedAiError = removeCloudAddOnResult.error
+ ? getErrorMessage(
+ removeCloudAddOnResult.error,
+ t`Unable to disconnect from this AI provider.`,
+ )
+ : undefined;
+
return (
<>
{isConfigured ? (
@@ -212,6 +235,12 @@ export function MetabaseAIProviderSetup() {
</Text>
)}
+ {removeMetabaseManagedAiError && (
+ <Text size="sm" c="error">
+ {removeMetabaseManagedAiError}
+ </Text>
+ )}
+
<MetabotSettingUpModal
isSavingConfiguration={
isSettingUpModalOpen && updateMetabotSettingsResult.isLoading
diff --git a/frontend/src/metabase-types/api/cloud-add-ons.ts b/frontend/src/metabase-types/api/cloud-add-ons.ts
index d7d0c3605b6..c51f344baca 100644
--- a/frontend/src/metabase-types/api/cloud-add-ons.ts
+++ b/frontend/src/metabase-types/api/cloud-add-ons.ts
@@ -1,11 +1,17 @@
+export type CloudAddOnProductType =
+ | "metabase-ai"
+ | "metabase-ai-tiered"
+ | "metabase-ai-managed"
+ | "python-execution"
+ | "transforms-basic"
+ | "transforms-advanced";
+
export interface PurchaseCloudAddOnRequest {
- product_type:
- | "metabase-ai"
- | "metabase-ai-tiered"
- | "metabase-ai-managed"
- | "python-execution"
- | "transforms-basic"
- | "transforms-advanced";
+ product_type: CloudAddOnProductType;
quantity?: number;
terms_of_service?: boolean;
}
+
+export interface RemoveCloudAddOnRequest {
+ product_type: CloudAddOnProductType;
+}
diff --git a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx
index aca58bd456b..e5c32648d7e 100644
--- a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.tsx
@@ -67,21 +67,28 @@ function getModelDescription(provider: MetabotProvider | undefined) {
const MetabotSetupContext = createContext<{
connectHandlerRef: MutableRefObject<(() => Promise<void>) | null> | null;
+ disconnectHandlerRef: MutableRefObject<(() => Promise<void>) | null> | null;
isLoading: boolean;
isConnectButtonEnabled: boolean;
setIsConnectButtonEnabled: (enabled: boolean) => void;
}>({
isLoading: false,
connectHandlerRef: null,
+ disconnectHandlerRef: null,
isConnectButtonEnabled: false,
setIsConnectButtonEnabled: () => {},
});
export function useMetabotSetupContext(
onConnect: (() => Promise<void>) | null,
+ onDisconnect: (() => Promise<void>) | null = null,
) {
- const { connectHandlerRef, isLoading, setIsConnectButtonEnabled } =
- useContext(MetabotSetupContext);
+ const {
+ connectHandlerRef,
+ disconnectHandlerRef,
+ isLoading,
+ setIsConnectButtonEnabled,
+ } = useContext(MetabotSetupContext);
useEffect(() => {
if (!connectHandlerRef) {
@@ -97,6 +104,18 @@ export function useMetabotSetupContext(
};
}, [connectHandlerRef, onConnect, setIsConnectButtonEnabled]);
+ useEffect(() => {
+ if (!disconnectHandlerRef) {
+ return;
+ }
+
+ disconnectHandlerRef.current = onDisconnect;
+
+ return () => {
+ disconnectHandlerRef.current = null;
+ };
+ }, [disconnectHandlerRef, onDisconnect]);
+
return { isLoading };
}
@@ -130,6 +149,7 @@ export function MetabotSetup({ id }: { id?: string }) {
}, [connectedProvider]);
const [updateSettings, updateSettingsResult] = useUpdateSettingsMutation();
+ const disconnectHandlerRef = useRef<(() => Promise<void>) | null>(null);
const { details: providerApiKeyDetails } = useAdminSettings([
"llm-anthropic-api-key",
@@ -142,6 +162,12 @@ export function MetabotSetup({ id }: { id?: string }) {
return;
}
+ try {
+ await disconnectHandlerRef.current?.();
+ } catch {
+ return;
+ }
+
const settingsToClear: Record<string, null> = {
"llm-metabot-provider": null,
};
@@ -182,7 +208,13 @@ export function MetabotSetup({ id }: { id?: string }) {
toastColor: "error",
});
}
- }, [connectedProvider, providerApiKeyDetails, updateSettings, sendToast]);
+ }, [
+ connectedProvider,
+ disconnectHandlerRef,
+ providerApiKeyDetails,
+ updateSettings,
+ sendToast,
+ ]);
const providerOptions = useMemo(() => {
const options = Object.values(getProviderOptions(offerMetabaseAiManaged));
@@ -195,6 +227,7 @@ export function MetabotSetup({ id }: { id?: string }) {
const connectHandlerRef = useRef<(() => Promise<void>) | null>(null);
const [isConnecting, setIsConnecting] = useState(false);
+ const [isDisconnecting, setIsDisconnecting] = useState(false);
const handleConnect = async () => {
if (!connectHandlerRef.current) {
return;
@@ -207,13 +240,15 @@ export function MetabotSetup({ id }: { id?: string }) {
}
};
- const isLoading = isConnecting || updateSettingsResult.isLoading;
+ const isLoading =
+ isConnecting || isDisconnecting || updateSettingsResult.isLoading;
const [isConnectButtonEnabled, setIsConnectButtonEnabled] = useState(false);
return (
<MetabotSetupContext.Provider
value={{
connectHandlerRef,
+ disconnectHandlerRef,
isLoading,
setIsConnectButtonEnabled,
isConnectButtonEnabled,
@@ -294,7 +329,14 @@ export function MetabotSetup({ id }: { id?: string }) {
c="danger"
loading={isLoading}
disabled={isLoading}
- onClick={handleDisconnect}
+ onClick={async () => {
+ setIsDisconnecting(true);
+ try {
+ await handleDisconnect();
+ } finally {
+ setIsDisconnecting(false);
+ }
+ }}
>
{t`Disconnect`}
</Button>
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 689a9c0e9e0..e2a00f9b429 100644
--- a/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAdmin/MetabotSetup.unit.spec.tsx
@@ -117,6 +117,7 @@ type SetupOptions = {
tokenStatusFeatures?: TokenStatusFeature[];
refreshedTokenStatusFeatures?: TokenStatusFeature[];
purchaseCloudAddOnResponse?: number | { status: number; body: unknown };
+ removeCloudAddOnResponse?: number | { status: number; body: unknown };
apiKeyValues?: Partial<Record<MetabotProvider, string | null>>;
pauseUpdateResponse?: boolean;
settingUpdateResponse?: number | { status: number; body?: unknown };
@@ -140,6 +141,7 @@ async function setup({
tokenStatusFeatures = [],
refreshedTokenStatusFeatures = tokenStatusFeatures,
purchaseCloudAddOnResponse = 200,
+ removeCloudAddOnResponse = 200,
apiKeyValues,
pauseUpdateResponse = false,
settingUpdateResponse = 204,
@@ -227,6 +229,7 @@ async function setup({
metabasePricePerUnit,
metabotUsageQuota: metabotUsageQuotas?.[0] ?? null,
purchaseCloudAddOnResponse,
+ removeCloudAddOnResponse,
});
fetchMock.post("path:/api/premium-features/token/refresh", () => {
@@ -918,11 +921,11 @@ describe("MetabotSetup", () => {
).not.toBeInTheDocument();
});
- it("disconnects the Metabase-managed provider without clearing an API key", async () => {
+ it("disconnects the Metabase-managed provider by removing the add-on before clearing the provider setting", async () => {
await setup({
isHosted: true,
- savedProviderValue: "metabase/anthropic/claude-sonnet-4-6",
tokenStatusFeatures: ["metabase-ai-managed"],
+ savedProviderValue: "metabase/anthropic/claude-sonnet-4-6",
});
await screen.findByText("Current billing cycle");
@@ -930,19 +933,68 @@ describe("MetabotSetup", () => {
await screen.findByRole("button", { name: "Disconnect" }),
);
+ await waitFor(() => {
+ expect(
+ fetchMock.callHistory.called(
+ "path:/api/ee/cloud-add-ons/metabase-ai-managed",
+ ),
+ ).toBe(true);
+ });
+
await waitFor(() => {
expect(fetchMock.callHistory.called("path:/api/setting")).toBe(true);
});
+ const removeRequest = fetchMock.callHistory
+ .calls("path:/api/ee/cloud-add-ons/metabase-ai-managed")
+ .find((call) => call.request?.method === "DELETE");
const request = fetchMock.callHistory
.calls("path:/api/setting")
.find((call) => call.request?.method === "PUT");
+ expect(removeRequest).toBeDefined();
expect(request?.options?.body).toBe(
JSON.stringify({
"llm-metabot-provider": null,
}),
);
+
+ const callHistory = fetchMock.callHistory.calls();
+
+ expect(
+ callHistory.indexOf(removeRequest as (typeof callHistory)[number]),
+ ).toBeLessThan(
+ callHistory.indexOf(request as (typeof callHistory)[number]),
+ );
+ });
+
+ it("does not clear the provider setting if removing the Metabase-managed add-on fails", async () => {
+ await setup({
+ isHosted: true,
+ tokenStatusFeatures: ["metabase-ai-managed"],
+ savedProviderValue: "metabase/anthropic/claude-sonnet-4-6",
+ removeCloudAddOnResponse: 500,
+ });
+
+ await screen.findByText("Current billing cycle");
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Disconnect" }),
+ );
+
+ await waitFor(() => {
+ expect(
+ screen.getByText("Unable to disconnect from this AI provider."),
+ ).toBeInTheDocument();
+ });
+
+ expect(
+ fetchMock.callHistory
+ .calls("path:/api/setting")
+ .some((call) => call.request?.method === "PUT"),
+ ).toBe(false);
+ expect(
+ screen.getByRole("button", { name: "Disconnect" }),
+ ).toBeInTheDocument();
});
it("shows an error toast when disconnect fails", async () => {
diff --git a/frontend/test/__support__/server-mocks/metabot.ts b/frontend/test/__support__/server-mocks/metabot.ts
index 243a4806830..043cd72105a 100644
--- a/frontend/test/__support__/server-mocks/metabot.ts
+++ b/frontend/test/__support__/server-mocks/metabot.ts
@@ -167,6 +167,7 @@ type SetupMetabaseManagedAiEndpointsOptions = {
updated_at: string | null;
} | null;
purchaseCloudAddOnResponse?: number | { status: number; body: unknown };
+ removeCloudAddOnResponse?: number | { status: number; body: unknown };
};
export function setupMetabaseManagedAiEndpoints({
@@ -174,6 +175,7 @@ export function setupMetabaseManagedAiEndpoints({
metabasePricePerUnit = 3.75,
metabotUsageQuota = null,
purchaseCloudAddOnResponse = 200,
+ removeCloudAddOnResponse = 200,
}: SetupMetabaseManagedAiEndpointsOptions = {}) {
fetchMock.get("path:/api/ee/metabot/usage", {
tokens: metabotUsageQuota?.tokens ?? null,
@@ -211,6 +213,11 @@ export function setupMetabaseManagedAiEndpoints({
`path:/api/ee/cloud-add-ons/${METABASE_MANAGED_AI_PRODUCT_TYPE}`,
purchaseCloudAddOnResponse,
);
+
+ fetchMock.delete(
+ `path:/api/ee/cloud-add-ons/${METABASE_MANAGED_AI_PRODUCT_TYPE}`,
+ removeCloudAddOnResponse,
+ );
}
const METABOT_GROUP_PERMISSIONS_ROUTE_NAME = "metabot-group-permissions";