[Scheduler] Rework the component

fabpot · fabpot · commit 6907079681f7 · 2023-03-16T08:19:14.000+01:00
diff --git a/DependencyInjection/Compiler/UnusedTagsPass.php b/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -80,7 +80,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'routing.expression_language_provider',
         'routing.loader',
         'routing.route_loader',
-        'scheduler.schedule_config_locator',
+        'scheduler.schedule_provider',
         'security.authenticator.login_linker',
         'security.expression_language_provider',
         'security.remember_me_aware',
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -37,6 +37,7 @@
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
 use Symfony\Component\RateLimiter\Policy\TokenBucketLimiter;
 use Symfony\Component\RemoteEvent\RemoteEvent;
+use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
 use Symfony\Component\Semaphore\Semaphore;
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Translation\Translator;
@@ -173,6 +174,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $this->addLockSection($rootNode, $enableIfStandalone);
         $this->addSemaphoreSection($rootNode, $enableIfStandalone);
         $this->addMessengerSection($rootNode, $enableIfStandalone);
+        $this->addSchedulerSection($rootNode, $enableIfStandalone);
         $this->addRobotsIndexSection($rootNode);
         $this->addHttpClientSection($rootNode, $enableIfStandalone);
         $this->addMailerSection($rootNode, $enableIfStandalone);
@@ -1606,6 +1608,18 @@ function ($a) {
         ;
     }
 
+    private function addSchedulerSection(ArrayNodeDefinition $rootNode, callable $enableIfStandalone): void
+    {
+        $rootNode
+            ->children()
+                ->arrayNode('scheduler')
+                    ->info('Scheduler configuration')
+                    ->{$enableIfStandalone('symfony/scheduler', SchedulerTransportFactory::class)}()
+                ->end()
+            ->end()
+        ;
+    }
+
     private function addRobotsIndexSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -215,8 +215,8 @@
 use Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer;
 use Symfony\Component\RemoteEvent\RemoteEvent;
 use Symfony\Component\Routing\Loader\Psr4DirectoryLoader;
-use Symfony\Component\Scheduler\Locator\ScheduleConfigLocatorInterface;
-use Symfony\Component\Scheduler\Messenger\ScheduleTransportFactory;
+use Symfony\Component\Scheduler\Attribute\AsSchedule;
+use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
 use Symfony\Component\Security\Core\AuthenticationEvents;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
@@ -528,9 +528,18 @@ public function load(array $configs, ContainerBuilder $container)
         // validation depends on form, annotations being registered
         $this->registerValidationConfiguration($config['validation'], $container, $loader, $propertyInfoEnabled);
 
+        $messengerEnabled = $this->readConfigEnabled('messenger', $container, $config['messenger']);
+
+        if ($this->readConfigEnabled('scheduler', $container, $config['scheduler'])) {
+            if (!$messengerEnabled) {
+                throw new LogicException('Scheduler support cannot be enabled as the Messenger component is not '.(interface_exists(MessageBusInterface::class) ? 'enabled.' : 'installed. Try running "composer require symfony/messenger".'));
+            }
+            $this->registerSchedulerConfiguration($config['scheduler'], $container, $loader);
+        }
+
         // messenger depends on validation being registered
-        if ($this->readConfigEnabled('messenger', $container, $config['messenger'])) {
-            $this->registerMessengerConfiguration($config['messenger'], $container, $loader, $config['validation']);
+        if ($messengerEnabled) {
+            $this->registerMessengerConfiguration($config['messenger'], $container, $loader, $this->readConfigEnabled('validation', $container, $config['validation']));
         } else {
             $container->removeDefinition('console.command.messenger_consume_messages');
             $container->removeDefinition('console.command.messenger_stats');
@@ -675,8 +684,6 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('messenger.message_handler');
         $container->registerForAutoconfiguration(TransportFactoryInterface::class)
             ->addTag('messenger.transport_factory');
-        $container->registerForAutoconfiguration(ScheduleConfigLocatorInterface::class)
-            ->addTag('scheduler.schedule_config_locator');
         $container->registerForAutoconfiguration(MimeTypeGuesserInterface::class)
             ->addTag('mime.mime_type_guesser');
         $container->registerForAutoconfiguration(LoggerAwareInterface::class)
@@ -710,10 +717,12 @@ public function load(array $configs, ContainerBuilder $container)
             }
             $definition->addTag('messenger.message_handler', $tagAttributes);
         });
