search

yorkie-team / yorkie

Yorkie is a document store for collaborative applications.
https://yorkie.dev
Apache License 2.0
771 stars 143 forks source link

Handle panic during conversion to connectCode #951

Closed blurfx closed 1 month ago

blurfx commented 1 month ago

What this PR does / why we need it:

If an unhashable error is given, the error cannot be converted to a connecteError with a map, causing a panic and shutting down the server.

Which issue(s) this PR fixes:

Fixes #944

Special notes for your reviewer:

Would it be a good idea to log errors in recover?

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance the errorToConnectError function by implementing panic recovery, ensuring the server handles non-hashable errors without crashing. This addition improves error resilience while retaining the function's clarity and original logic.

Changes

Files Change Summary
server/rpc/connecthelper/status.go Added panic recovery in errorToConnectError function to prevent server crashes from non-hashable errors. Variables connectCode and ok were moved to explicit declarations for clarity.
server/rpc/connecthelper/status_test.go Introduced a test suite for errorToConnectError, validating error type conversion and ensuring correct behavior for converter.ErrPackRequired and mongo.CommandError.

Assessment against linked issues

Objective Addressed Explanation
Server should not panic when handling non-hashable errors (#944) ✅

🐇 "In the code where errors may lurk,
A safeguard now does its work!
With panics caught, we safely tread,
No more crashes, just stable threads.
A hop towards resilience, oh what a delight,
Errors handled, our future looks bright!" 🐰✨

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.
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 51.03%. Comparing base (54910c1) to head (79e6402).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #951 +/- ## ========================================== - Coverage 51.31% 51.03% -0.29% ========================================== Files 71 73 +2 Lines 10679 10774 +95 ========================================== + Hits 5480 5498 +18 - Misses 4650 4725 +75 - Partials 549 551 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

blurfx commented 1 month ago

@krapie No, it doesn't. Should we print or log errors in this case?

krapie commented 1 month ago

@blurfx I think printing out error details may help us to take actions upon that specific error like mongo.CommandError.

hackerwins commented 1 month ago

@krapie @blurfx It seems that an error will propagate to the callers and be output by the interceptor. 🤔

https://github.com/yorkie-team/yorkie/blob/54910c172e5d648235777c49a532ccc8eefdf222/server/rpc/interceptors/default.go#L52-L55