Skip to content

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

feat: toggle transform dirty status on setting change (#68684)

Edward Paget233dbfecdcb1
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/impl.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/impl.clj
index 985ff5ef896..5a18137968a 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/impl.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/impl.clj
@@ -409,39 +409,3 @@
(:id (async-import! (settings/remote-sync-branch) true {}))))
(u/prog1 nil
(collection/clear-remote-synced-collection!))))
-
-(defn sync-transform-tracking!
- "Called when remote-sync-transforms setting changes.
- When enabled: mark all existing transforms, transform tags, and transforms-namespace collections
- as 'create' for initial sync.
- When disabled: remove all transform-related tracking entries."
- [enabled?]
- (let [timestamp (t/offset-date-time)]
- (if enabled?
- (do
- ;; Mark all transforms-namespace collections for initial sync
- (doseq [coll (t2/select [:model/Collection :id :name] :namespace (name collection/transforms-ns))]
- (t2/insert! :model/RemoteSyncObject
- {:model_type "Collection"
- :model_id (:id coll)
- :model_name (:name coll)
- :status "create"
- :status_changed_at timestamp}))
- ;; Mark all existing transforms and transform tags for initial sync
- (doseq [[model name-key] [[:model/Transform :name]
- [:model/TransformTag :name]]]
- (doseq [entity (t2/select [model :id name-key])]
- (t2/insert! :model/RemoteSyncObject
- {:model_type (name (last (str/split (name model) #"/")))
- :model_id (:id entity)
- :model_name (get entity name-key)
- :status "create"
- :status_changed_at timestamp}))))
- ;; Remove all transform-related tracking (including transforms-namespace collections)
- (let [transform-coll-ids (t2/select-pks-set :model/Collection :namespace (name collection/transforms-ns))]
- (t2/delete! :model/RemoteSyncObject
- :model_type [:in ["Transform" "TransformTag"]])
- (when (seq transform-coll-ids)
- (t2/delete! :model/RemoteSyncObject
- :model_type "Collection"
- :model_id [:in transform-coll-ids]))))))
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj
index 1cc44d3cb0d..659d408aed6 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj
@@ -1,7 +1,9 @@
(ns metabase-enterprise.remote-sync.settings
(:require
[clojure.string :as str]
+ [java-time.api :as t]
[metabase-enterprise.remote-sync.source.git :as git]
+ [metabase.collections.models.collection :as collection]
[metabase.settings.core :as setting :refer [defsetting]]
[metabase.util.i18n :refer [deferred-tru]]
[toucan2.core :as t2]))
@@ -86,13 +88,51 @@
:encryption :no
:default (* 1000 60 5))
+(defn sync-transform-tracking!
+ "Called when remote-sync-transforms setting changes.
+ When enabled: mark all existing transforms, transform tags, and transforms-namespace collections
+ as 'create' for initial sync.
+ When disabled: remove all transform-related tracking entries."
+ [enabled?]
+ (let [timestamp (t/offset-date-time)
+ transform-coll-ids (t2/select-pks-set :model/Collection :namespace (name collection/transforms-ns))]
+ (t2/delete! :model/RemoteSyncObject
+ :model_type [:in ["Transform" "TransformTag"]])
+ (when (seq transform-coll-ids)
+ (t2/delete! :model/RemoteSyncObject
+ :model_type "Collection"
+ :model_id [:in transform-coll-ids]))
+ (when enabled?
+ (doseq [coll (t2/select [:model/Collection :id :name] :namespace (name collection/transforms-ns))]
+ (t2/insert! :model/RemoteSyncObject
+ {:model_type "Collection"
+ :model_id (:id coll)
+ :model_name (:name coll)
+ :status "create"
+ :status_changed_at timestamp}))
+ (doseq [[model name-key] [[:model/Transform :name]
+ [:model/TransformTag :name]]]
+ (doseq [entity (t2/select [model :id name-key])]
+ (t2/insert! :model/RemoteSyncObject
+ {:model_type (name (last (str/split (name model) #"/")))
+ :model_id (:id entity)
+ :model_name (get entity name-key)
+ :status "create"
+ :status_changed_at timestamp}))))))
+
+(defn- sync-transform-tracking-on-change
+ "Called when remote-sync-transforms setting changes."
+ [_old-value new-value]
+ (sync-transform-tracking! (boolean new-value)))
+
(defsetting remote-sync-transforms
(deferred-tru "Whether to sync transforms via remote-sync. When enabled, all transforms, transform tags, and transform jobs are synced as a single unit (all-or-nothing).")
:type :boolean
:visibility :admin
:export? false
:encryption :no
- :default false)
+ :default false
+ :on-change sync-transform-tracking-on-change)
(defsetting remote-sync-check-changes-cache-ttl-seconds
(deferred-tru "Time-to-live in seconds for the remote changes check cache. Default is 60 seconds.")
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/transforms_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/transforms_test.clj
index 3f9a963b00e..f7cefdf5e1a 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/transforms_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/transforms_test.clj
@@ -6,6 +6,7 @@
[java-time.api :as t]
[metabase-enterprise.remote-sync.impl :as impl]
[metabase-enterprise.remote-sync.models.remote-sync-object :as sync-object]
+ [metabase-enterprise.remote-sync.settings :as settings]
[metabase-enterprise.remote-sync.source.protocol :as source.p]
[metabase-enterprise.remote-sync.test-helpers :as test-helpers]
[metabase.collections.models.collection :as collection]
@@ -128,7 +129,7 @@
:model/TransformTag tag {:name "Existing Tag"}]
(is (zero? (t2/count :model/RemoteSyncObject :model_type [:in ["Transform" "TransformTag"]]))
"Should have no transform tracking entries initially")
- (impl/sync-transform-tracking! true)
+ (settings/sync-transform-tracking! true)
(is (t2/exists? :model/RemoteSyncObject
:model_type "Collection"
:model_id coll-id
@@ -154,14 +155,13 @@
:model/Transform transform {:name "Test Transform" :collection_id coll-id}
:model/TransformTag tag {:name "Test Tag"}]
(mt/with-temporary-setting-values [remote-sync-transforms true]
- (t2/insert! :model/RemoteSyncObject
- [{:model_type "Collection" :model_id coll-id :model_name "Transforms Collection" :status "synced" :status_changed_at (t/offset-date-time)}
- {:model_type "Transform" :model_id (:id transform) :model_name "Test Transform" :status "synced" :status_changed_at (t/offset-date-time)}
- {:model_type "TransformTag" :model_id (:id tag) :model_name "Test Tag" :status "synced" :status_changed_at (t/offset-date-time)}])
- (is (= 3 (t2/count :model/RemoteSyncObject :model_type [:in ["Collection" "Transform" "TransformTag"]]
- :model_id [:in [coll-id (:id transform) (:id tag)]]))
- "Should have 3 tracking entries")
- (impl/sync-transform-tracking! false)
+ (is (t2/exists? :model/RemoteSyncObject :model_type "Collection" :model_id coll-id)
+ "Collection tracking entry should exist")
+ (is (t2/exists? :model/RemoteSyncObject :model_type "Transform" :model_id (:id transform))
+ "Transform tracking entry should exist")
+ (is (t2/exists? :model/RemoteSyncObject :model_type "TransformTag" :model_id (:id tag))
+ "TransformTag tracking entry should exist")
+ (settings/sync-transform-tracking! false)
(is (zero? (t2/count :model/RemoteSyncObject :model_type [:in ["Transform" "TransformTag"]]))
"Transform and TransformTag tracking entries should be removed")
(is (zero? (t2/count :model/RemoteSyncObject :model_type "Collection" :model_id coll-id))