Improve W3C Baggage implementation with proper UTF-8 encoding and RFC7230 validation #763
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
This commit improves the W3C Baggage implementation to better align with the specification requirements: - Implement proper UTF-8 percent encoding for baggage values - Add RFC7230 token validation for baggage keys - Remove ASCII-only restriction from baggage values - Add 180-byte length limit for baggage strings - Maintain ASCII validation for resource attributes - Add comprehensive test coverage for W3C spec compliance Key changes: * EntryKey: Add RFC7230 token character validation * EntryValue: Allow any UTF-8 characters in values * W3CBaggagePropagator: Implement proper percent encoding/decoding * Tests: Add extensive W3C specification compliance tests fixes open-telemetry#761
batuhansk
requested review from
nachoBonafonte,
bryce-b,
vvydier and
ArielDemarco
as code owners
- Consolidate and restructure EntryKey tests for better organization - Add comprehensive RFC7230 token validation test cases - Add whitespace trimming and case sensitivity tests - Remove redundant unprintable character tests - Improve test documentation and readability
bryce-b
reviewed
May 6, 2025
Sources/OpenTelemetryApi/Baggage/Propagation/W3CBaggagePropagator.swift
Outdated
Show resolved
Hide resolved
bryce-b
approved these changes
May 6, 2025
nachoBonafonte
approved these changes
May 6, 2025
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #763 +/- ##
==========================================
+ Coverage 67.89% 68.18% +0.29%
==========================================
Files 344 326 -18
Lines 15169 14599 -570
==========================================
- Hits 10299 9955 -344
+ Misses 4870 4644 -226 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
Description
This PR improves the W3C Baggage implementation to better align with the specification requirements, focusing on proper UTF-8 encoding and RFC7230 validation.
Changes
!#$%&'*+-.^_|~` and alphanumeric)Key Implementation Details
EntryKey: Now validates against RFC7230 token specificationEntryValue: Allows any UTF-8 characters in values (will be percent-encoded during propagation)W3CBaggagePropagator: Implements proper percent encoding/decodingNotes
References
W3CBaggagePropagatorMissing Percent Encoding for Special Characters in Values #761