-
         $container->registerAttributeForAutoconfiguration(AsTargetedValueResolver::class, static function (ChildDefinition $definition, AsTargetedValueResolver $attribute): void {
             $definition->addTag('controller.targeted_value_resolver', $attribute->name ? ['name' => $attribute->name] : []);
         });
+        $container->registerAttributeForAutoconfiguration(AsSchedule::class, static function (ChildDefinition $definition, AsSchedule $attribute): void {
+            $definition->addTag('scheduler.schedule_provider', ['name' => $attribute->name]);
+        });
 
         if (!$container->getParameter('kernel.debug')) {
             // remove tagged iterator argument for resource checkers
@@ -1999,7 +2008,20 @@ private function registerSemaphoreConfiguration(array $config, ContainerBuilder
         }
     }
 
-    private function registerMessengerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, array $validationConfig): void
+    private function registerSchedulerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader): void
+    {
+        if (!class_exists(SchedulerTransportFactory::class)) {
+            throw new LogicException('Scheduler support cannot be enabled as the Scheduler component is not installed. Try running "composer require symfony/scheduler".');
+        }
+
+        if (!interface_exists(MessageBusInterface::class)) {
+            throw new LogicException('Scheduler support cannot be enabled as the Messenger component is not installed. Try running "composer require symfony/messenger".');
+        }
+
+        $loader->load('scheduler.php');
+    }
+
+    private function registerMessengerConfiguration(array $config, ContainerBuilder $container, PhpFileLoader $loader, bool $validationEnabled): void
     {
         if (!interface_exists(MessageBusInterface::class)) {
             throw new LogicException('Messenger support cannot be enabled as the Messenger component is not installed. Try running "composer require symfony/messenger".');
@@ -2031,10 +2053,6 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             $container->getDefinition('messenger.transport.beanstalkd.factory')->addTag('messenger.transport_factory');
         }
 
-        if (ContainerBuilder::willBeAvailable('symfony/scheduler', ScheduleTransportFactory::class, ['symfony/framework-bundle', 'symfony/messenger'])) {
-            $loader->load('scheduler.php');
-        }
-
         if (null === $config['default_bus'] && 1 === \count($config['buses'])) {
             $config['default_bus'] = key($config['buses']);
         }
@@ -2065,7 +2083,7 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             }
 
             foreach ($middleware as $middlewareItem) {
-                if (!$validationConfig['enabled'] && \in_array($middlewareItem['id'], ['validation', 'messenger.middleware.validation'], true)) {
+                if (!$validationEnabled && \in_array($middlewareItem['id'], ['validation', 'messenger.middleware.validation'], true)) {
                     throw new LogicException('The Validation middleware is only available when the Validator component is installed and enabled. Try running "composer require symfony/validator".');
                 }
             }
@@ -2091,7 +2109,6 @@ private function registerMessengerConfiguration(array $config, ContainerBuilder
             $container->removeDefinition('messenger.transport.redis.factory');
             $container->removeDefinition('messenger.transport.sqs.factory');
             $container->removeDefinition('messenger.transport.beanstalkd.factory');
-            $container->removeDefinition('scheduler.messenger_transport_factory');
             $container->removeAlias(SerializerInterface::class);
         } else {
             $container->getDefinition('messenger.transport.symfony_serializer')
diff --git a/FrameworkBundle.php b/FrameworkBundle.php
@@ -60,7 +60,7 @@
 use Symfony\Component\Mime\DependencyInjection\AddMimeTypeGuesserPass;
 use Symfony\Component\PropertyInfo\DependencyInjection\PropertyInfoPass;
 use Symfony\Component\Routing\DependencyInjection\RoutingResolverPass;
-use Symfony\Component\Scheduler\DependencyInjection\SchedulerPass;
+use Symfony\Component\Scheduler\DependencyInjection\AddScheduleMessengerPass;
 use Symfony\Component\Serializer\DependencyInjection\SerializerPass;
 use Symfony\Component\Translation\DependencyInjection\TranslationDumperPass;
 use Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass;
@@ -166,8 +166,8 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new TestServiceContainerWeakRefPass(), PassConfig::TYPE_BEFORE_REMOVING, -32);
         $container->addCompilerPass(new TestServiceContainerRealRefPass(), PassConfig::TYPE_AFTER_REMOVING);
         $this->addCompilerPassIfExists($container, AddMimeTypeGuesserPass::class);
+        $this->addCompilerPassIfExists($container, AddScheduleMessengerPass::class);
         $this->addCompilerPassIfExists($container, MessengerPass::class);
-        $this->addCompilerPassIfExists($container, SchedulerPass::class);
         $this->addCompilerPassIfExists($container, HttpClientPass::class);
         $this->addCompilerPassIfExists($container, AddAutoMappingConfigurationPass::class);
         $container->addCompilerPass(new RegisterReverseContainerPass(true));
diff --git a/Resources/config/cache.php b/Resources/config/cache.php
@@ -71,6 +71,11 @@
             ->private()
             ->tag('cache.pool')
 
+        ->set('cache.scheduler')
+            ->parent('cache.app')
+            ->private()
+            ->tag('cache.pool')
+
         ->set('cache.adapter.system', AdapterInterface::class)
             ->abstract()
             ->factory([AbstractAdapter::class, 'createSystemCache'])
diff --git a/Resources/config/messenger.php b/Resources/config/messenger.php
@@ -75,6 +75,7 @@
             ->tag('serializer.normalizer', ['priority' => -880])
 
         ->set('messenger.transport.native_php_serializer', PhpSerializer::class)
+        ->alias('messenger.default_serializer', 'messenger.transport.native_php_serializer')
 
         // Middleware
         ->set('messenger.middleware.handle_message', HandleMessageMiddleware::class)
diff --git a/Resources/config/scheduler.php b/Resources/config/scheduler.php
@@ -11,42 +11,15 @@
 
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
-use Symfony\Component\DependencyInjection\ServiceLocator;
-use Symfony\Component\Scheduler\Locator\ChainScheduleConfigLocator;
-use Symfony\Component\Scheduler\Messenger\ScheduleTransportFactory;
-use Symfony\Component\Scheduler\State\StateFactory;
+use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
-        ->set('scheduler.messenger_transport_factory', ScheduleTransportFactory::class)
+        ->set('scheduler.messenger_transport_factory', SchedulerTransportFactory::class)
             ->args([
+                tagged_locator('scheduler.schedule_provider', 'name'),
                 service('clock'),
-                service('scheduler.schedule_config_locator'),
-                service('scheduler.state_factory'),
             ])
             ->tag('messenger.transport_factory')
-
-        ->set('scheduler.schedule_config_locator', ChainScheduleConfigLocator::class)
-            ->args([
-                tagged_iterator('scheduler.schedule_config_locator'),
-            ])
-
-        ->set('scheduler.state_factory', StateFactory::class)
-            ->args([
-                service('scheduler.lock_locator'),
-                service('scheduler.cache_locator'),
-            ])
-
-        ->set('scheduler.lock_locator', ServiceLocator::class)
-            ->args([
-                [],
-            ])
-            ->tag('container.service_locator')
-
-        ->set('scheduler.cache_locator', ServiceLocator::class)
-            ->args([
-                [],
-            ])
-            ->tag('container.service_locator')
     ;
 };
