feat: Update contrib for the experimental response propagator interface (#436)

* Revise contrib for response propagator

* Bumped composer.json

* Updated Yii composer.json

* Fixed instrumentation integration tests

* Fixed Propagation tests

* Fixed style issue for Symfony

* Fixed semconv issue of MongoDB

* Bumped sem-conv version in MongoDB to 1.36

Author: jerrytfleung

_register.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use OpenTelemetry\Contrib\Propagation\TraceResponse\TraceResponsePropagator;
+use OpenTelemetry\SDK\Registry;
+
+if (!class_exists(Registry::class)) {
+    return;
+}
+
+Registry::registerResponsePropagator(
+    'traceresponse',
+    TraceResponsePropagator::getInstance()
+);

composer.json

@@ -10,20 +10,23 @@
   "prefer-stable": true,
   "require": {
     "php": "^8.1",
-    "open-telemetry/context": "^1.0"
+    "open-telemetry/context": "^1.4"
   },
   "autoload": {
     "psr-4": {
       "OpenTelemetry\\Contrib\\Propagation\\TraceResponse\\": "src/"
-    }
+    },
+    "files": [
+      "_register.php"
+    ]
   },
   "require-dev": {
     "friendsofphp/php-cs-fixer": "^3",
     "phan/phan": "^5.0",
     "phpstan/phpstan": "^1.1",
     "phpstan/phpstan-phpunit": "^1.0",
     "psalm/plugin-phpunit": "^0.19.2",
-    "open-telemetry/sdk": "^1.0",
+    "open-telemetry/sdk": "^1.8",
     "phpunit/phpunit": "^9.5",
     "vimeo/psalm": "6.4.0",
     "symfony/http-client": "^5.4|^6.0",

src/ResponsePropagator.php

@@ -9,26 +9,38 @@
 use OpenTelemetry\Context\ContextInterface;
 use OpenTelemetry\Context\Propagation\ArrayAccessGetterSetter;
 use OpenTelemetry\Context\Propagation\PropagationSetterInterface;
+use OpenTelemetry\Context\Propagation\ResponsePropagatorInterface;
 
 /**
  * Provides a ResponsePropagator for the Trace Context HTTP Response Headers Format
  *
  * @see https://w3c.github.io/trace-context/#trace-context-http-response-headers-format
  */
-final class TraceResponsePropagator implements ResponsePropagator
+final class TraceResponsePropagator implements ResponsePropagatorInterface
 {
     const IS_SAMPLED = '01';
     const NOT_SAMPLED = '00';
     const SUPPORTED_VERSION = '00';
     const TRACERESPONSE = 'traceresponse';
 
+    private static ?self $instance = null;
+
     public function fields(): array
     {
         return [
             self::TRACERESPONSE,
         ];
     }
 
+    public static function getInstance(): self
+    {
+        if (null === self::$instance) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
     public function inject(&$carrier, ?PropagationSetterInterface $setter = null, ?ContextInterface $context = null): void
     {
         $setter = $setter ?? ArrayAccessGetterSetter::getInstance();

src/TraceResponsePropagator.php

@@ -11,7 +11,7 @@
 use OpenTelemetry\API\Trace\TraceState;
 use OpenTelemetry\Context\Context;
 use OpenTelemetry\Context\ContextInterface;
-use OpenTelemetry\Contrib\Propagation\TraceResponse\TraceResponsePropagator as Propagator;
+use OpenTelemetry\Contrib\Propagation\TraceResponse\TraceResponsePropagator;
 use OpenTelemetry\SDK\Trace\Span;
 use PHPUnit\Framework\TestCase;
 
@@ -21,15 +21,20 @@ class PropagatorTest extends TestCase
     private const SPAN_ID = '53995c3f42cd8ad8';
     private const TRACERESPONSE_HEADER_SAMPLED = '00-5759e988bd862e3fe1be46a994272793-53995c3f42cd8ad8-01';
     private const TRACERESPONSE_HEADER_NOT_SAMPLED = '00-5759e988bd862e3fe1be46a994272793-53995c3f42cd8ad8-00';
+    private TraceResponsePropagator $propagator;
 
+    #[\Override]
+    protected function setUp(): void
+    {
+        $this->propagator = TraceResponsePropagator::getInstance();
+    }
     /**
      * @test
      * fields() should return an array of fields with AWS X-Ray Trace ID Header
      */
     public function test_fields()
     {
-        $propagator = new Propagator();
-        $this->assertSame($propagator->fields(), [Propagator::TRACERESPONSE]);
+        $this->assertSame($this->propagator->fields(), [TraceResponsePropagator::TRACERESPONSE]);
     }
 
     /**
@@ -40,7 +45,7 @@ public function test_fields()
     public function test_inject_valid_sampled_trace_id()
     {
         $carrier = [];
-        (new Propagator())->inject(
+        $this->propagator->inject(
             $carrier,
             null,
             $this->withSpanContext(
@@ -50,7 +55,7 @@ public function test_inject_valid_sampled_trace_id()
         );
 
         $this->assertSame(
-            [Propagator::TRACERESPONSE => self::TRACERESPONSE_HEADER_SAMPLED],
+            [TraceResponsePropagator::TRACERESPONSE => self::TRACERESPONSE_HEADER_SAMPLED],
             $carrier
         );
     }
@@ -62,7 +67,7 @@ public function test_inject_valid_sampled_trace_id()
     public function test_inject_valid_not_sampled_trace_id()
     {
         $carrier = [];
-        (new Propagator())->inject(
+        $this->propagator->inject(
             $carrier,
             null,
             $this->withSpanContext(
@@ -72,7 +77,7 @@ public function test_inject_valid_not_sampled_trace_id()
         );
 
         $this->assertSame(
-            [Propagator::TRACERESPONSE => self::TRACERESPONSE_HEADER_NOT_SAMPLED],
+            [TraceResponsePropagator::TRACERESPONSE => self::TRACERESPONSE_HEADER_NOT_SAMPLED],
             $carrier
         );
     }
@@ -84,7 +89,7 @@ public function test_inject_valid_not_sampled_trace_id()
     public function test_inject_trace_id_with_trace_state()
     {
         $carrier = [];
-        (new Propagator())->inject(
+        $this->propagator->inject(
             $carrier,
             null,
             $this->withSpanContext(
@@ -94,7 +99,7 @@ public function test_inject_trace_id_with_trace_state()
         );
 
         $this->assertSame(
-            [Propagator::TRACERESPONSE => self::TRACERESPONSE_HEADER_SAMPLED],
+            [TraceResponsePropagator::TRACERESPONSE => self::TRACERESPONSE_HEADER_SAMPLED],
             $carrier
         );
     }
@@ -106,7 +111,7 @@ public function test_inject_trace_id_with_trace_state()
     public function test_inject_trace_id_with_invalid_span_context()
     {
         $carrier = [];
-        (new Propagator())->inject(
+        $this->propagator->inject(
             $carrier,
             null,
             $this->withSpanContext(