Add the Scheduler component

upyx · fabpot · commit ee83bc793b64 · 2023-03-16T08:08:00.000+01:00
diff --git a/DependencyInjection/Compiler/UnusedTagsPass.php b/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -80,6 +80,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'routing.expression_language_provider',
         'routing.loader',
         'routing.route_loader',
+        'scheduler.schedule_config_locator',
         'security.authenticator.login_linker',
         'security.expression_language_provider',
         'security.remember_me_aware',
diff --git a/DependencyInjection/FrameworkExtension.php b/DependencyInjection/FrameworkExtension.php
@@ -215,6 +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\Security\Core\AuthenticationEvents;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
@@ -673,6 +675,8 @@ 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)
@@ -2027,6 +2031,10 @@ 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']);
         }
@@ -2083,6 +2091,7 @@ 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,6 +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\Serializer\DependencyInjection\SerializerPass;
 use Symfony\Component\Translation\DependencyInjection\TranslationDumperPass;
 use Symfony\Component\Translation\DependencyInjection\TranslationExtractorPass;
@@ -166,6 +167,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new TestServiceContainerRealRefPass(), PassConfig::TYPE_AFTER_REMOVING);
         $this->addCompilerPassIfExists($container, AddMimeTypeGuesserPass::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/scheduler.php b/Resources/config/scheduler.php
@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+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;
+
+return static function (ContainerConfigurator $container) {
+    $container->services()
+        ->set('scheduler.messenger_transport_factory', ScheduleTransportFactory::class)
+            ->args([
+                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/Tests/DependencyInjection/Fixtures/php/messenger_schedule.php b/Tests/DependencyInjection/Fixtures/php/messenger_schedule.php
@@ -0,0 +1,15 @@
+<?php
+
+$container->loadFromExtension('framework', [
+    'http_method_override' => false,
+    'messenger' => [
+        'transports' => [
+            'schedule' => [
+                'dsn' => 'schedule://default',
+                'options' => [
+                    'cache' => 'array',
+                ]
+            ],
+        ],
+    ],
+]);
diff --git a/Tests/DependencyInjection/Fixtures/php/messenger_transports.php b/Tests/DependencyInjection/Fixtures/php/messenger_transports.php
@@ -25,6 +25,7 @@
             'failed' => 'in-memory:///',
             'redis' => 'redis://127.0.0.1:6379/messages',
             'beanstalkd' => 'beanstalkd://127.0.0.1:11300',
+            'schedule' => 'schedule://default',
         ],
     ],
 ]);
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_schedule.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_schedule.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:framework="http://symfony.com/schema/dic/symfony"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+        http://symfony.com/schema/dic/symfony https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
+
+    <framework:config http-method-override="false">
+        <framework:messenger>
+            <framework:transport name="schedule" dsn="schedule://default" />
+        </framework:messenger>
+    </framework:config>
+</container>
diff --git a/Tests/DependencyInjection/Fixtures/xml/messenger_transports.xml b/Tests/DependencyInjection/Fixtures/xml/messenger_transports.xml
@@ -21,6 +21,7 @@
             <framework:transport name="failed" dsn="in-memory:///" />
             <framework:transport name="redis" dsn="redis://127.0.0.1:6379/messages" />
             <framework:transport name="beanstalkd" dsn="beanstalkd://127.0.0.1:11300" />
+            <framework:transport name="schedule" dsn="schedule://default" />
         </framework:messenger>
     </framework:config>
 </container>
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_schedule.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_schedule.yml
@@ -0,0 +1,5 @@
+framework:
+    http_method_override: false
+    messenger:
+        transports:
+            schedule: 'schedule://default'
diff --git a/Tests/DependencyInjection/Fixtures/yml/messenger_transports.yml b/Tests/DependencyInjection/Fixtures/yml/messenger_transports.yml
@@ -22,3 +22,4 @@ framework:
             failed: 'in-memory:///'
             redis: 'redis://127.0.0.1:6379/messages'
             beanstalkd: 'beanstalkd://127.0.0.1:11300'
