Feature: adjust conflict resolution to new behavior #70
Conversation
WalkthroughThe document on synchronization conflicts in encrypted file management has been expanded and clarified. It now explicitly states that Cryptomator appends the cloud provider’s conflict suffix to the decrypted filename, shortens the filename if it becomes too long, and uses a simple integer suffix "(X)" if the preferred name is already taken. A detailed table illustrating various conflict scenarios, cloud provider suffixes, original decrypted filenames, and resulting new decrypted filenames has been added. The note about manual conflict resolution has been reformatted for readability. The explanation clarifies that Cryptomator detects unexpected patterns in encrypted filenames and renames conflicted files by decrypting the encrypted part and appending the conflict suffix. The example filename was updated from "document.txt" to "projectPlan.doc" with a corresponding suffix example. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
source/desktop/sync-conflicts.rst (1)
23-23: Duplicate: Conflict suffix table formatting
The "New Decrypted Name" cell is missing a closing parenthesis and the file extension appears truncated, e.g.:businessPitchForTheGreatIdeaI (Created by Alice on 2024-01.odpPlease correct the truncation so the suffix and extension are complete.
🧹 Nitpick comments (5)
source/desktop/sync-conflicts.rst (5)
4-5: Refine repetition in the introductory sentence
The phrase "Working on encrypted data from multiple locations works the same as working on unencrypted data from multiple locations." is redundant. Consider streamlining to avoid the repeated "working on".Proposed change:
-Working on encrypted data from multiple locations works the same as working on unencrypted data from multiple locations. +Working on encrypted data from multiple locations is the same as working on unencrypted data from multiple locations.
7-8: Improve active voice and sentence flow
" You then need to determine which file to keep." is wordy. A more direct instruction improves readability.-You then need to determine which file to keep. +Decide which file to keep.
10-13: Maintain parallel sentence structure
Line 13 starts with "And", which breaks the parallelism with the prior sentences. Replace with "If" for consistency.-And if the decrypted filename already exists, the conflicted file has a simple ``(X)`` suffix, where X is an integer. +If the decrypted filename already exists, the conflicted file has a simple ``(X)`` suffix, where X is an integer.
29-32: Add missing period and ensure consistent punctuation
Line 31 (“It is recommended to manually check both files and determine which one to keep”) is missing a period. Ensure all lines in this note block end with proper punctuation.-It is recommended to manually check both files and determine which one to keep +It is recommended to manually check both files and determine which one to keep.
38-38: Clarify table reference and punctuation
The sentence ends without a period and could be more precise. Consider:-1. When a sync conflict is detected, Cryptomator will display the conflicted file with a suffix, see above table +1. When a sync conflict is detected, Cryptomator will display the conflicted file with a suffix, as shown in the table above.
📜 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 (3)
source/desktop/sync-conflicts.rst (3)
48-49: Clearer example filename
The updated example usingprojectPlan.docis more concrete thandocument.txtand aligns well with later references.
51-52: Approve conflict detection explanation
The new wording clarifies that conflicts occur on the encrypted filename and describes the detection mechanism succinctly.
54-55: Approve example mapping from encrypted to decrypted
The example demonstrating decryption of the encrypted filename and renaming with the conflict suffix is clear and accurate.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Depends on cryptomator/cryptomator#3707 and a new release.
Technical details taken from cryptomator/cryptofs#275