add NewErrorWithContext

[nunoo]

Summary by CodeRabbit

• New Features

  • Enhanced error handling with the introduction of contextual information in error messages.

• Bug Fixes

  • Improved error response writing by ensuring context is included in error handling.

[coderabbitai]

Walkthrough

The changes introduce a new function, NewErrorWithContext, in the error.go file to enhance error creation by including a context parameter. This function wraps the existing NewError function, allowing for contextual information to be included in StatusError generation. Additionally, the WriteErr function is modified to use NewErrorWithContext, ensuring that context is preserved in error responses.

Changes

Files	Change Summary
error.go	Added NewErrorWithContext function to include context in error creation; updated WriteErr to utilize this new function.

Poem

In the meadow where errors play,
A new context joins the fray.
With messages clear and bright,
Debugging now feels just right!
Hop along, let errors mend,
With context here, we shall transcend! 🐇✨

---

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
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.78%. Comparing base (69d32c3) to head (d13b066).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #582   +/-   ##
=======================================
  Coverage   92.78%   92.78%           
=======================================
  Files          22       22           
  Lines        3894     3896    +2     
=======================================
+ Hits         3613     3615    +2     
  Misses        236      236           
  Partials       45       45           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

error.go (1)

251-251: Add a comment to clarify the purpose of the context parameter.

The context parameter is currently unused within the function body. Consider adding a comment to explain its intended purpose and potential future usage. This will help developers understand why the parameter is included and how it might be utilized in the future.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 69d32c3 and d13b066.

Files selected for processing (1)

• error.go (1 hunks)

Additional comments not posted (1)

error.go (1)

259-259: LGTM!

The change to use NewErrorWithContext instead of NewError is a good one. It allows for the inclusion of the context when creating the error, which could be useful in the future if the context needs to be utilized within the error creation process. The rest of the function remains unchanged, so this update should not have any negative impact on the existing functionality.