[baggage] baggage item value encoding fix - custom encoder #5292
Conversation
This file contains 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
lachmatt
commented
Jan 31, 2024
| @@ -94,7 +94,7 @@ public override void Inject<T>(PropagationContext context, T carrier, Action<T, | |||
| continue; | |||
| } | |||
|
|
|||
| baggage.Append(WebUtility.UrlEncode(item.Key)).Append('=').Append(WebUtility.UrlEncode(item.Value)).Append(','); | |||
| baggage.Append(W3CBaggageValueEncoder.Encode(item.Key)).Append('=').Append(W3CBaggageValueEncoder.Encode(item.Value)).Append(','); | |||
There was a problem hiding this comment.
Baggage item keys should meet token requirement from the specification, and not be encoded.
I can address that in a separate PR.
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #5292 +/- ##
==========================================
- Coverage 83.38% 83.08% -0.31%
==========================================
Files 297 273 -24
Lines 12531 12011 -520
==========================================
- Hits 10449 9979 -470
+ Misses 2082 2032 -50
Flags with carried forward coverage won't be shown. Click here to find out more.
|
|
I haven't got time to look into this PR. Here is my general feedback:
|
4 tasks
lachmatt
changed the title
There is a section in OpenTelemetry Baggage Spec related to propagation that references W3C Baggage Specification.
Code comment mentions editor's draft. |
|
This PR was marked stale due to lack of activity and will be closed in 7 days. Commenting or Pushing will instruct the bot to automatically remove the label. This bot runs once per day. |
github-actions
bot
added
the
Stale
|
Closed as inactive. Feel free to reopen if this PR is still being worked on. |
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.
Fixes #5260
Changes
Fixes encoding of
' 'char in baggage item values when injecting baggage.Adds custom encoder, based on
WebUtility.Encodefrom runtime repository, with modifications related to space character encoding.Additionally, only characters required by the specification are percent-encoded, which results in minimal, compliant representation.
This is important considering baggage limits.
The need for the shortest, compliant representation expressed in #2012 (comment)
Alternatives:
Use
Uri.EscapeDataStringwhich correctly encodes spaces. The downside of this approach is many characters not required to be percent-encoded by the specification are percent-encoded.Merge requirement checklist
CHANGELOG.mdfiles updated for non-trivial changes