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
Uxw 1070/fail early if unsupported appdb version is detected (#70402)
Ben Grabowec678a17fce0
diff --git a/resources/metabase/app_db/supported-db-versions.edn b/resources/metabase/app_db/supported-db-versions.ednnew file mode 100644index 00000000000..3f943179886--- /dev/null+++ b/resources/metabase/app_db/supported-db-versions.edn@@ -0,0 +1,7 @@+;; Minimum supported versions for Metabase application databases.+;; Documentation reference:+;; https://www.metabase.com/docs/latest/installation-and-operation/migrating-from-h2#supported-databases-for-storing-your-metabase-application-data+{:h2 {:major 2 :minor 1 :patch 214}+ :postgres {:major 12 :minor 0 :patch 0}+ :mysql {:major 8 :minor 0 :patch 17}+ :mariadb {:major 10 :minor 2 :patch 2}}diff --git a/src/metabase/app_db/setup.clj b/src/metabase/app_db/setup.cljindex 64962ff108f..e998fb666ee 100644--- a/src/metabase/app_db/setup.clj+++ b/src/metabase/app_db/setup.clj@@ -7,7 +7,10 @@Because functions here don't know where the JDBC spec came from, you can use them to perform the usual applicationDB setup steps on arbitrary databases -- useful for functionality like the `load-from-h2` or `dump-to-h2` commands."(:require+ [clojure.edn :as edn]+ [clojure.java.io :as io][clojure.java.jdbc :as jdbc]+ [clojure.string :as str][honey.sql :as sql][metabase.app-db.connection :as mdb.connection][metabase.app-db.custom-migrations :as custom-migrations]@@ -120,6 +123,42 @@[result] (vals first-row)](= result 1)))+(defn- load-supported-db-versions+ []+ (if-let [resource (io/resource "metabase/app_db/supported-db-versions.edn")]+ (edn/read-string (slurp resource))+ (throw (ex-info "Resource not found: metabase/app_db/supported-db-versions.edn"+ {:path "metabase/app_db/supported-db-versions.edn"}))))++(def ^:private supported-db-versions+ "https://www.metabase.com/docs/latest/installation-and-operation/migrating-from-h2#supported-databases-for-storing-your-metabase-application-data"+ (load-supported-db-versions))++(defn- parse-db-version+ [product-version]+ (let [[_ major minor patch] (re-find #"^(\d+)(?:\.(\d+))?(?:\.(\d+))?" product-version)]+ {:major (or (some-> major parse-long) 0)+ :minor (or (some-> minor parse-long) 0)+ :patch (or (some-> patch parse-long) 0)}))++(mu/defn- db-version+ :- [:map+ [:major [:int {:min 0}]]+ [:minor [:int {:min 0}]]+ [:patch [:int {:min 0}]]]+ [^java.sql.DatabaseMetaData metadata :- (ms/InstanceOfClass java.sql.DatabaseMetaData)]+ (merge+ (parse-db-version (.getDatabaseProductVersion metadata))+ {:major (.getDatabaseMajorVersion metadata)+ :minor (.getDatabaseMinorVersion metadata)}))++(defn- supported-app-db-version?+ [db-type {:keys [major minor patch]}]+ (let [required-version (get supported-db-versions db-type)]+ (and required-version+ (not (pos? (compare ((juxt :major :minor :patch) required-version)+ [major minor patch]))))))+(mu/defn- verify-db-connection"Test connection to application database with `data-source` and throw an exception if we have any troublesconnecting."@@ -131,9 +170,27 @@(catch Throwable e(throw (ex-info error-msg {} e)))))(with-open [conn (.getConnection ^javax.sql.DataSource data-source)]- (let [metadata (.getMetaData conn)]- (log/infof "Successfully verified %s %s application database connection. %s"- (.getDatabaseProductName metadata) (.getDatabaseProductVersion metadata) (u/emoji "✅")))))+ (let [metadata (.getMetaData conn)+ db-version (db-version metadata)+ db-type (or (when (= "MariaDB" (.getDatabaseProductName metadata)) :mariadb)+ db-type)]+ (if (supported-app-db-version? db-type db-version)+ (log/infof "Successfully verified %s %s application database connection. %s"+ (.getDatabaseProductName metadata) (.getDatabaseProductVersion metadata) (u/emoji "✅"))+ (throw (ex-info (str/join \newline [(trs "Metabase {0} DB version not supported (found {1}, required {2}). Please upgrade your database to a supported version and try again."+ (name db-type)+ (format "%s.%s.%s (%s)"+ (:major db-version)+ (:minor db-version)+ (:patch db-version)+ (.getDatabaseProductVersion metadata))+ (let [required-version (get supported-db-versions db-type)]+ (format "%s.%s.%s"+ (:major required-version)+ (:minor required-version)+ (:patch required-version))))+ "https://www.metabase.com/docs/latest/installation-and-operation/migrating-from-h2#supported-databases-for-storing-your-metabase-application-data"])+ {}))))))(mu/defn- check-encryption"Ensure encryption env variable is correctly set if needed, and encrypt the database if it needs to bediff --git a/test/metabase/app_db/setup_test.clj b/test/metabase/app_db/setup_test.cljindex 250794b80c2..639c8ed3126 100644--- a/test/metabase/app_db/setup_test.clj+++ b/test/metabase/app_db/setup_test.clj@@ -27,6 +27,58 @@(#'mdb.setup/verify-db-connection :h2 (mdb.data-source/raw-connection-string->DataSource(format "jdbc:h2:mem:%s" (mt/random-name)))))))+(deftest supported-app-db-version?-test+ (testing "Should be able to check if an app DB is a supported version"+ (testing "for H2"+ (is (true? (#'mdb.setup/supported-app-db-version? :h2 {:major 2 :minor 1 :patch 214})))+ (is (true? (#'mdb.setup/supported-app-db-version? :h2 {:major 3 :minor 1 :patch 214})))+ (is (true? (#'mdb.setup/supported-app-db-version? :h2 {:major 2 :minor 2 :patch 0})))+ (is (true? (#'mdb.setup/supported-app-db-version? :h2 {:major 3 :minor 0 :patch 0})))+ (is (false? (#'mdb.setup/supported-app-db-version? :h2 {:major 2 :minor 1 :patch 213})))+ (is (false? (#'mdb.setup/supported-app-db-version? :h2 {:major 2 :minor 0 :patch 214})))+ (is (false? (#'mdb.setup/supported-app-db-version? :h2 {:major 1 :minor 1 :patch 214}))))+ (testing "for postgres"+ (is (true? (#'mdb.setup/supported-app-db-version? :postgres {:major 12 :minor 0 :patch 0})))+ (is (true? (#'mdb.setup/supported-app-db-version? :postgres {:major 13 :minor 0 :patch 0})))+ (is (true? (#'mdb.setup/supported-app-db-version? :postgres {:major 12 :minor 1 :patch 0})))+ (is (true? (#'mdb.setup/supported-app-db-version? :postgres {:major 12 :minor 1 :patch 1})))+ (is (false? (#'mdb.setup/supported-app-db-version? :postgres {:major 11 :minor 0 :patch 0})))+ (is (false? (#'mdb.setup/supported-app-db-version? :postgres {:major 12 :minor -1 :patch 0})))+ (is (false? (#'mdb.setup/supported-app-db-version? :postgres {:major 12 :minor 0 :patch -1}))))++ (testing "for mysql"+ (is (true? (#'mdb.setup/supported-app-db-version? :mysql {:major 8 :minor 0 :patch 17})))+ (is (true? (#'mdb.setup/supported-app-db-version? :mysql {:major 9 :minor 0 :patch 17})))+ (is (true? (#'mdb.setup/supported-app-db-version? :mysql {:major 8 :minor 1 :patch 17})))+ (is (true? (#'mdb.setup/supported-app-db-version? :mysql {:major 8 :minor 0 :patch 18})))+ (is (false? (#'mdb.setup/supported-app-db-version? :mysql {:major 7 :minor 0 :patch 17})))+ (is (false? (#'mdb.setup/supported-app-db-version? :mysql {:major 8 :minor -1 :patch 17})))+ (is (false? (#'mdb.setup/supported-app-db-version? :mysql {:major 8 :minor 0 :patch 16}))))++ (testing "for mariadb"+ (is (true? (#'mdb.setup/supported-app-db-version? :mariadb {:major 10 :minor 2 :patch 2})))+ (is (true? (#'mdb.setup/supported-app-db-version? :mariadb {:major 11 :minor 2 :patch 2})))+ (is (true? (#'mdb.setup/supported-app-db-version? :mariadb {:major 10 :minor 3 :patch 2})))+ (is (true? (#'mdb.setup/supported-app-db-version? :mariadb {:major 10 :minor 2 :patch 3})))+ (is (false? (#'mdb.setup/supported-app-db-version? :mariadb {:major 9 :minor 2 :patch 2})))+ (is (false? (#'mdb.setup/supported-app-db-version? :mariadb {:major 10 :minor 1 :patch 2})))+ (is (false? (#'mdb.setup/supported-app-db-version? :mariadb {:major 10 :minor 2 :patch 1}))))))++(deftest parse-db-version-test+ (testing "Can parse H2 version strings"+ (is (= {:major 2 :minor 1 :patch 214} (#'mdb.setup/parse-db-version "2.1.214 (2022-06-13)"))))+ (testing "Can parse postgres version strings"+ (is (= {:major 18 :minor 3 :patch 0} (#'mdb.setup/parse-db-version "18.3 (Debian 18.3-1.pgdg13+1)")))+ (is (= {:major 14 :minor 22 :patch 0} (#'mdb.setup/parse-db-version "14.22 (Debian 14.22-1.pgdg13+1)")))+ (is (= {:major 11 :minor 16 :patch 0} (#'mdb.setup/parse-db-version "11.16 (Debian 11.16-1.pgdg90+1)"))))++ (testing "Can parse mysql version strings"+ (is (= {:major 9 :minor 6 :patch 0} (#'mdb.setup/parse-db-version "9.6.0")))+ (is (= {:major 8 :minor 0 :patch 45} (#'mdb.setup/parse-db-version "8.0.45"))))++ (testing "Can parse mariadb version strings"+ (is (= {:major 12 :minor 2 :patch 2} (#'mdb.setup/parse-db-version "12.2.2-MariaDB-ubu2404")))))+(deftest setup-db-test(testing "Should be able to set up an arbitrary application DB"(letfn [(test* [data-source]