Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Custom filesystem exception for invalid ciphertext nodes #286

Merged
merged 2 commits into from
Mar 11, 2025

Conversation

infeo
Copy link
Member

@infeo infeo commented Mar 11, 2025

This PR changes an error behavior of the filesystem.

On the encrypted/ciphertext side, Cryptofs can represent decrypted/cleartext filenodes either as single files or directories. In the latter case the directory must contain any identification files in order to be recognized. (dir.c9r, symlink.c9r, etc)

In the current version, if such a file was not present, a NoSuchFileException is thrown. But this exception does not represent the actual state of the filesystem node: Instead of not being present, it is broken. And with the wrong exception library consumer might be tempted to use the "free" path, albeit it is not, only running into the next exception.

I replaced the wrong exception with a new, custom FileSystemException: InvalidFileNodeException. The consumer does not know about it and recieves ultimately a generic IOException, indicating there is something wrong with the filesystem node.

@infeo infeo added this to the next milestone Mar 11, 2025
@infeo infeo self-assigned this Mar 11, 2025
Copy link

coderabbitai bot commented Mar 11, 2025

Walkthrough

This pull request involves updates to exception handling in the CryptoPathMapper module. The getCiphertextFileType method's documentation has been revised to clarify the conditions under which exceptions are thrown, specifically changing the description of NoSuchFileException and introducing a new exception, InvalidFileNodeException, for cases where a ciphertext directory lacks an identification file. Additionally, a new class, InvalidFileNodeException, has been added to the org.cryptomator.cryptofs package, extending FileSystemException. The related unit test, testNoKnownFileExists, has been modified to expect the new exception type instead of the previous one, reflecting the changes in the error handling logic.

Possibly related PRs

  • Feature: More events and event refinement  #284: Introduces modifications in the same method (getCiphertextFileType) by switching exception types and handling broken file nodes, directly aligning with the exception handling changes in this PR.

Suggested labels

enhancement


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0bdad47 and 4dd38ab.

📒 Files selected for processing (2)
  • src/main/java/org/cryptomator/cryptofs/CryptoPathMapper.java (2 hunks)
  • src/main/java/org/cryptomator/cryptofs/CryptoPathMapper.java (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • src/main/java/org/cryptomator/cryptofs/CryptoPathMapper.java
  • src/main/java/org/cryptomator/cryptofs/CryptoPathMapper.java

🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@infeo infeo merged commit 49f5af2 into develop Mar 11, 2025
3 checks passed
@infeo infeo deleted the feature/invalid-file-node-exception branch March 11, 2025 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant