Skip to content

fix npe in webhook that was accidental #1845

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

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

motatoes
Copy link
Contributor

@motatoes motatoes commented Nov 28, 2024

Summary by CodeRabbit

  • New Features

    • Improved error handling for GitHub webhook events, ensuring consistent success responses ("ok") across various event types.
  • Bug Fixes

    • Enhanced logging for errors encountered during webhook processing to aid in internal tracking.

Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes in the pull request focus on the GithubAppWebHook method within the DiggerController class in next/controllers/github.go. The modifications enhance error handling and standardize response messages for various GitHub webhook events. Specifically, the method now consistently returns a success message ("ok") across different event types, including InstallationEvent, IssueCommentEvent, and PullRequestEvent, while logging errors internally for tracking purposes.

Changes

File Change Summary
next/controllers/github.go Updated GithubAppWebHook method to improve error handling and response messaging for webhook events. Consistently returns "ok" for InstallationEvent, PullRequestEvent, and PushEvent regardless of error state, while logging errors internally.

Poem

In the land of code where rabbits play,
We’ve tidied up the errors today.
With "ok" as our cheer, we hop with delight,
Logging the mishaps, keeping it right.
So here’s to the changes, let’s give a big cheer,
For a smoother webhook, let’s all persevere! 🐇✨


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 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 Nov 28, 2024

No security or compliance issues detected. Reviewed everything up to 98fab03.

Security Overview
  • 🔎 Scanned files: 1 changed file(s)
Detected Code Changes
Change Type Relevant files
Bug Fix ► github.go
    Fix webhook response handling
► terraform.go
    Fix plan output changes handling
► controllers/github.go
    Remove max projects validation and fix error handling
Refactor ► envgetters.go
    Remove unused environment configuration file

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

🧹 Outside diff range and nitpick comments (2)
next/controllers/github.go (2)

71-78: LGTM! Consider adding error tracking.

The standardization of webhook responses aligns with best practices. However, consider adding error tracking or metrics to monitor failed installation deletions.

 if *event.Action == "deleted" {
     err := handleInstallationDeletedEvent(event)
     if err != nil {
         log.Printf("Failed to handle webhook event. %v", err)
+        // TODO: Track error metric for monitoring
         return
     }
 }

Line range hint 92-96: Fix error handling for push events.

There's a bug in the error handling. The err variable is checked but it's not being assigned the return value from handlePushEventApplyAfterMerge.

Apply this fix:

 case *github.PushEvent:
     log.Printf("Got push event for %d", event.Repo.URL)
-    handlePushEventApplyAfterMerge(gh, event)
+    err := handlePushEventApplyAfterMerge(gh, event)
     if err != nil {
         log.Printf("handlePushEvent error: %v", err)
     }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 662bddf and 98fab03.

📒 Files selected for processing (1)
  • next/controllers/github.go (3 hunks)
🔇 Additional comments (1)
next/controllers/github.go (1)

87-87: LGTM! Response standardization is consistent.

The standardized "ok" response for pull request events maintains consistency with the webhook handling pattern.

@motatoes motatoes merged commit 59caccc into develop Nov 28, 2024
29 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Jul 2, 2025
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