feat: add preserve_path channel option to relay client#24
Merged
nickmarden merged 3 commits intomainfrom Apr 10, 2026
Merged
Conversation
When set to false, the relay forwarder uses the destination URL verbatim instead of appending the original webhook path. Useful when the destination already contains the full path and path-appending would break routing. Default behavior (path appending) is unchanged for all existing channels.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Docker Images BuiltImages are available for testing: # gatekeeperd
docker pull ghcr.io/tight-line/gatekeeperd:pr-24-e0838bd
# gatekeeper-relay
docker pull ghcr.io/tight-line/gatekeeper-relay:pr-24-e0838bddocker-compose.ymlGATEKEEPERD_IMAGE=ghcr.io/tight-line/gatekeeperd:pr-24-e0838bd \
RELAY_IMAGE=ghcr.io/tight-line/gatekeeper-relay:pr-24-e0838bd \
docker-compose --profile relay upHelm (values override)image:
repository: ghcr.io/tight-line/gatekeeperd # or gatekeeper-relay
tag: "pr-24-e0838bd"Images expire ~15 days after PR closes. |
|
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
preserve_pathoption to relay channel config (default:true, existing behavior unchanged)preserve_path: false, the relay forwarder uses the destination URL verbatim instead of appending the original webhook pathpreserve_pathvaluepreserve_path: falsecorrectly usinghasKeyguard (sofalseis not swallowed as falsy)/configure-helmand/configure-routeskills to ask about path-appending behavior when configuring relay channelsMotivation
When a relay channel destination already contains the full path, the default path-appending behavior causes double-pathing (e.g.,
http://svc:8080+ webhook path/googlechat-dev→http://svc:8080/googlechat-devwhen the intent was justhttp://svc:8080). Settingpreserve_path: falsefixes this without changing behavior for existing channels.Test plan
make testpasses with 100% coverageTestForwarder_Forward_PreservePath_False— verifies path is not appended whenpreserve_path: falseTestForwarder_Forward_PreservePath_False_QueryString— verifies query string is still forwardedTestChannelConfig_GetPreservePath— nil/true/false casesTestChannelConfig_GetPreservePath_YAMLRoundTrip— YAML parsing round-trip