mleczakm / monolog-sentry-bundle

Handler/Raven.php

<?php

declare(strict_types=1);

namespace Dziki\MonologSentryBundle\Handler;

use Monolog\Handler\RavenHandler;
use Monolog\Logger;
use Raven_Client;

class Raven extends RavenHandler
{
    /**
     * Because of https://github.com/Seldaek/monolog/pull/1179.
     */
    protected $logLevels = [
        Logger::DEBUG => Raven_Client::DEBUG,
        Logger::INFO => Raven_Client::INFO,
        Logger::NOTICE => Raven_Client::INFO,
        Logger::WARNING => Raven_Client::WARNING,
        Logger::ERROR => Raven_Client::ERROR,
        Logger::CRITICAL => Raven_Client::FATAL,
        Logger::ALERT => Raven_Client::FATAL,
        Logger::EMERGENCY => Raven_Client::FATAL,
    ];
    /**
     * Because of https://github.com/Seldaek/monolog/pull/1179.
     *
     * @var string
     */
    protected $release;

    public function setRelease($release)
    {
        $this->release = $release;
    }

    /**
     * {@inheritdoc}
     */
    public function handleBatch(array $records): void
    {
        $level = $this->level;

        // filter records based on their level
        $records = array_filter(

Consider using a different name than the parameter $records. This often makes code more readable.

            $records,
            function ($record) use ($level) {
                return $record['level'] >= $level;
            }
        );

        if (!$records) {

The expression $records of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using empty($expr) instead to make it clear that you intend to check for an array without elements.

            return;
        }

        // the record with the highest severity is the "main" one
        $record = array_reduce(
            $records,
            function ($highest, $record) {
                if ($record['level'] > $highest['level']) {
                    return $record;
                }

                return $highest;
            },
            reset($records)
        );

        foreach ($records as $r) {
            $log = $this->processRecord($r);

            $date = $log['datetime'] ?? time();

            $crumb = [
                'category' => $log['channel'],
                'message' => $log['message'],
                'level' => strtolower($log['level_name']),
                'timestamp' => (float) ($date instanceof \DateTimeInterface ? $date->format('U.u') : $date),
            ];

            if (array_key_exists('context', $log)) {
                if ('request' === $log['channel'] && array_key_exists('route_parameters', $log['context'])) {
                    $crumb['data']['route'] = $log['context']['route_parameters']['_route'];
                    $crumb['data']['controller'] = $log['context']['route_parameters']['_controller'];
                    $crumb['data']['uri'] = $log['context']['request_uri'];
                } elseif ('security' === $log['channel'] && array_key_exists('user', $log['context'])) {
                    $crumb['data']['user'] = $log['context']['user']['username'];
                } else {
                    $crumb['data'] = $log['context'];
                }
            }

            $this->ravenClient->breadcrumbs->record($crumb);
        }

        $this->handle($record);
    }

    /**
     * Because of https://github.com/Seldaek/monolog/pull/1179.
     *
     * @param array $record
     */
    protected function write(array $record): void
    {
        $previousUserContext = false;
        $options = [];
        $options['level'] = $this->logLevels[$record['level']];
        $options['tags'] = [];

        if (!empty($record['extra']['tags'])) {
            $options['tags'] = array_merge($options['tags'], $record['extra']['tags']);
            unset($record['extra']['tags']);
        }

        if (!empty($record['context']['tags'])) {

This code seems to be duplicated across your project.

            $options['tags'] = array_merge($options['tags'], $record['context']['tags']);
            unset($record['context']['tags']);
        }

        if (!empty($record['context']['fingerprint'])) {
            $options['fingerprint'] = $record['context']['fingerprint'];
            unset($record['context']['fingerprint']);
        }

        if (!empty($record['context']['logger'])) {

This code seems to be duplicated across your project.

            $options['logger'] = $record['context']['logger'];
            unset($record['context']['logger']);
        } else {
            $options['logger'] = $record['channel'];
        }

        foreach ($this->getExtraParameters() as $key) {
            foreach (['extra', 'context'] as $source) {
                if (!empty($record[$source][$key])) {
                    $options[$key] = $record[$source][$key];
                    unset($record[$source][$key]);
                }
            }
        }

        if (!empty($record['context'])) {
            $options['extra']['context'] = $record['context'];
            if (!empty($record['context']['user'])) {
                $previousUserContext = $this->ravenClient->context->user;
                $this->ravenClient->user_context($record['context']['user']);
                unset($options['extra']['context']['user']);
            }
        }

        if (!empty($record['contexts'])) {
            $options['contexts'] = $record['contexts'];
        }

        if (!empty($record['extra'])) {
            $options['extra']['extra'] = $record['extra'];
        }

        if (!empty($this->release) && !isset($options['release'])) {
            $options['release'] = $this->release;
        }

        if (isset($record['context']['exception']) && ($record['context']['exception'] instanceof \Exception || (PHP_VERSION_ID >= 70000 && $record['context']['exception'] instanceof \Throwable))) {
            $options['extra']['message'] = $record['formatted'];
            $this->ravenClient->captureException($record['context']['exception'], $options);
        } else {
            $this->ravenClient->captureMessage($record['formatted'], [], $options);
        }

        $this->ravenClient->breadcrumbs->reset();

        if (false !== $previousUserContext) {
            $this->ravenClient->user_context($previousUserContext);

It seems like $previousUserContext can also be of type null; however, Raven_Client::user_context() does only seem to accept array, maybe add an additional type check?

        }
    }
}