diff --git a/Resources/config/schema/symfony-1.0.xsd b/Resources/config/schema/symfony-1.0.xsd
@@ -24,6 +24,7 @@
             <xsd:element name="validation" type="validation" minOccurs="0" maxOccurs="1" />
             <xsd:element name="annotations" type="annotations" minOccurs="0" maxOccurs="1" />
             <xsd:element name="property-access" type="property_access" minOccurs="0" maxOccurs="1" />
+            <xsd:element name="scheduler" type="scheduler" minOccurs="0" maxOccurs="1" />
             <xsd:element name="serializer" type="serializer" minOccurs="0" maxOccurs="1" />
             <xsd:element name="property-info" type="property_info" minOccurs="0" maxOccurs="1" />
             <xsd:element name="cache" type="cache" minOccurs="0" maxOccurs="1" />
@@ -271,6 +272,10 @@
         <xsd:attribute name="throw-exception-on-invalid-property-path" type="xsd:boolean" />
     </xsd:complexType>
 
+    <xsd:complexType name="scheduler">
+        <xsd:attribute name="enabled" type="xsd:boolean" />
+    </xsd:complexType>
+
     <xsd:complexType name="serializer">
         <xsd:choice minOccurs="0" maxOccurs="unbounded">
             <xsd:element name="mapping" type="file_mapping" />
diff --git a/Tests/DependencyInjection/ConfigurationTest.php b/Tests/DependencyInjection/ConfigurationTest.php
@@ -26,6 +26,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Notifier\Notifier;
 use Symfony\Component\RateLimiter\Policy\TokenBucketLimiter;