+            schedule: 'schedule://default'
diff --git a/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -769,6 +769,13 @@ public function testWebLink()
     public function testMessengerServicesRemovedWhenDisabled()
     {
         $container = $this->createContainerFromFile('messenger_disabled');
+        $messengerDefinitions = array_filter(
+            $container->getDefinitions(),
+            static fn ($name) => str_starts_with($name, 'messenger.'),
+            \ARRAY_FILTER_USE_KEY
+        );
+
+        $this->assertEmpty($messengerDefinitions);
         $this->assertFalse($container->hasDefinition('console.command.messenger_consume_messages'));
         $this->assertFalse($container->hasDefinition('console.command.messenger_debug'));
         $this->assertFalse($container->hasDefinition('console.command.messenger_stop_workers'));
@@ -801,14 +808,28 @@ public function testMessengerWithExplictResetOnMessageLegacy()
 
     public function testMessenger()
     {
-        $container = $this->createContainerFromFile('messenger');
+        $container = $this->createContainerFromFile('messenger', [], true, false);
+        $container->addCompilerPass(new ResolveTaggedIteratorArgumentPass());
+        $container->compile();
+
+        $expectedFactories = [
+            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'));
         $this->assertTrue($container->hasDefinition('console.command.messenger_consume_messages'));
         $this->assertTrue($container->hasAlias('messenger.default_bus'));
         $this->assertTrue($container->getAlias('messenger.default_bus')->isPublic());
-        $this->assertTrue($container->hasDefinition('messenger.transport.amqp.factory'));
-        $this->assertTrue($container->hasDefinition('messenger.transport.redis.factory'));
         $this->assertTrue($container->hasDefinition('messenger.transport_factory'));
         $this->assertSame(TransportFactory::class, $container->getDefinition('messenger.transport_factory')->getClass());
+        $this->assertInstanceOf(TaggedIteratorArgument::class, $container->getDefinition('messenger.transport_factory')->getArgument(0));
+        $this->assertEquals($expectedFactories, $container->getDefinition('messenger.transport_factory')->getArgument(0)->getValues());
         $this->assertTrue($container->hasDefinition('messenger.listener.reset_services'));
         $this->assertSame('messenger.listener.reset_services', (string) $container->getDefinition('console.command.messenger_consume_messages')->getArgument(5));
     }
@@ -825,10 +846,7 @@ public function testMessengerWithoutConsole()
         $this->assertFalse($container->hasDefinition('console.command.messenger_consume_messages'));
         $this->assertTrue($container->hasAlias('messenger.default_bus'));
         $this->assertTrue($container->getAlias('messenger.default_bus')->isPublic());
-        $this->assertTrue($container->hasDefinition('messenger.transport.amqp.factory'));
-        $this->assertTrue($container->hasDefinition('messenger.transport.redis.factory'));
         $this->assertTrue($container->hasDefinition('messenger.transport_factory'));
-        $this->assertSame(TransportFactory::class, $container->getDefinition('messenger.transport_factory')->getClass());
         $this->assertFalse($container->hasDefinition('messenger.listener.reset_services'));
     }
 
@@ -953,6 +971,16 @@ public function testMessengerTransports()
 
         $this->assertTrue($container->hasDefinition('messenger.transport.beanstalkd.factory'));
 
+        $this->assertTrue($container->hasDefinition('messenger.transport.schedule'));
+        $transportFactory = $container->getDefinition('messenger.transport.schedule')->getFactory();
+        $transportArguments = $container->getDefinition('messenger.transport.schedule')->getArguments();
+
+        $this->assertEquals([new Reference('messenger.transport_factory'), 'createTransport'], $transportFactory);
+        $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));
@@ -966,6 +994,7 @@ public function testMessengerTransports()
             'default' => new Reference('messenger.transport.failed'),
             'failed' => new Reference('messenger.transport.failed'),
             'redis' => new Reference('messenger.transport.failed'),
