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

(API) Use custom err handler instead of panic #1402

Merged
merged 1 commit into from
Apr 23, 2024

Conversation

nick-bisonai
Copy link
Collaborator

@nick-bisonai nick-bisonai commented Apr 22, 2024

Description

On returning error, it now uses custom error handler which returns in form of

return c.Status(code).SendString(err.Error())

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.

Deployment

  • Should publish npm package
  • Should publish Docker image

Summary by CodeRabbit

  • Refactor
    • Improved error handling across various API controllers by replacing panic responses with error returns, enhancing system stability and error management.

@nick-bisonai nick-bisonai self-assigned this Apr 22, 2024
@nick-bisonai nick-bisonai requested a review from a team as a code owner April 22, 2024 01:07
Copy link
Contributor

coderabbitai bot commented Apr 22, 2024

Walkthrough

Walkthrough

The recent updates across various controller files in the API involve a significant shift in error handling practices. The primary change is the replacement of panic(err) with return err, moving towards a more robust and error-resilient approach. This modification ensures that errors are returned rather than causing system panics, enhancing stability and reliability.

Changes

Files Change Summary
controller.go in various APIs Replaced panic(err) with return err in multiple functions to improve error handling.
.../controller.go (aggregate, apierr, feed) Reordered import statements; updated error handling to return errors.

🐰✨
In the land of code, where rabbits hop,
A change was made, panics did stop.
Errors return, no more despair,
Stability reigns, with care and flair.
Hop, hop, hooray, on this fine day!
🌟🐇

These changes reflect a thoughtful approach to making the system more predictable and manageable, aligning with best practices in software development.


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b3b7658 and ee60e85.
Files selected for processing (13)
  • api/adapter/controller.go (5 hunks)
  • api/aggregate/controller.go (8 hunks)
  • api/aggregator/controller.go (10 hunks)
  • api/apierr/controller.go (6 hunks)
  • api/chain/controller.go (5 hunks)
  • api/data/controller.go (6 hunks)
  • api/feed/controller.go (5 hunks)
  • api/l2aggregator/controller.go (1 hunks)
  • api/listener/controller.go (6 hunks)
  • api/proxy/controller.go (7 hunks)
  • api/reporter/controller.go (9 hunks)
  • api/service/controller.go (5 hunks)
  • api/vrf/controller.go (7 hunks)
Additional comments not posted (72)
api/l2aggregator/controller.go (2)

24-24: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


29-29: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/chain/controller.go (8)

23-23: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


28-28: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


33-33: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


42-42: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


52-52: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


63-63: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


68-68: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


79-79: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/feed/controller.go (4)

34-34: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


44-44: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


57-57: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


69-69: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/service/controller.go (8)

22-22: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


27-27: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


32-32: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


41-41: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


50-50: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


59-59: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


64-64: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


74-74: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/apierr/controller.go (6)

32-32: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


37-37: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


48-48: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


57-57: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


66-66: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


79-79: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/data/controller.go (7)

37-37: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


42-42: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


47-47: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


58-58: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


68-68: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


81-81: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


94-94: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/proxy/controller.go (9)

28-28: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


33-33: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


42-42: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


51-51: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


61-61: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


72-72: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


77-77: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


87-87: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


97-97: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/vrf/controller.go (13)

41-41: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


46-46: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


51-51: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


62-62: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


76-76: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


82-82: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


87-87: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


92-92: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


102-102: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


112-112: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


117-117: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


128-128: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.


138-138: Change from panic to return is correctly implemented, aligning with the PR's objective to enhance error handling.

api/listener/controller.go (15)

40-40: Error handling improved by returning the error directly.


45-45: Error handling improved by returning the error directly.


50-50: Error handling improved by returning the error directly.


55-55: Error handling improved by returning the error directly.


64-64: Error handling improved by returning the error directly.


77-77: Error handling improved by returning the error directly.


84-84: Error handling improved by returning the error directly.


90-90: Error handling improved by returning the error directly.


98-98: Error handling improved by returning the error directly.


105-105: Error handling improved by returning the error directly.


115-115: Error handling improved by returning the error directly.


125-125: Error handling improved by returning the error directly.


130-130: Error handling improved by returning the error directly.


138-138: Error handling improved by returning the error directly.


149-149: Error handling improved by returning the error directly.


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

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

@nick-bisonai nick-bisonai linked an issue Apr 23, 2024 that may be closed by this pull request
Copy link
Member

@martinkersner martinkersner left a comment

Choose a reason for hiding this comment

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

LGTM!

@nick-bisonai nick-bisonai merged commit 2536379 into master Apr 23, 2024
1 check passed
@nick-bisonai nick-bisonai deleted the feat/fix-api-err-handling branch April 23, 2024 02:48
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.

Update api error handling
2 participants