+use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
 use Symfony\Component\Uid\Factory\UuidFactory;
 
 class ConfigurationTest extends TestCase
@@ -687,6 +688,9 @@ class_exists(SemaphoreStore::class) && SemaphoreStore::isSupported() ? 'semaphor
                 'enabled' => !class_exists(FullStack::class) && class_exists(HtmlSanitizer::class),
                 'sanitizers' => [],
             ],
+            'scheduler' => [
+                'enabled' => !class_exists(FullStack::class) && class_exists(SchedulerTransportFactory::class),
+            ],
             'exceptions' => [],
             'webhook' => [
                 'enabled' => false,
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger.php b/Tests/DependencyInjection/Fixtures/php/messenger.php
@@ -5,6 +5,7 @@
 
 $container->loadFromExtension('framework', [
     'http_method_override' => false,
+    'scheduler' => true,
     'messenger' => [
         'routing' => [
             FooMessage::class => ['sender.bar', 'sender.biz'],
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_schedule.php b/Tests/DependencyInjection/Fixtures/php/messenger_schedule.php
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger.xml b/Tests/DependencyInjection/Fixtures/xml/messenger.xml
@@ -6,6 +6,7 @@
         http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
 
     <framework:config http-method-override="false">
+        <framework:scheduler enabled="true" />
         <framework:messenger>
             <framework:routing message-class="Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage">
                 <framework:sender service="sender.bar" />
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger.yml b/Tests/DependencyInjection/Fixtures/yml/messenger.yml
@@ -1,5 +1,6 @@
 framework:
     http_method_override: false
+    scheduler: true
     messenger:
         routing:
             'Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage': ['sender.bar', 'sender.biz']
diff --git a/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -813,13 +813,13 @@ public function testMessenger()
         $container->compile();
 
         $expectedFactories = [
+            new Reference('scheduler.messenger_transport_factory'),
             new Reference('messenger.transport.amqp.factory'),
             new Reference('messenger.transport.redis.factory'),
             new Reference('messenger.transport.sync.factory'),
             new Reference('messenger.transport.in_memory.factory'),
             new Reference('messenger.transport.sqs.factory'),
             new Reference('messenger.transport.beanstalkd.factory'),
-            new Reference('scheduler.messenger_transport_factory'),
         ];
 
         $this->assertTrue($container->hasDefinition('messenger.receiver_locator'));
@@ -979,8 +979,6 @@ public function testMessengerTransports()
         $this->assertCount(3, $transportArguments);
         $this->assertSame('schedule://default', $transportArguments[0]);
 
-        $this->assertTrue($container->hasDefinition('scheduler.messenger_transport_factory'));
-
         $this->assertSame(10, $container->getDefinition('messenger.retry.multiplier_retry_strategy.customised')->getArgument(0));
         $this->assertSame(7, $container->getDefinition('messenger.retry.multiplier_retry_strategy.customised')->getArgument(1));
         $this->assertSame(3, $container->getDefinition('messenger.retry.multiplier_retry_strategy.customised')->getArgument(2));
diff --git a/Tests/Fixtures/Messenger/DummySchedule.php b/Tests/Fixtures/Messenger/DummySchedule.php
@@ -0,0 +1,26 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger;
+
+use Symfony\Component\Cache\Adapter\ArrayAdapter;
+use Symfony\Component\Lock\Key;
+use Symfony\Component\Lock\Lock;
+use Symfony\Component\Lock\Store\InMemoryStore;
+use Symfony\Component\Scheduler\Attribute\AsSchedule;
+use Symfony\Component\Scheduler\Schedule;
+use Symfony\Component\Scheduler\ScheduleProviderInterface;
+
+#[AsSchedule('dummy')]
+class DummySchedule implements ScheduleProviderInterface
+{
+    public static array $recurringMessages;
+
+    public function getSchedule(): Schedule
+    {
+        return (new Schedule())
+            ->add(...self::$recurringMessages)
+            ->stateful(new ArrayAdapter())
+            ->lock(new Lock(new Key('dummy'), new InMemoryStore()))
+        ;
+    }
+}
diff --git a/Tests/Fixtures/Messenger/DummyScheduleConfigLocator.php b/Tests/Fixtures/Messenger/DummyScheduleConfigLocator.php
diff --git a/Tests/Functional/SchedulerTest.php b/Tests/Functional/SchedulerTest.php
diff --git a/Tests/Functional/app/Scheduler/config.yml b/Tests/Functional/app/Scheduler/config.yml
