[Bugfix] [Platform] Sort Headers in Envoy #1994
Merged
Conversation
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
jwierzbo
approved these changes
Nov 19, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a bug where response headers in Envoy configurations were rendered in non-deterministic order due to Go's map iteration randomness. The fix ensures headers are sorted alphabetically by key, making the configuration output deterministic and checksum-stable.
Key Changes
- Modified header iteration in
RenderRouteto use sorted keys instead of random map iteration - Updated test helper to return checksum for validation
- Added determinism test that verifies the same configuration produces identical checksums across 128 iterations
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pkg/deployment/resources/gateway/gateway_config_destination.go | Changed ResponseHeaders iteration to use sorted keys via util.SortKeys(), ensuring deterministic header ordering in Envoy config |
| pkg/deployment/resources/gateway/gateway_config_test.go | Modified test helper to return checksum and added test loop to verify deterministic output with multiple targets and response headers |
| CHANGELOG.md | Added changelog entry for the bugfix |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.