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

handle crashes in goroutine events #1857

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

motatoes
Copy link
Contributor

@motatoes motatoes commented Dec 16, 2024

at the moment our webhook handler spawns a goroutine event. However if there is a panic in this goroutine it seems that it causes a crash of the gonic, this pr adds a recovery logic in both handling issue comment and pull request goroutines.

Summary by CodeRabbit

  • New Features

    • Enhanced error handling for pull request and issue comment events to improve application stability.
    • Streamlined processing of pull request events, including checks for branch existence and impacted projects.
    • Optimized handling of issue comments to only process relevant comments.
  • Bug Fixes

    • Implemented panic recovery mechanisms to prevent application crashes during event handling.

Copy link
Contributor

coderabbitai bot commented Dec 16, 2024

Walkthrough

The pull request focuses on improving error handling and control flow in the GitHub event processing functions within the backend/controllers/github.go file. The modifications primarily involve adding panic recovery mechanisms to handlePullRequestEvent and handleIssueCommentEvent functions. These changes aim to make the event handling more robust by preventing application crashes and implementing more precise checks for processing GitHub events, such as verifying branch existence and comment conditions.

Changes

File Change Summary
backend/controllers/github.go - Added panic recovery to handlePullRequestEvent and handleIssueCommentEvent functions
- Enhanced branch existence checks in pull request event handling
- Improved comment processing logic with stricter validation

Sequence Diagram

sequenceDiagram
    participant GH as GitHub Webhook
    participant Controller as DiggerController
    participant CIBackend as CI Backend

    GH->>Controller: Send Pull Request/Issue Comment Event
    Controller->>Controller: Panic Recovery Mechanism
    alt Valid Event
        Controller->>Controller: Validate Event Conditions
        Controller->>CIBackend: Process Event
    else Invalid Event
        Controller->>Controller: Log and Ignore
    end
Loading

Possibly related PRs

Poem

🐰 In GitHub's wild and woolly lane,
Where events bounce like a rabbit's refrain,
Panic recovers with grace so neat,
Digger's code now handles each feat!
Robust and nimble, no crash in sight,
Our code hops on with pure delight! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link

delve-auditor bot commented Dec 16, 2024

No security or compliance issues detected. Reviewed everything up to a28afc9.

Security Overview
  • 🔎 Scanned files: 1 changed file(s)
Detected Code Changes
Change Type Relevant files
Bug Fix ► github.go
    Add panic recovery for goroutine event handlers in handlePullRequestEvent and handleIssueCommentEvent
Diagnostics
  • Code Scan ID: 63543156-a613-4c2e-8e6d-1b7b992e291c

Reply to this PR with @delve-auditor followed by a description of what change you want and we'll auto-submit a change to this PR to implement it.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
backend/controllers/github.go (2)

312-317: Include stack traces in panic recovery logs for better debugging

Currently, the panic recovery in handlePullRequestEvent logs only the recovered value, which may not provide enough context for debugging. Including a stack trace will help in identifying the source of the panic more effectively.

Apply this diff to include stack traces:

+import "runtime/debug"

...

	defer func() {
		if r := recover(); r != nil {
-			log.Printf("Recovered from panic in handlePullRequestEvent handler: %v", r)
+			log.Printf("Recovered from panic in handlePullRequestEvent handler: %v\nStack Trace:\n%s", r, debug.Stack())
		}
	}()

693-698: Include stack traces in panic recovery logs for better debugging

Similarly, in handleIssueCommentEvent, including a stack trace in the panic recovery log will enhance debugging capabilities by providing more detailed context.

Apply this diff to include stack traces:

+import "runtime/debug"

...

	defer func() {
		if r := recover(); r != nil {
-			log.Printf("Recovered from panic in handleIssueCommentEvent handler: %v", r)
+			log.Printf("Recovered from panic in handleIssueCommentEvent handler: %v\nStack Trace:\n%s", r, debug.Stack())
		}
	}()
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 15b7491 and a28afc9.

📒 Files selected for processing (1)
  • backend/controllers/github.go (2 hunks)

@motatoes motatoes merged commit 6b2ee65 into develop Dec 16, 2024
12 checks passed
motatoes added a commit that referenced this pull request Jan 2, 2025
* add flag to ignore all external directories per project (#1851)

* add flag to ignore all external directories per project

* revert includeparentblocks flag (#1852)

* improve efficiency in terragrunt generation (#1854)

* improve efficiency in terragrunt generation

* Update action.yml (#1856)

* handle crashes in goroutine events (#1857)

* fix/recover from webhook goroutines (#1858)

* handle crashes in goroutine events

* include stacktrace in errors

* wip generation of terraform code from application code (#1855)

* terraform code generation demo


---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix: incorrect comment in backend/migrations (#1860)

* Update setup-opentofu to fix issues with 1.6.x downloads (#1861)

* restructure docs to have no columns (#1862)

* Create curl_bootstrap.sh

* refactor codegen parts (#1863)

* refactor codegen parts

* publish ai summaries (#1864)

* publish ai summaries

* add a header for summary comment (#1865)

* fix heading (#1866)

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Aldo <[email protected]>
Co-authored-by: Hugo Samayoa <[email protected]>
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.

1 participant