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 spend minutes trying to generate descriptions for massive schemas (#63739)

Cam Sauldad9b5c709ff
diff --git a/src/metabase/util/malli/describe.cljc b/src/metabase/util/malli/describe.cljc
index 171b2e00586..303f25505ef 100644
--- a/src/metabase/util/malli/describe.cljc
+++ b/src/metabase/util/malli/describe.cljc
@@ -13,12 +13,26 @@
(declare describe)
+;;; for HUGE schemas like `:metabase.lib.schema/query`, don't expand refs once we get past a certain depth, otherwise
+;;; we can take literal minutes to generate the description. Three levels of depth is probably about all that would
+;;; really be useful anyway for an error message.
+
+(def ^:private max-depth 3)
+
(defn- accept-ref [schema [k :as _children] options]
(or (description schema)
- (if (contains? (::parent-refs options) k)
+ (cond
+ (> (::depth options 0) max-depth)
+ (pr-str k)
+
+ (contains? (::parent-refs options) k)
(str "recursive " k)
+
+ :else
(describe (mr/resolve-schema schema)
- (update options ::parent-refs #(conj (set %) k))))))
+ (-> options
+ (update ::parent-refs #(conj (set %) k))
+ (update ::depth (fnil inc 0)))))))
;;; these implementations replace the normal ones which do not recursively resolve refs and schemas. We track
;;; `::parent-refs` to prevent infinite loops with self-referencing schemas
diff --git a/test/metabase/util/malli/describe_test.cljc b/test/metabase/util/malli/describe_test.cljc
index 9beb68631d9..9b34c834a09 100644
--- a/test/metabase/util/malli/describe_test.cljc
+++ b/test/metabase/util/malli/describe_test.cljc
@@ -1,6 +1,9 @@
(ns metabase.util.malli.describe-test
"Additional tests for this live in [[metabase.util.malli-test]]."
(:require
+ #?@(:clj
+ ([metabase.lib.schema]
+ [metabase.util :as u]))
[clojure.test :refer [are deftest is testing]]
[metabase.util.malli.describe :as umd]
[metabase.util.malli.registry :as mr]))
@@ -59,4 +62,6 @@
(umd/describe ::cons)))
(is (mr/validate ::map {:k :child, :parent {:k :parent}}))
(is (= "map where {:k -> <keyword>, :parent (optional) -> <recursive :metabase.util.malli.describe-test/map>}"
- (umd/describe ::map))))
+ (umd/describe ::map)))
+ #?(:clj
+ (is (string? (u/with-timeout 500 (umd/describe :metabase.lib.schema/query))))))