Feature: Flush cipherChannel before persisting lastModifed

[infeo]

Fixes #205.

See also #205 (comment).

Summary by CodeRabbit

• Refactor
  • Improved the reliability of file handling during close operations.
• Tests
  • Added new tests to ensure file changes are correctly persisted upon closing.

[coderabbitai]

Walkthrough

The modifications primarily address an issue with the Cryptomator project, where the order of operations during the closing of a cleartext file channel could inadvertently alter the lastModified timestamp. The changes ensure that the ciphertext channel is flushed before the last modified time is set, aligning with the objective to maintain data integrity by syncing file write operations with timestamp corrections.

Changes

File Path	Change Summary
.../cryptofs/ch/CleartextFileChannel.java	Added import, made persistLastModified method visible for testing, added force in implCloseChannel
.../cryptofs/ch/CleartextFileChannelTest.java	Added imports for Mockito, added testCloseFlushBeforePersist method

Assessment against linked issues

Objective	Addressed	Explanation
Investigate the issue where closing the cleartext file channel might change the lastModified timestamp (#205)	✅
Ensure the ciphertext channel is explicitly flushed before setting the last modified time (#205)	✅
Evaluate the impact of the current close process on the lastModified timestamp and propose a solution (#205)	✅
Review the flush() method in CleartextFileChannel for synchronization of file operations with timestamp (#205)	❓	The provided summary does not detail changes to the flush() method, making it unclear if this review occurred.
Verify the functionality of the close listener in OpenCryptoFile for proper deregistration and closure (#205)	❌	The summary does not mention modifications related to the close listener functionality.

Poem

In the realm of bytes and bits, a rabbit hopped and fixed the glitches,
With a leap and a bound, it patched the code, where time stamps twitched.
🐇💻✨
Through the cryptic maze, it danced, ensuring data's faithful stance,
Now close the file, have no fear, for the rabbit's magic keeps it clear.
🌟📁🛡️

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between dae30ac and 35f63e0.

Files selected for processing (2)

• src/main/java/org/cryptomator/cryptofs/ch/CleartextFileChannel.java (3 hunks)
• src/test/java/org/cryptomator/cryptofs/ch/CleartextFileChannelTest.java (2 hunks)

Additional comments: 5

src/main/java/org/cryptomator/cryptofs/ch/CleartextFileChannel.java (3)

• 3-3: The addition of com.google.common.annotations.VisibleForTesting import is appropriate for the change in visibility of persistLastModified to facilitate testing.
• 249-250: Changing the visibility of persistLastModified to @VisibleForTesting is a good practice to indicate that the method's visibility is increased for testing purposes.
• 327-327: The explicit call to ciphertextFileChannel.force(true) before persistLastModified ensures that any pending changes are flushed to disk before updating the lastModified timestamp, aligning with the PR's objective.

src/test/java/org/cryptomator/cryptofs/ch/CleartextFileChannelTest.java (2)

• 54-56: The addition of import static org.mockito.Mockito.inOrder; and import static org.mockito.Mockito.spy; is necessary for the new test method testCloseFlushBeforePersist to verify the order of method calls.
• 245-254: The new test method testCloseFlushBeforePersist correctly verifies that force(true) on ciphertextFileChannel is called before persistLastModified, ensuring the intended order of operations during channel closure. This aligns with the changes made in CleartextFileChannel.java.