Feature: adjust conflict resolution to new behavior #70
Conversation
WalkthroughThe changes modify the document addressing synchronization conflicts in encrypted data management. The original sentence about handling conflicts has been split into two sentences to improve clarity. The description of conflict suffixes has changed from a generic numerical format to a more descriptive one (for example, using a creator’s name). A table has been added to illustrate various scenarios of conflict suffix application, showing how filenames are modified under different circumstances. Additionally, the note section has been reformatted into separate lines to improve readability. The steps for handling sync conflicts now refer to the descriptive suffix format rather than an increasing integer indicator. An example within the document was also updated, changing the filename to better align with the new suffix approach. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/desktop/sync-conflicts.rst (3)
10-13: Detailed Conflict Resolution Behavior
This section outlines how Cryptomator handles conflicts by detecting them, appending the cloud provider’s suffix to the decrypted filename, and managing long filenames. The detailed steps add valuable clarity. Consider adding more specifics (if available) regarding any limitations on filename shortening.
24-28: Reformatted Note Section Improves Readability
Breaking the note into separate, indented lines improves clarity and makes the recommendations stand out. Ensure the indentation and punctuation are consistent with the rest of the document for a polished look.
33-33: Improved Step Instruction in Handling Sync Conflicts
Updating the first step to reference the detailed table enhances the clarity on how conflicts are displayed. A minor suggestion: adding a period at the end of the sentence could improve the consistency of the numbered list.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/desktop/sync-conflicts.rst(2 hunks)
🔇 Additional comments (5)
source/desktop/sync-conflicts.rst (5)
4-5: Enhanced Description of Encrypted Data Operations
The added sentences clarify that working on encrypted data from multiple locations follows similar principles as unencrypted data, and that synchronization conflicts are handled similarly to common cloud storage approaches. The explanation is clear and sets a good context for the reader.
7-8: Clear Conflict File Creation Explanation
These lines now clearly explain that when a sync conflict occurs, a descriptive suffix (e.g., “(Created by Alice)”) is appended by the cloud service, prompting the user to decide which file to keep. This aligns well with the intended new behavior.
43-44: Updated Example Filename to Reflect New Behavior
Switching the example filename to “projectPlan.doc” effectively demonstrates the new conflict suffix handling. This change clearly aligns with the revised descriptive format explained earlier.
46-47: Clear Explanation of Encrypted Filename Conflict Handling
The explanation that synchronization conflicts occur on the encrypted filename—and that Cryptomator uses decryption to handle these—is now clear and informative. This helps users understand the behind-the-scenes process.
49-50: Practical Example Demonstrates Conflict Resolution Process
The final example shows how a file is renamed by incorporating a conflict suffix, reinforcing the new behavior described in both the text and the table. Verify that the example remains consistent with the table’s details for complete clarity.
| | cloud provider suffix | original decrypted name | new decrypted name | comment | | ||
| |------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------| | ||
| | (Created by Alice) | businessPitch.odp | businessPitch (Created by Alice).odp | regular case | | ||
| | (Created by Alice) | businessPitch.odp | businessPitch (1).odp | preferred name already taken | | ||
| | (Created by Alice on 2024-01-31) | businessPitchForTheGreatIdeaIHadLastNight.odp | businessPitchForTheGreatIdeaI (Created by Alice on 2024-01.odp | maximum cleartext of the vault is set to 62 | |
There was a problem hiding this comment.
Conflict Suffix Table Formatting Issue
The table provides an excellent overview of how conflict resolution transforms filenames. However, in the third row (line 19), the "new decrypted name" appears misformatted (e.g., it seems to be missing a closing parenthesis or has an incomplete truncation indicator). Please review and correct this formatting to prevent potential confusion.
Depends on cryptomator/cryptomator#3707 and a new release.
Technical details taken from cryptomator/cryptofs#275