The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
GHY-4589: Bind values in settings/db.clj (7 non-id) (#83161)
Eric Normand90e5ff932819
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.ednindex 1e08c0c3a7d..31b9e15d6e7 100644--- a/.clj-kondo/config.edn+++ b/.clj-kondo/config.edn@@ -981,6 +981,8 @@;; `metabase.app-db.value-guard`.metabase.content-translation.db{:linters {:metabase/unsafe-app-db-query {:level :warning}}}+ metabase.settings.db+ {:linters {:metabase/unsafe-app-db-query {:level :warning}}};; .cljc tests run in both Clojure and ClojureScript — `with-dynamic-fn-redefs` is JVM-only,;; so leave these alone.diff --git a/src/metabase/settings/db.clj b/src/metabase/settings/db.cljindex 2c50086af4a..9a3873a8d2a 100644--- a/src/metabase/settings/db.clj+++ b/src/metabase/settings/db.clj@@ -10,7 +10,9 @@(mu/defn setting-value"The stored value of the Setting with `setting-key`, or nil."[setting-key :- [:or :keyword :string]]- (t2/select-one-fn :value :model/Setting :key setting-key))+ ;; The key is bound by its name: a keyword left bare compiles to a column, and bound as-is the driver cannot+ ;; convert it.+ (t2/select-one-fn :value :model/Setting :key [:auto/param (name setting-key)]))(mu/defn setting-values-by-key"A map of key to stored value for every Setting."@@ -21,19 +23,20 @@"Insert a Setting row for `setting-key` holding `value` and return it."[setting-key :- [:or :keyword :string]value :- :string]- (first (t2/insert-returning-instances! :model/Setting :key setting-key :value value)))+ (first (t2/insert-returning-instances! :model/Setting :key (name setting-key) :value value)))(mu/defn update-setting-value!"Set the value of the Setting with `setting-key` to `value`, returning the number updated."[setting-key :- [:or :keyword :string]value :- :string]- (t2/update! :model/Setting :key setting-key {:value value}))+ ;; `value` is written, not filtered on, so it stays unmarked: the before-update hook encrypts it.+ (t2/update! :model/Setting :key [:auto/param (name setting-key)] {:value value}))(mu/defn delete-setting!"Delete the Setting with `setting-key`, via a raw table delete that bypasses model hooks, returning the numberdeleted."[setting-key :- [:or :keyword :string]]- (t2/delete! (t2/table-name :model/Setting) :key setting-key))+ (t2/delete! (t2/table-name :model/Setting) :key [:auto/param (name setting-key)]))(mu/defn update-raw-setting-row!"Set the raw `value` and `value-with-aad` of the Setting row with `setting-key`, returning the number of rows@@ -41,7 +44,7 @@[setting-key :- [:or :keyword :string]value :- [:maybe :string]value-with-aad :- [:maybe :string]]- (t2/update! :setting {:key setting-key} {:value value, :value_with_aad value-with-aad}))+ (t2/update! :setting {:key [:auto/param (name setting-key)]} {:value value, :value_with_aad value-with-aad}))(mu/defn insert-raw-setting-row!"Insert a raw Setting row for `setting-key` holding `value` and `value-with-aad`, returning the number inserted."@@ -49,7 +52,7 @@value :- [:maybe :string]value-with-aad :- [:maybe :string]](t2/insert! (t2/table-name (t2/resolve-model :model/Setting))- :key setting-key, :value value, :value_with_aad value-with-aad))+ :key (name setting-key), :value value, :value_with_aad value-with-aad))(mu/defn current-timestamp-string"The application DB's own current timestamp, as a string."diff --git a/test/metabase/settings/db_test.clj b/test/metabase/settings/db_test.cljnew file mode 100644index 00000000000..af4ac5057b1--- /dev/null+++ b/test/metabase/settings/db_test.clj@@ -0,0 +1,40 @@+(ns metabase.settings.db-test+ (:require+ [clojure.test :refer :all]+ [metabase.settings.db :as settings.db]+ [metabase.settings.models.setting-test]+ [metabase.test :as mt]+ [toucan2.core :as t2]))++(defn- do-with-test-setting-row! [v f]+ (mt/with-temporary-setting-values [test-setting-1 nil]+ (settings.db/insert-setting! "test-setting-1" v)+ (f)))++(deftest setting-key-is-bound-as-a-value-test+ (testing "GHY-4589: the setting key is compared as a value, whether given as a string or a keyword"+ (do-with-test-setting-row!+ "v1"+ (fn []+ (is (= "v1" (settings.db/setting-value "test-setting-1")))+ (is (= "v1" (settings.db/setting-value :test-setting-1)))+ (is (= 1 (settings.db/update-setting-value! :test-setting-1 "v2")))+ (is (= "v2" (settings.db/setting-value "test-setting-1")))+ (is (= 1 (settings.db/update-raw-setting-row! :test-setting-1 "v3" nil)))+ (is (= 1 (settings.db/delete-setting! :test-setting-1)))+ (is (not (t2/exists? :setting :key "test-setting-1"))))))+ (testing "the insert functions store a keyword key by its name"+ (mt/with-temporary-setting-values [test-setting-1 nil]+ (is (= "v1" (:value (settings.db/insert-setting! :test-setting-1 "v1"))))+ (is (= 1 (settings.db/delete-setting! "test-setting-1")))+ (is (= 1 (settings.db/insert-raw-setting-row! :test-setting-1 "v2" nil)))+ (is (= "v2" (t2/select-one-fn :value :setting :key "test-setting-1")))))+ (testing "a key that looks like SQL matches nothing rather than being compiled"+ (do-with-test-setting-row!+ "v1"+ (fn []+ (is (nil? (settings.db/setting-value "x' OR '1'='1")))+ (is (= 0 (settings.db/update-setting-value! "x' OR '1'='1" "v2")))+ (is (= 0 (settings.db/update-raw-setting-row! "x' OR '1'='1" "v3" nil)))+ (is (= 0 (settings.db/delete-setting! "x' OR '1'='1")))+ (is (= "v1" (settings.db/setting-value "test-setting-1")))))))diff --git a/test/metabase/settings_rest/api_test.clj b/test/metabase/settings_rest/api_test.cljindex 1afdd18d5ca..a898e32de2e 100644--- a/test/metabase/settings_rest/api_test.clj+++ b/test/metabase/settings_rest/api_test.clj@@ -2,6 +2,7 @@(:require[clojure.string :as str][clojure.test :refer :all]+ [metabase.config.core :as config][metabase.driver.h2 :as h2][metabase.permissions.validation :as validation][metabase.settings.models.setting :as setting :refer [defsetting]]@@ -440,3 +441,18 @@(mt/user-http-request user-id :put 204 "setting/test-user-local-only-setting" {:value "NEW"})(is (= "NEW"(mt/user-http-request user-id :get 200 "setting/test-user-local-only-setting")))))))++(deftest set-setting-read-from-app-db-test+ (testing "PUT /api/setting/:key inserts, updates and deletes the row that GET reads back from the app DB (GHY-4589)"+ ;; With the cache off, GET reads the row by key rather than from memory, so the filter on the key is exercised.+ (binding [config/*disable-setting-cache* true]+ (mt/with-temporary-setting-values [test-setting-1 nil]+ (mt/user-http-request :crowberto :put 204 "setting/test-setting-1" {:value "first"})+ (is (= "first" (fetch-setting :test-setting-1 200)))+ (testing "a value that looks like SQL is stored and read back as a string"+ (mt/user-http-request :crowberto :put 204 "setting/test-setting-1" {:value "x' OR '1'='1"})+ (is (= "x' OR '1'='1" (fetch-setting :test-setting-1 200))))+ (testing "clearing the value deletes the row"+ (mt/user-http-request :crowberto :put 204 "setting/test-setting-1" {:value nil})+ (is (nil? (fetch-setting :test-setting-1 204)))+ (is (not (t2/exists? :model/Setting :key "test-setting-1"))))))))