Skip to content

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

Use partial settings update when switching branches during Remote Sync conflict (#69874)

Anderson5e6eb552e34f
diff --git a/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj b/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj
index 873b0dac70b..78c21b7e08b 100644
--- a/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj
+++ b/enterprise/backend/src/metabase_enterprise/remote_sync/settings.clj
@@ -197,21 +197,24 @@
Throws ExceptionInfo if the git settings are invalid or if unable to connect to the repository."
[{:keys [remote-sync-url remote-sync-token] :as settings}]
- (if (and (contains? settings :remote-sync-url)
- (str/blank? remote-sync-url))
- (t2/with-transaction [_conn]
- (setting/set! :remote-sync-url nil)
- (setting/set! :remote-sync-token nil)
- (setting/set! :remote-sync-branch nil))
- (let [current-token (setting/get :remote-sync-token)
- obfuscated? (= remote-sync-token (setting/obfuscate-value current-token))
- token-to-check (if obfuscated? current-token remote-sync-token)
- _ (check-git-settings! (assoc settings :remote-sync-token token-to-check))]
+ (let [git-related-keys #{:remote-sync-url :remote-sync-token :remote-sync-type :remote-sync-branch}
+ updating-git-settings? (some git-related-keys (keys settings))]
+ (if (and (contains? settings :remote-sync-url)
+ (str/blank? remote-sync-url))
(t2/with-transaction [_conn]
- (doseq [k [:remote-sync-url :remote-sync-token :remote-sync-type :remote-sync-branch :remote-sync-auto-import :remote-sync-transforms]]
- (when (and (contains? settings k)
- (not (and (= k :remote-sync-token) obfuscated?)))
- (setting/set! k (k settings))))))))
+ (setting/set! :remote-sync-url nil)
+ (setting/set! :remote-sync-token nil)
+ (setting/set! :remote-sync-branch nil))
+ (let [current-token (setting/get :remote-sync-token)
+ obfuscated? (= remote-sync-token (setting/obfuscate-value current-token))
+ token-to-check (if obfuscated? current-token remote-sync-token)
+ _ (when updating-git-settings?
+ (check-git-settings! (assoc settings :remote-sync-token token-to-check)))]
+ (t2/with-transaction [_conn]
+ (doseq [k [:remote-sync-url :remote-sync-token :remote-sync-type :remote-sync-branch :remote-sync-auto-import :remote-sync-transforms]]
+ (when (and (contains? settings k)
+ (not (and (= k :remote-sync-token) obfuscated?)))
+ (setting/set! k (k settings)))))))))
(defn library-is-remote-synced?
"Returns true if the Library collection exists and is remote-synced.
diff --git a/enterprise/backend/test/metabase_enterprise/remote_sync/settings_test.clj b/enterprise/backend/test/metabase_enterprise/remote_sync/settings_test.clj
index fc0af503da6..6d7bf6ad178 100644
--- a/enterprise/backend/test/metabase_enterprise/remote_sync/settings_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/remote_sync/settings_test.clj
@@ -44,6 +44,54 @@
(settings/check-and-update-remote-settings! (assoc default-settings :remote-sync-token nil))
(is (= nil (settings/remote-sync-token))))))))
+(deftest check-and-update-remote-settings-partial-updates
+ (testing "Partial updates for non-git settings do not trigger git validation"
+ (let [git-check-called? (atom false)]
+ (with-redefs [settings/check-git-settings! (fn [_]
+ (reset! git-check-called? true)
+ true)]
+ (mt/with-temporary-setting-values [:remote-sync-transforms false
+ :remote-sync-auto-import false]
+ (testing "Updating only remote-sync-transforms does not check git settings"
+ (reset! git-check-called? false)
+ (settings/check-and-update-remote-settings! {:remote-sync-transforms true})
+ (is (false? @git-check-called?) "Git validation should not be called for transforms-only update")
+ (is (true? (settings/remote-sync-transforms))))
+
+ (testing "Updating only remote-sync-auto-import does not check git settings"
+ (reset! git-check-called? false)
+ (settings/check-and-update-remote-settings! {:remote-sync-auto-import true})
+ (is (false? @git-check-called?) "Git validation should not be called for auto-import-only update")
+ (is (true? (settings/remote-sync-auto-import))))
+
+ (testing "Updating both non-git settings does not check git settings"
+ (reset! git-check-called? false)
+ (settings/check-and-update-remote-settings! {:remote-sync-transforms false
+ :remote-sync-auto-import false})
+ (is (false? @git-check-called?) "Git validation should not be called for non-git settings")
+ (is (false? (settings/remote-sync-transforms)))
+ (is (false? (settings/remote-sync-auto-import))))))))
+
+ (testing "Partial updates with git-related settings do trigger git validation"
+ (let [git-check-called? (atom false)]
+ (with-redefs [settings/check-git-settings! (fn [_]
+ (reset! git-check-called? true)
+ true)]
+ (mt/with-temporary-setting-values [:remote-sync-url "file://my/url.git"
+ :remote-sync-type :read-only
+ :remote-sync-branch "main"]
+ (testing "Updating remote-sync-type triggers git validation"
+ (reset! git-check-called? false)
+ (settings/check-and-update-remote-settings! {:remote-sync-type :read-write})
+ (is (true? @git-check-called?) "Git validation should be called when updating type")
+ (is (= :read-write (settings/remote-sync-type))))
+
+ (testing "Updating remote-sync-branch triggers git validation"
+ (reset! git-check-called? false)
+ (settings/check-and-update-remote-settings! {:remote-sync-branch "develop"})
+ (is (true? @git-check-called?) "Git validation should be called when updating branch")
+ (is (= "develop" (settings/remote-sync-branch)))))))))
+
(deftest check-git-settings-rejects-non-https-urls
(testing "git:// URLs are rejected with a helpful error message"
(is (thrown-with-msg? clojure.lang.ExceptionInfo
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncConflictModal/SyncConflictModal.tsx b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncConflictModal/SyncConflictModal.tsx
index 309cae1597b..78adb7aeed3 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncConflictModal/SyncConflictModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/components/SyncConflictModal/SyncConflictModal.tsx
@@ -1,10 +1,7 @@
import { useCallback, useMemo, useState } from "react";
import { t } from "ttag";
-import {
- useGetAdminSettingsDetailsQuery,
- useGetSettingsQuery,
-} from "metabase/api";
+import { useGetSettingsQuery } from "metabase/api";
import { useSetting } from "metabase/common/hooks";
import { useMetadataToasts } from "metabase/metadata/hooks";
import { Box, Button, Group, Icon, Modal } from "metabase/ui";
@@ -15,13 +12,9 @@ import {
} from "metabase-enterprise/api";
import { useGetLibraryCollection } from "metabase-enterprise/data-studio/library/utils";
import {
- BRANCH_KEY,
COLLECTIONS_KEY,
REMOTE_SYNC_KEY,
- TOKEN_KEY,
TRANSFORMS_KEY,
- TYPE_KEY,
- URL_KEY,
} from "metabase-enterprise/remote_sync/constants";
import { getIsRemoteSyncReadOnly } from "metabase-enterprise/remote_sync/selectors";
import type {
@@ -60,7 +53,6 @@ export const SyncConflictModal = (props: UnsyncedWarningModalProps) => {
const isRemoteSyncEnabled = !!useSetting(REMOTE_SYNC_KEY);
const isRemoteSyncReadOnly = useSelector(getIsRemoteSyncReadOnly);
const { data: settingValues } = useGetSettingsQuery();
- const { data: settingDetails } = useGetAdminSettingsDetailsQuery();
const { data: libraryCollection } = useGetLibraryCollection({
skip: !isRemoteSyncEnabled,
});
@@ -80,14 +72,9 @@ export const SyncConflictModal = (props: UnsyncedWarningModalProps) => {
const markLibraryAndTransformsAsSynced = useCallback(async () => {
try {
const remoteSyncSettings: RemoteSyncConfigurationSettings = {
- [URL_KEY]: settingDetails?.[URL_KEY]?.value || null,
- [TOKEN_KEY]: settingDetails?.[TOKEN_KEY]?.value || null,
- [BRANCH_KEY]: settingValues?.[BRANCH_KEY] || null,
- [TYPE_KEY]: settingValues?.[TYPE_KEY] || null,
[COLLECTIONS_KEY]: (settingValues as RemoteSyncConfigurationSettings)[
COLLECTIONS_KEY
],
- [REMOTE_SYNC_KEY]: true,
[TRANSFORMS_KEY]: true,
};
@@ -106,7 +93,6 @@ export const SyncConflictModal = (props: UnsyncedWarningModalProps) => {
}, [
libraryCollection?.id,
sendErrorToast,
- settingDetails,
settingValues,
updateRemoteSyncSettings,
]);