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

Use common error when removing an unwatched file #37

Merged
merged 1 commit into from Mar 6, 2024
Merged

Conversation

shogo82148
Copy link
Owner

@shogo82148 shogo82148 commented Mar 6, 2024

port of fsnotify/fsnotify#460

Summary by CodeRabbit

  • Bug Fixes
    • Updated error messages to provide more specific information for non-existent watch errors.

Copy link

coderabbitai bot commented Mar 6, 2024

Warning

Rate Limit Exceeded

@shogo82148 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 36 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 83fe815 and 63cfc04.

Walkthrough

The recent modifications in fsnotify.go and windows.go enhance the clarity of error messages for the ErrNonExistentWatch case. These updates aim to provide users with more specific information when they encounter errors related to non-existent watches, improving the debugging experience and overall usability of the system.

Changes

Files Change Summary
fsnotify.go, windows.go Updated error messages for ErrNonExistentWatch to be more specific.

🐇✨
In the realm of code, where watchers keep an eye,
Two files were touched, under the vast sky.
"Be clearer," they said, with a soft, gentle tweak,
Now errors speak truth, for the answers you seek.
Cheers to clarity, in this digital expanse,
With each careful change, we enhance.
🌟🐾

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

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.
    • 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 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 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 83fe815 and 4e5112c.
Files selected for processing (5)
  • fsnotify.go (1 hunks)
  • inotify.go (1 hunks)
  • inotify_test.go (3 hunks)
  • kqueue.go (2 hunks)
  • windows.go (1 hunks)
Additional comments: 9
fsnotify.go (2)
  • 68-68: The updated error message for ErrNonExistentWatch is more descriptive and helpful. Good improvement.
  • 69-69: Prefixing the ErrEventOverflow error message with fsnotify: enhances consistency across error messages in the library. Good change.
inotify.go (1)
  • 137-137: Using fmt.Errorf with the %w verb to wrap ErrNonExistentWatch in the Remove function enhances error handling by allowing callers to distinguish this error programmatically. This is a best practice in Go.
inotify_test.go (3)
  • 11-11: The addition of the errors package import is necessary for the updated error handling using errors.Is in tests. This is a good practice for precise error comparison.
  • 307-308: The modification in error handling in TestInotifyRemoveTwice to check for a specific error using errors.Is improves test accuracy and aligns with best practices for error handling.
  • 390-390: Changing the permission mode representation to octal in TestInotifyOverflow improves readability and aligns with conventional Unix/Linux practices.
kqueue.go (2)
  • 77-77: The change from var to := for declaring pathsToRemove improves readability and is more idiomatic Go. This is a good use of type inference.
  • 110-110: The modification of the error message in the Remove function to include ErrNonExistentWatch aligns with the PR's objective to standardize and improve error messaging. This change makes the error more informative by specifying the type of error and the file name involved, which is beneficial for debugging.
windows.go (1)
  • 319-319: The modification of the error message in the remWatch function to include ErrNonExistentWatch aligns with the PR's objective to standardize and improve error messaging. This change makes the error more informative by specifying the type of error and the pathname involved, which is beneficial for debugging on Windows platforms.

port of fsnotify/fsnotify#460

The errors returned by the various implementations of the watcher are all different
which makes handling them difficult. This PR follows the suggestion in:
fsnotify/fsnotify#455 (comment) by @mattn
to create a common error which is wrapped by the implementations.
@shogo82148 shogo82148 merged commit 069bd5f into main Mar 6, 2024
112 checks passed
@shogo82148 shogo82148 deleted the port-460 branch March 6, 2024 14:49
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.

None yet

2 participants