Skip to content

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

Fix metabot UI settings not respecting appdb state (#73498)

Tyler Plude7dfb72f4955f
diff --git a/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.tsx b/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.tsx
index 8cabaaf6124..9f1d2953423 100644
--- a/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.tsx
@@ -5,21 +5,19 @@ import {
SettingsPageWrapper,
SettingsSection,
} from "metabase/admin/components/SettingsSection";
+import { useListMetabotsQuery } from "metabase/api";
import { useAdminSetting } from "metabase/api/utils";
import { ExternalLink } from "metabase/common/components/ExternalLink";
import { Link } from "metabase/common/components/Link";
+import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { useDocsUrl, useSetting } from "metabase/common/hooks";
-import {
- FIXED_METABOT_ENTITY_IDS,
- FIXED_METABOT_IDS,
-} from "metabase/metabot/constants";
+import { FIXED_METABOT_IDS } from "metabase/metabot/constants";
import {
PLUGIN_EMBEDDING_IFRAME_SDK,
PLUGIN_EMBEDDING_SDK,
} from "metabase/plugins";
import { useRouter } from "metabase/router/useRouter";
import { Divider, Flex, Stack, Switch, Tabs } from "metabase/ui";
-import type { MetabotInfo } from "metabase-types/api";
import { McpAppsSettings } from "./McpAppsSettings";
import { MetabotSettingsPanel } from "./MetabotSettingsPanel";
@@ -36,18 +34,6 @@ const AI_FEATURES_ENABLED_SECTION_ID = "ai-features-enabled";
const DEFAULT_METABOT_PATH = `/admin/metabot/${FIXED_METABOT_IDS.DEFAULT}`;
const EMBEDDED_METABOT_PATH = `/admin/metabot/${FIXED_METABOT_IDS.EMBEDDED}`;
-const INTERNAL_METABOT = {
- id: FIXED_METABOT_IDS.DEFAULT,
- entity_id: FIXED_METABOT_ENTITY_IDS.DEFAULT,
- name: "Metabot",
-} as MetabotInfo;
-
-const EMBEDDED_METABOT = {
- id: FIXED_METABOT_IDS.EMBEDDED,
- entity_id: FIXED_METABOT_ENTITY_IDS.EMBEDDED,
- name: "Embedded Metabot",
-} as MetabotInfo;
-
export function AISettingsPage() {
const {
location: { pathname },
@@ -151,8 +137,12 @@ function MetabotSettingsSection({
id: string;
selectedTab: MetabotTabValue;
}) {
- const activeMetabot =
- selectedTab === "embedded" ? EMBEDDED_METABOT : INTERNAL_METABOT;
+ const { data, isLoading, error } = useListMetabotsQuery();
+ const activeMetabotId =
+ selectedTab === "embedded"
+ ? FIXED_METABOT_IDS.EMBEDDED
+ : FIXED_METABOT_IDS.DEFAULT;
+ const activeMetabot = data?.items.find((m) => m.id === activeMetabotId);
const showTabs = hasEmbedding;
return (
@@ -180,7 +170,14 @@ function MetabotSettingsSection({
</Tabs>
)}
- <MetabotSettingsPanel metabot={activeMetabot} />
+ {activeMetabot ? (
+ <MetabotSettingsPanel metabot={activeMetabot} />
+ ) : (
+ <LoadingAndErrorWrapper
+ loading={isLoading}
+ error={error ? t`Error loading Metabot configuration` : null}
+ />
+ )}
</SettingsSection>
);
}
diff --git a/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.unit.spec.tsx
index 10c89eadfed..ae91e5c1b89 100644
--- a/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAdmin/AISettingsPage.unit.spec.tsx
@@ -12,10 +12,14 @@ import {
setupSettingsEndpoints,
setupUpdateSettingEndpoint,
} from "__support__/server-mocks";
-import { setupMetabotPromptSuggestionsEndpoint } from "__support__/server-mocks/metabot";
+import {
+ setupMetabotPromptSuggestionsEndpoint,
+ setupMetabotsEndpoints,
+} from "__support__/server-mocks/metabot";
import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen, waitFor } from "__support__/ui";
import { FIXED_METABOT_IDS } from "metabase/metabot/constants";
+import { buildDefaultMetabots } from "metabase/metabot/tests/utils";
import { reinitialize } from "metabase/plugins";
import { createMockSettingsState } from "metabase/redux/store/mocks";
import {
@@ -34,16 +38,25 @@ const defaultSeedCollections = [
const setup = async ({
aiFeaturesEnabled = true,
enableEmbedding = false,
+ contentVerification = false,
initialRoute = "/admin/metabot",
isConfigured = true,
+ metabots = buildDefaultMetabots(),
+ collections = defaultSeedCollections,
}: {
aiFeaturesEnabled?: boolean;
enableEmbedding?: boolean;
+ contentVerification?: boolean;
initialRoute?: string;
isConfigured?: boolean;
+ metabots?: Parameters<typeof setupMetabotsEndpoints>[0];
+ collections?: Parameters<
+ typeof setupCollectionByIdEndpoint
+ >[0]["collections"];
} = {}) => {
const tokenFeatures = createMockTokenFeatures({
embedding_sdk: enableEmbedding,
+ content_verification: contentVerification,
});
mockSettings({ "token-features": tokenFeatures });
@@ -80,15 +93,11 @@ const setup = async ({
}),
]);
setupUpdateSettingEndpoint();
- setupCollectionByIdEndpoint({
- collections: defaultSeedCollections.map((c: any) => ({
- id: c.model_id,
- ...c,
- })),
- });
+ setupCollectionByIdEndpoint({ collections });
setupRootCollectionItemsEndpoint({ rootCollectionItems: [] });
setupCollectionsEndpoints({ collections: [] });
setupRecentViewsAndSelectionsEndpoints(defaultSeedCollections as any);
+ setupMetabotsEndpoints(metabots);
[FIXED_METABOT_IDS.DEFAULT, FIXED_METABOT_IDS.EMBEDDED].forEach((metabotId) =>
setupMetabotPromptSuggestionsEndpoint({
@@ -189,6 +198,42 @@ describe("AISettingsPage", () => {
expect(screen.getByText("Enable Embedded Metabot")).toBeInTheDocument();
});
+ it("reflects the persisted use_verified_content state from the API", async () => {
+ await setup({
+ contentVerification: true,
+ metabots: buildDefaultMetabots({
+ default: { use_verified_content: true },
+ }),
+ });
+
+ expect(
+ await screen.findByRole("switch", {
+ name: "Only use Verified content",
+ }),
+ ).toBeChecked();
+ });
+
+ it("reflects the persisted collection_id from the API", async () => {
+ const verifiedCollection = createMockCollection({
+ id: 42,
+ name: "Verified content",
+ });
+
+ await setup({
+ collections: [...defaultSeedCollections, verifiedCollection],
+ metabots: buildDefaultMetabots({
+ default: { collection_id: 42 },
+ }),
+ });
+
+ expect(await screen.findByText("Verified content")).toBeInTheDocument();
+ expect(
+ await screen.findByRole("button", {
+ name: "Pick a different collection",
+ }),
+ ).toBeInTheDocument();
+ });
+
it("persists disable ai features", async () => {
await setup();
diff --git a/frontend/src/metabase/metabot/tests/utils.tsx b/frontend/src/metabase/metabot/tests/utils.tsx
index 9070880a5b3..c4ad4d20f35 100644
--- a/frontend/src/metabase/metabot/tests/utils.tsx
+++ b/frontend/src/metabase/metabot/tests/utils.tsx
@@ -22,14 +22,15 @@ import {
} from "metabase/api/ai-streaming/test-utils";
import type { State } from "metabase/redux/store";
import { createMockState } from "metabase/redux/store/mocks";
-import type { User } from "metabase-types/api";
+import type { MetabotInfo, User } from "metabase-types/api";
import {
+ createMockMetabotInfo,
createMockUser,
createMockUserMetabotPermissions,
} from "metabase-types/api/mocks";
import { Metabot } from "../components/Metabot";
-import { FIXED_METABOT_IDS } from "../constants";
+import { FIXED_METABOT_ENTITY_IDS, FIXED_METABOT_IDS } from "../constants";
import { MetabotProvider } from "../context";
import {
type MetabotAgentId,
@@ -151,6 +152,29 @@ export const adminQuotaLimitErroredResponse = [
`d:{"finishReason":"error","usage":{}}`,
];
+type DefaultMetabotOverrides = {
+ default?: Partial<MetabotInfo>;
+ embedded?: Partial<MetabotInfo>;
+};
+
+export function buildDefaultMetabots(
+ overrides: DefaultMetabotOverrides = {},
+): MetabotInfo[] {
+ return [
+ createMockMetabotInfo({
+ id: FIXED_METABOT_IDS.DEFAULT,
+ entity_id: FIXED_METABOT_ENTITY_IDS.DEFAULT,
+ ...overrides.default,
+ }),
+ createMockMetabotInfo({
+ id: FIXED_METABOT_IDS.EMBEDDED,
+ entity_id: FIXED_METABOT_ENTITY_IDS.EMBEDDED,
+ name: "Embedded Metabot",
+ ...overrides.embedded,
+ }),
+ ];
+}
+
// Setup function for metabot tests
export function setup(
options: {
diff --git a/src/metabase/analytics/prometheus.clj b/src/metabase/analytics/prometheus.clj
index 475179b4e29..86655cba059 100644
--- a/src/metabase/analytics/prometheus.clj
+++ b/src/metabase/analytics/prometheus.clj
@@ -5,7 +5,6 @@
Api is quite simple: [[setup!]] and [[shutdown!]]. After that you can retrieve metrics from
http://localhost:<prometheus-server-port>/metrics."
- (:refer-clojure :exclude [set!])
(:require
[clojure.java.jmx :as jmx]
[clojure.string :as str]
diff --git a/src/metabase/metabot/agent/user_context.clj b/src/metabase/metabot/agent/user_context.clj
index ef679483031..06006f19e76 100644
--- a/src/metabase/metabot/agent/user_context.clj
+++ b/src/metabase/metabot/agent/user_context.clj
@@ -350,9 +350,9 @@
Returns formatted string for template variable {{recent_views}}."
[context]
- (if-not (:user_recently_viewed context)
- ""
- (let [items (:user_recently_viewed context)]
+ (let [items (:user_recently_viewed context)]
+ (if-not (seq items)
+ ""
(te/lines "Here are some items the user has recently viewed:"
(for [item items]
(format-simple-entity (select-keys item [:type :id :name :description])))
diff --git a/src/metabase/metabot/api.clj b/src/metabase/metabot/api.clj
index 06075ba60f6..f8892c35113 100644
--- a/src/metabase/metabot/api.clj
+++ b/src/metabase/metabot/api.clj
@@ -124,7 +124,7 @@
When `:debug?` is true, enables debug logging which emits a `debug_log` data
part at the end of the stream with full LLM request/response data per iteration."
[{:keys [metabot-id profile-id message context history conversation-id state debug? ip-address embed-url]}]
- (let [enriched-context (metabot.context/create-context context)
+ (let [enriched-context (metabot.context/create-context context {:metabot-id metabot-id})
messages (concat history [message])
external-id (str (random-uuid))]
(sr/streaming-response {:content-type "text/event-stream"} [^OutputStream os canceled-chan]
diff --git a/src/metabase/metabot/context.clj b/src/metabase/metabot/context.clj
index 33d9e7ae226..594948dc051 100644
--- a/src/metabase/metabot/context.clj
+++ b/src/metabase/metabot/context.clj
@@ -10,7 +10,9 @@
[metabase.lib-be.core :as lib-be]
[metabase.lib.core :as lib]
[metabase.lib.schema :as lib.schema]
+ [metabase.metabot.config :as metabot.config]
[metabase.metabot.table-utils :as table-utils]
+ [metabase.premium-features.core :as premium-features]
[metabase.transforms-base.util :as transforms-base.u]
[metabase.util.json :as json]
[metabase.util.log :as log]
@@ -246,15 +248,66 @@
(assoc context :user_is_viewing annotated-viewing))
context))
+(defn- get-metabot
+ "Look up the metabot row for the given UUID/entity-id, mirroring the resolution used by `metabase.metabot.tools.search`."
+ [metabot-id]
+ (when metabot-id
+ (t2/select-one :model/Metabot
+ :entity_id (get-in metabot.config/metabot-config
+ [metabot-id :entity-id]
+ metabot-id))))
+
+(defn- verified-only?
+ [metabot]
+ (and (:use_verified_content metabot)
+ (premium-features/has-feature? :content-verification)))
+
+(defn- batch-verified-ids
+ "Of the given `ids`, return the set whose most-recent ModerationReview for `item-type` has status \"verified\"."
+ [ids item-type]
+ (if (empty? ids)
+ #{}
+ (t2/select-fn-set :moderated_item_id :model/ModerationReview
+ :moderated_item_id [:in ids]
+ :moderated_item_type item-type
+ :most_recent true
+ :status "verified")))
+
+(defn- filter-recents-to-verified
+ "Drop card/dataset/metric/dashboard recents that aren't verified. Tables (and any other
+ non-moderatable model) pass through unchanged."
+ [recents]
+ (let [card-like-ids (->> recents
+ (filter #(#{:card :dataset :metric} (:model %)))
+ (map :id))
+ dashboard-ids (->> recents
+ (filter #(= :dashboard (:model %)))
+ (map :id))
+ verified-cards (batch-verified-ids card-like-ids "card")
+ verified-dashboards (batch-verified-ids dashboard-ids "dashboard")]
+ (filter (fn [{:keys [id model]}]
+ (case model
+ (:card :dataset :metric) (contains? verified-cards id)
+ :dashboard (contains? verified-dashboards id)
+ true))
+ recents)))
+
(defn- add-recent-views
"Add user's recent views to the context since these have a higher likelihood of being relevant to a user's query.
Includes the 5 most recent items across cards, datasets, metrics, dashboards, and tables.
- (Excludes collections and documents for now, which aren't searchable by Metabot.)"
- [context]
+ (Excludes collections and documents for now, which aren't searchable by Metabot.)
+
+ When `metabot-id` is provided and the metabot has `use_verified_content` enabled (and the
+ `:content-verification` premium feature is active), filters out unverified cards/datasets/metrics
+ /dashboards before taking the top 5. Tables are not moderatable and always pass through."
+ [context {:keys [metabot-id] :as _opts}]
(try
(let [recents (:recents (activity-feed/get-recents api/*current-user-id*
[:views :selections]
{:models [:card :dataset :metric :dashboard :table]}))
+ recents (cond->> recents
+ (verified-only? (get-metabot metabot-id))
+ filter-recents-to-verified)
processed-recents (mapv (fn [item]
(let [item-type
(case (:model item)
@@ -287,5 +340,5 @@
(-> context
enhance-context-with-schema
annotate-transform-source-types
- add-recent-views
+ (add-recent-views (or opts {}))
(set-user-time opts))))
diff --git a/src/metabase/slackbot/streaming.clj b/src/metabase/slackbot/streaming.clj
index b4f85106835..7e5fcee8ab2 100644
--- a/src/metabase/slackbot/streaming.clj
+++ b/src/metabase/slackbot/streaming.clj
@@ -7,6 +7,7 @@
[metabase.api.common :as api]
[metabase.channel.slack :as channel.slack]
[metabase.metabot.agent.core :as agent]
+ [metabase.metabot.config :as metabot.config]
[metabase.metabot.context :as metabot.context]
[metabase.metabot.core :as metabot]
[metabase.metabot.envelope :as metabot.envelope]
@@ -197,7 +198,8 @@
context (metabot.context/create-context
{:current_time_with_timezone (str (java.time.OffsetDateTime/now))
:capabilities capabilities
- :slack_channel_id channel-id})
+ :slack_channel_id channel-id}
+ {:metabot-id metabot.config/slackbot-metabot-id})
messages (conj (vec history) request-message)
parts-atom (atom [])
dispatch-xf (comp
diff --git a/test/metabase/metabot/agent/user_context_test.clj b/test/metabase/metabot/agent/user_context_test.clj
index fdd286d88bc..14f4fafe79c 100644
--- a/test/metabase/metabot/agent/user_context_test.clj
+++ b/test/metabase/metabot/agent/user_context_test.clj
@@ -249,6 +249,11 @@
(testing "returns empty string when no recent views"
(let [context {}
result (user-context/format-recent-views context)]
+ (is (= "" result))))
+
+ (testing "returns empty string when recent views is an empty vector (e.g. after verified-only filter)"
+ (let [context {:user_recently_viewed []}
+ result (user-context/format-recent-views context)]
(is (= "" result)))))
(deftest format-current-user-info-test
diff --git a/test/metabase/metabot/api_test.clj b/test/metabase/metabot/api_test.clj
index e55d0e3f539..1776c43c1d2 100644
--- a/test/metabase/metabot/api_test.clj
+++ b/test/metabase/metabot/api_test.clj
@@ -160,7 +160,7 @@
;; GZIPInputStream by default. Closing mid-stream causes ZLIB errors.
http/post (fn [url opts]
(real-http-post url (assoc opts :decompress-body false)))
- metabot.context/create-context identity
+ metabot.context/create-context (fn [ctx & _] ctx)
metabot.persistence/store-native-parts! (fn [_conv-id _prof-id parts & _kwargs]
(reset! stored-parts parts))
sr/async-cancellation-poll-interval-ms 5]
diff --git a/test/metabase/metabot/context_test.clj b/test/metabase/metabot/context_test.clj
index 6771d29636d..3da1c76ab8c 100644
--- a/test/metabase/metabot/context_test.clj
+++ b/test/metabase/metabot/context_test.clj
@@ -2,6 +2,7 @@
(:require
[clojure.test :refer :all]
[metabase.activity-feed.models.recent-views :as recent-views]
+ [metabase.content-verification.core :as moderation]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
[metabase.lib.test-metadata :as meta]
@@ -240,6 +241,117 @@
(is (= #{"question" "model" "dashboard" "table"}
(set (map :type recently-viewed)))))))))
+(deftest recent-views-verified-content-filter-test
+ (testing "Recent views filtering by verified content"
+ (mt/with-test-user :rasta
+ (mt/with-temp [:model/Card {vq1 :id} {:type "question" :name "verified q1"}
+ :model/Card {vq2 :id} {:type "question" :name "verified q2"}
+ :model/Card {vm1 :id} {:type "model" :name "verified m1"}
+ :model/Card {vm2 :id} {:type "model" :name "verified m2"}
+ :model/Dashboard {vd :id} {:name "verified d"}
+ :model/Card {uq :id} {:type "question" :name "unverified q"}
+ :model/Card {um :id} {:type "model" :name "unverified m"}
+ :model/Dashboard {ud :id} {:name "unverified d"}
+ :model/Table {table-id :id} {}
+ :model/Metabot {metabot-eid :entity_id} {:name "test metabot"
+ :use_verified_content true}]
+ (doseq [[id type] [[vq1 "card"] [vq2 "card"] [vm1 "card"] [vm2 "card"] [vd "dashboard"]]]
+ (moderation/create-review! {:moderated_item_id id
+ :moderated_item_type type
+ :moderator_id (mt/user->id :crowberto)
+ :status "verified"}))
+ ;; Insert verified items first (oldest), then table, then unverified (newest). Without
+ ;; filtering, `(take 5 …)` captures the 3 unverified + the table + 1 verified.
+ ;; Recents in newest-first order: ud, um, uq, table, vd, vm2, vm1, vq2, vq1.
+ (doseq [[model id] [[:model/Card vq1]
+ [:model/Card vq2]
+ [:model/Card vm1]
+ [:model/Card vm2]
+ [:model/Dashboard vd]
+ [:model/Table table-id]
+ [:model/Card uq]
+ [:model/Card um]
+ [:model/Dashboard ud]]]
+ (recent-views/update-users-recent-views! (mt/user->id :rasta) model id :view))
+
+ ;; IDs are unique per model but can collide across models (e.g. a Card and a Dashboard
+ ;; can share the same id). Identify items by [:type :id] pairs so cross-model collisions
+ ;; don't mask filtering bugs.
+ (let [as-pair (fn [type id] [type id])
+ vm1* (as-pair "model" vm1)
+ vm2* (as-pair "model" vm2)
+ vd* (as-pair "dashboard" vd)
+ uq* (as-pair "question" uq)
+ um* (as-pair "model" um)
+ ud* (as-pair "dashboard" ud)
+ table* (as-pair "table" table-id)
+ keys-of (fn [items] (set (map (juxt :type :id) items)))]
+
+ (testing "no metabot-id passed -> no filtering (even with :content-verification active)"
+ (mt/with-premium-features #{:content-verification}
+ (let [items (-> (context/create-context {}) :user_recently_viewed)
+ ks (keys-of items)]
+ (is (= 5 (count items)))
+ (is (contains? ks uq*))
+ (is (contains? ks um*))
+ (is (contains? ks ud*))
+ (is (contains? ks table*)))))
+
+ (testing "use_verified_content=true with :content-verification feature -> filters"
+ (mt/with-premium-features #{:content-verification}
+ (let [items (-> (context/create-context {} {:metabot-id metabot-eid})
+ :user_recently_viewed)
+ ks (keys-of items)]
+ (is (contains? ks table*) "tables are not moderatable and pass through")
+ (is (contains? ks vd*))
+ (is (not (contains? ks uq*)))
+ (is (not (contains? ks um*)))
+ (is (not (contains? ks ud*)))
+ (testing "filter is applied *before* `take 5` — verified items deeper in the list survive"
+ (is (= 5 (count items))
+ "Should keep 5 items even though 3 unverified items were ahead of older verified items")
+ (is (contains? ks vm2*))
+ (is (contains? ks vm1*))))))
+
+ (testing "use_verified_content=true but premium feature absent -> no filtering"
+ (mt/with-premium-features #{}
+ (let [items (-> (context/create-context {} {:metabot-id metabot-eid})
+ :user_recently_viewed)
+ ks (keys-of items)]
+ (is (contains? ks uq*))
+ (is (contains? ks um*))
+ (is (contains? ks ud*)))))
+
+ (testing "metabot-id that does not resolve -> no filtering"
+ (mt/with-premium-features #{:content-verification}
+ (let [items (-> (context/create-context {} {:metabot-id "nonexistent-entity-id"})
+ :user_recently_viewed)
+ ks (keys-of items)]
+ (is (contains? ks uq*))))))))))
+
+(deftest recent-views-most-recent-review-wins-test
+ (testing "A card that was verified and later un-verified is correctly excluded"
+ (mt/with-test-user :rasta
+ (mt/with-premium-features #{:content-verification}
+ (mt/with-temp [:model/Card {card-id :id} {:type "question" :name "flip-flop"}
+ :model/Metabot {metabot-eid :entity_id} {:name "test metabot"
+ :use_verified_content true}]
+ ;; First verify, then un-verify. create-review! marks older rows as most_recent=false.
+ (moderation/create-review! {:moderated_item_id card-id
+ :moderated_item_type "card"
+ :moderator_id (mt/user->id :crowberto)
+ :status "verified"})
+ (moderation/create-review! {:moderated_item_id card-id
+ :moderated_item_type "card"
+ :moderator_id (mt/user->id :crowberto)
+ :status nil})
+ (recent-views/update-users-recent-views! (mt/user->id :rasta) :model/Card card-id :view)
+ (let [items (-> (context/create-context {} {:metabot-id metabot-eid})
+ :user_recently_viewed)
+ ids (set (map :id items))]
+ (is (not (contains? ids card-id))
+ "Most-recent review with status=nil means the card is no longer verified")))))))
+
(deftest enhance-context-with-schema-mbql-query-test
(testing "MBQL adhoc query gets source table added to used_tables"
(mt/with-test-user :rasta