fix: return error response for webhook non-timeout error#1167
Merged
Conversation
Contributor
|
DescriptionSummary By MatterAI
🔄 What Changed
🔍 Impact of the Change
📁 Total Files Changed4 files changed. 🧪 Test AddedNo explicit tests are mentioned in the PR description. Manual testing or existing integration tests would be required to verify the new error handling and 🔒Security VulnerabilitiesNo new security vulnerabilities were detected in the provided code changes. MotivationThis PR aims to improve the error handling for webhook calls by returning a more informative error response for non-timeout errors, including the response body when available. Additionally, it introduces a mechanism to control how errors in individual guardrail checks affect the overall hook verdict. Type of Change
How Has This Been Tested?
Screenshots (if applicable)N/A Checklist
Related IssuesN/A Tip Quality Recommendations
Sequence DiagramsequenceDiagram
participant HM as HooksManager
participant WH as WebhookHandler (PluginHandler)
participant UT as Utils (post function)
participant EXT as External Webhook Service
HM->>WH: executeCheck(check.parameters)
activate WH
WH->>UT: post(webhookURL, headers, timeout)
activate UT
UT->>EXT: HTTP POST Request
activate EXT
alt Successful Response
EXT-->>UT: HTTP 2xx Response
UT-->>WH: Response Data
else HTTP Error (Non-Timeout)
EXT-->>UT: HTTP 4xx/5xx Response (with body)
UT->>UT: Create ErrorResponse (status, body, headers)
UT--xWH: Throw HttpError(ErrorResponse)
else Timeout Error
EXT--xUT: No Response (Timeout)
UT--xWH: Throw TimeoutError(url, timeout, method)
end
deactivate EXT
alt Error Caught in WebhookHandler
WH->>WH: Check if error is TimeoutError
alt If TimeoutError
WH->>WH: Prepare data with explanation, webhookUrl, requestContext
WH->>HM: Return result with error data (no responseData)
else If HttpError (Non-Timeout)
WH->>WH: Extract responseData, responseDataContentType from error.response
WH->>WH: Prepare data with explanation, webhookUrl, requestContext
WH->>WH: Conditionally add parsed responseData if JSON
WH->>HM: Return result with error data (including responseData)
end
end
deactivate WH
HM->>HM: Process checkResults
HM->>HM: Retrieve fail_on_error from check.parameters
HM->>HM: Determine final verdict based on result.verdict, result.error, and fail_on_error
HM-->>Client: Return HookResult
|
![matterai-app[bot]](https://avatars.githubusercontent.com/in/474549?s=60&v=4){kind=small}
b4s36t4
force-pushed
the
fix/webhook-plugin-errors
branch
from
25a441f to
b5d2963
Compare
Contributor
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
Contributor
|
Important PR Review SkippedPR review skipped as per the configuration setting. Run a manually review by commenting /matter review 💡Tips to use Matter AICommand List
|
VisargD
approved these changes
Jun 25, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Motivation
Type of Change
How Has This Been Tested?
Screenshots (if applicable)
Checklist
Related Issues