Skip to content

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

simpler way to set token: mt/with-random-premium-token! (#64188)

Oleksandr Solovyovcb13bdc086bc
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.edn
index cbbf8a98290..ce90522ab86 100644
--- a/.clj-kondo/config.edn
+++ b/.clj-kondo/config.edn
@@ -624,10 +624,11 @@
metabase.test/with-non-admin-groups-no-root-collection-perms hooks.common/do*
metabase.test/with-persistence-enabled! hooks.metabase.model-persistence.test-util/with-persistence-enabled!
metabase.test/with-prometheus-system! hooks.common/with-two-bindings
+ metabase.test/with-random-premium-token! hooks.common/with-one-binding
metabase.test/with-temp hooks.toucan2.tools.with-temp/with-temp
metabase.test/with-temp-file hooks.metabase.test.util/with-temp-file
metabase.test/with-temporary-setting-values hooks.metabase.test.util/with-temporary-setting-values
- metabase.users.api-test/with-temp-user-email! hooks.common/with-one-binding
+ metabase.users.api-test/with-temp-user-email! hooks.common/with-one-binding
metabase.util.i18n/deferred-trs hooks.metabase.util.i18n/deferred-trs
metabase.util.i18n/deferred-tru hooks.metabase.util.i18n/deferred-tru
metabase.util.i18n/trs hooks.metabase.util.i18n/trs
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
index 01dc346b4c4..e3776bf8554 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
@@ -94,8 +94,8 @@
feedback :- :map]
(let [token (premium-features/premium-embedding-token)
base-url (store-api/store-api-url)]
- (when (or (str/blank? token) (str/blank? base-url))
- (throw (ex-info "Cannot build a request. The license token and/or Store api url are missing!" {})))
+ (api/check-400 (not (or (str/blank? token) (str/blank? base-url)))
+ "Cannot build a request. The license token and/or Store api url are missing!")
(try
(http/post (str base-url "/api/v2/metabot/feedback/" token)
{:content-type :json
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
index 87c8a082441..d1eb86acce8 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
@@ -6,8 +6,6 @@
[medley.core :as m]
[metabase-enterprise.metabot-v3.client-test :as client-test]
[metabase-enterprise.metabot-v3.util :as metabot.u]
- [metabase.premium-features.token-check :as token-check]
- [metabase.premium-features.token-check-test :as token-check-test]
[metabase.test :as mt]
[metabase.util.json :as json]
[toucan2.core :as t2]))
@@ -63,29 +61,23 @@
(deftest feedback-endpoint-test
(mt/with-premium-features #{:metabot-v3}
- (with-redefs [token-check/fetch-token-status (fn [_x]
- {:valid true
- :status "fake"
- :features ["test" "fixture"]
- :trial false})]
- (let [premium-token (token-check-test/random-token)
- store-url "http://hm.example"]
+ (mt/with-random-premium-token! [premium-token]
+ (let [store-url "http://hm.example"]
(testing "Submits feedback to Harbormaster with token and base URL"
- (mt/with-temporary-setting-values [premium-embedding-token premium-token
- store-api-url store-url]
- (let [captured (atom nil)
- feedback {:metabot_id 1
- :feedback {:positive true
- :message_id "m-1"
- :freeform_feedback "ok"}
- :conversation_data {}
- :version "v0.0.0"
- :submission_time "2025-01-01T00:00:00Z"
- :is_admin false}
+ (mt/with-temporary-setting-values [store-api-url store-url]
+ (let [captured (atom nil)
+ feedback {:metabot_id 1
+ :feedback {:positive true
+ :message_id "m-1"
+ :freeform_feedback "ok"}
+ :conversation_data {}
+ :version "v0.0.0"
+ :submission_time "2025-01-01T00:00:00Z"
+ :is_admin false}
expected-url (str store-url "/api/v2/metabot/feedback/" premium-token)]
(mt/with-dynamic-fn-redefs
[http/post (fn [url opts]
- (reset! captured {:url url
+ (reset! captured {:url url
:body (json/decode+kw (:body opts))}))]
(let [_resp (mt/user-http-request :rasta :post 204 "ee/metabot-v3/feedback" feedback)]
(is (= {:url expected-url :body feedback}
@@ -95,11 +87,11 @@
(mt/with-temporary-setting-values [premium-embedding-token premium-token]
(mt/with-dynamic-fn-redefs
[http/post (fn [_url _opts]
- (throw (ex-info "boom" {})))]
+ (throw (ex-info "boom" {:status 404})))]
(mt/user-http-request :rasta :post 500 "ee/metabot-v3/feedback" {:any "payload"}))))
;; We're not testing the branch where the store-api-url is missing because that defsetting
;; has the default value. It doesn't work well with `with-temporary-setting-values` helper.
(testing "Throws when premium token is missing"
(mt/with-temporary-setting-values [premium-embedding-token nil]
- (mt/user-http-request :rasta :post 500 "ee/metabot-v3/feedback" {:foo "bar"})))))))
+ (mt/user-http-request :rasta :post 400 "ee/metabot-v3/feedback" {:foo "bar"})))))))
diff --git a/test/metabase/embedding/settings_test.clj b/test/metabase/embedding/settings_test.clj
index c2c8cc665df..60de2815c8a 100644
--- a/test/metabase/embedding/settings_test.clj
+++ b/test/metabase/embedding/settings_test.clj
@@ -5,8 +5,6 @@
[metabase.analytics.snowplow-test :as snowplow-test]
[metabase.config.core :as config]
[metabase.embedding.settings :as embed.settings]
- [metabase.premium-features.token-check :as token-check]
- [metabase.premium-features.token-check-test :as token-check-test]
[metabase.test :as mt]
[toucan2.core :as t2]))
@@ -22,15 +20,10 @@
(is (not (embed.settings/show-static-embed-terms)))))
(when config/ee-available?
(testing "should return false when an EE user has a valid token"
- (with-redefs [token-check/fetch-token-status (fn [_x]
- {:valid true
- :status "fake"
- :features ["test" "fixture"]
- :trial false})]
- (mt/with-temporary-setting-values [premium-embedding-token (token-check-test/random-token)]
- (is (not (embed.settings/show-static-embed-terms)))
- (embed.settings/show-static-embed-terms! false)
- (is (not (embed.settings/show-static-embed-terms))))))
+ (mt/with-random-premium-token! [_token]
+ (is (not (embed.settings/show-static-embed-terms)))
+ (embed.settings/show-static-embed-terms! false)
+ (is (not (embed.settings/show-static-embed-terms)))))
(testing "when an EE user doesn't have a valid token"
(mt/with-temporary-setting-values [premium-embedding-token nil show-static-embed-terms nil]
(testing "should return true when the user has not accepted licensing terms"
diff --git a/test/metabase/premium_features/api_test.clj b/test/metabase/premium_features/api_test.clj
index 333075d520d..93d923ae113 100644
--- a/test/metabase/premium_features/api_test.clj
+++ b/test/metabase/premium_features/api_test.clj
@@ -1,30 +1,23 @@
(ns metabase.premium-features.api-test
(:require
[clojure.test :refer :all]
- [metabase.premium-features.token-check :as token-check]
- [metabase.premium-features.token-check-test :as token-check-test]
[metabase.test :as mt]))
(set! *warn-on-reflection* true)
(deftest get-token-status-test
(testing "GET /api/premium-features/token/status"
- (with-redefs [token-check/fetch-token-status (fn [_x]
- {:valid true
- :status "fake"
- :features ["test" "fixture"]
- :trial false})]
- (mt/with-temporary-setting-values [:premium-embedding-token (token-check-test/random-token)]
- (testing "returns correctly"
- (is (= {:valid true
- :status "fake"
- :features ["test" "fixture"]
- :trial false}
- (mt/user-http-request :crowberto :get 200 "premium-features/token/status"))))
+ (mt/with-random-premium-token! [_token]
+ (testing "returns correctly"
+ (is (= {:valid true
+ :status "fake"
+ :features ["test" "fixture"]
+ :trial false}
+ (mt/user-http-request :crowberto :get 200 "premium-features/token/status"))))
- (testing "requires superusers"
- (is (= "You don't have permissions to do that."
- (mt/user-http-request :rasta :get 403 "premium-features/token/status"))))))
+ (testing "requires superusers"
+ (is (= "You don't have permissions to do that."
+ (mt/user-http-request :rasta :get 403 "premium-features/token/status")))))
(mt/with-temporary-setting-values [:premium-embedding-token nil]
(testing "returns 404 if no token is set"
diff --git a/test/metabase/premium_features/test_util.clj b/test/metabase/premium_features/test_util.clj
index 9731f9f1683..8a8c22d25c7 100644
--- a/test/metabase/premium_features/test_util.clj
+++ b/test/metabase/premium_features/test_util.clj
@@ -73,3 +73,9 @@
[& body]
(when config/ee-available?
`(do ~@body)))
+
+(defn random-token
+ "A random token-like string"
+ []
+ (let [alphabet (into [] (concat (range 0 10) (map char (range (int \a) (int \g)))))]
+ (apply str (repeatedly 64 #(rand-nth alphabet)))))
diff --git a/test/metabase/premium_features/token_check_test.clj b/test/metabase/premium_features/token_check_test.clj
index 37a96f3c45f..96bc413fad0 100644
--- a/test/metabase/premium_features/token_check_test.clj
+++ b/test/metabase/premium_features/token_check_test.clj
@@ -9,6 +9,7 @@
[metabase.config.core :as config]
[metabase.premium-features.core :as premium-features]
[metabase.premium-features.settings :as premium-features.settings]
+ [metabase.premium-features.test-util :as tu]
[metabase.premium-features.token-check :as token-check]
[metabase.test :as mt]
[metabase.test.fixtures :as fixtures]
@@ -51,14 +52,8 @@
:features ["test" "fixture"]
:trial false}))
-(defn random-token
- "A random token-like string"
- []
- (let [alphabet (into [] (concat (range 0 10) (map char (range (int \a) (int \g)))))]
- (apply str (repeatedly 64 #(rand-nth alphabet)))))
-
(deftest ^:parallel fetch-token-status-test
- (let [token (random-token)
+ (let [token (tu/random-token)
print-token (apply str (concat (take 4 token) "..." (take-last 4 token)))]
(testing "Do not log the token (#18249)"
(mt/with-log-messages-for-level [messages :info]
@@ -69,7 +64,7 @@
(deftest ^:parallel fetch-token-status-test-2
(testing "With the backend unavailable"
- (let [result (token-status-response (random-token) {:status 500})]
+ (let [result (token-status-response (tu/random-token) {:status 500})]
(is (false? (:valid result))))))
(deftest ^:parallel fetch-token-status-test-3
@@ -86,7 +81,7 @@
(deftest fetch-token-caches-successful-responses
(testing "For successful responses, the result is cached"
(let [call-count (atom 0)
- token (random-token)]
+ token (tu/random-token)]
(binding [http/request (fn [& _]
(swap! call-count inc)
{:status 200 :body "{\"valid\": true, \"status\": \"fake\"}"})]
@@ -96,7 +91,7 @@
(deftest fetch-token-caches-invalid-responses
(testing "For 4XX responses, the result is cached"
(let [call-count (atom 0)
- token (random-token)]
+ token (tu/random-token)]
(binding [http/request (fn [& _]
(swap! call-count inc)
{:status 400 :body "{\"valid\": false, \"status\": \"fake\"}"})]
@@ -106,7 +101,7 @@
(deftest fetch-token-does-not-cache-exceptions
(testing "For timeouts, 5XX errors, etc. we don't cache the result"
(let [call-count (atom 0)
- token (random-token)]
+ token (tu/random-token)]
(binding [http/request (fn [& _]
(swap! call-count inc)
(throw (ex-info "oh, fiddlesticks" {})))]
@@ -117,7 +112,7 @@
(deftest fetch-token-does-not-cache-5XX-responses
(let [call-count (atom 0)
- token (random-token)]
+ token (tu/random-token)]
(binding [http/request (fn [& _]
(swap! call-count inc)
{:status 500})]
@@ -133,13 +128,13 @@
(is (= {:valid false
:status "Unable to validate token"
:error-details "Token validation is currently unavailable."}
- (#'token-check/fetch-token-status (random-token))))
+ (#'token-check/fetch-token-status (tu/random-token))))
(is (= 0 @call-count))))))
(deftest ^:parallel fetch-token-status-test-4
(testing "With a valid token"
- (let [result (token-status-response (random-token) {:status 200
- :body token-response-fixture})]
+ (let [result (token-status-response (tu/random-token) {:status 200
+ :body token-response-fixture})]
(is (:valid result))
(is (contains? (set (:features result)) "test")))))
@@ -149,11 +144,11 @@
;; upstream in Cloud could break this. We probably want to catch that stuff anyway tho in tests rather than waiting
;; for bug reports to come in
(is (partial= {:valid false, :status "Token does not exist."}
- (#'token-check/fetch-token-status* (random-token))))))
+ (#'token-check/fetch-token-status* (tu/random-token))))))
(deftest fetch-token-does-not-call-db-when-cached
(testing "No DB calls are made when checking token status if the status is cached"
- (let [token (random-token)
+ (let [token (tu/random-token)
_ (#'token-check/fetch-token-status token)
;; Sigh. This is really quite horrific. But we need some wiggle room here: any endpoint that gets some setting
;; inside it is going to check to see whether it's time for an update check. If it is, it'll hit the DB to see
@@ -168,7 +163,7 @@
(deftest token-status-setting-test
(testing "If a `premium-embedding-token` has been set, the `token-status` setting should return the response
from the store.metabase.com endpoint for that token."
- (mt/with-temporary-raw-setting-values [premium-embedding-token (random-token)]
+ (mt/with-temporary-raw-setting-values [premium-embedding-token (tu/random-token)]
(is (= {:valid false, :status "Token does not exist."}
(premium-features/token-status)))))
(testing "If premium-embedding-token is nil, the token-status setting should also be nil."
diff --git a/test/metabase/test.clj b/test/metabase/test.clj
index 39e5957f129..0464ffdd074 100644
--- a/test/metabase/test.clj
+++ b/test/metabase/test.clj
@@ -290,6 +290,7 @@
with-all-users-data-perms-graph!
with-anaphora
with-prometheus-system!
+ with-random-premium-token!
with-temp-env-var-value!
with-temp-dir
with-temp-file
diff --git a/test/metabase/test/util.clj b/test/metabase/test/util.clj
index 3279d82516e..79b7dfe0479 100644
--- a/test/metabase/test/util.clj
+++ b/test/metabase/test/util.clj
@@ -590,6 +590,24 @@
[settings & body]
`(do-with-discarded-setting-changes! ~(mapv keyword settings) (fn [] ~@body)))
+(defmacro with-random-premium-token!
+ "Temporarily sets a premium embedding token to a random value and stubs token check to avoid
+ triggering premium token status checks. Use like:
+
+ (mt/with-random-premium-token [token-value]
+ (some-call))
+
+ The token-value binding will contain the random token that was set."
+ [[token-value] & body]
+ `(let [~token-value (premium-features.test-util/random-token)]
+ (with-redefs [metabase.premium-features.token-check/fetch-token-status
+ (constantly {:valid true
+ :status "fake"
+ :features ["test" "fixture"]
+ :trial false})]
+ (with-temporary-raw-setting-values [:premium-embedding-token ~token-value]
+ ~@body))))
+
(defn- maybe-merge-original-values
"For some map columns like `Database.settings` or `User.settings`, merge the original values with the temp ones to
preserve Settings that aren't explicitly overridden."