Skip to content

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

Show data apps in the remote sync changes lists (#83797)

Alexander Polyankin1f5e489c7256
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index 6f9637da931..18adc0caa9e 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -3748,6 +3748,7 @@
models
permissions
premium-features
+ remote-sync
request
settings
util
diff --git a/enterprise/backend/src/metabase_enterprise/data_apps/api.clj b/enterprise/backend/src/metabase_enterprise/data_apps/api.clj
index 23b47e01134..93743739a3a 100644
--- a/enterprise/backend/src/metabase_enterprise/data_apps/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/data_apps/api.clj
@@ -22,6 +22,7 @@
[metabase.lib-be.core :as lib-be]
[metabase.lib-be.schema :as lib-be.schema]
[metabase.lib.core :as lib]
+ [metabase.remote-sync.core :as remote-sync]
[metabase.settings.core :as setting]
[metabase.util :as u]
[metabase.util.i18n :refer [tru]]
@@ -292,12 +293,18 @@
[slug]
(api/write-check (api/check-404 (data-apps.db/data-app-by-slug slug))))
+(defn- check-editable!
+ "Throws a 403 when `app` is read-only under remote sync."
+ [app]
+ (api/check-403 (remote-sync/model-editable? :model/DataApp app)))
+
(api.macros/defendpoint :post "/" :- DataAppResponse
"Create a data app from its manifest fields and bundle. A draft with the same slug becomes the app."
[_route-params
_query-params
body :- CreateDataAppRequest]
(api/create-check :model/DataApp body)
+ (check-editable! (assoc body :draft false))
(let [app (data-apps.db/data-app (data-apps.apps/create-app! (with-bundle body)))]
(events/publish-event! :event/data-app-create {:object app :user-id api/*current-user-id*})
(data-app-response app)))
@@ -310,17 +317,22 @@
[{:keys [slug]} :- [:map {:closed true} [:slug ms/NonBlankString]]
_query-params
changes :- UpdateDataAppRequest]
- (let [app (write-check-data-app slug)]
+ (let [app (write-check-data-app slug)
+ synced-changes (dissoc changes :enabled)]
+ (when (seq synced-changes)
+ (check-editable! app))
(when (seq changes)
(data-apps.db/update-data-app! (:id app) (with-bundle changes)))
(let [app (data-apps.db/data-app (:id app))]
- (events/publish-event! :event/data-app-update {:object app :user-id api/*current-user-id*})
+ (when (seq synced-changes)
+ (events/publish-event! :event/data-app-update {:object app :user-id api/*current-user-id*}))
(data-app-response app))))
(api.macros/defendpoint :delete ["/:slug" :slug slug-regex] :- :nil
"Delete a data app, its bundle, and the collection and permission group it owns."
[{:keys [slug]} :- [:map {:closed true} [:slug ms/NonBlankString]]]
(let [app (write-check-data-app slug)]
+ (check-editable! app)
(data-apps.db/delete-data-app! (:id app))
(events/publish-event! :event/data-app-delete {:object app :user-id api/*current-user-id*}))
;; a `nil` body is rendered as a 204; matches the `:- :nil` response schema
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/db.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/db.clj
index c2ff4ee4f3c..a47aef1ce2e 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/db.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/db.clj
@@ -58,6 +58,13 @@
conditions :- Conditions]
(apply t2/select-fn-set :id model-key (mapcat identity conditions)))
+(mu/defn instances-where
+ "The instances of `model-key` matching `conditions` (a map of column to value or Toucan 2 operator-vector value,
+ or nil for every instance)."
+ [model-key :- :keyword
+ conditions :- Conditions]
+ (apply t2/select model-key (mapcat identity conditions)))
+
(mu/defn entity-id-where :- [:maybe :string]
"The `:entity_id` of the instance of `model-key` whose `column` equals `value`, or nil."
[model-key :- :keyword
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/events.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/events.clj
index 1fafe5e0c16..9a3af02159d 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/events.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/events.clj
@@ -88,6 +88,23 @@
(remote-sync.db/insert-rsos! rows))
(count rows)))
+(defn backfill-data-app-tracking!
+ "Insert a 'create' ledger row for every published DataApp that has none, returning the number of rows inserted."
+ []
+ (let [data-app-spec (spec/spec-for-model-key :model/DataApp)
+ tracked (remote-sync.db/tracked-model-ids "DataApp")
+ timestamp (t/offset-date-time)
+ rows (for [app (remote-sync.db/instances-where :model/DataApp (:conditions data-app-spec))
+ :when (not (contains? tracked (:id app)))]
+ (merge {:model_type "DataApp"
+ :model_id (:id app)
+ :status "create"
+ :status_changed_at timestamp}
+ (spec/build-sync-object-fields data-app-spec app)))]
+ (when (seq rows)
+ (remote-sync.db/insert-rsos! rows))
+ (count rows)))
+
(defn disable-library-tracking!
"Remove all snippet, snippets-namespace collection, and glossary tracking entries."
[]
@@ -176,11 +193,14 @@
(let [model-type (:model-type model-spec)
existing (remote-sync.db/lock-rso model-type model-id)]
(cond
+ (and (not existing)
+ (contains? #{"removed" "delete"} status))
+ nil
+
;; No row to lock, so a concurrent un-sync that hasn't inserted yet is invisible here (a phantom the
;; row lock can't cover). Re-check eligibility so a stale tracked-status event does not start tracking
;; an entity that has since left the synced set. This narrows, but cannot fully close, that window.
(and (not existing)
- (not (contains? #{"removed" "delete"} status))
(not (still-eligible? model-spec model-id)))
nil
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/init.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/init.clj
index 0599968caf2..9417adffbd8 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/init.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/init.clj
@@ -65,7 +65,10 @@
(when (= :read-write (settings/remote-sync-type))
(let [n (events/backfill-action-tracking!)]
(when (pos? n)
- (log/infof "Tracking %d existing actions for remote sync" n))))
+ (log/infof "Tracking %d existing actions for remote sync" n)))
+ (let [n (events/backfill-data-app-tracking!)]
+ (when (pos? n)
+ (log/infof "Tracking %d existing data apps for remote sync" n))))
(when-not (collection/has-remote-synced-collection?)
(if (nil? (settings/remote-sync-branch))
(log/warn "Remote sync is enabled but no remote-sync branch is set. Cannot do initial import.")
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/spec.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/spec.clj
index 20dcfd498be..5352eba7778 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/spec.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/spec.clj
@@ -881,6 +881,7 @@
"Determines if a model instance is editable based on remote sync configuration.
Returns false if:
+ - Remote sync is enabled AND
- The model has a spec in remote-sync-specs AND
- The instance is eligible for sync (via check-eligibility) AND
- remote-sync-type is :read-only
@@ -888,16 +889,15 @@
For models with global eligibility (e.g., :library-synced, :setting), the instance
argument can be nil or an empty map since eligibility doesn't depend on instance data."
[model-key instance]
- (if-let [spec (spec-for-model-key model-key)]
+ (if-let [spec (and (rs-settings/remote-sync-enabled) (spec-for-model-key model-key))]
(or (= (rs-settings/remote-sync-type) :read-write)
(not (check-eligibility spec instance)))
- ;; Model not in spec, always editable
true))
(defn batch-model-editable?
"Batch version of model-editable?. Returns a map of instance-id -> editable? boolean."
[model-key instances]
- (if-let [spec (spec-for-model-key model-key)]
+ (if-let [spec (and (rs-settings/remote-sync-enabled) (spec-for-model-key model-key))]
(if (= (rs-settings/remote-sync-type) :read-write)
(into {} (map (fn [inst] [(:id inst) true])) instances)
(let [eligibility-map (batch-check-eligibility spec instances)]
diff --git a/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj b/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj
index 012243b8e68..7d21f1feda6 100644
--- a/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/data_apps/api_test.clj
@@ -106,6 +106,42 @@
(is (not (t2/exists? :model/Collection :id resource_collection_id))
"and so is its resource collection"))))))
+(deftest read-only-remote-sync-blocks-data-app-changes-test
+ (mt/with-premium-features #{:data-apps}
+ (mt/with-model-cleanup [:model/DataApp :model/Collection :model/PermissionsGroup :model/RemoteSyncObject]
+ (create-app!)
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git"
+ remote-sync-type :read-only]
+ (testing "a read-only instance refuses to create, change, or delete an app"
+ (mt/user-http-request :crowberto :post 403 "apps" (assoc app-request :name "other"))
+ (is (not (t2/exists? :model/DataApp :name "other")))
+ (mt/user-http-request :crowberto :put 403 "apps/demo" {:display_name "Renamed"})
+ (mt/user-http-request :crowberto :put 403 "apps/demo" {:enabled false :display_name "Renamed"})
+ (mt/user-http-request :crowberto :delete 403 "apps/demo")
+ (is (=? {:display_name "Demo" :enabled true} (t2/select-one :model/DataApp :name "demo"))))
+ (testing "enabling and disabling stays allowed"
+ (is (=? {:enabled false}
+ (mt/user-http-request :crowberto :put 200 "apps/demo" {:enabled false}))))
+ (testing "drafts are outside sync, so they can still be created and deleted"
+ (mt/user-http-request :crowberto :post 200 "apps/draft-app/draft")
+ (mt/user-http-request :crowberto :delete 204 "apps/draft-app")))
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git"
+ remote-sync-type :read-write]
+ (testing "a read-write instance allows changes"
+ (is (=? {:display_name "Renamed"}
+ (mt/user-http-request :crowberto :put 200 "apps/demo" {:display_name "Renamed"}))))))))
+
+(deftest enabling-a-data-app-is-not-a-synced-change-test
+ (mt/with-premium-features #{:data-apps}
+ (mt/with-model-cleanup [:model/DataApp :model/Collection :model/PermissionsGroup :model/RemoteSyncObject]
+ (create-app!)
+ (let [app-id (t2/select-one-pk :model/DataApp :name "demo")]
+ (mt/user-http-request :crowberto :put 200 "apps/demo" {:enabled false})
+ (is (not (t2/exists? :model/RemoteSyncObject :model_type "DataApp" :model_id app-id)))
+ (mt/user-http-request :crowberto :put 200 "apps/demo" {:display_name "Renamed"})
+ (is (=? {:model_name "demo" :status "update"}
+ (t2/select-one :model/RemoteSyncObject :model_type "DataApp" :model_id app-id)))))))
+
(deftest ^:parallel query-definition-request-schema-is-closed-test
(is (empty? (closed-schemas/findings ::query-definition/query-definition))))
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/api_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/api_test.clj
index 68e3b585474..c1765d23ee3 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/api_test.clj
@@ -609,7 +609,7 @@
(deftest export-errors-in-read-only-mode-test
(testing "POST /api/ee/remote-sync/export errors when in read-only sync mode"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/RemoteSyncTask _ {:sync_task_type "foo"}]
(let [mock-source (test-helpers/create-mock-source)]
(mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git"
@@ -1509,6 +1509,7 @@
(testing "GHY-4650: a public link change on a read-only instance does not mark the synced item dirty, since it cannot be pushed"
(test-helpers/with-clean-object
(mt/with-temporary-setting-values [enable-public-sharing true
+ remote-sync-url "https://github.com/test/repo.git"
remote-sync-type :read-only]
(mt/with-temp [:model/Collection coll {:name "Remote Collection" :is_remote_synced true :location "/"}
:model/Dashboard dash {:name "Shared Dashboard" :collection_id (:id coll)}
@@ -1856,7 +1857,7 @@
{:remote-sync-type :read-only
:collections {synced-coll-id false}}))))
(testing "rejects collection changes when remote-sync-type is already read-only (default)"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(is (= "Cannot change synced collections when remote-sync-type is read-only."
(mt/user-http-request :crowberto :put 400 "ee/remote-sync/settings"
{:collections {coll-id true}})))))))))
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/events_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/events_test.clj
index 568edbe1057..138c8f29d0f 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/events_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/events_test.clj
@@ -27,6 +27,32 @@
(when-let [rows (seq (spec/sync-all-entities! (t/instant) imported-data))]
(t2/insert! :model/RemoteSyncObject rows)))
+(defn- track-as-synced!
+ "Replaces the RemoteSyncObject table with a single synced row for `entity` of `model-type`."
+ [model-type entity]
+ (t2/delete! :model/RemoteSyncObject)
+ (t2/insert! :model/RemoteSyncObject {:model_type model-type
+ :model_id (:id entity)
+ :model_name (:name entity)
+ :status "synced"
+ :status_changed_at (t/offset-date-time)}))
+
+(deftest deleting-an-untracked-entity-is-not-a-change-test
+ (testing "deleting or archiving an entity that was never tracked adds no RemoteSyncObject row"
+ (mt/with-temporary-setting-values [remote-sync-type :read-write]
+ (mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
+ :model/Card remote-sync-card {:name "Test Card"
+ :dataset_query (mt/mbql-query venues)
+ :collection_id (:id remote-sync-collection)}]
+ (t2/delete! :model/RemoteSyncObject)
+ (events/publish-event! :event/card-update
+ {:object (assoc remote-sync-card :archived true)
+ :previous-object remote-sync-card
+ :user-id (mt/user->id :rasta)})
+ (events/publish-event! :event/card-delete
+ {:object remote-sync-card :user-id (mt/user->id :rasta)})
+ (is (not (t2/exists? :model/RemoteSyncObject)))))))
+
;;; Model Change Event Tests
(deftest card-create-event-creates-entry-test
@@ -70,7 +96,7 @@
:model/Card remote-sync-card {:name "Test Card"
:dataset_query (mt/mbql-query venues)
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Card" remote-sync-card)
(events/publish-event! :event/card-update
{:object (assoc remote-sync-card :archived true)
:previous-object remote-sync-card
@@ -89,7 +115,7 @@
:model/Card remote-sync-card {:name "Test Card"
:dataset_query (mt/mbql-query venues)
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Card" remote-sync-card)
(events/publish-event! :event/card-delete
{:object remote-sync-card :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
@@ -228,7 +254,7 @@
(deftest events-on-read-only-instance-do-not-track-synced-items-test
(testing "On a read-only instance, no event marks a synced item dirty, since that change can never be pushed"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Dashboard dashboard {:name "Test Dashboard" :collection_id (:id remote-sync-collection)}]
(t2/delete! :model/RemoteSyncObject)
@@ -241,7 +267,7 @@
:model/Dashboard [:event/dashboard-public-link-created :event/dashboard-public-link-deleted]}
topic topics]
(testing topic
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
model instance {:name "Shared" :collection_id (:id remote-sync-collection)}]
(t2/delete! :model/RemoteSyncObject)
@@ -254,7 +280,7 @@
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Dashboard dashboard {:name "Test Dashboard"
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Dashboard" dashboard)
(events/publish-event! :event/dashboard-update
{:object (assoc dashboard :archived true)
:user-id (mt/user->id :rasta)})
@@ -271,7 +297,7 @@
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Dashboard dashboard {:name "Test Dashboard"
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Dashboard" dashboard)
(events/publish-event! :event/dashboard-delete
{:object dashboard :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
@@ -316,7 +342,7 @@
(mt/with-temporary-setting-values [remote-sync-type :read-write]
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Document document {:collection_id (u/the-id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Document" document)
(events/publish-event! :event/document-update
{:object (assoc document :archived true)
:user-id (mt/user->id :rasta)})
@@ -332,7 +358,7 @@
(mt/with-temporary-setting-values [remote-sync-type :read-write]
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Document document {:collection_id (u/the-id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Document" document)
(events/publish-event! :event/document-delete
{:object document :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
@@ -386,7 +412,7 @@
:model/NativeQuerySnippet snippet {:name "Test Snippet"
:content "SELECT 1"
:collection_id (:id snippet-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "NativeQuerySnippet" snippet)
(events/publish-event! :event/snippet-update
{:object (assoc snippet :archived true)
:user-id (mt/user->id :rasta)})
@@ -405,7 +431,7 @@
:model/NativeQuerySnippet snippet {:name "Test Snippet"
:content "SELECT 1"
:collection_id (:id snippet-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "NativeQuerySnippet" snippet)
(events/publish-event! :event/snippet-delete
{:object snippet :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
@@ -950,7 +976,7 @@
:model/Timeline timeline {:name "Test Timeline"
:collection_id (:id remote-sync-collection)
:archived true}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Timeline" timeline)
(events/publish-event! :event/timeline-update
{:object timeline :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
@@ -966,7 +992,7 @@
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Timeline timeline {:name "Test Timeline"
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Timeline" timeline)
(events/publish-event! :event/timeline-delete
{:object timeline :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
@@ -1028,7 +1054,7 @@
(mt/with-temp [:model/Collection remote-sync-collection {:is_remote_synced true :name "Remote-Sync"}
:model/Document doc {:name "Test Doc"
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Document" doc)
;; Trash the doc
(t2/update! :model/Document (:id doc) {:archived true})
(events/publish-event! :event/document-update
@@ -1096,7 +1122,7 @@
:model/Table table {:name "Test Table"
:is_published true
:collection_id (:id remote-sync-collection)}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Table" table)
(events/publish-event! :event/table-update
{:object (assoc table :archived_at (t/offset-date-time))
:user-id (mt/user->id :rasta)})
@@ -1218,7 +1244,7 @@
:table_id (:id table)
:definition {:source-table (:id table)
:filter [:> [:field 1 nil] 0]}}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Segment" segment)
(events/publish-event! :event/segment-update
{:object (assoc segment :archived true)
:user-id (mt/user->id :rasta)})
@@ -1240,7 +1266,7 @@
:table_id (:id table)
:definition {:source-table (:id table)
:filter [:> [:field 1 nil] 0]}}]
- (t2/delete! :model/RemoteSyncObject)
+ (track-as-synced! "Segment" segment)
(events/publish-event! :event/segment-delete
{:object segment :user-id (mt/user->id :rasta)})
(let [entries (t2/select :model/RemoteSyncObject)]
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/init_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/init_test.clj
index 92c0d451e4c..06a6017ffee 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/init_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/init_test.clj
@@ -283,3 +283,52 @@
(fn [_entry]
(#'init/remote-sync-init)
(is (zero? (glossary-rso-count))))))))
+
+;;; ------------------------------------------- Data app ledger backfill -------------------------------------------
+
+(defn- do-with-untracked-data-apps!
+ "Runs `f` with `{:published :draft :tracked}` data app ids under `remote-sync-type` `sync-type`, where only
+ `:tracked` has a DataApp ledger row."
+ [sync-type f]
+ (mt/with-temporary-setting-values [:remote-sync-url "file://my/repo.git"
+ :remote-sync-type sync-type
+ :remote-sync-branch "main"]
+ (mt/with-model-cleanup [:model/RemoteSyncObject :model/DataApp :model/Collection :model/PermissionsGroup]
+ (let [insert-app! (fn [slug draft?]
+ (t2/insert-returning-pk! :model/DataApp {:name slug
+ :display_name slug
+ :bundle_path "index.js"
+ :bundle (.getBytes "BUNDLE" "UTF-8")
+ :draft draft?}))
+ published (insert-app! "published" false)
+ draft (insert-app! "draft" true)
+ tracked (insert-app! "tracked" false)]
+ (t2/delete! :model/RemoteSyncObject :model_type "DataApp")
+ (t2/insert! :model/RemoteSyncObject {:model_type "DataApp" :model_id tracked :model_name "tracked"
+ :status "synced" :status_changed_at (t/offset-date-time)})
+ (mt/with-dynamic-fn-redefs [impl/async-import! (constantly nil)
+ remote-sync.object/dirty? (constantly false)]
+ (f {:published published :draft draft :tracked tracked}))))))
+
+(defn- data-app-rso-statuses []
+ (t2/select-fn->fn :model_id :status :model/RemoteSyncObject :model_type "DataApp"))
+
+(deftest remote-sync-init-backfills-data-app-tracking-test
+ (testing "read-write init tracks every untracked published data app as 'create', once, so the next push writes it"
+ (do-with-untracked-data-apps!
+ :read-write
+ (fn [{:keys [published tracked]}]
+ (#'init/remote-sync-init)
+ (is (= {published "create" tracked "synced"} (data-app-rso-statuses)))
+ (is (=? {:model_name "published"}
+ (t2/select-one :model/RemoteSyncObject :model_type "DataApp" :model_id published)))
+ (testing "a second run inserts nothing"
+ (is (= 0 (rs-events/backfill-data-app-tracking!))))))))
+
+(deftest remote-sync-init-data-app-backfill-skips-read-only-test
+ (testing "a read-only instance is not backfilled"
+ (do-with-untracked-data-apps!
+ :read-only
+ (fn [{:keys [tracked]}]
+ (#'init/remote-sync-init)
+ (is (= {tracked "synced"} (data-app-rso-statuses)))))))
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/snippets_api_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/snippets_api_test.clj
index 983b9a7c4a9..82a8f501642 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/snippets_api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/snippets_api_test.clj
@@ -19,7 +19,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}]
(data-perms/set-database-permission! (perms-group/all-users) (mt/id) :perms/create-queries :query-builder-and-native)
(perms/grant-collection-readwrite-permissions! (perms-group/all-users) collection)
@@ -62,7 +62,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-not-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}]
(data-perms/set-database-permission! (perms-group/all-users) (mt/id) :perms/create-queries :query-builder-and-native)
(perms/grant-collection-readwrite-permissions! (perms-group/all-users) collection)
@@ -87,7 +87,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:name "Original Name"
:content "SELECT 1"
@@ -129,7 +129,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-not-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:name "Original Name"
:content "SELECT 1"
@@ -152,7 +152,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:name "Test Snippet"
:content "SELECT 1"
@@ -172,7 +172,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:name "Test Snippet"
:content "SELECT 1"
@@ -193,7 +193,7 @@
(mt/with-premium-features #{:snippet-collections}
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:name "Test Snippet"
:content "SELECT 1"
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/spec_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/spec_test.clj
index 56f7afe392f..1755a30b0ee 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/spec_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/spec_test.clj
@@ -372,10 +372,21 @@
(deftest model-editable?-unknown-model-test
(testing "model-editable? returns true for models not in the spec"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(is (true? (spec/model-editable? :model/UnknownModel {}))
"Unknown models should always be editable"))))
+(deftest model-editable?-remote-sync-disabled-test
+ (testing "model-editable? returns true for every model while remote sync is not configured"
+ (mt/with-temporary-setting-values [remote-sync-url nil
+ remote-sync-type :read-only]
+ (is (true? (spec/model-editable? :model/DataApp {:draft false})))
+ (is (= {1 true} (spec/batch-model-editable? :model/DataApp [{:id 1 :draft false}]))))
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git"
+ remote-sync-type :read-only]
+ (is (false? (spec/model-editable? :model/DataApp {:draft false})))
+ (is (= {1 false} (spec/batch-model-editable? :model/DataApp [{:id 1 :draft false}]))))))
+
(deftest model-editable?-read-write-mode-test
(testing "model-editable? returns true in read-write mode regardless of eligibility"
(mt/with-temporary-setting-values [remote-sync-type :read-write]
@@ -387,12 +398,12 @@
(deftest model-editable?-library-synced-eligibility-test
(testing "model-editable? with :library-synced eligibility (NativeQuerySnippet)"
(testing "returns false when library is synced and mode is read-only"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection _ {:name "Library" :type "library" :is_remote_synced true :location "/"}]
(is (false? (spec/model-editable? :model/NativeQuerySnippet {}))
"Snippets should NOT be editable when library is synced and mode is read-only"))))
(testing "returns true when library is NOT synced even in read-only mode"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection _ {:name "Library" :type "library" :is_remote_synced false :location "/"}]
(is (true? (spec/model-editable? :model/NativeQuerySnippet {}))
"Snippets should be editable when library is NOT synced"))))))
@@ -400,12 +411,12 @@
(deftest model-editable?-setting-eligibility-test
(testing "model-editable? with :setting eligibility (Transform)"
(testing "returns false when setting is enabled and mode is read-only"
- (mt/with-temporary-setting-values [remote-sync-type :read-only
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only
remote-sync-transforms true]
(is (false? (spec/model-editable? :model/Transform {}))
"Transforms should NOT be editable when transforms setting is enabled and mode is read-only")))
(testing "returns true when setting is disabled even in read-only mode"
- (mt/with-temporary-setting-values [remote-sync-type :read-only
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only
remote-sync-transforms false]
(is (true? (spec/model-editable? :model/Transform {}))
"Transforms should be editable when transforms setting is disabled")))))
@@ -413,23 +424,23 @@
(deftest model-editable?-collection-eligibility-test
(testing "model-editable? with :collection eligibility (Card)"
(testing "returns false when card is in remote-synced collection and mode is read-only"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection {coll-id :id} {:name "Synced Collection" :is_remote_synced true :location "/"}]
(is (false? (spec/model-editable? :model/Card {:collection_id coll-id}))
"Cards in synced collections should NOT be editable in read-only mode"))))
(testing "returns true when card is in non-synced collection even in read-only mode"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection {coll-id :id} {:name "Normal Collection" :is_remote_synced false :location "/"}]
(is (true? (spec/model-editable? :model/Card {:collection_id coll-id}))
"Cards in non-synced collections should be editable"))))))
(deftest model-editable?-nil-instance-test
(testing "model-editable? works with nil instance for global eligibility models"
- (mt/with-temporary-setting-values [remote-sync-type :read-only
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only
remote-sync-transforms true]
(is (false? (spec/model-editable? :model/Transform nil))
"Transforms with nil instance should check setting-based eligibility"))
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection _ {:name "Library" :type "library" :is_remote_synced true :location "/"}]
(is (false? (spec/model-editable? :model/NativeQuerySnippet nil))
"Snippets with nil instance should check library-synced eligibility")))))
@@ -466,7 +477,7 @@
(deftest batch-model-editable?-unknown-model-test
(testing "batch-model-editable? returns true for all instances of unknown models"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(let [instances [{:id 1} {:id 2} {:id 3}]
result (spec/batch-model-editable? :model/UnknownModel instances)]
(is (= {1 true, 2 true, 3 true} result))))))
@@ -482,13 +493,13 @@
(deftest batch-model-editable?-library-synced-test
(testing "batch-model-editable? with :library-synced eligibility"
(testing "returns false for all when library is synced and mode is read-only"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection _ {:name "Library" :type "library" :is_remote_synced true :location "/"}]
(let [instances [{:id 1} {:id 2} {:id 3}]
result (spec/batch-model-editable? :model/NativeQuerySnippet instances)]
(is (= {1 false, 2 false, 3 false} result))))))
(testing "returns true for all when library is not synced"
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-temp [:model/Collection _ {:name "Library" :type "library" :is_remote_synced false :location "/"}]
(let [instances [{:id 1} {:id 2} {:id 3}]
result (spec/batch-model-editable? :model/NativeQuerySnippet instances)]
diff --git a/enterprise/backend/test/metabase_enterprise/snippet_collections/models/native_query_snippet/permissions_test.clj b/enterprise/backend/test/metabase_enterprise/snippet_collections/models/native_query_snippet/permissions_test.clj
index 949e5bdb04a..8c673544275 100644
--- a/enterprise/backend/test/metabase_enterprise/snippet_collections/models/native_query_snippet/permissions_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/snippet_collections/models/native_query_snippet/permissions_test.clj
@@ -101,7 +101,7 @@
(testing "Snippets are NOT writable when library is synced and mode is read-only"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:collection_id (:id collection)}]
@@ -115,7 +115,7 @@
(testing "Snippets cannot be created when library is synced and mode is read-only"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}]
(data-perms/set-database-permission! (perms-group/all-users) (mt/id) :perms/create-queries :query-builder-and-native)
@@ -128,7 +128,7 @@
(testing "Snippets cannot be updated when library is synced and mode is read-only"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:collection_id (:id collection)}]
@@ -142,7 +142,7 @@
(testing "Snippets are still readable when library is synced and mode is read-only"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:collection_id (:id collection)}]
@@ -170,7 +170,7 @@
(testing "Snippets ARE writable in read-only mode when library is NOT synced"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-not-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet {:collection_id (:id collection)}]
@@ -186,7 +186,7 @@
(testing "batched-hydrate :can_write respects remote-sync read-only mode"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet1 {:name "snippet1" :content "SELECT 1" :collection_id (:id collection)}
@@ -225,7 +225,7 @@
(testing "batched-hydrate :can_write allows writes when library is not synced"
(mt/with-premium-features #{:snippet-collections}
(collections.tu/with-library-not-synced
- (mt/with-temporary-setting-values [remote-sync-type :read-only]
+ (mt/with-temporary-setting-values [remote-sync-url "https://github.com/test/repo.git" remote-sync-type :read-only]
(mt/with-non-admin-groups-no-root-collection-for-namespace-perms "snippets"
(mt/with-temp [:model/Collection collection {:name "Test Collection", :namespace "snippets"}
:model/NativeQuerySnippet snippet1 {:name "snippet1" :content "SELECT 1" :collection_id (:id collection)}
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/AllChangesView.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/AllChangesView.unit.spec.tsx
index 08604010f4c..6883a1f179b 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/AllChangesView.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/AllChangesView.unit.spec.tsx
@@ -838,6 +838,31 @@ describe("AllChangesView", () => {
expect(screen.getByText("common.py")).toBeInTheDocument();
});
+ it("should group transform tests under Transforms with the test tube icon and no link", async () => {
+ const transformTestEntity = createMockRemoteSyncEntity({
+ id: 500,
+ name: "Orders are deduplicated",
+ model: "transformtest",
+ collection_id: undefined,
+ sync_status: "update",
+ });
+
+ setup({
+ entities: [transformTestEntity],
+ isTransformsSyncEnabled: true,
+ });
+
+ expect(
+ await screen.findByRole("link", { name: "Transforms" }),
+ ).toBeInTheDocument();
+ expect(screen.queryByText("Root")).not.toBeInTheDocument();
+ expect(screen.getByText("Orders are deduplicated")).toBeInTheDocument();
+ expect(screen.getByLabelText("test_tube icon")).toBeInTheDocument();
+ expect(
+ screen.queryByRole("link", { name: /Orders are deduplicated/ }),
+ ).not.toBeInTheDocument();
+ });
+
it("should group transforms-namespace collections under Transforms root", async () => {
const transformsCollection = createMockCollection({
id: 100,
@@ -1015,4 +1040,32 @@ describe("AllChangesView", () => {
).not.toBeInTheDocument();
});
});
+
+ describe("data apps", () => {
+ it("should group data apps under a Data apps root linked to the admin page", async () => {
+ const dataAppEntity = createMockRemoteSyncEntity({
+ id: 700,
+ name: "boba-staff-review",
+ model: "dataapp",
+ collection_id: undefined,
+ sync_status: "update",
+ });
+ const rootEntity = createMockRemoteSyncEntity({
+ id: 701,
+ name: "Root Question",
+ collection_id: undefined,
+ });
+
+ setup({ entities: [dataAppEntity, rootEntity] });
+
+ expect(
+ await screen.findByRole("link", { name: "Data apps" }),
+ ).toHaveAttribute("href", "/admin/settings/apps");
+ expect(screen.getByText("Root")).toBeInTheDocument();
+ expect(
+ screen.getByRole("link", { name: /boba-staff-review/ }),
+ ).toHaveAttribute("href", "/apps/boba-staff-review");
+ expect(screen.getAllByLabelText("app icon")).toHaveLength(2);
+ });
+ });
});
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/CollectionPath.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/CollectionPath.tsx
index b848a7c5633..e2be7419687 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/CollectionPath.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/CollectionPath.tsx
@@ -1,21 +1,23 @@
import { Fragment } from "react";
import { Anchor, Group, Text } from "metabase/ui";
-import { collection as collectionUrl, transformList } from "metabase/urls";
+import { collection as collectionUrl } from "metabase/urls";
-import { type CollectionPathSegment, TRANSFORMS_ROOT_ID } from "../../utils";
+import { getVirtualRoot } from "../../displayGroups";
+import type { CollectionPathSegment } from "../../utils";
interface CollectionPathProps {
segments: CollectionPathSegment[];
}
-const segmentUrl = (segment: CollectionPathSegment): string =>
- // The Transforms root is a virtual collection (sentinel id -1) with no real
- // collection page, so link it to the transforms list instead of building a
- // dead /collection/-1-... URL.
- segment.id === TRANSFORMS_ROOT_ID
- ? transformList()
+const segmentUrl = (segment: CollectionPathSegment): string => {
+ // Virtual roots (sentinel ids) have no real collection page, so link them to
+ // their list pages instead of building a dead /collection/-1-... URL.
+ const virtualRoot = getVirtualRoot(segment.id);
+ return virtualRoot
+ ? virtualRoot.url()
: collectionUrl({ id: segment.id, name: segment.name });
+};
// TODO: see if we can use the CollectionBreadcrumb component here
export const CollectionPath = ({ segments }: CollectionPathProps) => {
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/EntityLink.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/EntityLink.tsx
index e4a0c3d41a9..04becd3b9c8 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/EntityLink.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/ChangesLists/EntityLink.tsx
@@ -15,8 +15,8 @@ interface EntityLinkProps {
}
function getEntityUrl(entity: RemoteSyncEntity): string | null {
- // An action URL needs the parent model id, which dirty entries do not carry.
- if (entity.model === "action") {
+ // Action and transform test URLs need the parent entity id, which dirty entries do not carry.
+ if (entity.model === "action" || entity.model === "transformtest") {
return null;
}
return modelToUrl(entity);
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/displayGroups.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/displayGroups.ts
index d0cca765c93..ac77c30fcc8 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/displayGroups.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/displayGroups.ts
@@ -2,6 +2,7 @@ import { t } from "ttag";
import _ from "underscore";
import { isLibraryCollection } from "metabase/common/collections/utils";
+import { dataAppsSettings, transformList } from "metabase/urls";
import type {
Collection,
CollectionId,
@@ -17,6 +18,23 @@ import type {
*/
export const TRANSFORMS_ROOT_ID = -1;
+/**
+ * Sentinel value for the virtual Data apps root collection.
+ */
+const DATA_APPS_ROOT_ID = -2;
+
+/**
+ * A synthetic root collection for a group whose entities have no real one.
+ */
+export type VirtualRoot = {
+ /** Sentinel collection ID (e.g., -1 for Transforms) */
+ id: number;
+ /** i18n function for the root's name */
+ name: () => string;
+ /** Page the root links to, since it has no collection page */
+ url: () => string;
+};
+
/**
* Configuration for how entities are grouped and displayed in the changes view.
* Similar to the backend remote-sync-specs pattern.
@@ -28,10 +46,8 @@ export type DisplayGroupSpec = {
namespace?: string;
/** Model types that belong to this group */
models?: Set<RemoteSyncEntityModel>;
- /** Virtual root ID for groups that have a synthetic root (e.g., -1 for Transforms) */
- virtualRootId?: number;
- /** i18n function for virtual root name */
- virtualRootName?: () => string;
+ /** Synthetic root for groups whose entities have no real collection */
+ virtualRoot?: VirtualRoot;
/** Icon to display for this group's collections */
icon: IconName;
/** ID of another group whose path should be prepended */
@@ -48,9 +64,17 @@ const displayGroupSpecs: DisplayGroupSpec[] = [
{
id: "transforms",
namespace: "transforms",
- models: new Set(["transform", "transformtag", "pythonlibrary"]),
- virtualRootId: TRANSFORMS_ROOT_ID,
- virtualRootName: () => t`Transforms`,
+ models: new Set([
+ "transform",
+ "transformtag",
+ "transformtest",
+ "pythonlibrary",
+ ]),
+ virtualRoot: {
+ id: TRANSFORMS_ROOT_ID,
+ name: () => t`Transforms`,
+ url: transformList,
+ },
icon: "transform",
priority: 100,
},
@@ -69,6 +93,17 @@ const displayGroupSpecs: DisplayGroupSpec[] = [
pathPrefixGroupId: "library",
priority: 80,
},
+ {
+ id: "data-apps",
+ models: new Set(["dataapp"]),
+ virtualRoot: {
+ id: DATA_APPS_ROOT_ID,
+ name: () => t`Data apps`,
+ url: dataAppsSettings,
+ },
+ icon: "app",
+ priority: 70,
+ },
{
id: "tables",
models: new Set(["table", "field", "segment", "measure"]),
@@ -174,6 +209,9 @@ const getGroupKeyInfo = (
}
return { groupKey: entity.collection_id, spec };
}
+ if (spec.virtualRoot) {
+ return { groupKey: spec.virtualRoot.id, spec };
+ }
if (entity.collection_id != null) {
return { groupKey: entity.collection_id, spec };
}
@@ -241,8 +279,8 @@ const getPathPrefixSegments = (
collectionMap: Map<number, Collection>,
libraryCollectionId: number | null,
): CollectionPathSegment[] => {
- if (spec.id === "transforms" && spec.virtualRootId != null) {
- return [{ id: spec.virtualRootId, name: spec.virtualRootName?.() ?? "" }];
+ if (spec.id === "transforms" && spec.virtualRoot) {
+ return [getVirtualRootSegment(spec.virtualRoot)];
}
if (
spec.pathPrefixGroupId === "library" &&
@@ -259,6 +297,16 @@ const getPathPrefixSegments = (
return [];
};
+/**
+ * Get the virtual root with this sentinel collection ID.
+ */
+export const getVirtualRoot = (id: CollectionId): VirtualRoot | undefined =>
+ displayGroupSpecs.find((spec) => spec.virtualRoot?.id === id)?.virtualRoot;
+
+const getVirtualRootSegment = (
+ virtualRoot: VirtualRoot,
+): CollectionPathSegment => ({ id: virtualRoot.id, name: virtualRoot.name() });
+
/**
* Get the spec by ID.
*/
@@ -425,8 +473,10 @@ const buildCollectionGroup = ({
? TRANSFORMS_ROOT_ID
: Number(collectionId) || undefined;
- let pathSegments = isTransformsRoot
- ? [{ id: TRANSFORMS_ROOT_ID, name: t`Transforms` }]
+ const virtualRoot =
+ numericCollectionId != null ? getVirtualRoot(numericCollectionId) : null;
+ let pathSegments = virtualRoot
+ ? [getVirtualRootSegment(virtualRoot)]
: getCollectionPathSegments(numericCollectionId, collectionMap);
const prefixSegments = getPathPrefixSegments(
groupSpec,
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.ts
index 97714766e66..3c504f88597 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.ts
@@ -52,12 +52,13 @@ export function useHasTransformDirtyChanges(): boolean {
);
// Check if any dirty entity is:
- // 1. A transform, transform tag, or Python library
+ // 1. A transform, transform tag, transform test, or Python library
// 2. A collection in the transforms namespace
return dirty.some((entity) => {
if (
entity.model === "transform" ||
entity.model === "transformtag" ||
+ entity.model === "transformtest" ||
entity.model === "pythonlibrary"
) {
return true;
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.unit.spec.ts
index 8b4a345ca90..92cb090f9fe 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/hooks/use-has-transform-dirty-changes.unit.spec.ts
@@ -131,6 +131,17 @@ describe("useHasTransformDirtyChanges", () => {
});
});
+ it("returns true when a transform test entity is dirty", async () => {
+ const { result } = setup({
+ collections: [createMockTransformsCollection()],
+ dirty: [createMockRemoteSyncEntity({ model: "transformtest" })],
+ });
+
+ await waitFor(() => {
+ expect(result.current).toBe(true);
+ });
+ });
+
it("returns true when a transform tag entity is dirty", async () => {
const { result } = setup({
collections: [createMockTransformsCollection()],
diff --git a/frontend/src/metabase-types/api/remote-sync.ts b/frontend/src/metabase-types/api/remote-sync.ts
index 048a23d068c..e32611a8472 100644
--- a/frontend/src/metabase-types/api/remote-sync.ts
+++ b/frontend/src/metabase-types/api/remote-sync.ts
@@ -19,8 +19,10 @@ export type RemoteSyncEntityModel =
| "transform"
| "transformtag"
| "transformjob"
+ | "transformtest"
| "pythonlibrary"
- | "glossary";
+ | "glossary"
+ | "dataapp";
export type RemoteSyncEntityStatus =
| "create"
diff --git a/frontend/src/metabase/common/utils/icon.ts b/frontend/src/metabase/common/utils/icon.ts
index e2da2cf46d4..6f6927a7c06 100644
--- a/frontend/src/metabase/common/utils/icon.ts
+++ b/frontend/src/metabase/common/utils/icon.ts
@@ -20,7 +20,9 @@ export type IconModel =
| "user"
| "nativequerysnippet"
| "pythonlibrary"
- | "glossary";
+ | "glossary"
+ | "dataapp"
+ | "transformtest";
export type ObjectWithModel = {
id?: unknown;
@@ -62,6 +64,8 @@ export const modelIconMap: Record<IconModel, IconName> = {
pythonlibrary: "code_block",
glossary: "glossary",
exploration: "telescope",
+ dataapp: "app",
+ transformtest: "test_tube",
};
export type IconData = {
diff --git a/frontend/src/metabase/urls/data-apps.ts b/frontend/src/metabase/urls/data-apps.ts
index db9cedb5ef0..2929bd0684d 100644
--- a/frontend/src/metabase/urls/data-apps.ts
+++ b/frontend/src/metabase/urls/data-apps.ts
@@ -25,3 +25,8 @@ export const DATA_APP_REALM_HOST_URL = "/api/apps/sandbox-host";
export function dataApp(name: string) {
return `${DATA_APP_ROOT_URL}/${encodeURIComponent(name)}`;
}
+
+/** Admin page listing the data apps: `/admin/settings/apps`. */
+export function dataAppsSettings() {
+ return `/admin/settings/${DATA_APP_URL_SEGMENT}`;
+}
diff --git a/frontend/src/metabase/urls/modelToUrl.ts b/frontend/src/metabase/urls/modelToUrl.ts
index d666b893eba..9fdcfa871dc 100644
--- a/frontend/src/metabase/urls/modelToUrl.ts
+++ b/frontend/src/metabase/urls/modelToUrl.ts
@@ -12,6 +12,7 @@ import { browseDatabase } from "./browse";
import { card } from "./cards";
import { collection } from "./collections";
import { dashboard } from "./dashboards";
+import { dataApp } from "./data-apps";
import {
dataStudioGlossary,
dataStudioPublishedTableMeasure,
@@ -101,6 +102,8 @@ export function modelToUrl(item: UrlableModel): string {
return exploration(item.id);
case "glossary":
return dataStudioGlossary();
+ case "dataapp":
+ return dataApp(item.name);
default:
return NOT_FOUND_URL;
}