Umbrellio\Jaravel\Middleware\HttpTracingMiddleware

Complexity

Total Complexity

7

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	1
A	handle()	0	21	2
A	traceIdHeader()	0	3	1
A	addTraceIdToHeaderIfNeeded()	0	11	2
A	terminate()	0	13	1

<?php

declare(strict_types=1);

namespace Umbrellio\Jaravel\Middleware;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Config;
use OpenTelemetry\API\Trace\Propagation\TraceContextPropagator;
use OpenTelemetry\SDK\Trace\Span;
use Symfony\Component\HttpFoundation\Response;
use Umbrellio\Jaravel\Services\Caller;
use Umbrellio\Jaravel\Services\Http\TracingRequestGuard;
use Umbrellio\Jaravel\Services\Span\ActiveSpanTraceIdRetriever;
use Umbrellio\Jaravel\Services\Span\SpanCreator;
use Umbrellio\Jaravel\Services\Span\SpanAttributeHelper;
use Umbrellio\Jaravel\Services\TraceIdHeaderRetriever;

class HttpTracingMiddleware
{
    private SpanCreator $spanCreator;
    private TracingRequestGuard $requestGuard;
    private ActiveSpanTraceIdRetriever $activeTraceIdRetriever;
    private TraceIdHeaderRetriever $traceIdHeaderRetriever;

    public function __construct(
        SpanCreator $spanCreator,
        TracingRequestGuard $requestGuard,
        ActiveSpanTraceIdRetriever $activeTraceIdRetriever,
        TraceIdHeaderRetriever $traceIdHeaderRetriever
    ) {
        $this->spanCreator = $spanCreator;
        $this->requestGuard = $requestGuard;
        $this->activeTraceIdRetriever = $activeTraceIdRetriever;
        $this->traceIdHeaderRetriever = $traceIdHeaderRetriever;
    }

    /** @param Request $request */
    public function handle($request, callable $next)
    {
        if (!$this->requestGuard->allowRequest($request)) {
            return $next($request);
        }

        $headers = $request->server->all();

        $traceIdHeader = $this->traceIdHeaderRetriever->retrieve($headers, $this->traceIdHeader());

        $this->spanCreator->create(
            Caller::call(Config::get('jaravel.http.span_name'), [$request]),
            $traceIdHeader
        )->activate();

        /** @var Response $response */
        $response = $next($request);

        $this->addTraceIdToHeaderIfNeeded($response);

        return $response;
    }

    public function terminate($request, $response)
    {
        $span = Span::getCurrent();
        $scope = $span->activate();

        $callableConfig = Config::get('jaravel.http.attributes', fn () => [
            'type' => 'http',
        ]);

        SpanAttributeHelper::setAttributes($span, Caller::call($callableConfig, [$request, $response]));

        $span->end();
        $scope->detach();
    }

    private function addTraceIdToHeaderIfNeeded(Response $response): void
    {
        $headerName = $this->traceIdHeader();

        if (!$headerName) {
            return;
        }

        $traceId = $this->activeTraceIdRetriever->retrieve();

        $response->headers->set($headerName, $traceId);
    }

    private function traceIdHeader(): ?string
    {
        return 'HTTP_' . strtoupper(TraceContextPropagator::TRACEPARENT);
    }
}