SentryTraceConsoleListener::addAppBootstrapSpan() - Code Metrics - Inspection of "Trace" - yiisoft/yii-sentry - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#19)

unknown
created 2022-08-24 18:40 UTC
SentryTraceConsoleListener::addAppBootstrapSpan() A

↳ Parent: SentryTraceConsoleListener
Complexity

Conditions	5
Paths	6
Size

Total Lines	31
Code Lines	17
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	30
Importance

Changes
Metric	Value
cc	5
eloc	17
nc	6
nop	0
dl	0
loc	31
ccs	0
cts	18
cp	0
crap	30
rs	9.3888
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Sentry\Tracing;

use Sentry\SentrySdk;
use Sentry\State\HubInterface;
use Sentry\Tracing\Span;
use Sentry\Tracing\SpanContext;
use Sentry\Tracing\Transaction;
use Sentry\Tracing\TransactionContext;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Event\ConsoleCommandEvent;
use Symfony\Component\Console\Event\ConsoleTerminateEvent;
use Symfony\Component\Console\Input\InputInterface;
use Yiisoft\Yii\Console\Event\ApplicationShutdown;

final class SentryTraceConsoleListener
{
    /**
     * The current active transaction.
     *
     * @psalm-suppress PropertyNotSetInConstructor
     *
     * @var Transaction|null
     */
    protected ?Transaction $transaction;
    /**
     * The span for the `app.handle` part of the application.
     *
     * @psalm-suppress PropertyNotSetInConstructor
     *
     * @var Span|null
     */
    protected ?Span $appSpan;
    /**
     * The span for the `app.handle` part of the application.
     *
     * @psalm-suppress PropertyNotSetInConstructor
     *
     * @var Span|null
     */
    protected ?Span $bootSpan;
    /**
     * The timestamp of application bootstrap completion.
     *
     * @var float|null
     */
    private ?float $bootedTimestamp;

    public function __construct(
        private HubInterface $hub,
    ) {
        $this->bootedTimestamp = microtime(true);
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * @return Transaction|null
     */
    public function getTransaction(): ?Transaction
    {
        return $this->transaction;
    }

    /**
     * @param Transaction|null $transaction
     *
     * @return self
     */
    public function setTransaction(?Transaction $transaction): self
    {
        $this->transaction = $transaction;

        return $this;
    }

    public function listenAppStart(): void
    {
        $this->startTransaction();
    }

    private function startTransaction(): void
    {
        $requestStartTime = (defined('APP_START_TIME')
            ? (float)APP_START_TIME

            : microtime(true));
        $context = new TransactionContext();

        $context->setOp('console');

        $context->setStartTimestamp($requestStartTime);
        $context->setStartTimestamp(/** @scrutinizer ignore-type */ $requestStartTime);

        $this->transaction = $this->hub->startTransaction($context);
        $this->transaction->setName('undefined command');
        // Setting the Transaction on the Hub
        SentrySdk::getCurrentHub()->setSpan($this->transaction);

        $this->addAppBootstrapSpan();
    }

    private function addAppBootstrapSpan(): void
    {
        if ($this->bootedTimestamp === null) {
            return;
        }
        if (null === $this->transaction) {
            return;
        }

        $appStartTime = defined('APP_START_TIME')
            ? (float)APP_START_TIME

            : null;

        if ($appStartTime === null) {
            return;
        }

        $spanContextStart = new SpanContext();
        $spanContextStart->setOp('app.bootstrap');
        $spanContextStart->setStartTimestamp($appStartTime);
        $spanContextStart->setEndTimestamp($this->bootedTimestamp);

        $span = $this->transaction->startChild($spanContextStart);

        // Consume the booted timestamp, because we don't want to report the bootstrap span more than once
        $this->bootedTimestamp = null;

        // Add more information about the bootstrap section if possible
        $this->addBootDetailTimeSpans($span);

        $this->bootSpan = $span;
    }

    private function addBootDetailTimeSpans(Span $bootstrap): void
    {
        if (
            !defined('SENTRY_AUTOLOAD')
            || !SENTRY_AUTOLOAD

            || !is_numeric(SENTRY_AUTOLOAD)
        ) {
            return;
        }

        $autoload = new SpanContext();
        $autoload->setOp('autoload');
        $autoload->setStartTimestamp($bootstrap->getStartTimestamp());
        $autoload->setEndTimestamp((float)SENTRY_AUTOLOAD);

        $bootstrap->startChild($autoload);
    }

    public function listenBeginCommand(ConsoleCommandEvent $event): void
    {
        $command = $event->getCommand();
        $input = $event->getInput();
        $this->startCommand($command, $input);
    }

    private function startCommand(?Command $command, InputInterface $input): void
    {
        if (null === $this->transaction) {
            return;
        }
        $name = $command?->getName() ?? 'undefined command';
        $inputArgs = [
            'arguments' => $input->getArguments(),
            'options' => $input->getOptions(),
        ];
        $this->transaction->setData([
            'name' => $name,
            'input' => $inputArgs,
        ]);
        $this->transaction->setName($name);

        $bootstrapSpan = $this->bootSpan;

        $appContextStart = new SpanContext();
        $appContextStart->setOp('app.handle');
        $appContextStart->setStartTimestamp(
            $bootstrapSpan
            /** @scrutinizer ignore-type */ $bootstrapSpan
                ? $bootstrapSpan->getEndTimestamp()
                : microtime(true)
        );

        $this->appSpan = $this->transaction->startChild($appContextStart);

        SentrySdk::getCurrentHub()->setSpan($this->appSpan);
    }

    public function listenShutdown(ApplicationShutdown $event): void
    {
        $exitCode = $event->getExitCode();
        $this->terminate($exitCode);
    }

    public function terminate(int $exitCode): void
    {
        if ($this->transaction !== null) {
            $this->appSpan?->finish();
            $this->appSpan = null;

            $this->transaction->setTags(['exitCode' => (string)$exitCode]);
            // Make sure we set the transaction and not have a child span in the Sentry SDK
            // If the transaction is not on the scope during finish, the trace.context is wrong
            SentrySdk::getCurrentHub()->setSpan($this->transaction);

            $this->transaction->finish();
            $this->transaction = null;
        }
    }

    public function listenCommandTerminate(?ConsoleTerminateEvent $terminateEvent): void
    public function listenCommandTerminate(/** @scrutinizer ignore-unused */ ?ConsoleTerminateEvent $terminateEvent): void
    {
        $this->appSpan?->finish(microtime(true));
        $this->appSpan?->finish(/** @scrutinizer ignore-type */ microtime(true));
    }

    /**
     * @return Span|null
     */
    public function getAppSpan(): ?Span
    {
        return $this->appSpan;
    }

    /**
     * @param Span|null $appSpan
     */
    public function setAppSpan(?Span $appSpan): void
    {
        $this->appSpan = $appSpan;
    }
}

yiisoft / yii-sentry

Pull Request — master (#19)

SentryTraceConsoleListener::addAppBootstrapSpan() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
