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
Add malli typing for transform execution methods (#70250)
Chris Truter9c44b338870b
diff --git a/enterprise/backend/src/metabase_enterprise/transforms_python/base.clj b/enterprise/backend/src/metabase_enterprise/transforms_python/base.cljindex d0eda8d5e5f..f8d556caae4 100644--- a/enterprise/backend/src/metabase_enterprise/transforms_python/base.clj+++ b/enterprise/backend/src/metabase_enterprise/transforms_python/base.clj@@ -14,12 +14,14 @@[metabase.driver :as driver][metabase.driver.util :as driver.u][metabase.transforms-base.interface :as transforms-base.i]+ [metabase.transforms-base.schema :as transforms-base.schema][metabase.transforms-base.util :as transforms-base.u][metabase.transforms.instrumentation :as transforms.instrumentation][metabase.util :as u][metabase.util.format :as u.format][metabase.util.i18n :as i18n][metabase.util.log :as log]+ [metabase.util.malli :as mu][toucan2.core :as t2])(:import(java.io File)@@ -276,7 +278,7 @@;;; ------------------------------------------------- Base Execution Entry Point --------------------------------------------------(defn run-python-transform!+(mu/defn run-python-transform! :- ::transforms-base.schema/execute-base-result"Execute Python transform. Returns result map.Does:@@ -298,11 +300,12 @@- `:cancel-chan` - optional, pre-created promise-chan for cancellation (avoids bridging latency)Returns:- {:status :succeeded | :failed | :cancelled+ {:status :succeeded | :failed | :cancelled | :timeout:result <http response>:logs <string>:error <exception if failed>}"- [transform {:keys [cancelled? run-id with-stage-timing-fn message-log cancel-chan]}]+ [transform :- ::transforms-base.schema/transform+ {:keys [cancelled? run-id with-stage-timing-fn message-log cancel-chan]} :- [:maybe ::transforms-base.schema/execute-base-options]](assert (transforms-base.u/python-transform? transform) "Transform must be a python transform")(let [message-log (or message-log (empty-message-log))](trydiff --git a/src/metabase/transforms_base/query.clj b/src/metabase/transforms_base/query.cljindex f00c8fd41b9..cfb9347745f 100644--- a/src/metabase/transforms_base/query.clj+++ b/src/metabase/transforms_base/query.clj@@ -9,8 +9,10 @@[metabase.lib.schema.common :as schema.common][metabase.query-processor.compile :as qp.compile][metabase.transforms-base.interface :as transforms-base.i]+ [metabase.transforms-base.schema :as transforms-base.schema][metabase.transforms-base.util :as transforms-base.u][metabase.util.log :as log]+ [metabase.util.malli :as mu][metabase.util.malli.registry :as mr][toucan2.core :as t2]))@@ -53,7 +55,7 @@;;; ------------------------------------------------- Base Execution --------------------------------------------------(defn run-query-transform!+(mu/defn run-query-transform! :- ::transforms-base.schema/execute-base-result"Execute query transform (MBQL/native). Returns result map.Does:@@ -76,8 +78,8 @@{:status :succeeded | :failed | :cancelled:result <driver result>:error <exception if failed>}"- [{:keys [id source target] :as transform}- {:keys [cancelled?] :as _opts}]+ [{:keys [id source target] :as transform} :- ::transforms-base.schema/transform+ {:keys [cancelled?] :as _opts} :- [:maybe ::transforms-base.schema/execute-base-options]](try;; Check cancellation before starting(when (and cancelled? (cancelled?))diff --git a/src/metabase/transforms_base/schema.clj b/src/metabase/transforms_base/schema.cljnew file mode 100644index 00000000000..0604a3137ce--- /dev/null+++ b/src/metabase/transforms_base/schema.clj@@ -0,0 +1,62 @@+(ns metabase.transforms-base.schema+ "Malli schemas for base transform execution.++ These are the minimal schemas needed for execute-base! and its implementations.+ The full transforms module (metabase.transforms.schema) extends these with+ additional fields like :id (required for scheduled execution)."+ (:require+ [metabase.util.malli.registry :as mr]+ [metabase.util.malli.schema :as ms])+ (:import+ (clojure.core.async.impl.channels ManyToManyChannel)+ (clojure.lang Atom)))++;;; ------------------------------------------------- Primitives -------------------------------------------------++(mr/def ::atom+ (ms/InstanceOfClass Atom))++(mr/def ::chan+ (ms/InstanceOfClass ManyToManyChannel))++;;; ------------------------------------------------- Transform -------------------------------------------------++(mr/def ::transform-target+ "Target specification for a transform. Must include at least :type and :name."+ [:map+ [:type :string]+ [:database {:optional true} :int]+ [:schema {:optional true} [:maybe :string]]+ [:name :string]])++(mr/def ::transform+ "A transform map as expected by execute-base! implementations."+ [:map+ ;; The :id is only present for Global transforms, and missing for Workspace transforms.+ [:id {:optional true} pos-int?]+ [:source [:map [:type [:or :string :keyword]]]]+ [:target ::transform-target]+ [:name {:optional true} :string]+ [:description {:optional true} [:maybe :string]]])++;;; ------------------------------------------------- Options -------------------------------------------------++(mr/def ::execute-base-options+ "Options map for execute-base! and its implementations."+ [:map+ [:cancelled? {:optional true} ifn?]+ [:run-id {:optional true} [:maybe pos-int?]]+ [:with-stage-timing-fn {:optional true} ifn?]+ [:publish-events? {:optional true} :boolean]+ [:message-log {:optional true} [:maybe ::atom]]+ [:cancel-chan {:optional true} [:maybe ::chan]]])++;;; ------------------------------------------------- Result -------------------------------------------------++(mr/def ::execute-base-result+ "Result map returned by execute-base!."+ [:map+ [:status [:enum :succeeded :failed :cancelled :timeout]]+ [:result {:optional true} :any]+ [:error {:optional true} [:maybe (ms/InstanceOfClass Throwable)]]+ [:logs {:optional true} [:maybe :string]]])