Add backing implementation for [apim.webhooks.http] enable = false - #14259
Open
ashanhr wants to merge 2 commits into
Open
Add backing implementation for [apim.webhooks.http] enable = false#14259ashanhr wants to merge 2 commits into
ashanhr wants to merge 2 commits into
Conversation
ashanhr
requested review from
AnuGayan,
Arshardh,
chamilaadhi and
tharindu1st
as code owners
July 17, 2026 04:59
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (6)
🚧 Files skipped from review as they are similar to previous changes (6)
📝 WalkthroughWalkthroughAdds HTTP webhook enablement to both product distributions. The change adds matching Synapse ChangesHTTP webhook enablement
Estimated code review effort: 2 (Simple) | ~10 minutes Mergeability Score: ⚪ Minimal · up to The PR adds the HTTP webhook enable/disable configuration and renders the corresponding suspend behavior in both distributions; no actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Registers apim.webhooks.http.enable in default.json (default: true) and adds WebhookServer.xml.j2 templates for both all-in-one and gateway distributions. The config mapper now renders WebhookServer.xml with suspend="true" when the key is set to false, which prevents Synapse from binding port 9021 on startup. Fixes: wso2/api-manager#5141 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
ashanhr
force-pushed
the
fix/17871-webhook-http-enable
branch
from
July 17, 2026 05:20
4da302e to
d7cec3e
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #14259 +/- ##
=========================================
Coverage 62.77% 62.77%
Complexity 161 161
=========================================
Files 25 25
Lines 454 454
Branches 11 11
=========================================
Hits 285 285
Misses 163 163
Partials 6 6
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
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
1 participant
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.
Summary
apim.webhooks.http.enable(default:true) indefault.jsonfor both theall-in-one-apimandgatewaydistributions.WebhookServer.xml.j2templates (inapim-synapse-config/andsynapse-configs/default/inbound-endpoints/) that render thesuspendattribute from the config key.When
[apim.webhooks.http] enable = falseis set indeployment.toml, the config mapper now rendersWebhookServer.xmlwithsuspend="true", which prevents Synapse from binding port 9021 at startup. Previously this config key was silently ignored because there was nodefault.jsonentry and no j2 template.This follows the same pattern already established for the HTTPS webhook (
apim.webhooks.https.enable+SecureWebhookServer.xml.j2).Dev Test
Tested against a 4.1.0 pack (patching the template and default.json files directly):
[apim.webhooks.http] enable = falseindeployment.tomlWebhookServer.xmlrendered withsuspend="true"lsof -i :9021returns nothing)Related issue
wso2/api-manager#5141