Yiisoft\Yii\Debug\Collector\ContainerInterfaceProxy

Complexity

Total Complexity

38

Size/Duplication

Total Lines	190
Duplicated Lines	0 %

Test Coverage

Coverage

90.91%

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	withDecoratedServices()	0	5	1
A	isActive()	0	3	2
A	getInstance()	0	7	2
A	getServiceProxyCache()	0	3	1
A	isDecorated()	0	3	2
A	setServiceProxyCache()	0	3	1
A	has()	0	15	2
A	getCommonMethodProxy()	0	13	4
A	getServiceProxyFromArray()	0	16	5
B	getServiceProxy()	0	27	10
A	getCommonServiceProxy()	0	6	1
A	get()	0	25	5
A	getServiceProxyFromCallable()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug\Collector;

use Exception;
use Psr\Container\ContainerExceptionInterface;
use Psr\Container\ContainerInterface;
use Yiisoft\Proxy\ProxyManager;
use Yiisoft\Proxy\ProxyTrait;

use function is_callable;
use function is_object;
use function is_string;

final class ContainerInterfaceProxy implements ContainerInterface
{
    use ProxyLogTrait;
    use ProxyTrait;

    public const LOG_NOTHING = 0;
    public const LOG_ARGUMENTS = 1;
    public const LOG_RESULT = 2;
    public const LOG_ERROR = 4;

    private ProxyManager $proxyManager;

    private array $decoratedServices = [];

The private property $decoratedServices is not used, and could be removed.

    private array $serviceProxy = [];

    public function __construct(protected ContainerInterface $container, ContainerProxyConfig $config)
    {
        $this->config = $config;
        $this->proxyManager = new ProxyManager($this->config->getProxyCachePath());
    }

    public function withDecoratedServices(array $decoratedServices): self
    {
        $new = clone $this;
        $new->config = $this->config->withDecoratedServices($decoratedServices);
        return $new;
    }

    public function get($id): mixed
    {
        $this->resetCurrentError();
        $timeStart = microtime(true);
        $instance = null;

The assignment to $instance is dead and can be removed.

        try {
            $instance = $this->getInstance($id);
        } catch (ContainerExceptionInterface $e) {
            $this->repeatError($e);
        } finally {
            $this->logProxy(ContainerInterface::class, $this->container, 'get', [$id], $instance, $timeStart);

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

        }

        if (

Boolean operators between conditions must be at the beginning or end of the line, but not both

            is_object($instance)
            && (
                ($proxy = $this->getServiceProxyCache($id)) ||
                ($proxy = $this->getServiceProxy($id, $instance))
            )
        ) {
            $this->setServiceProxyCache($id, $proxy);
            return $proxy;
        }

        return $instance;
    }

    /**
     * @throws ContainerExceptionInterface
     */
    private function getInstance(string $id): mixed
    {
        if ($id === ContainerInterface::class) {
            return $this;
        }

        return $this->container->get($id);
    }

    private function isDecorated(string $service): bool
    {
        return $this->isActive() && $this->config->hasDecoratedService($service);
    }

    public function isActive(): bool
    {
        return $this->config->getIsActive() && $this->config->getDecoratedServices() !== [];
    }

    private function getServiceProxyCache(string $service): ?object
    {
        return $this->serviceProxy[$service] ?? null;
    }

    private function getServiceProxy(string $service, object $instance): ?object
    {
        if (!$this->isDecorated($service)) {
            return null;
        }

        if ($this->config->hasDecoratedServiceCallableConfig($service)) {
            return $this->getServiceProxyFromCallable($this->config->getDecoratedServiceConfig($service), $instance);
        }

        if ($this->config->hasDecoratedServiceArrayConfigWithStringKeys($service)) {
            return $this->getCommonMethodProxy(
                interface_exists($service) || class_exists($service) ? $service : $instance::class,
                $instance,
                $this->config->getDecoratedServiceConfig($service)
            );
        }

        if ($this->config->hasDecoratedServiceArrayConfig($service)) {
            return $this->getServiceProxyFromArray($instance, $this->config->getDecoratedServiceConfig($service));
        }

        if (interface_exists($service) && ($this->config->hasCollector() || $this->config->hasDispatcher())) {
            return $this->getCommonServiceProxy($service, $instance);
        }

        return null;
    }

    private function getServiceProxyFromCallable(callable $callback, object $instance): ?object
    {
        return $callback($this, $instance);
    }

    /**
     * @psalm-param class-string $service
     */
    private function getCommonMethodProxy(string $service, object $instance, array $callbacks): ?object
    {
        $methods = [];
        foreach ($callbacks as $method => $callback) {
            if (is_string($method) && is_callable($callback)) {
                $methods[$method] = $callback;
            }
        }

        return $this->proxyManager->createObjectProxy(
            $service,
            ServiceMethodProxy::class,
            [$service, $instance, $methods, $this->config]
        );
    }

    private function getServiceProxyFromArray(object $instance, array $params): ?object
    {
        try {
            $proxyClass = array_shift($params);
            foreach ($params as $index => $param) {
                if (is_string($param)) {
                    try {
                        $params[$index] = $this->get($param);
                    } catch (Exception) {
                        //leave as is
                    }
                }
            }
            return new $proxyClass($instance, ...$params);
        } catch (Exception) {
            return null;
        }
    }

    /**
     * @psalm-param class-string $service
     */
    private function getCommonServiceProxy(string $service, object $instance): object
    {
        return $this->proxyManager->createObjectProxy(
            $service,
            ServiceProxy::class,
            [$service, $instance, $this->config]
        );
    }

    private function setServiceProxyCache(string $service, object $instance): void
    {
        $this->serviceProxy[$service] = $instance;
    }

    /**
     * @psalm-suppress InvalidCatch
     */
    public function has($id): bool
    {
        $this->resetCurrentError();
        $timeStart = microtime(true);
        $result = null;

The assignment to $result is dead and can be removed.

        try {
            $result = $this->container->has($id);
        } catch (ContainerExceptionInterface $e) {
            $this->repeatError($e);
        } finally {
            $this->logProxy(ContainerInterface::class, $this->container, 'has', [$id], $result, $timeStart);

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

        }

        return (bool)$result;
    }
}