Skip to content

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

Don't count app-db not setup errors in circuit breaker (#65295)

dpsutton830a6d5c839c
diff --git a/src/metabase/premium_features/token_check.clj b/src/metabase/premium_features/token_check.clj
index 6ec1ddb9b48..9f3a12fd492 100644
--- a/src/metabase/premium_features/token_check.clj
+++ b/src/metabase/premium_features/token_check.clj
@@ -288,6 +288,11 @@
(when *token-check-happening*
(throw (ex-info "Token check is being called recursively, there is a good chance some `defenterprise` is causing this"
{:pass-thru true})))
+ ;; important to not count these errors against the circuit breaker. These are not the types of errors we need
+ ;; to circuit break. (#65294)
+ (when-not ((requiring-resolve 'metabase.app-db.core/db-is-set-up?))
+ (throw (ex-info "Metabase DB is not yet set up"
+ {:reason :token-check/app-db-not-ready})))
(locking lock
(binding [*token-check-happening* true]
(try (dh/with-circuit-breaker breaker
diff --git a/test/metabase/premium_features/token_check_test.clj b/test/metabase/premium_features/token_check_test.clj
index ff6c2d20709..3b9c2f9a4bf 100644
--- a/test/metabase/premium_features/token_check_test.clj
+++ b/test/metabase/premium_features/token_check_test.clj
@@ -4,6 +4,7 @@
[clojure.test :refer :all]
[mb.hawk.parallel]
[metabase.app-db.connection :as mdb.connection]
+ [metabase.app-db.core :as mdb]
[metabase.premium-features.core :as premium-features]
[metabase.premium-features.test-util :as tu]
[metabase.premium-features.token-check :as token-check]
@@ -125,7 +126,38 @@
(testing "When connectivity is restored we get successful token checks"
(reset! behavior :success)
(Thread/sleep 100) ;; wait for circuit breaker to open back up
- (is (= good-response (token-check/-check-token checker token))))))
+ (is (= good-response (token-check/-check-token checker token)))))
+ (testing "App db not setup yet does not invoke the circuit breaker (#65294)"
+ (let [token (tu/random-token)
+ good-response {:valid true
+ :status :fake
+ :features [:feature1 :feature2]}
+ token-response (fn [_token]
+ good-response)
+ checker (token-check/make-checker
+ {:base (reify token-check/TokenChecker
+ (-check-token [_ token]
+ (token-response token))
+ (-clear-cache! [_]))
+ :circuit-breaker {:failure-threshold-ratio-in-period [4 4 1000]
+ :delay-ms 5000
+ :success-threshold 1}
+ :timeout-ms 100
+ :ttl-ms 200
+ :grace-period (token-check/guava-cache-grace-period 1000 TimeUnit/MILLISECONDS)})]
+ (with-redefs [mdb/db-is-set-up? (constantly false)]
+ (is (= {:valid false
+ :status "Unable to validate token"
+ :error-details "Metabase DB is not yet set up"}
+ (token-check/-check-token checker token)))
+ (dotimes [_ 50] (token-check/-check-token checker token))
+ (is (= {:valid false
+ :status "Unable to validate token"
+ :error-details "Metabase DB is not yet set up"}
+ (token-check/-check-token checker token))))
+ (testing "When the db-is-set-up? we are not blocked by the circuit breaker"
+ (with-redefs [mdb/db-is-set-up? (constantly true)]
+ (is (= good-response (token-check/-check-token checker token))))))))
(deftest grace-period-test
(testing "implementation check"