panic: introduce Catch() shortcut for Catcher.Do()

[amery]

Summary by CodeRabbit

• New Features

  • Introduced a new Catch function for simplified error handling during function execution.

• Documentation

  • Updated the README to clarify error handling processes and refined descriptions for better understanding.

[coderabbitai]

Walkthrough

The pull request introduces updates to the darvaza.org/core package, specifically enhancing the error handling documentation in the README. The term Catcher has been replaced with Catch() to clarify its functionality, streamlining error management during function panics. Additionally, a new Catch function has been added to the panic.go file, which simplifies the usage of the existing Catcher struct for handling errors and panic recovery. The core functionalities and interfaces remain unchanged.

Changes

Files	Change Summary
README.md, panic.go	Updated documentation to clarify error handling; replaced Catcher with Catch(); added Catch function for simplified error handling and panic recovery.

Possibly related PRs

• README: add better description of Wrap and Panic related helpers #76: The changes in this PR also involve updates to the error handling section in the README, specifically mentioning the Catcher function and PanicError, which are directly related to the modifications made in the main PR regarding error handling and the introduction of the Catch function.

Suggested reviewers

• karasz

Poem

In the land of code where errors play,
A new Catch has come to save the day.
With Catcher now a tale of the past,
Our panic woes are fading fast!
So hop along, let bugs take flight,
For error handling is now just right! 🐇✨

---

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.

[deepsource-io]

Here's the code health analysis summary for commits 832ee62..bebfa12. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Shell	✅ Success		View Check ↗
Go	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

panic.go (1)

75-81: LGTM! Consider an optimization for high-frequency use cases.

The new Catch function is well-implemented and aligns perfectly with the PR objectives. It provides a clean and straightforward shortcut for Catcher.Do(), simplifying error handling in the context of panics.

The function is concise, easy to understand, and has clear documentation. It correctly handles both organic errors and recovered panics, making it a valuable addition to the package.

For high-frequency use cases, consider providing an additional function that reuses a Catcher instance to avoid repeated allocations. For example:

var globalCatcher Catcher

// CatchWithReuse uses a global [Catcher] to safely call a function and
// return the organic error or the [Recovered] [PanicError].
func CatchWithReuse(fn func() error) error {
    return globalCatcher.Do(fn)
}

This optimization could be beneficial in scenarios where Catch is called frequently, and the slight performance improvement from reusing the Catcher instance becomes significant.

README.md (1)

95-97: LGTM! Consider adding a code example.

The introduction of Catch() is well-documented and aligns with the PR objectives. The description clearly explains its functionality and relationship with PanicError and Catcher.

To further improve the documentation, consider adding a simple code example demonstrating the usage of Catch(). This would help users quickly understand how to implement it in their code.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 832ee62 and bebfa12.

📒 Files selected for processing (2)

• README.md (1 hunks)
• panic.go (1 hunks)

[karasz]

LGTM