move TextMapPropagatorFactoryInterface to SDK

reorganise extension propagator factories into SDK, and add a deptrac rule to allow SDK->Extension dependency. Add PackageDependency attribute to the SDK-housed extension propagator factories.
open-telemetry · Jan 17, 2025 · 0571d3b · 0571d3b
1 parent ae70eeb
commit 0571d3b
Show file tree

Hide file tree

Showing 23 changed files with 96 additions and 95 deletions.
diff --git a/composer.json b/composer.json
@@ -44,7 +44,8 @@
         "open-telemetry/exporter-otlp": "1.0.x-dev",
         "open-telemetry/exporter-zipkin": "1.0.x-dev",
         "open-telemetry/extension-propagator-b3": "1.0.x-dev",
-        "open-telemetry/extension-propagator-jaeger": "0.0.2",
+        "open-telemetry/extension-propagator-cloudtrace": "0.0.4",
+        "open-telemetry/extension-propagator-jaeger": "0.0.3",
         "open-telemetry/gen-otlp-protobuf": "1.0.x-dev",
         "open-telemetry/sdk": "1.0.x-dev",
         "open-telemetry/sdk-configuration": "0.1.x-dev",
@@ -65,9 +66,6 @@
             "src/Contrib/Otlp/_register.php",
             "src/Contrib/Grpc/_register.php",
             "src/Contrib/Zipkin/_register.php",
-            "src/Extension/Propagator/B3/_register.php",
-            "src/Extension/Propagator/CloudTrace/_register.php",
-            "src/Extension/Propagator/Jaeger/_register.php",
             "src/SDK/_register.php",
             "src/SDK/Common/Dev/Compatibility/_load.php",
             "src/SDK/Common/Util/functions.php",
@@ -130,12 +128,10 @@
             "autoload-files": [
                 "examples/src/_register.php",
                 "src/API/_register.php",
+                "src/Config/SDK/_register.php",
                 "src/Contrib/Otlp/_register.php",
                 "src/Contrib/Grpc/_register.php",
                 "src/Contrib/Zipkin/_register.php",
-                "src/Extension/Propagator/B3/_register.php",
-                "src/Extension/Propagator/CloudTrace/_register.php",
-                "src/Extension/Propagator/Jaeger/_register.php",
                 "src/SDK/_register.php",
                 "tests/_register.php"
             ],

diff --git a/deptrac.yaml b/deptrac.yaml
@@ -131,6 +131,7 @@ deptrac:
       SDK:
           - +API
           - ConfigSDK
+          - Extension
           - SemConv
           - PsrHttp
           - HttpPlug

diff --git a/src/Config/SDK/ComponentProvider/Propagator/TextMapPropagatorCloudTrace.php b/src/Config/SDK/ComponentProvider/Propagator/TextMapPropagatorCloudTrace.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\Config\SDK\ComponentProvider\Propagator;
+
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProvider;
+use OpenTelemetry\Config\SDK\Configuration\ComponentProviderRegistry;
+use OpenTelemetry\Config\SDK\Configuration\Context;
+use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\CloudTrace\CloudTracePropagator;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeBuilder;
+
+/**
+ * @implements ComponentProvider<TextMapPropagatorInterface>
+ */
+#[PackageDependency('open-telemetry/extension-propagator-cloudtrace', '^0.0.4')]
+final class TextMapPropagatorCloudTrace implements ComponentProvider
+{
+    /**
+     * @param array{} $properties
+     */
+    public function createPlugin(array $properties, Context $context): TextMapPropagatorInterface
+    {
+        return CloudTracePropagator::getInstance();
+    }
+
+    public function getConfig(ComponentProviderRegistry $registry, NodeBuilder $builder): ArrayNodeDefinition
+    {
+        return $builder->arrayNode('cloudtrace');
+    }
+}
diff --git a/src/Config/SDK/ComponentProvider/Propagator/TextMapPropagatorJaeger.php b/src/Config/SDK/ComponentProvider/Propagator/TextMapPropagatorJaeger.php
@@ -16,7 +16,7 @@
 /**
  * @implements ComponentProvider<TextMapPropagatorInterface>
  */
