symfony · Guikingone · Dec 14, 2019 · May 17, 2020 · May 18, 2020 · May 18, 2020
diff --git a/composer.json b/composer.json
@@ -79,6 +79,13 @@
         "symfony/property-info": "self.version",
         "symfony/proxy-manager-bridge": "self.version",
         "symfony/routing": "self.version",
+        "symfony/scheduler": "self.version",
+        "symfony/dkron-scheduler": "self.version",
+        "symfony/doctrine-scheduler": "self.version",
+        "symfony/google-scheduler": "self.version",
+        "symfony/kubernetes-scheduler": "self.version",
+        "symfony/nomad-scheduler": "self.version",
+        "symfony/redis-scheduler": "self.version",
         "symfony/security-core": "self.version",
         "symfony/security-csrf": "self.version",
         "symfony/security-guard": "self.version",
@@ -116,6 +123,7 @@
         "doctrine/orm": "~2.4,>=2.4.5",
         "doctrine/reflection": "~1.0",
         "doctrine/doctrine-bundle": "^2.0",
+        "dragonmantank/cron-expression": "^3.0",
         "guzzlehttp/promises": "^1.3.1",
         "masterminds/html5": "^2.6",
         "monolog/monolog": "^1.25.1|^2",
@@ -128,6 +136,7 @@
         "psr/simple-cache": "^1.0",
         "egulias/email-validator": "~1.2,>=1.2.8|~2.0",
         "symfony/phpunit-bridge": "^5.2",
+        "symfony/mercure": "^0.3.0",
         "symfony/security-acl": "~2.8|~3.0",
         "phpdocumentor/reflection-docblock": "^3.0|^4.0|^5.0",
         "twig/cssinliner-extra": "^2.12",