+            'schedule' => new Reference('messenger.transport.failed'),
         ];
 
         $failureTransportsReferences = array_map(function (ServiceClosureArgument $serviceClosureArgument) {
diff --git a/Tests/Fixtures/Messenger/DummyScheduleConfigLocator.php b/Tests/Fixtures/Messenger/DummyScheduleConfigLocator.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger;
+
+use Psr\Container\NotFoundExceptionInterface;
+use Symfony\Component\Scheduler\Locator\ScheduleConfigLocatorInterface;
+use Symfony\Component\Scheduler\Schedule\ScheduleConfig;
+
+class DummyScheduleConfigLocator implements ScheduleConfigLocatorInterface
+{
+    /**
+     * @var array<string, ScheduleConfig>
+     */
+    public static array $schedules = [];
+
+    public function get(string $id): ScheduleConfig
+    {
+        if (isset(static::$schedules[$id])) {
+            return static::$schedules[$id];
+        }
+
+        throw new class(sprintf('You have requested a non-existent schedule "%s".', $id)) extends \InvalidArgumentException implements NotFoundExceptionInterface { };
+    }
+
+    public function has(string $id): bool
+    {
+        return isset(static::$schedules[$id]);
+    }
+}
diff --git a/Tests/Functional/SchedulerTest.php b/Tests/Functional/SchedulerTest.php
@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
+
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\BarMessage;
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyScheduleConfigLocator;
+use Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\FooMessage;
+use Symfony\Component\Clock\MockClock;
+use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\Scheduler\Messenger\ScheduleTransport;
+use Symfony\Component\Scheduler\Schedule\ScheduleConfig;
+use Symfony\Component\Scheduler\Trigger\PeriodicalTrigger;
+
+class SchedulerTest extends AbstractWebTestCase
+{
+    public function testScheduler()
+    {
+        $scheduleConfig = new ScheduleConfig([
+            [PeriodicalTrigger::create(600, '2020-01-01T00:00:00Z'), $foo = new FooMessage()],
+            [PeriodicalTrigger::create(600, '2020-01-01T00:01:00Z'), $bar = new BarMessage()],
+        ]);
+        DummyScheduleConfigLocator::$schedules = ['default' => $scheduleConfig];
+
+        $container = self::getContainer();
+        $container->set('clock', $clock = new MockClock('2020-01-01T00:09:59Z'));
+
+        $this->assertTrue($container->get('receivers')->has('schedule'));
+        $this->assertInstanceOf(ScheduleTransport::class, $cron = $container->get('receivers')->get('schedule'));
+
+        $fetchMessages = static function (float $sleep) use ($clock, $cron) {
+            if (0 < $sleep) {
+                $clock->sleep($sleep);
+            }
+            $messages = [];
+            foreach ($cron->get() as $key => $envelope) {
+                $messages[$key] = $envelope->getMessage();
+            }
+
+            return $messages;
+        };
+
+        $this->assertSame([], $fetchMessages(0.0));
+        $this->assertSame([$foo], $fetchMessages(1.0));
+        $this->assertSame([], $fetchMessages(1.0));
+        $this->assertSame([$bar], $fetchMessages(60.0));
+        $this->assertSame([$foo, $bar], $fetchMessages(600.0));
+    }
+
+    protected static function createKernel(array $options = []): KernelInterface
+    {
+        return parent::createKernel(['test_case' => 'Scheduler'] + $options);
+    }
+}
diff --git a/Tests/Functional/app/Scheduler/bundles.php b/Tests/Functional/app/Scheduler/bundles.php
@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
+
+return [
+    new FrameworkBundle(),
+];
diff --git a/Tests/Functional/app/Scheduler/config.yml b/Tests/Functional/app/Scheduler/config.yml
@@ -0,0 +1,23 @@
+imports:
+    - { resource: ../config/default.yml }
+
+framework:
+    lock: ~
+    messenger:
+        transports:
+            schedule:
+                dsn: 'schedule://default'
+                options:
+                    cache: 'app'
+                    lock: 'default'
+
+services:
+    Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyScheduleConfigLocator:
+        autoconfigure: true
+
+    clock:
+        synthetic: true
+
+    receivers:
+        public: true
+        alias: 'messenger.receiver_locator'
diff --git a/composer.json b/composer.json
