8p / EightPointsGuzzleBundle

src/DataCollector/HttpDataCollector.php

<?php

namespace EightPoints\Bundle\GuzzleBundle\DataCollector;

use EightPoints\Bundle\GuzzleBundle\Log\LogGroup;
use EightPoints\Bundle\GuzzleBundle\Log\LoggerInterface;
use EightPoints\Bundle\GuzzleBundle\Log\LogMessage;
use Psr\Log\LogLevel;
use Symfony\Component\HttpKernel\DataCollector\DataCollector;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Collecting http data for Symfony profiler
 */
class HttpDataCollector extends DataCollector
{
    use DataCollectorSymfonyCompatibilityTrait;

    /** @var \EightPoints\Bundle\GuzzleBundle\Log\LoggerInterface[] */
    protected $loggers;

    /** @var float */
    private $slowResponseTime;

    /**
     * @param \EightPoints\Bundle\GuzzleBundle\Log\LoggerInterface[] $loggers
     * @param float|int $slowResponseTime Time in seconds
     */
    public function __construct(array $loggers, float $slowResponseTime)
    {
        $this->loggers = $loggers;
        $this->slowResponseTime = $slowResponseTime;

        $this->reset();
    }

    /**
     * {@inheritdoc}
     */
    protected function doCollect(Request $request, Response $response, \Throwable $exception = null)

The parameter $response is not used and could be removed.

The parameter $exception is not used and could be removed.

    {
        $messages = [];
        foreach ($this->loggers as $logger) {
            $messages = array_merge($messages, $logger->getMessages());
        }

        if ($this->slowResponseTime > 0) {
            foreach ($messages as $message) {
                if (!$message instanceof LogMessage) {
                    continue;
                }

                if ($message->getTransferTime() >= $this->slowResponseTime) {
                    $this->data['hasSlowResponse'] = true;
                    break;
                }
            }
        }

        $requestId = $request->getUri();

        // clear log to have only messages related to Symfony request context
        foreach ($this->loggers as $logger) {
            $logger->clear();
        }

        $logGroup = $this->getLogGroup($requestId);
        $logGroup->setRequestName($request->getPathInfo());
        $logGroup->addMessages($messages);
    }

    /**
     * {@inheritdoc}
     */
    public function getName() : string
    {
        return 'eight_points_guzzle';
    }

    /**
     * Resets this data collector to its initial state.
     *
     * @return void
     */
    public function reset() : void
    {
        $this->data = [
            'logs' => [],
            'callCount' => 0,
            'totalTime' => 0,
            'hasSlowResponse' => false,
        ];
    }

    /**
     * Returning log entries
     *
     * @return array
     */
    public function getLogs() : array
    {
        return array_key_exists('logs', $this->data) ? $this->data['logs'] : [];

It seems like $this->data can also be of type Symfony\Component\VarDumper\Cloner\Data; however, parameter $search of array_key_exists() does only seem to accept array, maybe add an additional type check?

The expression return array_key_exists('logs', $this->data) ? $this->data['logs'] : array() could return the type Symfony\Component\VarDumper\Cloner\Data|null which is incompatible with the type-hinted return array. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get all messages
     *
     * @return array
     */
    public function getMessages() : array
    {
        $messages = [];

        foreach ($this->getLogs() as $log) {
            foreach ($log->getMessages() as $message) {
                $messages[] = $message;
            }
        }

        return $messages;
    }

    /**
     * Return amount of http calls
     *
     * @return integer
     */
    public function getCallCount() : int
    {
        return count($this->getMessages());
    }

    /**
     * Get Error Count
     *
     * @return integer
     */
    public function getErrorCount() : int
    {
        return count($this->getErrorsByType(LogLevel::ERROR));
    }

    /**
     * @param string $type
     *
     * @return array
     */
    public function getErrorsByType(string $type) : array
    {
        return array_filter(
            $this->getMessages(),
            function (LogMessage $message) use ($type) {
                return $message->getLevel() === $type;
            }
        );
    }

    /**
     * Get total time of all requests
     *
     * @return float
     */
    public function getTotalTime() : float
    {
        return $this->data['totalTime'];

The expression return $this->data['totalTime'] could return the type Symfony\Component\VarDumper\Cloner\Data|null which is incompatible with the type-hinted return double. Consider adding an additional type-check to rule them out.

    }

    /**
     * Check if there were any slow responses
     *
     * @return bool
     */
    public function hasSlowResponses() : bool
    {
        return $this->data['hasSlowResponse'];

The expression return $this->data['hasSlowResponse'] could return the type Symfony\Component\VarDumper\Cloner\Data|null which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    /**
     * @param float $time
     *
     * @return void
     */
    public function addTotalTime(float $time) : void
    {
        $this->data['totalTime'] += $time;
    }

    /**
     * Returns (new) LogGroup based on given id
     *
     * @param string $id
     *
     * @return \EightPoints\Bundle\GuzzleBundle\Log\LogGroup
     */
    protected function getLogGroup(string $id) : LogGroup
    {
        if (!isset($this->data['logs'][$id])) {
            $this->data['logs'][$id] = new LogGroup();
        }

        return $this->data['logs'][$id];

The expression return $this->data['logs'][$id] could return the type Symfony\Component\VarDumper\Cloner\Data|null which is incompatible with the type-hinted return EightPoints\Bundle\GuzzleBundle\Log\LogGroup. Consider adding an additional type-check to rule them out.

    }
}