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 action keywords (#79464)

Ben Grabow3fb5cbcb74e6
diff --git a/enterprise/backend/src/metabase_enterprise/action_v2/actions.clj b/enterprise/backend/src/metabase_enterprise/action_v2/actions.clj
index 04dbc1ff8a3..5142eb39205 100644
--- a/enterprise/backend/src/metabase_enterprise/action_v2/actions.clj
+++ b/enterprise/backend/src/metabase_enterprise/action_v2/actions.clj
@@ -13,9 +13,9 @@
(:import
(clojure.lang ExceptionInfo)))
-(derive :data-grid.row/create :data-grid.row/common)
-(derive :data-grid.row/update :data-grid.row/common)
-(derive :data-grid.row/delete :data-grid.row/common)
+(actions/derive! :data-grid.row/create :data-grid.row/common)
+(actions/derive! :data-grid.row/update :data-grid.row/common)
+(actions/derive! :data-grid.row/delete :data-grid.row/common)
(defn- unsupported-dbs-msg [target-dbs unsupported-dbs]
(cond
diff --git a/src/metabase/actions/actions.clj b/src/metabase/actions/actions.clj
index b052d716ae0..e1515b34f88 100644
--- a/src/metabase/actions/actions.clj
+++ b/src/metabase/actions/actions.clj
@@ -5,6 +5,7 @@
[metabase.actions.args :as actions.args]
[metabase.actions.db :as actions.db]
[metabase.actions.events :as actions.events]
+ [metabase.actions.hierarchy :as actions.hierarchy]
[metabase.actions.scope :as actions.scope]
[metabase.actions.settings :as actions.settings]
[metabase.api.common :as api]
@@ -31,7 +32,8 @@
"Allow actions to dynamically generating a :mapping, in none has been configured."
{:arglists '([action-kw scope]), :added "0.57.0"}
(fn [action-kw _scope]
- action-kw))
+ action-kw)
+ :hierarchy #'actions.hierarchy/hierarchy)
(defmethod default-mapping :default [_ _])
diff --git a/src/metabase/actions/args.clj b/src/metabase/actions/args.clj
index caadeabf06f..48b8db353fb 100644
--- a/src/metabase/actions/args.clj
+++ b/src/metabase/actions/args.clj
@@ -1,6 +1,7 @@
(ns ^:instrument/always metabase.actions.args
(:require
[metabase.actions.db :as actions.db]
+ [metabase.actions.hierarchy :as actions.hierarchy]
;; legacy usage, do not use this in new code
^{:clj-kondo/ignore [:discouraged-namespace]} [metabase.legacy-mbql.normalize :as mbql.normalize]
[metabase.lib.schema.id :as lib.schema.id]
@@ -14,19 +15,22 @@
(action-arg-map-schema :model.row/create) => :actions.args.crud/row.create"
{:arglists '([action]), :added "0.44.0"}
- keyword)
+ keyword
+ :hierarchy #'actions.hierarchy/hierarchy)
(defmulti normalize-action-arg-map
"Normalize the `arg-map` passed to [[perform-action!]] for a specific `action`."
{:arglists '([action arg-map]), :added "0.44.0"}
(fn [action _arg-map]
- (keyword action)))
+ (keyword action))
+ :hierarchy #'actions.hierarchy/hierarchy)
(defmulti validate-inputs!
"Check whether the given action is supported for the given inputs, and if not throw an error."
{:arglists '([action inputs]), :added "0.57.0"}
(fn [action _inputs]
- (keyword action)))
+ (keyword action))
+ :hierarchy #'actions.hierarchy/hierarchy)
(defmethod normalize-action-arg-map :default
[_action arg-map]
@@ -156,9 +160,9 @@
;;;; `:table.row/create`, `:table.row/delete`, `:table.row/update` -- these all have the exact same shapes
-(derive :table.row/create :table.row/common)
-(derive :table.row/update :table.row/common)
-(derive :table.row/delete :table.row/common)
+(actions.hierarchy/derive! :table.row/create :table.row/common)
+(actions.hierarchy/derive! :table.row/update :table.row/common)
+(actions.hierarchy/derive! :table.row/delete :table.row/common)
(defmethod action-arg-map-schema :table.row/common
[_action]
diff --git a/src/metabase/actions/core.clj b/src/metabase/actions/core.clj
index 1b2daff7713..bd19fdf9aa1 100644
--- a/src/metabase/actions/core.clj
+++ b/src/metabase/actions/core.clj
@@ -6,6 +6,7 @@
[metabase.actions.error]
[metabase.actions.events]
[metabase.actions.execution]
+ [metabase.actions.hierarchy]
[metabase.actions.http-action]
[metabase.actions.models]
[metabase.actions.scope]
@@ -15,6 +16,7 @@
metabase.actions.actions/keep-me
metabase.actions.error/keep-me
metabase.actions.execution/keep-me
+ metabase.actions.hierarchy/keep-me
metabase.actions.http-action/keep-me
metabase.actions.models/keep-me
metabase.actions.scope/keep-me)
@@ -46,6 +48,8 @@
violate-not-null-constraint
violate-permission-constraint
violate-unique-constraint]
+ [metabase.actions.hierarchy
+ derive!]
[metabase.actions.execution
execute-action!
execute-dashcard!
diff --git a/src/metabase/actions/hierarchy.clj b/src/metabase/actions/hierarchy.clj
new file mode 100644
index 00000000000..55e13fd28e6
--- /dev/null
+++ b/src/metabase/actions/hierarchy.clj
@@ -0,0 +1,20 @@
+(ns metabase.actions.hierarchy
+ "Keyword hierarchy relating action keywords to the keywords whose method implementations they share.
+
+ Kept separate from Clojure's global hierarchy so that action relationships are visible in one place and
+ cannot collide with other users of the global hierarchy.
+
+ Driver-level action methods resolve `[driver action]` through `driver/hierarchy`, and should only ever
+ dispatch on concrete actions - this hierarchy is irrelevant there.
+
+ (derive! :table.row/create :table.row/common)")
+
+(defonce ^{:doc "The action hierarchy. A var holding a hierarchy map, mutated by [[derive!]]."}
+ hierarchy
+ (make-hierarchy))
+
+(defn derive!
+ "Make `parent` an ancestor of `tag` in the action [[hierarchy]]."
+ [tag parent]
+ (alter-var-root #'hierarchy derive tag parent)
+ nil)
diff --git a/src/metabase/driver/sql_jdbc/actions.clj b/src/metabase/driver/sql_jdbc/actions.clj
index 5362d133759..912f2dd545c 100644
--- a/src/metabase/driver/sql_jdbc/actions.clj
+++ b/src/metabase/driver/sql_jdbc/actions.clj
@@ -185,6 +185,7 @@
[[connection-binding database-id] & body]
`(do-with-jdbc-transaction ~database-id (fn [~(vary-meta connection-binding assoc :tag 'Connection)] ~@body)))
+;; Name a concrete action, not a group like `:table.row/common`: `driver/hierarchy` has no action groups.
(defmulti prepare-query*
"Multimethod for preparing a honeysql query `hsql-query` for a given action type `action`.
`action` is a keyword like `:model.row/create` or `:table.row/create`; `hsql-query` is a generic