cryptomator / cryptofs

Java Filesystem Provider with integrated encryption
GNU Affero General Public License v3.0
94 stars 35 forks source link

Feature: First close file channel, then persist lastModified #228

Closed infeo closed 3 months ago

infeo commented 4 months ago

This PR changes the logic of persisting the lastModfied date from before closing the ciphertext channel to afterwards. Additionally, the cryptofs internal lastModifiedDate is always updated, even when persisting to storage fails.

This impl change is motivated by the behaviour of some fs/storage implemenations, which set the lastModified time to "now" when closing a channel, regardless of changes made.

Before merging, we should test the implementation with different scenarios: OneDrive pCloud GoogleDrive iCloud Dropbox LocalFS
Windows ❓1
macOS
Linux ➖ 2 ➖ 2 ➖ 2 ➖ 2 ➖ 2

The test was to edit and save an spreadsheet/document file and copying files of different sizes into the vault.

1: iCloud on Windows is... strange. First of all, everything copied into the iCloud dir gets as mTime the current time. Inside a Cryptomator vault, this becomes even stranger. Sometimes, the files are set to the current time, but especially bigger files (<30MB) get ... "some" time. "Some" can be the current, the former file mTime or something in between.

2: On Linux there are no offical filesystem integrations. GNOME offers "online account", but these are not accessible from the filesystem.

coderabbitai[bot] commented 4 months ago

Walkthrough

Overall, the changes improve the handling of file attributes and channel closures in the Cryptomator project. Key modifications include the restructuring of methods for better readability, the removal of unnecessary exception declarations, and enhanced testability. These adjustments ensure a more robust, maintainable, and test-friendly codebase.

Changes

File Path Change Summary
src/.../CryptoBasicFileAttributeView.java Modified setTimes method to set ciphertext attributes before checking and setting last modified time.
src/.../ChannelCloseListener.java Updated closed method signature to remove throws IOException.
src/.../CleartextFileChannel.java Annotated flush with @VisibleForTesting, refactored implCloseChannel, and added new helper methods.
src/.../OpenCryptoFile.java Refined channelClosed method to ensure correct file closure logic.
src/test/.../CleartextFileChannelTest.java Removed unused imports and adjusted tests for new method signatures and order verification.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CryptoBasicFileAttributeView
    participant Filesystem
    participant CleartextFileChannel
    participant OpenCryptoFile

    User ->> CryptoBasicFileAttributeView: setTimes(lastModifiedTime, lastAccessTime, createTime)
    CryptoBasicFileAttributeView ->> Filesystem: Set ciphertext attributes
    CryptoBasicFileAttributeView ->> OpenCryptoFile: Check and set last modified time

    User ->> CleartextFileChannel: Close Channel
    CleartextFileChannel ->> OpenCryptoFile: channelClosed(cleartextFileChannel)
    OpenCryptoFile ->> CleartextFileChannel: Close if no open channels
    CleartextFileChannel ->> Filesystem: Flush and close

Poem

In Cryptomator's code we delve,
Refactoring methods, oh so swell.
Channels close with graceful ease,
Testing's simpler, bugs appease.
Attributes set, secure and right,
In the codebase, shines the light.


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - 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 testing code 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 and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.