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

Provide error codes for enhancing error handling from clients #927

Closed hackerwins closed 2 months ago

hackerwins commented 2 months ago

What this PR does / why we need it:

Provide error codes for enhancing error handling from clients

Previously, server sends connect.Code to clients to indicate error code, such as FailedPrecondition, in a simplistic manner. This makes it challenging for clients to differentiate and handle individual situations effectively.

This commit provides error detailed codes as metadata for enhancing error handling from clients.

Which issue(s) this PR fixes:

Addresses #922

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Additional documentation:

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce major updates to error handling and mapping across several files in the connecthelper and converter packages to better handle connect.Error and enhance error reporting. Additionally, conditional checks were added in the WatchDocument method to ensure proper control flow before performing document operations.

Changes

Files Summary
api/converter/errors.go Introduced ErrorCodeOf function to extract the error code from a given error, specifically handling connect.Error.
server/rpc/.../status.go Extensive updates to error handling and mapping logic, introducing new functions such as CodeOf, errorToConnectError, and structErrorToConnectError, and modifying ToStatusError to map errors to connectRPC codes.
server/rpc/testcases/testcases.go Added imports and new assertions using functions from connecthelper and converter for better error code comparisons in various test functions.
server/rpc/yorkie_server.go Added a conditional check in the WatchDocument method to handle errors before finding active client information, affecting control flow.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant YorkieServer
    participant Document
    Client->>YorkieServer: WatchDocument()
    YorkieServer->>YorkieServer: Check conditions
    alt Conditions met
        YorkieServer->>Document: Find active client info
        Document-->>YorkieServer: Return info
        YorkieServer-->>Client: Proceed with operations
    else Conditions not met
        YorkieServer-->>Client: Return error
    end

Poem

In code's deep forest, changes profound, Errors mapped, new paths found. 🌲 Connect's whispers, softly they speak, Ensuring flows, robust and sleek. Document watches, guarded with care, All in sync, a code we share. 🚀

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 Configration 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 2 months ago

Codecov Report

Attention: Patch coverage is 15.78947% with 16 lines in your changes missing coverage. Please review.

Project coverage is 50.80%. Comparing base (28ef053) to head (e76b42d). Report is 1 commits behind head on main.

Files Patch % Lines
api/converter/errors.go 0.00% 13 Missing :warning:
server/rpc/yorkie_server.go 50.00% 2 Missing and 1 partial :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #927 +/- ## ========================================== - Coverage 50.86% 50.80% -0.07% ========================================== Files 70 71 +1 Lines 10551 10564 +13 ========================================== Hits 5367 5367 - Misses 4652 4665 +13 Partials 532 532 ```

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