Skip to content

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

Handle order-dependent `:settings` when reading config files (#76467)

Braden Shepherdson8e80871ddca8
diff --git a/enterprise/backend/src/metabase_enterprise/advanced_config/file/settings.clj b/enterprise/backend/src/metabase_enterprise/advanced_config/file/settings.clj
index c28e48a12fe..60f9c38c3d9 100644
--- a/enterprise/backend/src/metabase_enterprise/advanced_config/file/settings.clj
+++ b/enterprise/backend/src/metabase_enterprise/advanced_config/file/settings.clj
@@ -10,10 +10,31 @@
[_section-name]
(s/map-of keyword? any?))
+(def ^:private setting-priority
+ "Lower numbers are applied first. This allows certain settings (e.g. `:premium-embedding-token`) which are depended
+ on by other settings (e.g. `:jwt-enabled`) to be loaded first, before those that depend on them.
+
+ This makes the `:settings` section independent of the order keys appear in the config file (UXW-3782)."
+ {:premium-embedding-token 0})
+
+(def ^:private default-setting-priority
+ "Priority for settings not listed in [[setting-priority]]. Arbitrary; it just needs to sort after every explicit
+ priority."
+ 1000)
+
+(defn- sort-by-dependency-order
+ "Order the config-file settings so feature-gating settings (the premium token) are applied first.
+
+ `sort-by` is stable, so settings of equal priority keep their original order."
+ [settings]
+ (sort-by (fn [[setting-name _]]
+ (get setting-priority setting-name default-setting-priority))
+ settings))
+
(defmethod advanced-config.file.i/initialize-section! :settings
[_section-name settings]
(log/info "Setting setting values from config file")
- (doseq [[setting-name setting-value] settings]
+ (doseq [[setting-name setting-value] (sort-by-dependency-order settings)]
(log/infof "Setting value for Setting %s" setting-name)
(if (setting/registered? setting-name)
(setting/set! setting-name setting-value)
diff --git a/enterprise/backend/test/metabase_enterprise/advanced_config/file/settings_test.clj b/enterprise/backend/test/metabase_enterprise/advanced_config/file/settings_test.clj
index f9e80a76ef0..c48336d021a 100644
--- a/enterprise/backend/test/metabase_enterprise/advanced_config/file/settings_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/advanced_config/file/settings_test.clj
@@ -2,10 +2,16 @@
(:require
[clojure.test :refer :all]
[metabase-enterprise.advanced-config.file :as advanced-config.file]
- [metabase.settings.core :refer [defsetting]]
+ [metabase.premium-features.settings :as premium-features.settings]
+ [metabase.premium-features.test-util :as premium-features.tu]
+ [metabase.premium-features.token-check :as token-check]
+ [metabase.settings.core :as setting :refer [defsetting]]
[metabase.test :as mt]
+ [metabase.test.fixtures :as fixtures]
[metabase.util :as u]))
+(use-fixtures :once (fixtures/initialize :db))
+
(use-fixtures :each (fn [thunk]
(binding [advanced-config.file/*supported-versions* {:min 1, :max 1}]
(mt/with-premium-features #{:config-text-file}
@@ -16,6 +22,36 @@
:visibility :internal
:encryption :no)
+(defsetting config-from-file-feature-gated-test-setting
+ "Internal test setting gated behind a premium feature."
+ :visibility :internal
+ :encryption :no
+ :feature :test-config-ordering-feature)
+
+(deftest settings-applied-token-first-test
+ (testing "premium-embedding-token is applied before other settings, regardless of file order (UXW-3782)"
+ ;; Simulate a token that, once set, unlocks `:test-config-ordering-feature`. We stub the token setter so we don't
+ ;; hit the MetaStore, and make the feature set reflect whether the token has been applied yet.
+ (mt/with-dynamic-fn-redefs [token-check/-set-premium-embedding-token!
+ #(setting/set-value-of-type! :string :premium-embedding-token %)]
+ (binding [token-check/*token-features* (fn []
+ (cond-> #{"config-text-file"}
+ (premium-features.settings/premium-embedding-token)
+ (conj "test-config-ordering-feature")))]
+ ;; Inside the stubbed setter, so the original token is restored through the stub too.
+ (mt/with-temporary-setting-values [premium-embedding-token nil
+ config-from-file-feature-gated-test-setting nil]
+ (testing "feature-gated setting listed BEFORE the token still succeeds"
+ (advanced-config.file/initialize!
+ {:version 1
+ ;; array-map preserves insertion order: gated setting first, token second
+ ;; The YAML reader preserves order similarly, so this is a good test without needing a real file.
+ :config {:settings (array-map
+ :config-from-file-feature-gated-test-setting "yes"
+ :premium-embedding-token (premium-features.tu/random-token))}})
+ (is (= "yes"
+ (config-from-file-feature-gated-test-setting)))))))))
+
(deftest settings-test
(testing "Should be able to set settings with config-from-file"
(config-from-file-settings-test-setting! nil)
diff --git a/test/metabase/warehouses_rest/api_test.clj b/test/metabase/warehouses_rest/api_test.clj
index 25e5cca4bd9..53f5625d1b8 100644
--- a/test/metabase/warehouses_rest/api_test.clj
+++ b/test/metabase/warehouses_rest/api_test.clj
@@ -1242,7 +1242,10 @@
(mt/user-http-request :rasta :get 200 "database")
(call-count)))
-(deftest ^:parallel databases-caching
+;; Not ^:parallel: `GET /api/database` lists every Database in the app DB, so Databases that concurrently running
+;; tests create or delete (and any caches they invalidate) can change the query count between the warm-up request
+;; and the counted one.
+(deftest ^:synchronized databases-caching
(testing "GET /api/database"
(testing "Testing that listing all databases does not make excessive queries with multiple databases"
(let [baseline (database-list-call-count)]