Introduce symfony/uid bridge to generate JobExecution ids (#138)

* Introduce symfony/uid bridge to generate JobExecution ids

* Configure job execution id generator in Symfony app

* Add reference to new bridge everywhere

* Fix compatibility with Symfony 6.4

* Add documentation about JobExecution id generator being customizable in a Symfony app

Author: yann-eugone

src/DependencyInjection/Configuration.php

@@ -5,6 +5,7 @@
 namespace Yokai\Batch\Bridge\Symfony\Framework\DependencyInjection;
 
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\Config\Definition\Builder\NodeDefinition;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
@@ -15,6 +16,7 @@
  *      storage: StorageConfig,
  *      launcher: LauncherConfig,
  *      parameters: ParametersConfig,
+ *      id: string,
  *      ui: UserInterfaceConfig,
  *  }
  * @phpstan-type StorageConfig array{
@@ -65,6 +67,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->append($this->storage())
                 ->append($this->launcher())
                 ->append($this->parameters())
+                ->append($this->id())
                 ->append($this->ui())
             ->end()
         ;
@@ -178,6 +181,24 @@ private function parameters(): ArrayNodeDefinition
         return $node;
     }
 
+    private function id(): NodeDefinition
+    {
+        /** @var ArrayNodeDefinition $node */
+        $node = (new TreeBuilder('root'))->getRootNode();
+
+        $node
+            ->addDefaultsIfNotSet()
+            ->children()
+                ->enumNode('id')
+                    ->values(JobExecutionIdGeneratorDefinitionFactory::TYPES)
+                    ->defaultValue(JobExecutionIdGeneratorDefinitionFactory::DEFAULT)
+                ->end()
+            ->end()
+        ;
+
+        return $node->getChildNodeDefinitions()['id'];
+    }
+
     private function ui(): ArrayNodeDefinition
     {
         /** @var ArrayNodeDefinition $node */

src/DependencyInjection/JobExecutionIdGeneratorDefinitionFactory.php

@@ -0,0 +1,72 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Bridge\Symfony\Framework\DependencyInjection;
+
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Exception\LogicException;
+use Symfony\Component\DependencyInjection\Reference;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\RandomBasedUuidJobExecutionIdGenerator;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\TimeBasedUuidJobExecutionIdGenerator;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\UlidJobExecutionIdGenerator;
+use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
+
+/**
+ * This is a helper for building services definitions of {@see JobExecutionIdGeneratorInterface}.
+ */
+final class JobExecutionIdGeneratorDefinitionFactory
+{
+    public const TYPES = [
+        self::UNIQID,
+        self::SYMFONY_RANDOM_UUID,
+        self::SYMFONY_TIME_UUID,
+        self::SYMFONY_ULID,
+    ];
+    public const DEFAULT = self::UNIQID;
+
+    private const UNIQID = 'uniqid';
+    private const SYMFONY_RANDOM_UUID = 'symfony.uuid.random';
+    private const SYMFONY_TIME_UUID = 'symfony.uuid.time';
+    private const SYMFONY_ULID = 'symfony.ulid';
+
+    /**
+     * Build a service definition for configured type.
+     */
+    public static function fromType(string $type): Definition
+    {
+        return match ($type) {
+            self::UNIQID => self::uniqid(),
+            self::SYMFONY_RANDOM_UUID => self::symfonyRandomUuid(),
+            self::SYMFONY_TIME_UUID => self::symfonyTimeUuid(),
+            self::SYMFONY_ULID => self::symfonyUlid(),
+            default => throw new LogicException('Unsupported job job execution id generator type "' . $type . '".'),
+        };
+    }
+
+    private static function uniqid(): Definition
+    {
+        return new Definition(UniqidJobExecutionIdGenerator::class);
+    }
+
+    private static function symfonyRandomUuid(): Definition
+    {
+        return new Definition(RandomBasedUuidJobExecutionIdGenerator::class, [
+            '$uuidFactory' => new Reference('uuid.factory'),
+        ]);
+    }
+
+    private static function symfonyTimeUuid(): Definition
+    {
+        return new Definition(TimeBasedUuidJobExecutionIdGenerator::class, [
+            '$uuidFactory' => new Reference('uuid.factory'),
+        ]);
+    }
+
+    private static function symfonyUlid(): Definition
+    {
+        return new Definition(UlidJobExecutionIdGenerator::class, [
+            '$ulidFactory' => new Reference('ulid.factory'),
+        ]);
+    }
+}

src/DependencyInjection/YokaiBatchExtension.php

@@ -22,6 +22,7 @@
 use Yokai\Batch\Bridge\Symfony\Framework\UserInterface\Templating\ConfigurableTemplating;
 use Yokai\Batch\Bridge\Symfony\Framework\UserInterface\Templating\SonataAdminTemplating;
 use Yokai\Batch\Bridge\Symfony\Framework\UserInterface\Templating\TemplatingInterface;
+use Yokai\Batch\Factory\JobExecutionIdGeneratorInterface;
 use Yokai\Batch\Factory\JobExecutionParametersBuilder\PerJobJobExecutionParametersBuilder;
 use Yokai\Batch\Factory\JobExecutionParametersBuilder\StaticJobExecutionParametersBuilder;
 use Yokai\Batch\Launcher\JobLauncherInterface;
@@ -68,6 +69,9 @@ public function load(array $configs, ContainerBuilder $container): void
         $this->configureParameters($container, $config['parameters']);
         $this->configureUserInterface($container, $loader, $config['ui']);
 
+        $jobExecutionIdGeneratorDefinition = JobExecutionIdGeneratorDefinitionFactory::fromType($config['id']);
+        $container->setDefinition(JobExecutionIdGeneratorInterface::class, $jobExecutionIdGeneratorDefinition);
+
         $container->registerAliasForArgument('yokai_batch.logger', LoggerInterface::class, 'yokaiBatchLogger');
     }
 