-#[PackageDependency('open-telemetry/extension-propagator-jaeger', '^0.0.2')]
+#[PackageDependency('open-telemetry/extension-propagator-jaeger', '^0.0.3')]
 final class TextMapPropagatorJaeger implements ComponentProvider
 {
     /**

diff --git a/src/Config/SDK/_register.php b/src/Config/SDK/_register.php
@@ -16,6 +16,7 @@
 use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorB3;
 use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorB3Multi;
 use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorBaggage;
+use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorCloudTrace;
 use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorComposite;
 use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorJaeger;
 use OpenTelemetry\Config\SDK\ComponentProvider\Propagator\TextMapPropagatorTraceContext;
@@ -34,6 +35,7 @@
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorB3Multi::class);
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorBaggage::class);
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorComposite::class);
+ServiceLoader::register(ComponentProvider::class, TextMapPropagatorCloudTrace::class);
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorJaeger::class);
 ServiceLoader::register(ComponentProvider::class, TextMapPropagatorTraceContext::class);
 

diff --git a/src/Context/Propagation/TextMapPropagatorFactoryInterface.php b/src/Context/Propagation/TextMapPropagatorFactoryInterface.php
diff --git a/src/Extension/Propagator/B3/_register.php b/src/Extension/Propagator/B3/_register.php
diff --git a/src/Extension/Propagator/B3/composer.json b/src/Extension/Propagator/B3/composer.json
@@ -25,19 +25,12 @@
     "autoload": {
         "psr-4": {
             "OpenTelemetry\\Extension\\Propagator\\B3\\": "."
-        },
-        "files": [
-            "_register.php"
-        ]
+        }
     },
     "extra": {
         "branch-alias": {
             "dev-main": "1.0.x-dev",
             "dev-2.x": "2.x-dev"
-        },
-        "spi-config": {
-            "autoload-files": true,
-            "prune-autoload-files": true
         }
     }
 }
diff --git a/src/Extension/Propagator/CloudTrace/_register.php b/src/Extension/Propagator/CloudTrace/_register.php
diff --git a/src/Extension/Propagator/CloudTrace/composer.json b/src/Extension/Propagator/CloudTrace/composer.json
@@ -25,19 +25,12 @@
     "autoload": {
         "psr-4": {
             "OpenTelemetry\\Extension\\Propagator\\CloudTrace\\": "."
-        },
-        "files": [
-            "_register.php"
-        ]
+        }
     },
     "extra": {
         "branch-alias": {
             "dev-main": "1.0.x-dev",
             "dev-2.x": "2.x-dev"
-        },
-        "spi-config": {
-            "autoload-files": true,
-            "prune-autoload-files": true
         }
     }
 }
diff --git a/src/Extension/Propagator/Jaeger/_register.php b/src/Extension/Propagator/Jaeger/_register.php
diff --git a/src/Extension/Propagator/Jaeger/composer.json b/src/Extension/Propagator/Jaeger/composer.json
@@ -25,19 +25,12 @@
     "autoload": {
         "psr-4": {
             "OpenTelemetry\\Extension\\Propagator\\Jaeger\\": "."
-        },
-        "files": [
-            "_register.php"
-        ]
+        }
     },
     "extra": {
         "branch-alias": {
             "dev-main": "1.0.x-dev",
             "dev-2.x": "2.x-dev"
-        },
-        "spi-config": {
-            "autoload-files": true,
-            "prune-autoload-files": true
         }
     }
 }
diff --git a/src/SDK/Common/Services/Loader.php b/src/SDK/Common/Services/Loader.php
@@ -5,11 +5,11 @@
 namespace OpenTelemetry\SDK\Common\Services;
 
 use Nevay\SPI\ServiceLoader;
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use OpenTelemetry\SDK\Common\Export\TransportFactoryInterface;
 use OpenTelemetry\SDK\Logs\LogRecordExporterFactoryInterface;
 use OpenTelemetry\SDK\Metrics\MetricExporterFactoryInterface;
+use OpenTelemetry\SDK\Propagation\TextMapPropagatorFactoryInterface;
 use OpenTelemetry\SDK\Resource\ResourceDetectorFactoryInterface;
 use OpenTelemetry\SDK\Resource\ResourceDetectorInterface;
 use OpenTelemetry\SDK\Trace\SpanExporter\SpanExporterFactoryInterface;
@@ -21,7 +21,7 @@
 class Loader
 {
     /**
-     * @param class-string $class
+     * @param class-string<SpiLoadableInterface> $class
      * @phan-suppress PhanTypeNonVarPassByRef
      */
     private static function getFactory(string $class, string $type): mixed

diff --git a/...ropagator/B3/B3MultiPropagatorFactory.php → .../Propagation/B3MultiPropagatorFactory.php b/...ropagator/B3/B3MultiPropagatorFactory.php → .../Propagation/B3MultiPropagatorFactory.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Extension\Propagator\B3;
+namespace OpenTelemetry\SDK\Propagation;
 
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\B3\B3Propagator;
 
+#[PackageDependency('open-telemetry/extension-propagator-b3', '^1')]
 class B3MultiPropagatorFactory implements TextMapPropagatorFactoryInterface
 {
     public function create(): TextMapPropagatorInterface

diff --git a/...ion/Propagator/B3/B3PropagatorFactory.php → src/SDK/Propagation/B3PropagatorFactory.php b/...ion/Propagator/B3/B3PropagatorFactory.php → src/SDK/Propagation/B3PropagatorFactory.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Extension\Propagator\B3;
+namespace OpenTelemetry\SDK\Propagation;
 
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\B3\B3Propagator;
 
+#[PackageDependency('open-telemetry/extension-propagator-b3', '^1')]
 class B3PropagatorFactory implements TextMapPropagatorFactoryInterface
 {
     public function create(): TextMapPropagatorInterface

diff --git a/src/SDK/Propagation/BaggagePropagatorFactory.php b/src/SDK/Propagation/BaggagePropagatorFactory.php
@@ -7,7 +7,6 @@
 ;
 
 use OpenTelemetry\API\Baggage\Propagation\BaggagePropagator;
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use OpenTelemetry\SDK\Common\Configuration\KnownValues;
 

diff --git a/...ace/CloudTraceOneWayPropagatorFactory.php → ...ion/CloudTraceOneWayPropagatorFactory.php b/...ace/CloudTraceOneWayPropagatorFactory.php → ...ion/CloudTraceOneWayPropagatorFactory.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Extension\Propagator\CloudTrace;
+namespace OpenTelemetry\SDK\Propagation;
 
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\CloudTrace\CloudTracePropagator;
 
+#[PackageDependency('open-telemetry/extension-propagator-cloudtrace', '^0')]
 class CloudTraceOneWayPropagatorFactory implements TextMapPropagatorFactoryInterface
 {
     public function create(): TextMapPropagatorInterface

diff --git a/...loudTrace/CloudTracePropagatorFactory.php → ...opagation/CloudTracePropagatorFactory.php b/...loudTrace/CloudTracePropagatorFactory.php → ...opagation/CloudTracePropagatorFactory.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Extension\Propagator\CloudTrace;
+namespace OpenTelemetry\SDK\Propagation;
 
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\CloudTrace\CloudTracePropagator;
 
+#[PackageDependency('open-telemetry/extension-propagator-cloudtrace', '^0')]
 class CloudTracePropagatorFactory implements TextMapPropagatorFactoryInterface
 {
     public function create(): TextMapPropagatorInterface

diff --git a/...Jaeger/JaegerBaggagePropagatorFactory.php → ...gation/JaegerBaggagePropagatorFactory.php b/...Jaeger/JaegerBaggagePropagatorFactory.php → ...gation/JaegerBaggagePropagatorFactory.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Extension\Propagator\Jaeger;
+namespace OpenTelemetry\SDK\Propagation;
 
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\Jaeger\JaegerBaggagePropagator;
 
+#[PackageDependency('open-telemetry/extension-propagator-jaeger', '^0')]
 class JaegerBaggagePropagatorFactory implements TextMapPropagatorFactoryInterface
 {
     public function create(): TextMapPropagatorInterface

diff --git a/...agator/Jaeger/JaegerPropagatorFactory.php → ...K/Propagation/JaegerPropagatorFactory.php b/...agator/Jaeger/JaegerPropagatorFactory.php → ...K/Propagation/JaegerPropagatorFactory.php
@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace OpenTelemetry\Extension\Propagator\Jaeger;
+namespace OpenTelemetry\SDK\Propagation;
 
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
+use Nevay\SPI\ServiceProviderDependency\PackageDependency;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\Extension\Propagator\Jaeger\JaegerPropagator;
 
+#[PackageDependency('open-telemetry/extension-propagator-jaeger', '^0')]
 class JaegerPropagatorFactory implements TextMapPropagatorFactoryInterface
 {
     public function create(): TextMapPropagatorInterface

diff --git a/src/SDK/Propagation/TextMapPropagatorFactoryInterface.php b/src/SDK/Propagation/TextMapPropagatorFactoryInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OpenTelemetry\SDK\Propagation;
+
+use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
+use OpenTelemetry\SDK\Common\Services\SpiLoadableInterface;
+
+interface TextMapPropagatorFactoryInterface extends SpiLoadableInterface
+{
+    public function create(): TextMapPropagatorInterface;
+}
diff --git a/src/SDK/Propagation/TraceContextPropagatorFactory.php b/src/SDK/Propagation/TraceContextPropagatorFactory.php
@@ -7,7 +7,6 @@
 ;
 
 use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
 use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
 use OpenTelemetry\SDK\Common\Configuration\KnownValues;
 

diff --git a/src/SDK/_register.php b/src/SDK/_register.php
@@ -3,22 +3,33 @@
 declare(strict_types=1);
 
 use Nevay\SPI\ServiceLoader;
-
-use OpenTelemetry\Context\Propagation\TextMapPropagatorFactoryInterface;
 use OpenTelemetry\SDK\Common\Export\Http\PsrTransportFactory;
 use OpenTelemetry\SDK\Common\Export\Stream\StreamTransportFactory;
 use OpenTelemetry\SDK\Common\Export\TransportFactoryInterface;
 use OpenTelemetry\SDK\Logs\Exporter as LogsExporter;
 use OpenTelemetry\SDK\Logs\LogRecordExporterFactoryInterface;
 use OpenTelemetry\SDK\Metrics\MetricExporter;
 use OpenTelemetry\SDK\Metrics\MetricExporterFactoryInterface;
+use OpenTelemetry\SDK\Propagation\B3MultiPropagatorFactory;
+use OpenTelemetry\SDK\Propagation\B3PropagatorFactory;
 use OpenTelemetry\SDK\Propagation\BaggagePropagatorFactory;
+use OpenTelemetry\SDK\Propagation\CloudTraceOneWayPropagatorFactory;
+use OpenTelemetry\SDK\Propagation\CloudTracePropagatorFactory;
+use OpenTelemetry\SDK\Propagation\JaegerBaggagePropagatorFactory;
+use OpenTelemetry\SDK\Propagation\JaegerPropagatorFactory;
+use OpenTelemetry\SDK\Propagation\TextMapPropagatorFactoryInterface;
 use OpenTelemetry\SDK\Propagation\TraceContextPropagatorFactory;
 use OpenTelemetry\SDK\Trace\SpanExporter;
 use OpenTelemetry\SDK\Trace\SpanExporter\SpanExporterFactoryInterface;
 
 ServiceLoader::register(TextMapPropagatorFactoryInterface::class, BaggagePropagatorFactory::class);
 ServiceLoader::register(TextMapPropagatorFactoryInterface::class, TraceContextPropagatorFactory::class);
+ServiceLoader::register(TextMapPropagatorFactoryInterface::class, B3PropagatorFactory::class);
+ServiceLoader::register(TextMapPropagatorFactoryInterface::class, B3MultiPropagatorFactory::class);
+ServiceLoader::register(TextMapPropagatorFactoryInterface::class, CloudTracePropagatorFactory::class);
+ServiceLoader::register(TextMapPropagatorFactoryInterface::class, CloudTraceOneWayPropagatorFactory::class);
+ServiceLoader::register(TextMapPropagatorFactoryInterface::class, JaegerPropagatorFactory::class);
+ServiceLoader::register(TextMapPropagatorFactoryInterface::class, JaegerBaggagePropagatorFactory::class);
 
 ServiceLoader::register(LogRecordExporterFactoryInterface::class, LogsExporter\ConsoleExporterFactory::class);
 ServiceLoader::register(LogRecordExporterFactoryInterface::class, LogsExporter\InMemoryExporterFactory::class);
-Original file line number
+Diff line change
@@ Expand Up / @@ -131,6 +131,7 @@ deptrac: @@
           SDK:
               - +API
               - ConfigSDK
+              - Extension
               - SemConv
               - PsrHttp
               - HttpPlug
@@ Expand Down @@