Skip to content

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

Use explicit hierarchy for domain entity types (#79459)

Ben Grabow3390d6976386
diff --git a/src/metabase/xrays/domain_entities/core.clj b/src/metabase/xrays/domain_entities/core.clj
index a8483878413..7a84625f4e6 100644
--- a/src/metabase/xrays/domain_entities/core.clj
+++ b/src/metabase/xrays/domain_entities/core.clj
@@ -9,6 +9,7 @@
[metabase.util.malli :as mu]
[metabase.util.malli.schema :as ms]
[metabase.util.match :as match]
+ [metabase.xrays.domain-entities.hierarchy :as domain-entities.hierarchy]
[metabase.xrays.domain-entities.specs :as domain-entities.specs :refer [*domain-entity-specs* MBQL]]
[toucan2.core :as t2]))
@@ -93,7 +94,7 @@
(defn- best-match
[candidates]
(->> candidates
- (sort-by (juxt (comp count ancestors :type) (comp count :required_attributes)))
+ (sort-by (juxt (comp count domain-entities.hierarchy/ancestors :type) (comp count :required_attributes)))
last))
(defn- instantiate-dimensions
diff --git a/src/metabase/xrays/domain_entities/hierarchy.clj b/src/metabase/xrays/domain_entities/hierarchy.clj
new file mode 100644
index 00000000000..7c781a30459
--- /dev/null
+++ b/src/metabase/xrays/domain_entities/hierarchy.clj
@@ -0,0 +1,28 @@
+(ns metabase.xrays.domain-entities.hierarchy
+ "Keyword hierarchy relating domain entity types, all descending from `:DomainEntity/*`.
+
+ Kept separate from Clojure's global hierarchy so that a spec loaded from a YAML file cannot collide with other
+ users of the global hierarchy. Specs declare their parent through `refines`.
+
+ (derive! :DomainEntity/GenericTable :DomainEntity/*)"
+ (:refer-clojure :exclude [ancestors isa?]))
+
+(defonce ^{:doc "The domain entity hierarchy. A var holding a hierarchy map, mutated by [[derive!]]."}
+ hierarchy
+ (make-hierarchy))
+
+(defn derive!
+ "Make `parent` an ancestor of `tag` in the domain entity [[hierarchy]]."
+ [tag parent]
+ (alter-var-root #'hierarchy derive tag parent)
+ nil)
+
+(defn isa?
+ "Whether `child` is `parent` or descends from it in the domain entity [[hierarchy]]."
+ [child parent]
+ (clojure.core/isa? hierarchy child parent))
+
+(defn ancestors
+ "The set of keywords `tag` descends from in the domain entity [[hierarchy]], or `nil` if there are none."
+ [tag]
+ (clojure.core/ancestors hierarchy tag))
diff --git a/src/metabase/xrays/domain_entities/specs.clj b/src/metabase/xrays/domain_entities/specs.clj
index 803a90e67a8..4ae1610843d 100644
--- a/src/metabase/xrays/domain_entities/specs.clj
+++ b/src/metabase/xrays/domain_entities/specs.clj
@@ -12,7 +12,8 @@
[metabase.lib.schema.id :as lib.schema.id]
[metabase.util.malli.registry :as mr]
[metabase.util.malli.schema :as ms]
- [metabase.util.yaml :as yaml]))
+ [metabase.util.yaml :as yaml]
+ [metabase.xrays.domain-entities.hierarchy :as domain-entities.hierarchy]))
(mr/def ::xrays-dimension
"X-rays has its own special `:dimension` psuedo-MBQL clause in templates; it's different from the `:dimension` clause
@@ -74,7 +75,7 @@
:keyword
[:fn
{:error/message "Valid DomainEntity"}
- #(isa? % :DomainEntity/*)]])
+ #(domain-entities.hierarchy/isa? % :DomainEntity/*)]])
(def ^:private Identifier :string)
@@ -142,7 +143,7 @@
[{:keys [name refines] :as spec}]
(let [spec-type (keyword "DomainEntity" name)
refines (some->> refines (keyword "DomainEntity"))]
- (derive spec-type (or refines :DomainEntity/*))
+ (domain-entities.hierarchy/derive! spec-type (or refines :DomainEntity/*))
(-> spec
(dissoc :refines)
(assoc :type spec-type))))