cryptomator / cryptofs

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

Refactoring: Simplify OpenCryptoFile #238

Open infeo opened 3 months ago

infeo commented 3 months ago

As already observed in other PRs, the class OpenCryptoFile can be simplified. This PR applies these simplifications.

coderabbitai[bot] commented 3 months ago

Walkthrough

The recent changes include significant modifications across several classes to enhance functionality and simplify management of file channels. Key updates involve replacing specific listener implementations with more generic Runnable interfaces, introducing a new ChunkIO dependency for improved chunk management, and streamlining the code by removing unnecessary parameters and data structures. These adjustments aim to boost performance and clarity while ensuring robust handling of file operations.

Changes

Files Change Summary
src/main/java/org/cryptomator/cryptofs/ch/ChannelComponent.java, src/main/java/org/cryptomator/cryptofs/ch/CleartextFileChannel.java, src/test/java/org/cryptomator/cryptofs/ch/CleartextFileChannelTest.java Updated method signatures to replace ChannelCloseListener with Runnable, enhancing flexibility in channel closure handling. Introduced ChunkIO for better chunk management.
src/main/java/org/cryptomator/cryptofs/fh/ChunkIO.java Changed visibility of ChunkIO class from package-private to public, improving accessibility across packages.
src/main/java/org/cryptomator/cryptofs/fh/OpenCryptoFile.java, src/test/java/org/cryptomator/cryptofs/fh/OpenCryptoFileTest.java Removed ChunkIO dependencies from constructors, simplifying channel management. Updated tests accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ChannelComponent
    participant CleartextFileChannel
    participant ChunkIO

    Client->>ChannelComponent: create(ciphertextChannel, options, closeListener)
    ChannelComponent->>CleartextFileChannel: new CleartextFileChannel(ciphertextChannel, chunkIO, ...)
    CleartextFileChannel->>ChunkIO: registerChannel(ciphertextChannel)
    Client->>CleartextFileChannel: close()
    CleartextFileChannel->>ChunkIO: unregisterChannel(ciphertextChannel)

πŸ‡ In a world of code, so bright and keen,
New channels manage, with grace unseen.
Runnables dance, and chunks align,
Data flows smoothlyβ€”oh, how divine!
With each little change, we hop with glee,
A brighter tomorrow for you and me! 🌟


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.