Preserve dirty user data on domain removal#9436
Merged
Conversation
i2h3
added
bug
feature: 📁 file provider
github-project-automation
bot
moved this to 🧭 Planning evaluation (don't pick)
in 💻 Desktop Clients team
i2h3
moved this from 🧭 Planning evaluation (don't pick)
to 🏗️ In progress
in 💻 Desktop Clients team
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a macOS Virtual Files data-loss scenario by preserving “dirty” (locally modified but not yet uploaded) File Provider content when a File Provider domain is removed, and adds user-facing notification/diagnostics to reduce the chance of silent loss.
Changes:
- Switch File Provider domain removal to preserve dirty user data and add a helper to locate the domain’s user-visible root URL.
- Add XPC plumbing + extension implementation to detect whether the File Provider has dirty user data.
- Add a new
DirtyUserDataObserverplus Swift Testing coverage, and document testing conventions inAGENTS.md.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| src/gui/macOS/fileproviderxpc_mac.mm | Adds synchronous XPC call to query dirty user data state. |
| src/gui/macOS/fileproviderxpc.h | Exposes dirty-user-data query on the XPC wrapper. |
| src/gui/macOS/fileprovidersettingscontroller_mac.mm | Warns users and opens Finder when dirty data is detected before domain removal. |
| src/gui/macOS/fileproviderdomainmanager.mm | Uses preserve-dirty removal mode and adds user-visible URL lookup for a domain. |
| src/gui/macOS/fileproviderdomainmanager.h | Declares userVisibleUrlForDomainIdentifier. |
| shell_integration/.../ClientCommunicationProtocol.h | Extends XPC protocol with dirty-user-data query method. |
| shell_integration/.../FileProviderExtension+ClientCommunicationProtocol.swift | Implements dirty-user-data check in the extension via materialized item enumeration. |
| shell_integration/.../DirtyUserDataObserver.swift | Adds enumeration observer that detects unuploaded items. |
| shell_integration/.../DirtyUserDataObserverTests.swift | Adds Swift Testing suite for the observer. |
| shell_integration/.../FileProviderItemMock.swift | Adds a minimal mock item for observer tests. |
| AGENTS.md | Adds Swift Testing conventions and guidance for mocks/tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...ProviderKit/Tests/NextcloudFileProviderKitTests/Enumeration/DirtyUserDataObserverTests.swift
Show resolved
Hide resolved
...loudFileProviderKit/Sources/NextcloudFileProviderKit/Enumeration/DirtyUserDataObserver.swift
Show resolved
Hide resolved
...NextcloudIntegration/FileProviderExt/FileProviderExtension+ClientCommunicationProtocol.swift
Outdated
Show resolved
Hide resolved
i2h3
force-pushed
the
i2h3/fix/9417-domain-removal-mode
branch
from
3a71f89 to
617edca
Compare
Signed-off-by: Iva Horn <[email protected]>
i2h3
force-pushed
the
i2h3/fix/9417-domain-removal-mode
branch
from
617edca to
4107f3c
Compare
|
Artifact containing the AppImage: nextcloud-appimage-pr-9436.zip Digest: To test this change/fix you can download the above artifact file, unzip it, and run it. Please make sure to quit your existing Nextcloud app and backup your data. |
|
github-project-automation
bot
moved this from 🏗️ In progress
to ☑️ Done
in 💻 Desktop Clients team
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary: Closes #9417 because client-side data loss of unsynchronized items on file provider domain removal is prevented.
This also matches the behavior of iCloud Drive when it is disabled on a Mac.
In case of "dirty user data" a timestamped folder in
~/Library/CloudStoragewill be created by macOS which contains all unsynchronized items. This avoids data loss on the client side when removing the file provider domain for a Nextcloud client account and does not conflict when the account possibly is set up anew.The client reveals that folder on removal.
Also, this pull request disables the checkbox for the duration of setup or cleanup of a file provider domain, so race conditions and so on can be avoided by waiting for the transactions to complete.