feat: add trace id header capability (#13)

contributors: @mmross

Author: cawolf

.codacy.yml

@@ -1,2 +1,3 @@
 exclude_paths:
-  - Tests/**/*
+  - Tests/*
+  - Tests/**/*

Internal/ZipkinTracingId.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Auxmoney\OpentracingBundle\Internal;
+
+use Auxmoney\OpentracingBundle\Service\Tracing;
+use Zipkin\Propagation\B3;
+
+class ZipkinTracingId implements TracingId
+{
+    private $tracing;
+
+    public function __construct(Tracing $tracing)
+    {
+        $this->tracing = $tracing;
+    }
+
+    public function getAsString(): string
+    {
+        $context = $this->tracing->injectTracingHeadersIntoCarrier([]);
+        $traceHeaderName = strtolower(B3::TRACE_ID_NAME);
+        return $context[$traceHeaderName] ?? 'none';
+    }
+}

Resources/config/services.yaml

@@ -14,3 +14,6 @@ services:
 
   Auxmoney\OpentracingBundle\Factory\SamplerFactory:
     class: Auxmoney\OpentracingBundle\Factory\ZipkinSamplerFactory
+
+  Auxmoney\OpentracingBundle\Internal\TracingId:
+    class: Auxmoney\OpentracingBundle\Internal\ZipkinTracingId

Tests/Functional/TestProjectFiles/default/src/Command/TestCommand.php

@@ -4,28 +4,25 @@
 
 namespace App\Command;
 
-use Auxmoney\OpentracingBundle\Internal\Opentracing;
+use Auxmoney\OpentracingBundle\Internal\TracingId;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use const OpenTracing\Formats\TEXT_MAP;
 
 class TestCommand extends Command
 {
-    private $opentracing;
+    private $tracingId;
 
-    public function __construct(Opentracing $opentracing)
+    public function __construct(TracingId $tracingId)
     {
         parent::__construct('test:zipkin');
         $this->setDescription('some fancy command description');
-        $this->opentracing = $opentracing;
+        $this->tracingId = $tracingId;
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $carrier = [];
-        $this->opentracing->getTracerInstance()->inject($this->opentracing->getTracerInstance()->getActiveSpan()->getContext(), TEXT_MAP, $carrier);
-        $output->writeln(current($carrier));
+        $output->writeln($this->tracingId->getAsString());
         return 0;
     }
 }

Tests/Internal/ZipkinTracingIdTest.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Auxmoney\OpentracingBundle\Tests\Internal;
+
+use Auxmoney\OpentracingBundle\Internal\ZipkinTracingId;
+use Auxmoney\OpentracingBundle\Service\Tracing;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
+
+class ZipkinTracingIdTest extends TestCase
+{
+    /** @var Tracing|ObjectProphecy */
+    private $tracing;
+    /** @var ZipkinTracingId */
+    private $subject;
+
+    public function setUp()
+    {
+        parent::setUp();
+        $this->tracing = $this->prophesize(Tracing::class);
+
+        $this->subject = new ZipkinTracingId($this->tracing->reveal());
+    }
+
+    public function testGetAsStringSuccess(): void
+    {
+        $this->tracing->injectTracingHeadersIntoCarrier([])->shouldBeCalled()->willReturn(['x-b3-traceid' => 'abc']);
+
+        self::assertSame('abc', $this->subject->getAsString());
+    }
+
+    public function testGetAsStringNoHeader(): void
+    {
+        $this->tracing->injectTracingHeadersIntoCarrier([])->shouldBeCalled()->willReturn([]);
+
+        self::assertSame('none', $this->subject->getAsString());
+    }
+}

Tests/OpentracingBundleTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Auxmoney\OpentracingBundle\Tests;
+
+use Auxmoney\OpentracingBundle\DependencyInjection\PSR18CompilerPass;
+use Auxmoney\OpentracingBundle\OpentracingBundle;
+use PHPUnit\Framework\TestCase;
+use Prophecy\Argument;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+class OpentracingBundleTest extends TestCase
+{
+    /** @var OpentracingBundle */
+    private $subject;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->subject = new OpentracingBundle();
+    }
+
+    public function testBuild(): void
+    {
+        $containerBuilder = $this->prophesize(ContainerBuilder::class);
+        $containerBuilder->addCompilerPass(Argument::type(PSR18CompilerPass::class))->shouldBeCalled();
+
+        $this->subject->build($containerBuilder->reveal());
+    }
+}

composer.json

@@ -19,7 +19,7 @@
   "require": {
     "php": "^7.1.33",
     "ext-json": "*",
-    "auxmoney/opentracing-bundle-core": "^0.6",
+    "auxmoney/opentracing-bundle-core": "^0.6.6",
     "opentracing/opentracing": "1.0.0-beta5@beta",
     "jcchavezs/zipkin-opentracing": "^0.1"
   },