PhpTek\Sentry\Adaptor\SentryAdaptor

Complexity

Total Complexity

21

Size/Duplication

Total Lines	152
Duplicated Lines	10.53 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	getSDK()	0	4	1
B	setContext()	16	41	8
A	getContext()	0	16	3
B	getOpts()	0	27	7

<?php

/**
 * Class: SentryAdaptor.
 *
 * @author  Russell Michell 2017-2019 <russ@theruss.com>
 * @package phptek/sentry
 */

namespace PhpTek\Sentry\Adaptor;

use Sentry\State\Hub;
use Sentry\ClientBuilder;
use Sentry\State\Scope;
use Sentry\ClientInterface;
use Sentry\Severity;
use SilverStripe\Core\Config\Configurable;
use SilverStripe\Core\Injector\Injector;
use PhpTek\Sentry\Adaptor\SentrySeverity;

/**
 * The SentryAdaptor provides a functionality bridge between the getsentry/sentry
 * PHP SDK and {@link SentryLogger} itself.
 */
class SentryAdaptor
{
    use Configurable;

    /**
     * @var ClientInterface
     */
    protected $sentry;
    
    /**
     * Internal storage for context. Used only in the case of non-exception
     * data sent to Sentry.
     * 
     * @var array
     */
    protected $context = [];

    /**
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        $client = ClientBuilder::create($this->getOpts() ?: [])->getClient();
        Hub::setCurrent(new Hub($client));

        $this->sentry = $client;
    }

    /**
     * @return ClientInterface
     */
    public function getSDK() : ClientInterface
    {
        return $this->sentry;
    }

    /**
     * Configures Sentry "context" to display additional information about a SilverStripe
     * application's runtime and context.
     * 
     * @param  string $field
     * @param  mixed  $data
     * @return void
     * @throws SentryLogWriterException
     */
    public function setContext(string $field, $data) : void
    {
        $options = Hub::getCurrent()->getClient()->getOptions();
        
        switch ($field) {
            case 'env':
                $options->setEnvironment($data);
                $this->context['env'] = $data;
                break;
            case 'tags':

This code seems to be duplicated across your project.

                Hub::getCurrent()->configureScope(function (Scope $scope) use($data) : void {
                    foreach ($data as $tagName => $tagData) {
                        $scope->setTag($tagName, $tagData);
                        $this->context['tags'][$tagName] = $tagData;
                    }
                });
                break;
            case 'user':
                Hub::getCurrent()->configureScope(function (Scope $scope) use($data) : void {
                    $scope->setUser($data);
                    $this->context['user'] = $data;
                });
                break;
            case 'extra':

This code seems to be duplicated across your project.

                Hub::getCurrent()->configureScope(function (Scope $scope) use($data) : void {
                    foreach ($data as $extraKey => $extraData) {
                        $scope->setExtra($extraKey, $extraData);
                        $this->context['extra'][$extraKey] = $extraData;
                    }
                });
                break;
            case 'level':
                Hub::getCurrent()->configureScope(function (Scope $scope) use($data) : void {
                    $scope->setLevel(new Severity(SentrySeverity::process_severity($level = $data)));
                });
                break;
            default:
                $msg = sprintf('Unknown field "%s" passed to %s().', $field, __FUNCTION__);
                throw new SentryLogWriterException($msg);
        }
    }
    
    /**
     * Get _locally_ set contextual data, that we should be able to get from Sentry's
     * current {@link Scope}.
     * 
     * Note: This (re) sets data to a new instance of {@link Scope} for passing to 
     * captureMessage(). One would expect this to be set by default, as it is for
     * $record data sent to Sentry via captureException(), but it isn't.
     * 
     * @todo Investigate sentry/php-sdk's API for alternative ways to handle "manual"
     * logging, where data is not an exception and results in being passed to captureMessage().
     * 
     * @return Scope
     */
    public function getContext() : Scope
    {
        $scope = new Scope();

        $scope->setUser($this->context['user']);
        
        foreach ($this->context['tags'] as $tagKey => $tagData) {
            $scope->setTag($tagKey, $tagData);
        }
        
        foreach ($this->context['extra'] as $extraKey => $extraData) {
            $scope->setExtra($extraKey, $extraData);
        }
        
        return $scope;
    }

    /**
     * Get various userland options to pass to Raven. Includes detecting and setting
     * proxy options too.
     *
     * @param  string $opt
     * @return mixed  string|array|null depending on whether $opts is passed.
     */
    protected function getOpts(string $opt = '')
    {
        // Extract env-vars from YML config
        $opts = Injector::inst()->convertServiceProperty($this->config()->get('opts'));

        // Deal with proxy settings. Raven_Client permits host:port format but SilverStripe's
        // YML config only permits single backtick-enclosed env/consts per config
        if (!empty($opts['http_proxy'])) {
            if (!empty($opts['http_proxy']['host']) && !empty($opts['http_proxy']['port'])) {
                $opts['http_proxy'] = sprintf(
                    '%s:%s',
                    $opts['http_proxy']['host'],
                    $opts['http_proxy']['port']
                );
            }
        }

        if ($opt && !empty($opts[$opt])) {
            // Return one
            return $opts[$opt];
        } else if (!$opt) {
            // Return all
            return $opts;
        }

        return null;
    }
}