QueueBootloader::addPushInterceptor() - Code Metrics - Inspection of "[spiral/queue] Adding `RetryPolicyInterceptor`" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#980)

by Maxim

created 2023-09-05 06:17 UTC

QueueBootloader::addPushInterceptor() A

↳ Parent: QueueBootloader

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
eloc	3
dl	0
loc	5
ccs	4
cts	4
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

declare(strict_types=1);

namespace Spiral\Queue\Bootloader;

use Psr\Container\ContainerInterface;
use Psr\EventDispatcher\EventDispatcherInterface;
use Spiral\Boot\{AbstractKernel, EnvironmentInterface};
use Spiral\Boot\Bootloader\Bootloader;
use Spiral\Config\ConfiguratorInterface;
use Spiral\Config\Patch\Append;
use Spiral\Core\{BinderInterface, FactoryInterface, InterceptableCore};
use Spiral\Core\Container\Autowire;
use Spiral\Core\CoreInterceptorInterface;
use Spiral\Queue\{QueueConnectionProviderInterface,
    QueueInterface,
    QueueManager,
    QueueRegistry,
    SerializerRegistryInterface
};
use Spiral\Queue\Config\QueueConfig;
use Spiral\Queue\ContainerRegistry;
use Spiral\Queue\Core\QueueInjector;
use Spiral\Queue\Driver\{NullDriver, SyncDriver};
use Spiral\Queue\Failed\{FailedJobHandlerInterface, LogFailedJobHandler};
use Spiral\Queue\HandlerRegistryInterface;
use Spiral\Queue\Interceptor\Consume\{Core as ConsumeCore, ErrorHandlerInterceptor, Handler, RetryPolicyInterceptor};
use Spiral\Telemetry\Bootloader\TelemetryBootloader;
use Spiral\Telemetry\TracerFactoryInterface;

final class QueueBootloader extends Bootloader
{
    protected const DEPENDENCIES = [
        TelemetryBootloader::class,
    ];

    protected const SINGLETONS = [
        HandlerRegistryInterface::class => QueueRegistry::class,
        SerializerRegistryInterface::class => QueueRegistry::class,
        FailedJobHandlerInterface::class => LogFailedJobHandler::class,
        QueueConnectionProviderInterface::class => QueueManager::class,
        QueueManager::class => [self::class, 'initQueueManager'],
        QueueRegistry::class => [self::class, 'initRegistry'],
        Handler::class => [self::class, 'initHandler'],
    ];

    public function __construct(
        private readonly ConfiguratorInterface $config,
    ) {
    }

    public function init(
        ContainerInterface $container,
        BinderInterface $binder,
        EnvironmentInterface $env,
        AbstractKernel $kernel,
    ): void {
        $this->initQueueConfig($env);

        $this->registerDriverAlias(SyncDriver::class, 'sync');
        $binder->bindInjector(QueueInterface::class, QueueInjector::class);

        $kernel->booted(static function () use ($container): void {
            $registry = $container->get(QueueRegistry::class);
            $config = $container->get(QueueConfig::class);

            foreach ($config->getRegistryHandlers() as $jobType => $handler) {
                $registry->setHandler($jobType, $handler);
            }

            foreach ($config->getRegistrySerializers() as $jobType => $serializer) {
                $registry->setSerializer($jobType, $serializer);
            }
        });
    }

    /**
     * @param class-string<CoreInterceptorInterface>|CoreInterceptorInterface|Autowire $interceptor

     */
    public function addConsumeInterceptor(string|CoreInterceptorInterface|Autowire $interceptor): void
    {
        $this->config->modify(
            QueueConfig::CONFIG,
            new Append('interceptors.consume', null, $interceptor),
        );
    }

    /**
     * @param class-string<CoreInterceptorInterface>|CoreInterceptorInterface|Autowire $interceptor

     */
    public function addPushInterceptor(string|CoreInterceptorInterface|Autowire $interceptor): void
    {
        $this->config->modify(
            QueueConfig::CONFIG,
            new Append('interceptors.push', null, $interceptor),
        );
    }

    public function registerDriverAlias(string $driverClass, string $alias): void
    {
        $this->config->modify(
            QueueConfig::CONFIG,
            new Append('driverAliases', $alias, $driverClass),
        );
    }

    protected function initQueueManager(FactoryInterface $factory): QueueManager
    {
        return $factory->make(QueueManager::class);
    }

