Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[api-baggage] revert space encoding change #5687

Merged

Conversation

lachmatt
Copy link
Contributor

@lachmatt lachmatt commented Jun 11, 2024

Changes

Revert changes from #5303 because Uri.UnescapeDataString doesn't replace percent-encoded octet sequences that do not match the UTF-8 encoding scheme with the replacement code point (U+FFFD). This is required by the W3C Baggage spec.

The plan is to address all of the issues related to baggage propagation with the later release.

Merge requirement checklist

  • CONTRIBUTING guidelines followed (license requirements, nullable enabled, static analysis, etc.)
  • Unit tests added/updated
  • Appropriate CHANGELOG.md files updated for non-trivial changes
  • Changes in public API reviewed (if applicable)

@lachmatt lachmatt requested a review from a team June 11, 2024 12:35
@lachmatt lachmatt changed the title [baggage] revert space encoding change from 5303 [baggage] revert space encoding change from https://github.com/open-telemetry/opentelemetry-dotnet/pull/5303 Jun 11, 2024
@lachmatt lachmatt changed the title [baggage] revert space encoding change from https://github.com/open-telemetry/opentelemetry-dotnet/pull/5303 [baggage] revert space encoding change from #5303 Jun 11, 2024
@@ -2,6 +2,9 @@

## Unreleased

* **Breaking change:** Revert space character encoding change from `+` to `%20`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add this PR # as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added in e474fa7

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add more information about why we're reverting this change to the changelog or PR description. Something to the effect of "... because the fix did not properly address the inconsistency with the baggage spec. We will address this issue more completely in a later release"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR description updated.

Copy link

codecov bot commented Jun 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.99%. Comparing base (6250307) to head (a0d4af5).
Report is 258 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5687      +/-   ##
==========================================
+ Coverage   83.38%   85.99%   +2.61%     
==========================================
  Files         297      254      -43     
  Lines       12531    11054    -1477     
==========================================
- Hits        10449     9506     -943     
+ Misses       2082     1548     -534     
Flag Coverage Δ
unittests ?
unittests-Project-Experimental 85.94% <100.00%> (?)
unittests-Project-Stable 85.99% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
...metry.Api/Context/Propagation/BaggagePropagator.cs 85.48% <100.00%> (ø)

... and 124 files with indirect coverage changes

@github-actions github-actions bot added the pkg:OpenTelemetry.Api Issues related to OpenTelemetry.Api NuGet package label Jun 11, 2024
Copy link
Member

@alanwest alanwest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we circle back to fixing this again, we should start with a solid test suite and vet it across other language implementations. Without a well-vetted test suite it is difficult to review and be confident in these fixes because most people do not have the depth of familiarity required of the baggage specification.

@CodeBlanch CodeBlanch changed the title [baggage] revert space encoding change from #5303 [api-baggage] revert space encoding change Jun 12, 2024
@CodeBlanch CodeBlanch merged commit dc390a6 into open-telemetry:main Jun 12, 2024
40 checks passed
@lachmatt lachmatt deleted the revert-baggage-space-encoding branch June 12, 2024 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg:OpenTelemetry.Api Issues related to OpenTelemetry.Api NuGet package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants