feature #51525 [Messenger][Scheduler] Add AsCronTask & AsPeriodicTask attributes (valtzu)

This PR was squashed before being merged into the 6.4 branch.

Discussion
----------

[Messenger][Scheduler] Add AsCronTask & AsPeriodicTask attributes

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       | Fix #51432
| License       | MIT
| Doc PR        | symfony/symfony-docs#... _// todo_

Simplify scheduler usage by allowing to declare an attribute `AsCronTask` / `AsPeriodicTask` on any registered & autoconfigured service.

Example usage:

```php
#[AsPeriodicTask(frequency: 5, jitter: 1, arguments: ['Hello from periodic trigger'])]
class BusinessLogic
{
    public function __invoke(string $message): void
    {
        echo "$message\n";
    }
}
```

```php
#[AsCronTask('* * * * *', arguments: 'hello -v')]
#[AsCommand('app:do-stuff')]
class DoStuffCommand extends Command
{
    // ...
}
```

```yaml
services:
  some_other_service:
    class: # ...
    tags:
      - name: scheduler.task
        trigger: cron
        expression: '0 9-17 * * *'
        method: 'someMethod'
        transports: [async]
```

`bin/console debug:schedule` output:

```bash
Scheduler
=========

default
-------

 ------------------------------------------- ---------------------------------------- ---------------------------------
  Message                                     Trigger                                  Next Run
 ------------------------------------------- ---------------------------------------- ---------------------------------
  `@App`\BusinessLogic                          every 5 seconds with 0-1 second jitter   Sat, 02 Sep 2023 10:55:36 +0000
  app:do-stuff hello -v                       * * * * *                                Sat, 02 Sep 2023 13:56:00 +0300
  `@some_other_service`::someMethod via async   0 9-17 * * *                             Sat, 02 Sep 2023 14:00:00 +0300
 ------------------------------------------- ---------------------------------------- ---------------------------------

```

And then run `bin/console messenger:consume scheduler_default` to run the scheduler, like the usual.

---

**To-do (help needed):**
1. tests
2. docs
3. validate the approach (creating `RecurringMessage`s using DI)

Commits
-------

ed27b20c1a [Messenger][Scheduler] Add AsCronTask & AsPeriodicTask attributes

Author: fabpot

DependencyInjection/Compiler/UnusedTagsPass.php

@@ -84,6 +84,7 @@ class UnusedTagsPass implements CompilerPassInterface
         'routing.loader',
         'routing.route_loader',
         'scheduler.schedule_provider',
+        'scheduler.task',
         'security.authenticator.login_linker',
         'security.expression_language_provider',
         'security.remember_me_handler',

DependencyInjection/FrameworkExtension.php

@@ -145,6 +145,8 @@
 use Symfony\Component\RemoteEvent\Attribute\AsRemoteEventConsumer;
 use Symfony\Component\RemoteEvent\RemoteEvent;
 use Symfony\Component\Routing\Loader\AnnotationClassLoader;
+use Symfony\Component\Scheduler\Attribute\AsCronTask;
+use Symfony\Component\Scheduler\Attribute\AsPeriodicTask;
 use Symfony\Component\Scheduler\Attribute\AsSchedule;
 use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
 use Symfony\Component\Security\Core\AuthenticationEvents;
@@ -702,6 +704,26 @@ public function load(array $configs, ContainerBuilder $container)
         $container->registerAttributeForAutoconfiguration(AsSchedule::class, static function (ChildDefinition $definition, AsSchedule $attribute): void {
             $definition->addTag('scheduler.schedule_provider', ['name' => $attribute->name]);
         });
+        foreach ([AsPeriodicTask::class, AsCronTask::class] as $taskAttributeClass) {
+            $container->registerAttributeForAutoconfiguration(
+                $taskAttributeClass,
+                static function (ChildDefinition $definition, AsPeriodicTask|AsCronTask $attribute, \ReflectionClass|\ReflectionMethod $reflector): void {
+                    $tagAttributes = get_object_vars($attribute) + [
+                        'trigger' => match ($attribute::class) {
+                            AsPeriodicTask::class => 'every',
+                            AsCronTask::class => 'cron',
+                        },
+                    ];
+                    if ($reflector instanceof \ReflectionMethod) {
+                        if (isset($tagAttributes['method'])) {
+                            throw new LogicException(sprintf('%s attribute cannot declare a method on "%s::%s()".', $attribute::class, $reflector->class, $reflector->name));
+                        }
+                        $tagAttributes['method'] = $reflector->getName();
+                    }
+                    $definition->addTag('scheduler.task', $tagAttributes);
+                }
+            );
+        }
 
         if (!$container->getParameter('kernel.debug')) {
             // remove tagged iterator argument for resource checkers

Resources/config/scheduler.php

@@ -12,9 +12,15 @@
 namespace Symfony\Component\DependencyInjection\Loader\Configurator;
 
 use Symfony\Component\Scheduler\Messenger\SchedulerTransportFactory;
+use Symfony\Component\Scheduler\Messenger\ServiceCallMessageHandler;
 
 return static function (ContainerConfigurator $container) {
     $container->services()
+        ->set('scheduler.messenger.service_call_message_handler', ServiceCallMessageHandler::class)
+            ->args([
+                tagged_locator('scheduler.task'),
+            ])
+            ->tag('messenger.message_handler')
         ->set('scheduler.messenger_transport_factory', SchedulerTransportFactory::class)
             ->args([
                 tagged_locator('scheduler.schedule_provider', 'name'),

Tests/Fixtures/Messenger/DummyTask.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger;
+
+use Symfony\Component\Scheduler\Attribute\AsCronTask;
+use Symfony\Component\Scheduler\Attribute\AsPeriodicTask;
+
+#[AsCronTask(expression: '* * * * *', arguments: [1], schedule: 'dummy')]
+#[AsCronTask(expression: '0 * * * *', timezone: 'Europe/Berlin', arguments: ['2'], schedule: 'dummy', method: 'method2')]
+#[AsPeriodicTask(frequency: 5, arguments: [3], schedule: 'dummy')]
+#[AsPeriodicTask(frequency: 'every day', from: '00:00:00', jitter: 60, arguments: ['4'], schedule: 'dummy', method: 'method4')]
+class DummyTask
+{
+    public static array $calls = [];
+
+    #[AsPeriodicTask(frequency: 'every hour', from: '09:00:00', until: '17:00:00', arguments: ['b' => 6, 'a' => '5'], schedule: 'dummy')]
+    #[AsCronTask(expression: '0 0 * * *', arguments: ['7', 8], schedule: 'dummy')]
+    public function attributesOnMethod(string $a, int $b): void
+    {
+        self::$calls[__FUNCTION__][] = [$a, $b];
+    }
+
+    public function __call(string $name, array $arguments)
+    {
+        self::$calls[$name][] = $arguments;
+    }
+}

Tests/Functional/app/Scheduler/config.yml

@@ -10,6 +10,9 @@ services:
     Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummySchedule:
         autoconfigure: true
 
+    Symfony\Bundle\FrameworkBundle\Tests\Fixtures\Messenger\DummyTask:
+        autoconfigure: true
+
     clock:
         synthetic: true