yiisoft / yii-debug

src/Collector/ProxyLogTrait.php

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Collector;

use Yiisoft\Yii\Debug\Event\ProxyMethodCallEvent;

trait ProxyLogTrait
{
    private ContainerProxyConfig $config;

    protected function logProxy(
        string $service,
        object $instance,
        string $method,
        array $arguments,
        mixed $result,
        float $timeStart
    ): void {
        $error = $this->getCurrentError();

It seems like getCurrentError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->processLogData($arguments, $result, $error);

        if ($this->config->getCollector() !== null) {
            $this->logToCollector($service, $instance, $method, $arguments, $result, $error, $timeStart);
        }

        if ($this->config->getDispatcher() !== null) {
            $this->logToEvent($service, $instance, $method, $arguments, $result, $error, $timeStart);
        }
    }

    /**
     * @psalm-param-out array|null $arguments
     */
    private function processLogData(array &$arguments, mixed &$result, ?object &$error): void
    {
        if (!($this->config->getLogLevel() & ContainerInterfaceProxy::LOG_ARGUMENTS)) {
            $arguments = null;
        }

        if (!($this->config->getLogLevel() & ContainerInterfaceProxy::LOG_RESULT)) {
            $result = null;
        }

        if (!($this->config->getLogLevel() & ContainerInterfaceProxy::LOG_ERROR)) {
            $error = null;
        }
    }

    private function logToCollector(
        string $service,
        object $instance,
        string $method,
        ?array $arguments,
        mixed $result,
        ?object $error,
        float $timeStart
    ): void {
        $this->config->getCollector()?->collect(
            $service,
            $instance::class,
            $method,
            $arguments,
            $result,
            $this->getCurrentResultStatus(),
            $error,
            $timeStart,
            microtime(true),

It seems like microtime(true) can also be of type string; however, parameter $timeEnd of Yiisoft\Yii\Debug\Collector\ServiceCollector::collect() does only seem to accept double, maybe add an additional type check?

        );
    }

    private function logToEvent(
        string $service,
        object $instance,
        string $method,
        ?array $arguments,
        mixed $result,
        ?object $error,
        float $timeStart
    ): void {
        $this->config->getDispatcher()?->dispatch(
            new ProxyMethodCallEvent(
                $service,
                $instance::class,
                $method,
                $arguments,
                $result,
                $this->getCurrentResultStatus(),
                $error,
                $timeStart,
                microtime(true),

It seems like microtime(true) can also be of type string; however, parameter $timeEnd of Yiisoft\Yii\Debug\Event\ProxyMethodCallEvent::__construct() does only seem to accept double, maybe add an additional type check?

            )
        );
    }

    private function getCurrentResultStatus(): string
    {
        if (!$this->hasCurrentError()) {

It seems like hasCurrentError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            return 'success';
        }

        return 'failed';
    }
}