Passed
Pull Request — master (#8)
by
unknown
02:57
created

addTraceIdToHeaderIfNeeded()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 11
Code Lines 5

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 5
c 1
b 0
f 0
dl 0
loc 11
rs 10
cc 2
nc 2
nop 1
1
<?php
2
3
declare(strict_types=1);
4
5
namespace Umbrellio\Jaravel\Middleware;
6
7
use Illuminate\Http\Request;
8
use Illuminate\Support\Facades\Config;
9
use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
10
use OpenTelemetry\SDK\Trace\Span;
11
use Symfony\Component\HttpFoundation\Response;
12
use Umbrellio\Jaravel\Services\Caller;
13
use Umbrellio\Jaravel\Services\Http\TracingRequestGuard;
14
use Umbrellio\Jaravel\Services\Span\ActiveSpanTraceIdRetriever;
15
use Umbrellio\Jaravel\Services\Span\SpanCreator;
16
use Umbrellio\Jaravel\Services\Span\SpanAttributeHelper;
17
use Umbrellio\Jaravel\Services\TraceIdHeaderRetriever;
18
19
class HttpTracingMiddleware
20
{
21
    private SpanCreator $spanCreator;
22
    private TracingRequestGuard $requestGuard;
23
    private ActiveSpanTraceIdRetriever $activeTraceIdRetriever;
24
    private TraceIdHeaderRetriever $traceIdHeaderRetriever;
25
26
    public function __construct(
27
        SpanCreator $spanCreator,
28
        TracingRequestGuard $requestGuard,
29
        ActiveSpanTraceIdRetriever $activeTraceIdRetriever,
30
        TraceIdHeaderRetriever $traceIdHeaderRetriever
31
    ) {
32
        $this->spanCreator = $spanCreator;
33
        $this->requestGuard = $requestGuard;
34
        $this->activeTraceIdRetriever = $activeTraceIdRetriever;
35
        $this->traceIdHeaderRetriever = $traceIdHeaderRetriever;
36
    }
37
38
    /** @param Request $request */
39
    public function handle($request, callable $next)
40
    {
41
        if (!$this->requestGuard->allowRequest($request)) {
42
            return $next($request);
43
        }
44
45
        $headers = $request->server->all();
46
47
        $traceIdHeader = $this->traceIdHeaderRetriever->retrieve($headers, $this->traceIdHeader());
48
49
        logger('Jaravel: Incoming request. Trace id: ', [$headers, $traceIdHeader]);
50
51
        $this->spanCreator->create(
52
            Caller::call(Config::get('jaravel.http.span_name'), [$request]),
53
            $traceIdHeader
54
        )->activate();
55
56
        /** @var Response $response */
57
        $response = $next($request);
58
59
        $this->addTraceIdToHeaderIfNeeded($response);
60
61
        return $response;
62
    }
63
64
    public function terminate($request, $response)
65
    {
66
        $span = Span::getCurrent();
67
        $scope = $span->activate();
68
69
        $callableConfig = Config::get('jaravel.http.attributes', fn () => [
70
            'type' => 'http',
71
        ]);
72
73
        SpanAttributeHelper::setAttributes($span, Caller::call($callableConfig, [$request, $response]));
74
75
        $span->end();
76
        $scope->detach();
77
    }
78
79
    private function addTraceIdToHeaderIfNeeded(Response $response): void
80
    {
81
        $headerName = $this->traceIdHeader();
82
83
        if (!$headerName) {
84
            return;
85
        }
86
87
        $traceId = $this->activeTraceIdRetriever->retrieve();
88
89
        $response->headers->set($headerName, $traceId);
90
    }
91
92
    private function traceIdHeader(): ?string
93
    {
94
        return 'HTTP_' . strtoupper(TraceContextPropagator::TRACEPARENT);
95
    }
96
}
97