Yiisoft\Yii\Sentry\YiiSentryConfig

Complexity

Total Complexity

17

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Test Coverage

Coverage

80.65%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getUserConfig()	0	5	2
A	hasDsnSet()	0	5	1
A	getIntegrations()	0	7	3
A	__construct()	0	2	1
A	couldHavePerformanceTracingEnabled()	0	6	2
A	getTracing()	0	7	3
A	getOptions()	0	7	3
A	getLogLevel()	0	3	2

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Sentry;

use InvalidArgumentException;

final class YiiSentryConfig
{
    public function __construct(protected array $config)
    {
    }

    /**
     * Check if a DSN was set in the config.
     *
     * @return bool
     */
    public function hasDsnSet(): bool
    {
        $config = $this->getUserConfig();

        return !empty($config['options']['dsn']);
    }

    /**
     * Retrieve the user configuration.
     *
     * @return array
     */
    public function getUserConfig(): array
    {
        $config = $this->config;

        return empty($config) ? [] : $config;
    }

    public function getOptions(): array
    {
        return empty($this->config['options'])
            ? []
            : (is_array($this->config['options'])
                ? $this->config['options']
                : throw  new InvalidArgumentException('options must be an array'));
    }

    public function getTracing(): array
    {
        return empty($this->config['tracing'])
            ? []
            : (is_array($this->config['tracing'])
                ? $this->config['tracing']
                : throw  new InvalidArgumentException('tracing must be an array'));
    }

    public function getLogLevel(): ?string
    {
        return isset($this->config['log_level']) ? (string)$this->config['log_level'] : null;
    }

    /**
     * @return array
     */
    public function getIntegrations(): array
    {
        return empty($this->config['integrations'])
            ? []
            : (is_array($this->config['integrations'])
                ? $this->config['integrations']
                : throw  new InvalidArgumentException('integrations must be an array'));
    }

    /**
     * Checks if the config is set in such a way that performance tracing could be enabled.
     *
     * Because of `traces_sampler` being dynamic we can never be 100% confident but that is also not important.
     *
     * @return bool
     */
    public function couldHavePerformanceTracingEnabled(): bool
    {
        $config = $this->getUserConfig();

        return !empty($config['options']['traces_sample_rate'])
            || !empty($config['options']['traces_sampler']);
    }
}