disallow empty string for baggage name (#1484)

spec 1.36.0 clarifies that empty string is not a valid baggage name
open-telemetry · Jan 29, 2025 · 420b5ef · 420b5ef
1 parent e3f77b7
commit 420b5ef
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/src/API/Baggage/BaggageBuilder.php b/src/API/Baggage/BaggageBuilder.php
@@ -22,6 +22,9 @@ public function remove(string $key): BaggageBuilderInterface
     /** @inheritDoc */
     public function set(string $key, $value, ?MetadataInterface $metadata = null): BaggageBuilderInterface
     {
+        if ($key === '') {
+            return $this;
+        }
         $metadata ??= Metadata::getEmpty();
 
         $this->entries[$key] = new Entry($value, $metadata);

diff --git a/tests/Unit/API/Baggage/BaggageTest.php b/tests/Unit/API/Baggage/BaggageTest.php
@@ -125,5 +125,11 @@ public function test_get_all(): void
         );
     }
 
+    public function test_empty_name_disallowed(): void
+    {
+        $baggage = Baggage::getBuilder()->set('', 'bar')->build();
+        $this->assertTrue($baggage->isEmpty());
+    }
+
     // endregion
 }