diff --git a/src/Symfony/Bridge/Doctrine/SchemaListener/SchedulerTransportDoctrineSchemaSubscriber.php b/src/Symfony/Bridge/Doctrine/SchemaListener/SchedulerTransportDoctrineSchemaSubscriber.php
@@ -0,0 +1,81 @@
+<?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\Bridge\Doctrine\SchemaListener;
+
+use Doctrine\Common\EventSubscriber;
+use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
+use Doctrine\DBAL\Events;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use Doctrine\ORM\Tools\ToolEvents;
+use Symfony\Component\Scheduler\Bridge\Doctrine\Transport\DoctrineTransport;
+use Symfony\Component\Scheduler\Transport\TransportInterface;
+
+/**
+ * @author Guillaume Loulier <contact@guillaumeloulier.fr>
+ */
+final class SchedulerTransportDoctrineSchemaSubscriber implements EventSubscriber
+{
+    private const PROCESSING_TABLE_FLAG = self::class.':processing';
+
+    private $transports;
+
+    /**
+     * @param iterable|TransportInterface[] $transports
+     */
+    public function __construct(iterable $transports)
+    {
+        $this->transports = $transports;
+    }
+
+    public function postGenerateSchema(GenerateSchemaEventArgs $event): void
+    {
+        $connection = $event->getEntityManager()->getConnection();
+        foreach ($this->transports as $transport) {
+            if (!$transport instanceof DoctrineTransport) {
+                continue;
+            }
+
+            $transport->configureSchema($event->getSchema(), $connection);
+        }
+    }
+
+    public function onSchemaCreateTable(SchemaCreateTableEventArgs $event): void
+    {
+        $table = $event->getTable();
+
+        if ($table->hasOption(self::PROCESSING_TABLE_FLAG)) {
+            return;
+        }
+
+        foreach ($this->transports as $transport) {
+            if (!$transport instanceof DoctrineTransport) {
+                continue;
+            }
+
+            $table->addOption(self::PROCESSING_TABLE_FLAG, true);
+            $createTableSql = $event->getPlatform()->getCreateTableSQL($table);
+
+            $event->addSql($createTableSql);
+            $event->preventDefault();
+
+            return;
+        }
+    }
+
+    public function getSubscribedEvents(): array
+    {
+        return [
+            ToolEvents::postGenerateSchema,
+            Events::onSchemaCreateTable,
+        ];
+    }
+}
diff --git a/...y/Bridge/Doctrine/Tests/SchemaListener/SchedulerTransportDoctrineSchemaSubscriberTest.php b/...y/Bridge/Doctrine/Tests/SchemaListener/SchedulerTransportDoctrineSchemaSubscriberTest.php
@@ -0,0 +1,81 @@
+<?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\Bridge\Doctrine\Tests\SchemaListener;
+
+use Doctrine\DBAL\Connection;
+use Doctrine\DBAL\Event\SchemaCreateTableEventArgs;
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\DBAL\Schema\Table;
+use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Doctrine\SchemaListener\SchedulerTransportDoctrineSchemaSubscriber;
+use Symfony\Component\Scheduler\Bridge\Doctrine\Transport\DoctrineTransport;
+use Symfony\Component\Scheduler\Transport\TransportInterface;
+
+/**
+ * @author Ryan Weaver <ryan@symfonycasts.com>
+ * @author Guillaume Loulier <contact@guillaumeloulier.fr>
+ *
+ * {@see MessengerTransportDoctrineSchemaSubscriberTest for complete introduction}
+ */
+final class SchedulerTransportDoctrineSchemaSubscriberTest extends TestCase
+{
+    public function testPostGenerateSchema(): void
+    {
+        $schema = new Schema();
+
+        $connection = $this->createMock(Connection::class);
+
+        $entityManager = $this->createMock(EntityManagerInterface::class);
+        $entityManager->expects(self::once())->method('getConnection')->willReturn($connection);
+
+        $event = new GenerateSchemaEventArgs($entityManager, $schema);
+
+        $doctrineTransport = $this->createMock(DoctrineTransport::class);
+        $doctrineTransport->expects(self::once())->method('configureSchema')->with($schema, $connection);
+
+        $otherTransport = $this->createMock(TransportInterface::class);
+        $otherTransport->expects(self::never())->method(self::anything());
+
+        $subscriber = new SchedulerTransportDoctrineSchemaSubscriber([$doctrineTransport, $otherTransport]);
+        $subscriber->postGenerateSchema($event);
+    }
+
+    public function testOnSchemaCreateTable(): void
+    {
+        $platform = $this->createMock(AbstractPlatform::class);
+
+        $table = new Table('tasks_table');
+        $event = new SchemaCreateTableEventArgs($table, [], [], $platform);
+
+        $otherTransport = $this->createMock(TransportInterface::class);
+        $otherTransport->expects(self::never())->method($this->anything());
+
+        $doctrineTransport = $this->createMock(DoctrineTransport::class);
+
+        // we use the platform to generate the full create table sql
+        $platform->expects(self::once())
+            ->method('getCreateTableSQL')
+            ->with($table)
+            ->willReturn('CREATE TABLE pizza (id integer NOT NULL)');
+
+        $subscriber = new SchedulerTransportDoctrineSchemaSubscriber([$otherTransport, $doctrineTransport]);
+        $subscriber->onSchemaCreateTable($event);
+
+        static::assertTrue($event->isDefaultPrevented());
+        static::assertSame([
+            'CREATE TABLE pizza (id integer NOT NULL)',
+        ], $event->getSql());
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/composer.json b/src/Symfony/Bridge/Doctrine/composer.json
@@ -34,6 +34,7 @@
         "symfony/http-kernel": "^5.0",
         "symfony/messenger": "^4.4|^5.0",
         "symfony/doctrine-messenger": "^5.1",
+        "symfony/doctrine-scheduler": "^4.4|^5.0",
         "symfony/property-access": "^4.4|^5.0",
         "symfony/property-info": "^5.0",
         "symfony/proxy-manager-bridge": "^4.4|^5.0",

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/UnusedTagsPass.php
@@ -72,6 +72,14 @@ class UnusedTagsPass implements CompilerPassInterface
         'routing.expression_language_provider',
         'routing.loader',
         'routing.route_loader',
+        'scheduler.entry_point',
+        'scheduler.exporter_formatter',
+        'scheduler.hub',
+        'scheduler.hub_subscriber',
+        'scheduler.runner',
+        'scheduler.task_factory',
+        'scheduler.transport',
+        'scheduler.transport_factory',
         'security.expression_language_provider',
         'security.remember_me_aware',
         'security.voter',

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php
@@ -30,6 +30,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Notifier\Notifier;
 use Symfony\Component\PropertyInfo\PropertyInfoExtractorInterface;
+use Symfony\Component\Scheduler\SchedulerInterface;
 use Symfony\Component\Serializer\Serializer;
 use Symfony\Component\Translation\Translator;
 use Symfony\Component\Validator\Validation;
@@ -133,6 +134,7 @@ public function getConfigTreeBuilder()
         $this->addMailerSection($rootNode);
         $this->addSecretsSection($rootNode);
         $this->addNotifierSection($rootNode);
+        $this->addSchedulerSection($rootNode);
 
         return $treeBuilder;
     }
@@ -1254,7 +1256,7 @@ function ($a) {
                                                         return $middleware;
                                                     }
                                                     if (1 < \count($middleware)) {
-                                                        throw new \InvalidArgumentException(sprintf('Invalid middleware at path "framework.messenger": a map with a single factory id as key and its arguments as value was expected, %s given.', json_encode($middleware)));
+                                                        throw new \InvalidArgumentException(sprintf('Invalid middleware at path "framework.messenger": a map with a single factory id as key and its arguments as value was expected, "%s" given.', json_encode($middleware)));
                                                     }
 
                                                     return [
@@ -1641,4 +1643,103 @@ private function addNotifierSection(ArrayNodeDefinition $rootNode)
             ->end()
         ;
     }
+
+    private function addSchedulerSection(ArrayNodeDefinition $rootNode): void
+    {
+        $rootNode
+            ->children()
+                ->arrayNode('scheduler')
+                    ->info('Scheduler configuration')
+                    ->{!class_exists(FullStack::class) && class_exists(SchedulerInterface::class) ? 'canBeDisabled' : 'canBeEnabled'}()
+                    ->children()
+                        ->scalarNode('export_directory')
+                            ->info('The path where the tasks should be exported')
+                            ->defaultValue('%kernel.project_dir%/var/scheduler/exports')
+                        ->end()
+                        ->scalarNode('output_path')
+                            ->info('The path where the output should be sent')
+                            ->defaultValue('%kernel.project_dir%/var/scheduler')
+                        ->end()
+                        ->scalarNode('path')
+                            ->info('The path used to trigger tasks using http request, default to "/_tasks"')
+                            ->defaultValue('/_tasks')
+                        ->end()
+                        ->scalarNode('timezone')
+                            ->info('The timezone used by every scheduler (if not override in each one), if not defined, the default value will be "UTC"')
+                            ->defaultValue('UTC')
+                        ->end()
+                        ->scalarNode('lock_store')
+                            ->info('The store used by every worker to prevent overlapping, by default, a FlockStore is created')
+                            ->defaultNull()
+                        ->end()
+                    ->end()
+                    ->fixXmlConfig('transport')
+                    ->children()
+                        ->arrayNode('transports')
+                            ->useAttributeAsKey('name')
+                            ->normalizeKeys(false)
+                            ->prototype('array')
+                                ->fixXmlConfig('option')
+                                ->children()
+                                    ->scalarNode('dsn')->end()
+                                    ->arrayNode('options')
+                                        ->normalizeKeys(false)
+                                        ->defaultValue([])
+                                        ->prototype('variable')->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                    ->fixXmlConfig('scheduler')
+                    ->children()
+                        ->arrayNode('schedulers')
+                            ->useAttributeAsKey('name')
+                            ->prototype('array')
+                                ->children()
+                                    ->scalarNode('transport')
+                                        ->info('A valid transport defined in the related configuration')
+                                        ->cannotBeEmpty()
+                                        ->isRequired()
+                                    ->end()
+                                    ->scalarNode('timezone')
+                                        ->info('The timezone used by this scheduler, if not defined, the default value will be the one defined in "scheduler.timezone"')
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                    ->fixXmlConfig('task')
+                    ->children()
+                        ->arrayNode('tasks')
+                            ->useAttributeAsKey('name')
+                            ->normalizeKeys(false)
+                            ->fixXmlConfig('tag')
+                            ->fixXmlConfig('option')
+                                ->prototype('array')
+                                    ->children()
+                                        ->scalarNode('scheduler')
+                                            ->cannotBeEmpty()
+                                            ->isRequired()
+                                        ->end()
+                                        ->scalarNode('command')->end()
+                                        ->scalarNode('expression')->end()
+                                        ->scalarNode('type')->end()
+                                        ->arrayNode('options')
+                                            ->defaultValue([])
+                                            ->prototype('variable')->end()
+                                        ->end()
+                                        ->arrayNode('tags')
+                                            ->defaultValue([])
+                                            ->prototype('variable')->end()
+                                        ->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end()
+        ;
+    }
 }