Sync with Remove setters and getters

Fixes #issue_371

.github/workflows/test.yml

@@ -6,7 +6,7 @@ on:
     - 'release/*'
   pull_request:
 env:
-  CORE_REPO_SHA: d3694fc520f8542b232fd1065133286f4591dcec
+  CORE_REPO_SHA: 0f80fdcbf29420b2134926b014a7d2abb0fa6778
 
 jobs:
   build:

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python-contrib/compare/v0.18b0...HEAD)
+- Remove getters and setters from propagators
+  ([#372](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/364))
 - Updated instrumentations to use `opentelemetry.trace.use_span` instead of `Tracer.use_span()`
   ([#364](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/364))
 

docs/nitpick-exceptions.ini

@@ -2,10 +2,6 @@
 class_references=
     ; TODO: Understand why sphinx is not able to find this local class
     opentelemetry.propagators.textmap.TextMapPropagator
-    ; - AwsXRayFormat
-    opentelemetry.propagators.textmap.DictGetter
-    ; API
-    opentelemetry.propagators.textmap.Getter
     ; - DatadogFormat
     ; - AWSXRayFormat
     opentelemetry.sdk.trace.id_generator.IdGenerator

exporter/opentelemetry-exporter-datadog/src/opentelemetry/exporter/datadog/propagator.py

@@ -18,8 +18,6 @@
 from opentelemetry.context import Context
 from opentelemetry.exporter.datadog import constants
 from opentelemetry.propagators.textmap import (
-    Getter,
-    Setter,
     TextMapPropagator,
     TextMapPropagatorT,
 )
@@ -36,23 +34,16 @@ class DatadogFormat(TextMapPropagator):
 
     def extract(
         self,
-        getter: Getter[TextMapPropagatorT],
         carrier: TextMapPropagatorT,
         context: typing.Optional[Context] = None,
     ) -> Context:
-        trace_id = extract_first_element(
-            getter.get(carrier, self.TRACE_ID_KEY)
-        )
+        trace_id = carrier.get(self.TRACE_ID_KEY)
 
-        span_id = extract_first_element(
-            getter.get(carrier, self.PARENT_ID_KEY)
-        )
+        span_id = carrier.get(self.PARENT_ID_KEY)
 
-        sampled = extract_first_element(
-            getter.get(carrier, self.SAMPLING_PRIORITY_KEY)
-        )
+        sampled = carrier.get(self.SAMPLING_PRIORITY_KEY)
 
-        origin = extract_first_element(getter.get(carrier, self.ORIGIN_KEY))
+        origin = carrier.get(self.ORIGIN_KEY)
 
         trace_flags = trace.TraceFlags()
         if sampled and int(sampled) in (
@@ -81,7 +72,6 @@ def extract(
 
     def inject(
         self,
-        set_in_carrier: Setter[TextMapPropagatorT],
         carrier: TextMapPropagatorT,
         context: typing.Optional[Context] = None,
     ) -> None:
@@ -90,23 +80,15 @@ def inject(
         if span_context == trace.INVALID_SPAN_CONTEXT:
             return
         sampled = (trace.TraceFlags.SAMPLED & span.context.trace_flags) != 0
-        set_in_carrier(
-            carrier, self.TRACE_ID_KEY, format_trace_id(span.context.trace_id),
-        )
-        set_in_carrier(
-            carrier, self.PARENT_ID_KEY, format_span_id(span.context.span_id)
-        )
-        set_in_carrier(
-            carrier,
-            self.SAMPLING_PRIORITY_KEY,
-            str(constants.AUTO_KEEP if sampled else constants.AUTO_REJECT),
+        carrier[self.TRACE_ID_KEY] = format_trace_id(span.context.trace_id)
+        carrier[self.PARENT_ID_KEY] = format_span_id(span.context.span_id)
+        carrier[self.SAMPLING_PRIORITY_KEY] = str(
+            constants.AUTO_KEEP if sampled else constants.AUTO_REJECT
         )
         if constants.DD_ORIGIN in span.context.trace_state:
-            set_in_carrier(
-                carrier,
-                self.ORIGIN_KEY,
-                span.context.trace_state[constants.DD_ORIGIN],
-            )
+            carrier[self.ORIGIN_KEY] = span.context.trace_state[
+                constants.DD_ORIGIN
+            ]
 
     @property
     def fields(self):
@@ -131,11 +113,3 @@ def format_trace_id(trace_id: int) -> str:
 def format_span_id(span_id: int) -> str:
     """Format the span id for Datadog."""
     return str(span_id)
-
-
-def extract_first_element(
-    items: typing.Iterable[TextMapPropagatorT],
-) -> typing.Optional[TextMapPropagatorT]:
-    if items is None:
-        return None
-    return next(iter(items), None)

exporter/opentelemetry-exporter-datadog/tests/test_datadog_format.py

@@ -17,15 +17,12 @@
 
 from opentelemetry import trace as trace_api
 from opentelemetry.exporter.datadog import constants, propagator
-from opentelemetry.propagators.textmap import DictGetter
 from opentelemetry.sdk import trace
 from opentelemetry.sdk.trace.id_generator import RandomIdGenerator
 from opentelemetry.trace import get_current_span, set_span_in_context
 
 FORMAT = propagator.DatadogFormat()
 
-carrier_getter = DictGetter()
-
 
 class TestDatadogFormat(unittest.TestCase):
     @classmethod
@@ -45,7 +42,6 @@ def test_malformed_headers(self):
         malformed_parent_id_key = FORMAT.PARENT_ID_KEY + "-x"
         context = get_current_span(
             FORMAT.extract(
-                carrier_getter,
                 {
                     malformed_trace_id_key: self.serialized_trace_id,
                     malformed_parent_id_key: self.serialized_parent_id,
@@ -63,7 +59,7 @@ def test_missing_trace_id(self):
             FORMAT.PARENT_ID_KEY: self.serialized_parent_id,
         }
 
-        ctx = FORMAT.extract(carrier_getter, carrier)
+        ctx = FORMAT.extract(carrier)
         span_context = get_current_span(ctx).get_span_context()
         self.assertEqual(span_context.trace_id, trace_api.INVALID_TRACE_ID)
 
@@ -73,15 +69,14 @@ def test_missing_parent_id(self):
             FORMAT.TRACE_ID_KEY: self.serialized_trace_id,
         }
 
-        ctx = FORMAT.extract(carrier_getter, carrier)
+        ctx = FORMAT.extract(carrier)
         span_context = get_current_span(ctx).get_span_context()
         self.assertEqual(span_context.span_id, trace_api.INVALID_SPAN_ID)
 
     def test_context_propagation(self):
         """Test the propagation of Datadog headers."""
         parent_span_context = get_current_span(
             FORMAT.extract(
-                carrier_getter,
                 {
                     FORMAT.TRACE_ID_KEY: self.serialized_trace_id,
                     FORMAT.PARENT_ID_KEY: self.serialized_parent_id,
@@ -118,7 +113,7 @@ def test_context_propagation(self):
 
         child_carrier = {}
         child_context = set_span_in_context(child)
-        FORMAT.inject(dict.__setitem__, child_carrier, context=child_context)
+        FORMAT.inject(child_carrier, context=child_context)
 
         self.assertEqual(
             child_carrier[FORMAT.TRACE_ID_KEY], self.serialized_trace_id
@@ -138,7 +133,6 @@ def test_sampling_priority_auto_reject(self):
         """Test sampling priority rejected."""
         parent_span_context = get_current_span(
             FORMAT.extract(
-                carrier_getter,
                 {
                     FORMAT.TRACE_ID_KEY: self.serialized_trace_id,
                     FORMAT.PARENT_ID_KEY: self.serialized_parent_id,
@@ -165,7 +159,7 @@ def test_sampling_priority_auto_reject(self):
 
         child_carrier = {}
         child_context = set_span_in_context(child)
-        FORMAT.inject(dict.__setitem__, child_carrier, context=child_context)
+        FORMAT.inject(child_carrier, context=child_context)
 
         self.assertEqual(
             child_carrier[FORMAT.SAMPLING_PRIORITY_KEY],
@@ -178,8 +172,6 @@ def test_fields(self, mock_get_current_span):
 
         tracer = trace.TracerProvider().get_tracer("sdk_tracer_provider")
 
-        mock_set_in_carrier = Mock()
-
         mock_get_current_span.configure_mock(
             **{
                 "return_value": Mock(
@@ -193,13 +185,10 @@ def test_fields(self, mock_get_current_span):
             }
         )
 
+        carrier = {}
+
         with tracer.start_as_current_span("parent"):
             with tracer.start_as_current_span("child"):
-                FORMAT.inject(mock_set_in_carrier, {})
-
-        inject_fields = set()
-
-        for call in mock_set_in_carrier.mock_calls:
-            inject_fields.add(call[1][1])
+                FORMAT.inject(carrier)
 
-        self.assertEqual(FORMAT.fields, inject_fields)
+        self.assertEqual(FORMAT.fields, carrier.keys())

instrumentation/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py

@@ -13,12 +13,11 @@
 # limitations under the License.
 
 """
-The opentelemetry-instrumentation-asgi package provides an ASGI middleware that can be used
-on any ASGI framework (such as Django-channels / Quart) to track requests
-timing through OpenTelemetry.
+The opentelemetry-instrumentation-asgi package provides an ASGI middleware that
+can be used on any ASGI framework (such as Django-channels / Quart) to track
+requests timing through OpenTelemetry.
 """
 
-import typing
 import urllib
 from functools import wraps
 from typing import Tuple
@@ -29,46 +28,37 @@
 from opentelemetry.instrumentation.asgi.version import __version__  # noqa
 from opentelemetry.instrumentation.utils import http_status_to_status_code
 from opentelemetry.propagate import extract
-from opentelemetry.propagators.textmap import DictGetter
 from opentelemetry.trace.status import Status, StatusCode
+from opentelemetry.util.http import BaseCustomGetDictionary
 
 
-class CarrierGetter(DictGetter):
-    def get(
-        self, carrier: dict, key: str
-    ) -> typing.Optional[typing.List[str]]:
-        """Getter implementation to retrieve a HTTP header value from the ASGI
-        scope.
+class _ASGICustomGetDictionary(BaseCustomGetDictionary):
+    def get(self, name, default=None):
 
-        Args:
-            carrier: ASGI scope object
-            key: header name in scope
-        Returns:
-            A list with a single string with the header value if it exists,
-                else None.
-        """
-        headers = carrier.get("headers")
-        if not headers:
-            return None
+        if "headers" not in self.keys():
+            return default
+
+        # ASGI header keys are in lower case
+        name = name.lower()
 
-        # asgi header keys are in lower case
-        key = key.lower()
         decoded = [
-            _value.decode("utf8")
-            for (_key, _value) in headers
-            if _key.decode("utf8") == key
+            value.decode("utf8")
+            for key, value in self["headers"]
+            if key.decode("utf8") == key
         ]
-        if not decoded:
-            return None
-        return decoded
 
+        if not decoded:
+            return default
 
-carrier_getter = CarrierGetter()
+        return decoded
 
 
 def collect_request_attributes(scope):
     """Collects HTTP request attributes from the ASGI scope and returns a
     dictionary to be used as span creation attributes."""
+
+    scope = _ASGICustomGetDictionary(scope)
+
     server_host, port, http_url = get_host_port_url_tuple(scope)
     query_string = scope.get("query_string")
     if query_string and http_url:
@@ -88,10 +78,10 @@ def collect_request_attributes(scope):
     if http_method:
         result["http.method"] = http_method
 
-    http_host_value_list = carrier_getter.get(scope, "host")
+    http_host_value_list = scope.get("host")
     if http_host_value_list:
         result["http.server_name"] = ",".join(http_host_value_list)
-    http_user_agent = carrier_getter.get(scope, "user-agent")
+    http_user_agent = scope.get("user-agent")
     if http_user_agent:
         result["http.user_agent"] = http_user_agent[0]
 
@@ -186,7 +176,7 @@ async def __call__(self, scope, receive, send):
         if self.excluded_urls and self.excluded_urls.url_disabled(url):
             return await self.app(scope, receive, send)
 
-        token = context.attach(extract(carrier_getter, scope))
+        token = context.attach(extract(scope))
         span_name, additional_attributes = self.span_details_callback(scope)
 
         try:

instrumentation/opentelemetry-instrumentation-asgi/tests/test_getter.py

@@ -14,37 +14,21 @@
 
 from unittest import TestCase
 
-from opentelemetry.instrumentation.asgi import CarrierGetter
+from opentelemetry.instrumentation.asgi import _ASGICustomGetDictionary
 
 
-class TestCarrierGetter(TestCase):
+class TestASGICustomGetDictionary(TestCase):
     def test_get_none(self):
-        getter = CarrierGetter()
-        carrier = {}
-        val = getter.get(carrier, "test")
-        self.assertIsNone(val)
-
-    def test_get_(self):
-        getter = CarrierGetter()
-        carrier = {"headers": [(b"test-key", b"val")]}
-        expected_val = ["val"]
-        self.assertEqual(
-            getter.get(carrier, "Test-Key"),
-            expected_val,
-            "Should be case insensitive",
-        )
-        self.assertEqual(
-            getter.get(carrier, "test-key"),
-            expected_val,
-            "Should be case insensitive",
-        )
-        self.assertEqual(
-            getter.get(carrier, "TEST-KEY"),
-            expected_val,
-            "Should be case insensitive",
+        self.assertIsNone(_ASGICustomGetDictionary({}).get("test"))
+
+    def test_case_sensitivity(self):
+
+        celery_custom_get_dictionary = _ASGICustomGetDictionary(
+            {"headers": [(b"test-key", b"val")]}
         )
 
-    def test_keys(self):
-        getter = CarrierGetter()
-        keys = getter.keys({})
-        self.assertEqual(keys, [])
+        self.assertEqual(celery_custom_get_dictionary.get("Test-key"), ["val"])
+
+        self.assertEqual(celery_custom_get_dictionary.get("test-key"), ["val"])
+
+        self.assertEqual(celery_custom_get_dictionary.get("TEST-KEY"), ["val"])

instrumentation/opentelemetry-instrumentation-botocore/tests/test_botocore_instrumentation.py

@@ -410,15 +410,15 @@ def check_headers(**kwargs):
                 },
             )
 
-            self.assertIn(MockTextMapPropagator.TRACE_ID_KEY, headers)
+            self.assertIn(MockTextMapPropagator.trace_id_key, headers)
             self.assertEqual(
                 str(span.get_span_context().trace_id),
-                headers[MockTextMapPropagator.TRACE_ID_KEY],
+                headers[MockTextMapPropagator.trace_id_key],
             )
-            self.assertIn(MockTextMapPropagator.SPAN_ID_KEY, headers)
+            self.assertIn(MockTextMapPropagator.span_id_key, headers)
             self.assertEqual(
                 str(span.get_span_context().span_id),
-                headers[MockTextMapPropagator.SPAN_ID_KEY],
+                headers[MockTextMapPropagator.span_id_key],
             )
 
         finally: