Skip to content

Commit 1fe31a9

Browse files
authored
fix: update W3CBaggagePropagator to properly handle whitespace (#5680)
* fix: update W3CBaggagePropagator to properly handle whitespace * add changelog fragment * add newline to changelog entry
1 parent 008b5b0 commit 1fe31a9

5 files changed

Lines changed: 45 additions & 5 deletions

File tree

‎.changelog/5680.fixed‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
`opentelemetry-api`: update W3CBaggagePropagator to properly handle whitespace

‎opentelemetry-api/src/opentelemetry/baggage/__init__.py‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ def _is_valid_key(name: str) -> bool:
108108

109109
def _is_valid_value(value: object) -> bool:
110110
parts = str(value).split(";")
111-
is_valid_value = _VALUE_PATTERN.fullmatch(parts[0]) is not None
111+
# W3C Baggage allows optional whitespace between the value and ";"
112+
is_valid_value = _VALUE_PATTERN.fullmatch(parts[0].rstrip(" \t")) is not None
112113
if len(parts) > 1: # one or more properties metadata
113114
for property in parts[1:]:
114115
if _PROPERT_PATTERN.fullmatch(property) is None:

‎opentelemetry-api/src/opentelemetry/baggage/propagation/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,10 @@ def extract(
111111
_logger.warning("Baggage list-member `%s` doesn't match the format", entry)
112112
continue
113113

114+
# W3C Baggage allows optional whitespace around "="
115+
name = name.strip(" \t")
116+
value = value.strip(" \t")
117+
114118
if not _is_valid_pair(name, value):
115119
_logger.warning("Invalid baggage entry: `%s`", entry)
116120
continue

‎opentelemetry-api/tests/baggage/test_baggage.py‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,11 @@ def test_clear_baggage(self):
6969
self.assertEqual(get_all(context=ctx), {})
7070

7171
def test__is_valid_value(self):
72-
self.assertTrue(_is_valid_value("GET%20%2Fapi%2F%2Freport"))
72+
for value, expected in (
73+
("GET%20%2Fapi%2F%2Freport", True),
74+
("val1 ;prop=1", True),
75+
("val1\t; p1 = 1 ; p2", True),
76+
("val 1;prop", False),
77+
):
78+
with self.subTest(value=value):
79+
self.assertEqual(_is_valid_value(value), expected)

‎opentelemetry-api/tests/propagators/test_w3cbaggagepropagator.py‎

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,36 @@ def test_valid_header(self):
4646
expected = {"key1": "val1", "key2": "val2"}
4747
self.assertEqual(self._extract(header), expected)
4848

49-
def test_invalid_header_with_space(self):
50-
header = "key1 = val1, key2 =val2 "
51-
self.assertEqual(self._extract(header), {})
49+
def test_valid_header_with_whitespace(self):
50+
for header, expected in (
51+
(
52+
"key1 = val1, key2 =val2 ",
53+
{"key1": "val1", "key2": "val2"},
54+
),
55+
("some_name = some_value", {"some_name": "some_value"}),
56+
("key1\t=\tval1", {"key1": "val1"}),
57+
("key1 = val1;prop=1", {"key1": "val1;prop=1"}),
58+
(
59+
"key1 = val1 ; prop1 = 1 ; prop2 ;prop3= 2",
60+
{"key1": "val1 ; prop1 = 1 ; prop2 ;prop3= 2"},
61+
),
62+
(
63+
"key1=val1, key2 = val2;prop = 1;prop2",
64+
{"key1": "val1", "key2": "val2;prop = 1;prop2"},
65+
),
66+
):
67+
with self.subTest(header=header):
68+
self.assertEqual(self._extract(header), expected)
69+
70+
def test_invalid_header_with_inner_whitespace(self):
71+
for header in (
72+
"key 1=val1",
73+
"key1=val 1",
74+
"key1=val1;pr op=1",
75+
" = ",
76+
):
77+
with self.subTest(header=header):
78+
self.assertEqual(self._extract(header), {})
5279

5380
def test_valid_header_with_properties(self):
5481
header = "key1=val1,key2=val2;prop=1;prop2;prop3=2"

0 commit comments

Comments
 (0)