    protected function initRegistry(
        ContainerInterface $container,
        FactoryInterface $factory,
        ContainerRegistry $registry,
    ) {
        return new QueueRegistry($container, $factory, $registry);
    }

    protected function initHandler(
        ConsumeCore $core,
        QueueConfig $config,
        ContainerInterface $container,
        FactoryInterface $factory,
        TracerFactoryInterface $tracerFactory,
        ?EventDispatcherInterface $dispatcher = null,
    ): Handler {
        $core = new InterceptableCore($core, $dispatcher);

        foreach ($config->getConsumeInterceptors() as $interceptor) {
            if (\is_string($interceptor)) {
                $interceptor = $container->get($interceptor);
            } elseif ($interceptor instanceof Autowire) {
                $interceptor = $interceptor->resolve($factory);
            }

            \assert($interceptor instanceof CoreInterceptorInterface);
            $core->addInterceptor($interceptor);
        }

        return new Handler($core, $tracerFactory);
    }

    private function initQueueConfig(EnvironmentInterface $env): void
    {
        $this->config->setDefaults(
            QueueConfig::CONFIG,
            [
                'default' => $env->get('QUEUE_CONNECTION', 'sync'),
                'connections' => [
                    'sync' => [
                        'driver' => 'sync',
                    ],
                ],
                'registry' => [
                    'handlers' => [],
                    'serializers' => [],
                ],
                'driverAliases' => [
                    'sync' => SyncDriver::class,
                    'null' => NullDriver::class,
                ],
                'interceptors' => [
                    'consume' => [
                        ErrorHandlerInterceptor::class,
                        RetryPolicyInterceptor::class,
                    ],
                    'push' => [],
                ],
            ],
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Spiral\Queue\Bootloader;
6
7		use Psr\Container\ContainerInterface;
8		use Psr\EventDispatcher\EventDispatcherInterface;
9		use Spiral\Boot\{AbstractKernel, EnvironmentInterface};
10		use Spiral\Boot\Bootloader\Bootloader;
11		use Spiral\Config\ConfiguratorInterface;
12		use Spiral\Config\Patch\Append;
13		use Spiral\Core\{BinderInterface, FactoryInterface, InterceptableCore};
14		use Spiral\Core\Container\Autowire;
15		use Spiral\Core\CoreInterceptorInterface;
16		use Spiral\Queue\{QueueConnectionProviderInterface,
17		QueueInterface,
18		QueueManager,
19		QueueRegistry,
20		SerializerRegistryInterface
21		};
22		use Spiral\Queue\Config\QueueConfig;
23		use Spiral\Queue\ContainerRegistry;
24		use Spiral\Queue\Core\QueueInjector;
25		use Spiral\Queue\Driver\{NullDriver, SyncDriver};
26		use Spiral\Queue\Failed\{FailedJobHandlerInterface, LogFailedJobHandler};
27		use Spiral\Queue\HandlerRegistryInterface;
28		use Spiral\Queue\Interceptor\Consume\{Core as ConsumeCore, ErrorHandlerInterceptor, Handler, RetryPolicyInterceptor};
29		use Spiral\Telemetry\Bootloader\TelemetryBootloader;
30		use Spiral\Telemetry\TracerFactoryInterface;
31
32		final class QueueBootloader extends Bootloader
33		{
34		protected const DEPENDENCIES = [
35		TelemetryBootloader::class,
36		];
37
38		protected const SINGLETONS = [
39		HandlerRegistryInterface::class => QueueRegistry::class,
40		SerializerRegistryInterface::class => QueueRegistry::class,
41		FailedJobHandlerInterface::class => LogFailedJobHandler::class,
42		QueueConnectionProviderInterface::class => QueueManager::class,
43		QueueManager::class => [self::class, 'initQueueManager'],
44		QueueRegistry::class => [self::class, 'initRegistry'],
45		Handler::class => [self::class, 'initHandler'],
46		];
47
48	306	public function __construct(
49		private readonly ConfiguratorInterface $config,
50		) {
51	306	}
52
53	306	public function init(
54		ContainerInterface $container,
55		BinderInterface $binder,
56		EnvironmentInterface $env,
57		AbstractKernel $kernel,
58		): void {
59	306	$this->initQueueConfig($env);
60
61	306	$this->registerDriverAlias(SyncDriver::class, 'sync');
62	306	$binder->bindInjector(QueueInterface::class, QueueInjector::class);
63
64	306	$kernel->booted(static function () use ($container): void {
65	306	$registry = $container->get(QueueRegistry::class);
66	306	$config = $container->get(QueueConfig::class);
67
68	306	foreach ($config->getRegistryHandlers() as $jobType => $handler) {
69		$registry->setHandler($jobType, $handler);
70		}
71
72	306	foreach ($config->getRegistrySerializers() as $jobType => $serializer) {
73		$registry->setSerializer($jobType, $serializer);
74		}
75	306	});
76		}
77
78		/**
79		* @param class-string<CoreInterceptorInterface>\|CoreInterceptorInterface\|Autowire $interceptor
		0 ignored issues – show Documentation Bug introduced 2022-09-13 07:04 UTC by Report Bug Copy Issue Report The doc comment `class-string<CoreInterce...eptorInterface\|Autowire` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<CoreInterceptorInterface>\|CoreInterceptorInterface\|Autowire. Loading history...
80		*/
81	1	public function addConsumeInterceptor(string\|CoreInterceptorInterface\|Autowire $interceptor): void
82		{
83	1	$this->config->modify(
84	1	QueueConfig::CONFIG,
85	1	new Append('interceptors.consume', null, $interceptor),
86	1	);
87		}
88
89		/**
90		* @param class-string<CoreInterceptorInterface>\|CoreInterceptorInterface\|Autowire $interceptor
		0 ignored issues – show Documentation Bug introduced 2022-09-13 07:04 UTC by Report Bug Copy Issue Report The doc comment `class-string<CoreInterce...eptorInterface\|Autowire` at position `0` could not be parsed: Unknown type name 'class-string' at position 0 in class-string<CoreInterceptorInterface>\|CoreInterceptorInterface\|Autowire. Loading history...
91		*/
92	1	public function addPushInterceptor(string\|CoreInterceptorInterface\|Autowire $interceptor): void
93		{
94	1	$this->config->modify(
95	1	QueueConfig::CONFIG,
96	1	new Append('interceptors.push', null, $interceptor),
97	1	);
98		}
99
100	306	public function registerDriverAlias(string $driverClass, string $alias): void
101		{
102	306	$this->config->modify(
103	306	QueueConfig::CONFIG,
104	306	new Append('driverAliases', $alias, $driverClass),
105	306	);
106		}
107
108	3	protected function initQueueManager(FactoryInterface $factory): QueueManager
109		{
110	3	return $factory->make(QueueManager::class);
111		}
112
113	306	protected function initRegistry(
114		ContainerInterface $container,
115		FactoryInterface $factory,
116		ContainerRegistry $registry,
117		) {
118	306	return new QueueRegistry($container, $factory, $registry);
119		}
120
121	2	protected function initHandler(
122		ConsumeCore $core,
123		QueueConfig $config,
124		ContainerInterface $container,
125		FactoryInterface $factory,
126		TracerFactoryInterface $tracerFactory,
127		?EventDispatcherInterface $dispatcher = null,
128		): Handler {
129	2	$core = new InterceptableCore($core, $dispatcher);
130
131	2	foreach ($config->getConsumeInterceptors() as $interceptor) {
132	2	if (\is_string($interceptor)) {
133	2	$interceptor = $container->get($interceptor);
134		} elseif ($interceptor instanceof Autowire) {
135		$interceptor = $interceptor->resolve($factory);
136		}
137
138	2	\assert($interceptor instanceof CoreInterceptorInterface);
139	2	$core->addInterceptor($interceptor);
140		}
141
142	2	return new Handler($core, $tracerFactory);
143		}
144
145	306	private function initQueueConfig(EnvironmentInterface $env): void
146		{
147	306	$this->config->setDefaults(
148	306	QueueConfig::CONFIG,
149	306	[
150	306	'default' => $env->get('QUEUE_CONNECTION', 'sync'),
151	306	'connections' => [
152	306	'sync' => [
153	306	'driver' => 'sync',
154	306	],
155	306	],
156	306	'registry' => [
157	306	'handlers' => [],
158	306	'serializers' => [],
159	306	],
160	306	'driverAliases' => [
161	306	'sync' => SyncDriver::class,
162	306	'null' => NullDriver::class,
163	306	],
164	306	'interceptors' => [
165	306	'consume' => [
166	306	ErrorHandlerInterceptor::class,
167	306	RetryPolicyInterceptor::class,
168	306	],
169	306	'push' => [],
170	306	],
171	306	],
172	306	);
173		}
174		}
175

spiral / framework

Pull Request — master (#980)

QueueBootloader::addPushInterceptor() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like