allow to pass iterator to with_baggage()

Author: gruebel

opentelemetry-sdk/src/propagation/baggage.rs

@@ -1,5 +1,5 @@
 use opentelemetry::{
-    baggage::{Baggage, BaggageExt, KeyValueMetadata},
+    baggage::{BaggageExt, KeyValueMetadata},
     otel_warn,
     propagation::{text_map_propagator::FieldIter, Extractor, Injector, TextMapPropagator},
     Context,
@@ -151,7 +151,7 @@ impl TextMapPropagator for BaggagePropagator {
                     None
                 }
             });
-            cx.with_baggage(Baggage::from_iter(baggage))
+            cx.with_baggage(baggage)
         } else {
             cx.clone()
         }
@@ -278,7 +278,7 @@ mod tests {
 
         for (kvm, header_parts) in valid_inject_data() {
             let mut injector = HashMap::new();
-            let cx = Context::current_with_baggage(Baggage::from_iter(kvm));
+            let cx = Context::current_with_baggage(kvm);
             propagator.inject_context(&cx, &mut injector);
             let header_value = injector.get(BAGGAGE_HEADER).unwrap();
             assert_eq!(header_parts.join(",").len(), header_value.len(),);
@@ -310,7 +310,7 @@ mod tests {
 
         for (kvm, header_parts) in valid_inject_data_metadata() {
             let mut injector = HashMap::new();
-            let cx = Context::current_with_baggage(Baggage::from_iter(kvm));
+            let cx = Context::current_with_baggage(kvm);
             propagator.inject_context(&cx, &mut injector);
             let header_value = injector.get(BAGGAGE_HEADER).unwrap();
 

opentelemetry/CHANGELOG.md

@@ -12,7 +12,7 @@
   - Updated `Baggage` constants to reflect latest standard (`MAX_KEY_VALUE_PAIRS` - 180 -> 64, `MAX_BYTES_FOR_ONE_PAIR` - removed) and increased insert performance see #[2284](https://github.com/open-telemetry/opentelemetry-rust/pull/2284).
   - Align `Baggage.remove()` signature with `.get()` to take the key as a reference
   - `Baggage` can't be retrieved from the `Context` directly anymore and needs to be accessed via `context.baggage()`
-  - `with_baggage()` and `current_with_baggage()` only accept a `Baggage` instance and override any existing `Baggage` in the `Context`
+  - `with_baggage()` and `current_with_baggage()` override any existing `Baggage` in the `Context`
 
 ## 0.28.0
 

opentelemetry/src/baggage.rs

@@ -273,6 +273,16 @@ impl FromIterator<KeyValueMetadata> for Baggage {
     }
 }
 
+impl<I> From<I> for Baggage
+where
+    I: IntoIterator,
+    I::Item: Into<KeyValueMetadata>,
+{
+    fn from(value: I) -> Self {
+        value.into_iter().map(Into::into).collect()
+    }
+}
+
 fn encode(s: &str) -> String {
     let mut encoded_string = String::with_capacity(s.len());
 
@@ -312,21 +322,27 @@ pub trait BaggageExt {
     /// # Examples
     ///
     /// ```
-    /// use opentelemetry::{baggage::{Baggage, BaggageExt}, Context, StringValue};
+    /// use opentelemetry::{baggage::{Baggage, BaggageExt}, Context, KeyValue, StringValue};
     ///
+    /// // Explicit `Baggage` creation
     /// let mut baggage = Baggage::new();
     /// let _ = baggage.insert("my-name", "my-value");
     ///
     /// let cx = Context::map_current(|cx| {
     ///     cx.with_baggage(baggage)
     /// });
     ///
+    /// // Passing an iterator
+    /// let cx = Context::map_current(|cx| {
+    ///     cx.with_baggage(vec![KeyValue::new("my-name", "my-value")])
+    /// });
+    ///
     /// assert_eq!(
     ///     cx.baggage().get("my-name"),
     ///     Some(&StringValue::from("my-value")),
     /// )
     /// ```
-    fn with_baggage(&self, baggage: Baggage) -> Self;
+    fn with_baggage<T: Into<Baggage>>(&self, baggage: T) -> Self;
 
     /// Returns a clone of the current context with the included name/value pairs.
     ///
@@ -345,7 +361,7 @@ pub trait BaggageExt {
     ///     Some(&StringValue::from("my-value")),
     /// )
     /// ```
-    fn current_with_baggage(baggage: Baggage) -> Self;
+    fn current_with_baggage<T: Into<Baggage>>(baggage: T) -> Self;
 
     /// Returns a clone of the given context with no baggage.
     ///
@@ -370,11 +386,11 @@ pub trait BaggageExt {
 struct BaggageContextValue(Baggage);
 
 impl BaggageExt for Context {
-    fn with_baggage(&self, baggage: Baggage) -> Self {
-        self.with_value(BaggageContextValue(baggage))
+    fn with_baggage<T: Into<Baggage>>(&self, baggage: T) -> Self {
+        self.with_value(BaggageContextValue(baggage.into()))
     }
 
-    fn current_with_baggage(baggage: Baggage) -> Self {
+    fn current_with_baggage<T: Into<Baggage>>(baggage: T) -> Self {
         Context::map_current(|cx| cx.with_baggage(baggage))
     }
 

opentelemetry/src/propagation/composite.rs

@@ -23,7 +23,7 @@ use std::collections::HashSet;
 ///
 /// ```
 /// use opentelemetry::{
-///     baggage::{Baggage, BaggageExt},
+///     baggage::BaggageExt,
 ///     propagation::{TextMapPropagator, TextMapCompositePropagator},
 ///
 ///     trace::{TraceContextExt, Tracer, TracerProvider},
@@ -56,7 +56,7 @@ use std::collections::HashSet;
 /// // with the current context, call inject to add the headers
 /// composite_propagator.inject_context(
 ///     &Context::current_with_span(example_span)
-///         .with_baggage(Baggage::from_iter([KeyValue::new("test", "example")])),
+///         .with_baggage(vec![KeyValue::new("test", "example")]),
 ///     &mut injector,
 /// );
 ///
@@ -115,7 +115,7 @@ impl TextMapPropagator for TextMapCompositePropagator {
 
 #[cfg(all(test, feature = "trace"))]
 mod tests {
-    use crate::baggage::{Baggage, BaggageExt};
+    use crate::baggage::BaggageExt;
     use crate::propagation::TextMapCompositePropagator;
     use crate::testing::trace::TestSpan;
     use crate::{
@@ -162,9 +162,7 @@ mod tests {
                     false,
                     TraceState::default(),
                 )),
-                ("baggage", Some(_)) => {
-                    cx.with_baggage(Baggage::from_iter([KeyValue::new("baggagekey", "value")]))
-                }
+                ("baggage", Some(_)) => cx.with_baggage(vec![KeyValue::new("baggagekey", "value")]),
                 _ => cx.clone(),
             }
         }
@@ -184,7 +182,7 @@ mod tests {
             TraceState::default(),
         )));
         // setup for baggage propagator
-        cx.with_baggage(Baggage::from_iter([KeyValue::new("baggagekey", "value")]))
+        cx.with_baggage(vec![KeyValue::new("baggagekey", "value")])
     }
 
     fn test_data() -> Vec<(&'static str, &'static str)> {