Baggage::ToHeader/FromHeader use form-style `+` for space, which other W3C Baggage implementations read as a literal plus
Maintainers usually reply within 1 day
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 88/100
Research direction
Start with UrlEncode and UrlDecode in api/include/opentelemetry/baggage/baggage.h, then read the baggage encoding tests in api/test/baggage and their CMakeLists.txt. Verify that spaces serialize as %20 and literal + characters remain literal when decoding; update affected expectations and run the baggage encoding, baggage, and baggage propagator tests.
Written by the indexing model from the issue text.
Description
Describe your environment
- opentelemetry-cpp
mainate854d29, built with GCC 11.5.0, CMake 3.18.4, googletest 1.10. api/include/opentelemetry/baggage/baggage.his byte-identical on currentmain3ee38aa.
Location (open-telemetry/opentelemetry-cpp @ default branch 3ee38aa):
api/include/opentelemetry/baggage/baggage.h:323-326:UrlEncodewrites a space as+.api/include/opentelemetry/baggage/baggage.h:358-361:UrlDecode, used byFromHeader, maps every+back to a space.
// UrlEncode
else if (c == ' ')
{
ret.push_back('+');
}
// UrlDecode
else if (str[i] == '+')
{
ret.push_back(' ');
}
Problem
C++ round-trips with itself, but the + convention is form encoding, which W3C Baggage does not use. A + is a legal baggage-octet, so a header containing hello+world is syntactically valid; the problem is interoperability, in both directions:
- C++ → spec-conforming parser:
hello worldis sent ashello+worldand is read ashello+world. For example, opentelemetry-go decodes withurl.PathUnescape(baggage.goL409), which leaves+as is. - Spec-conforming producer → C++: a literal
+, which the grammar allows without escaping (e.g.expr=1+1), is decoded by C++ as a space (1 1).
Scope: I am only reporting the space/+ mapping. C++ currently percent-encodes a literal + as %2B on output. That is allowed ("Code points which are not required to be percent-encoded MAY be percent-encoded"), and I am not reporting it as a bug.
Steps to reproduce
Reproduction
#include <gtest/gtest.h>
#include <string>
#include "opentelemetry/baggage/baggage.h"
#include "opentelemetry/nostd/shared_ptr.h"
using namespace opentelemetry::baggage;
TEST(BaggageEncodingTest, SpaceEncodedAsPercent20NotPlus)
{
opentelemetry::nostd::shared_ptr<Baggage> baggage(new Baggage{});
baggage = baggage->Set("key", "hello world");
EXPECT_EQ(baggage->ToHeader(), "key=hello%20world");
}
I added this as api/test/baggage/baggage_encoding_test.cc, registered it in api/test/baggage/CMakeLists.txt, and ran it with ctest (environment above).
What is the expected behavior?
The value hello world should be sent as hello%20world, so that any W3C Baggage parser decodes it back to hello world.
W3C Baggage (Working Draft 2024-05-30), §3.3.1.3 value: "Any code points outside of the baggage-octet range MUST be percent-encoded … Percent-encoding is defined in [RFC3986], Section 2.1". baggage-octet (%x21 / %x23-2B / %x2D-3A / %x3C-5B / %x5D-7E) excludes space and includes + as an ordinary character. The spec's own example is serverNode=DF%2028. The spec does not use application/x-www-form-urlencoded, so + does not mean space.
What is the actual behavior?
api/test/baggage/baggage_encoding_test.cc:27: Failure
Expected equality of these values:
header
Which is: "key=hello+world"
"key=hello%20world"
[ FAILED ] BaggageEncodingTest.SpaceEncodedAsPercent20NotPlus (0 ms)
Additional context
Already fixed in open-telemetry/opentelemetry-go
PR: https://github.com/open-telemetry/opentelemetry-go/pull/4756 — "baggage: Fix escaping in Member.String" (merged 2023-12-21T08:16:13Z, merge commit 885210bf332). It switches Member.String from url.QueryEscape to url.PathEscape, so a space is written as %20 rather than +. The decode side of that SDK uses url.PathUnescape, which leaves + alone.
How opentelemetry-go fixed it:
--- a/baggage/baggage.go
+++ b/baggage/baggage.go
@@ -320,8 +320,10 @@ func (m Member) Properties() []Property { return m.properties.Copy() }
// String encodes Member into a string compliant with the W3C Baggage
// specification.
func (m Member) String() string {
- // A key is just an ASCII string, but a value is URL encoded UTF-8.
- s := fmt.Sprintf("%s%s%s", m.key, keyValueDelimiter, url.QueryEscape(m.value))
+ // A key is just an ASCII string. A value is restricted to be
+ // US-ASCII characters excluding CTLs, whitespace,
+ // DQUOTE, comma, semicolon, and backslash.
+ s := fmt.Sprintf("%s%s%s", m.key, keyValueDelimiter, url.PathEscape(m.value))
if len(m.properties) > 0 {
s = fmt.Sprintf("%s%s%s", s, propertyDelimiter, m.properties.String())
}
Suggested fix
Write a space as %20 in UrlEncode and treat + as a literal character in UrlDecode. Values that older C++ versions emitted with + are then read with a literal + by an updated C++ receiver, which is how other spec-conforming receivers already read them:
diff --git a/api/include/opentelemetry/baggage/baggage.h b/api/include/opentelemetry/baggage/baggage.h
--- a/api/include/opentelemetry/baggage/baggage.h
+++ b/api/include/opentelemetry/baggage/baggage.h
@@ -320,10 +320,6 @@ class OPENTELEMETRY_EXPORT Baggage
{
ret.push_back(c);
}
- else if (c == ' ')
- {
- ret.push_back('+');
- }
else
{
ret.push_back('%');
@@ -355,10 +351,6 @@ class OPENTELEMETRY_EXPORT Baggage
common::detail::HexDigitValue(str[i + 2])));
i += 2;
}
- else if (str[i] == '+')
- {
- ret.push_back(' ');
- }
// See https://www.w3.org/TR/baggage/#definition
else if ((str[i] >= '!') /* 21 */
&& (str[i] <= '~') /* 7E */
Verified on e854d29 (GCC 11.4.0, googletest 1.14.0, SDK and tests compiled directly with g++): the test above fails without this patch and passes with it; baggage_test and baggage_propagator_test pass with it, after changing the three baggage_test expectations that pinned the + form to %20.
I can submit a PR for this.
Checked: #3754/#3758 (values containing : rejected by the parser, fixed) and #1536/#4364 (percent-decoding OTEL_RESOURCE_ATTRIBUTES) do not cover the space/+ mapping.
- Dominant language
- C++
- Stars
- 1.4k
- Forks
- 663
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 44
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from open-telemetry/opentelemetry-cpp
-
needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
open-telemetry/opentelemetry-cpp#4697 · 1 comment ·
Maintainers usually reply within 1 day
-
TracerContext construction might result in a terminateMay be free again @akshat-lakhera claimed this 37 days ago, and no pull request is open. Opentriage/accepted
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
open-telemetry/opentelemetry-cpp#4684 · 2 comments · 2 reactions ·
Maintainers usually reply within 1 day
-
[CI] Add Ubuntu 26.04 runners to the CI workflowMay be free again A pull request for this issue was closed without being merged. Opentriage/accepted
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
open-telemetry/opentelemetry-cpp#4596 · 2 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
[BUG] Resource::Create() throws bad_variant_access if process.executable.name isn't a stringMay be free again A pull request for this issue was closed without being merged. Openbug help wanted Stale triage/accepted
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
open-telemetry/opentelemetry-cpp#4535 · 2 comments · 2 reactions ·
Maintainers usually reply within 1 day
-
[BUG] OnResponse() can call std::terminate() when the response body fails to parse as JSON/protobufPossibly taken @YuEfSaEDU claimed this 62 days ago. Openbug help wanted Stale triage/accepted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
open-telemetry/opentelemetry-cpp#4534 · 3 comments · 1 reaction ·
Maintainers usually reply within 1 day
All issues in open-telemetry/opentelemetry-cpp
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
HarperFast/rocksdb-js#1118 ·
Maintainers usually reply within 1 day
-
bug triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
26.04 bug dark-mode Easy Hack impress symptom: visual
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
CollaboraOnline/online#16421 · 1 comment ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
telegramdesktop/tdesktop#31653 ·
Maintainers usually reply within 1 day
-
area/cs bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
ydb-platform/ydb#59881 · 1 comment ·
Maintainers usually reply within 1 day