src/Resources/services/global/alias.xml

@@ -19,9 +19,6 @@
         <service id="Yokai\Batch\Job\JobExecutor"
                  alias="yokai_batch.job_executor"/>
 
-        <service id="Yokai\Batch\Factory\JobExecutionIdGeneratorInterface"
-                 alias="yokai_batch.job_execution_id_generator.uniqid"/>
-
         <service id="Yokai\Batch\Factory\JobExecutionParametersBuilderInterface"
                  alias="yokai_batch.job_execution_parameters_builder.chain"/>
     </services>

src/Resources/services/global/core.xml

@@ -31,9 +31,6 @@
             <argument type="service" id="event_dispatcher" on-invalid="null"/>
         </service>
 
-        <service id="yokai_batch.job_execution_id_generator.uniqid"
-                 class="Yokai\Batch\Factory\UniqidJobExecutionIdGenerator"/>
-
         <service id="yokai_batch.job_execution_parameters_builder.chain"
                  class="Yokai\Batch\Factory\JobExecutionParametersBuilder\ChainJobExecutionParametersBuilder">
             <argument type="tagged_iterator" tag="yokai_batch.job_execution_parameters_builder"/>

tests/DependencyInjection/YokaiBatchExtensionTest.php

@@ -19,10 +19,15 @@
 use Yokai\Batch\Bridge\Symfony\Framework\UserInterface\Templating\SonataAdminTemplating;
 use Yokai\Batch\Bridge\Symfony\Framework\UserInterface\Templating\TemplatingInterface;
 use Yokai\Batch\Bridge\Symfony\Messenger\DispatchMessageJobLauncher;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\RandomBasedUuidJobExecutionIdGenerator;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\TimeBasedUuidJobExecutionIdGenerator;
+use Yokai\Batch\Bridge\Symfony\Uid\Factory\UlidJobExecutionIdGenerator;
+use Yokai\Batch\Factory\JobExecutionIdGeneratorInterface;
 use Yokai\Batch\Factory\JobExecutionParametersBuilder\ChainJobExecutionParametersBuilder;
 use Yokai\Batch\Factory\JobExecutionParametersBuilder\PerJobJobExecutionParametersBuilder;
 use Yokai\Batch\Factory\JobExecutionParametersBuilder\StaticJobExecutionParametersBuilder;
 use Yokai\Batch\Factory\JobExecutionParametersBuilderInterface;
+use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
 use Yokai\Batch\Launcher\JobLauncherInterface;
 use Yokai\Batch\Launcher\SimpleJobLauncher;
 use Yokai\Batch\Storage\FilesystemJobExecutionStorage;
@@ -377,6 +382,41 @@ public function errors(): \Generator
         ];
     }
 
+    /**
+     * @dataProvider id
+     */
+    public function testId(array $config, string $idGenerator): void
+    {
+        $container = $this->createContainer($config);
+
+        $idGeneratorDefinition = $this->getDefinition($container, JobExecutionIdGeneratorInterface::class);
+        self::assertSame($idGenerator, $idGeneratorDefinition->getClass());
+    }
+
+    public function id(): \Generator
+    {
+        yield 'Default config' => [
+            [],
+            UniqidJobExecutionIdGenerator::class,
+        ];
+        yield 'Explicit uniqid' => [
+            ['id' => 'uniqid'],
+            UniqidJobExecutionIdGenerator::class,
+        ];
+        yield 'Symfony random based UUID' => [
+            ['id' => 'symfony.uuid.random'],
+            RandomBasedUuidJobExecutionIdGenerator::class,
+        ];
+        yield 'Symfony time based UUID' => [
+            ['id' => 'symfony.uuid.time'],
+            TimeBasedUuidJobExecutionIdGenerator::class,
+        ];
+        yield 'Symfony ULID' => [
+            ['id' => 'symfony.ulid'],
+            UlidJobExecutionIdGenerator::class,
+        ];
+    }
+
     private function createContainer(array $config, \Closure|null $configure = null): ContainerBuilder
     {
         $container = new ContainerBuilder();