JobExecution id generation (#13)

* Centralize JobExecution default id generation

* Use service to generate JobExecution id

Author: yann-eugone

src/batch-symfony-console/src/RunCommandJobLauncher.php

@@ -49,8 +49,6 @@ public function __construct(
      */
     public function launch(string $name, array $configuration = []): JobExecution
     {
-        $configuration['_id'] = $configuration['_id'] ?? uniqid();
-
         $jobExecution = $this->jobExecutionFactory->create($name, $configuration);
         $jobExecution->setStatus(BatchStatus::PENDING);
         $this->jobExecutionStorage->store($jobExecution);

src/batch-symfony-console/tests/RunCommandJobLauncherTest.php

@@ -12,6 +12,7 @@
 use Yokai\Batch\Bridge\Symfony\Console\CommandRunner;
 use Yokai\Batch\Bridge\Symfony\Console\RunCommandJobLauncher;
 use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
 use Yokai\Batch\JobExecution;
 use Yokai\Batch\Storage\JobExecutionStorageInterface;
 
@@ -44,7 +45,7 @@ function ($jobExecution): bool {
         $storage->store($jobExecutionAssertions)->shouldBeCalledTimes(1);
 
         $launcher = new RunCommandJobLauncher(
-            new JobExecutionFactory(),
+            new JobExecutionFactory(new UniqidJobExecutionIdGenerator()),
             $commandRunner->reveal(),
             $storage->reveal(),
             'test.log'

src/batch-symfony-framework/src/Resources/services/global/alias.xml

@@ -12,5 +12,8 @@
 
         <service id="Yokai\Batch\Registry\JobRegistry"
                  alias="yokai_batch.job_registry"/>
+
+        <service id="Yokai\Batch\Factory\JobExecutionIdGeneratorInterface"
+                 alias="yokai_batch.job_execution_id_generator.uniqid"/>
     </services>
 </container>

src/batch-symfony-framework/src/Resources/services/global/factory.xml

@@ -8,6 +8,11 @@
         <defaults public="false"/>
 
         <service id="yokai_batch.job_execution_factory"
-                 class="Yokai\Batch\Factory\JobExecutionFactory"/>
+                 class="Yokai\Batch\Factory\JobExecutionFactory">
+            <argument type="service" id="Yokai\Batch\Factory\JobExecutionIdGeneratorInterface"/>
+        </service>
+
+        <service id="yokai_batch.job_execution_id_generator.uniqid"
+                 class="Yokai\Batch\Factory\UniqidJobExecutionIdGenerator"/>
     </services>
 </container>

src/batch-symfony-messenger/src/DispatchMessageJobLauncher.php

@@ -40,8 +40,6 @@ public function __construct(
 
     public function launch(string $name, array $configuration = []): JobExecution
     {
-        $configuration['_id'] = $configuration['_id'] ?? uniqid();
-
         // create and store execution before dispatching message
         // guarantee job execution exists if message bus transport is asynchronous
         $jobExecution = $this->jobExecutionFactory->create($name, $configuration);

src/batch-symfony-messenger/tests/DispatchMessageJobLauncherTest.php

@@ -14,6 +14,7 @@
 use Yokai\Batch\Bridge\Symfony\Messenger\DispatchMessageJobLauncher;
 use Yokai\Batch\Bridge\Symfony\Messenger\LaunchJobMessage;
 use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
 use Yokai\Batch\JobExecution;
 use Yokai\Batch\Storage\JobExecutionStorageInterface;
 
@@ -52,7 +53,7 @@ function ($message): bool {
             ->willReturn(new Envelope(new LaunchJobMessage('unused')));
 
         $jobLauncher = new DispatchMessageJobLauncher(
-            new JobExecutionFactory(),
+            new JobExecutionFactory(new UniqidJobExecutionIdGenerator()),
             $storage->reveal(),
             $messageBus->reveal()
         );

src/batch/src/Factory/JobExecutionFactory.php

@@ -9,6 +9,19 @@
 
 final class JobExecutionFactory
 {
+    /**
+     * @var JobExecutionIdGeneratorInterface
+     */
+    private JobExecutionIdGeneratorInterface $idGenerator;
+
+    /**
+     * @param JobExecutionIdGeneratorInterface $idGenerator
+     */
+    public function __construct(JobExecutionIdGeneratorInterface $idGenerator)
+    {
+        $this->idGenerator = $idGenerator;
+    }
+
     /**
      * @param string $name
      * @param array  $configuration
@@ -17,7 +30,7 @@ final class JobExecutionFactory
      */
     public function create(string $name, array $configuration = []): JobExecution
     {
-        $configuration['_id'] = $configuration['_id'] ?? uniqid();
+        $configuration['_id'] = $configuration['_id'] ?? $this->idGenerator->generate();
 
         return JobExecution::createRoot($configuration['_id'], $name, null, new JobParameters($configuration));
     }

src/batch/src/Factory/JobExecutionIdGeneratorInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Factory;
+
+interface JobExecutionIdGeneratorInterface
+{
+    /**
+     * @return string
+     */
+    public function generate(): string;
+}

src/batch/src/Factory/UniqidJobExecutionIdGenerator.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Factory;
+
+final class UniqidJobExecutionIdGenerator implements JobExecutionIdGeneratorInterface
+{
+    /**
+     * @inheritdoc
+     */
+    public function generate(): string
+    {
+        return \uniqid();
+    }
+}

src/batch/tests/Factory/JobExecutionFactoryTest.php

@@ -6,13 +6,14 @@
 
 use PHPUnit\Framework\TestCase;
 use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
 use Yokai\Batch\JobExecution;
 
 class JobExecutionFactoryTest extends TestCase
 {
     public function testCreate(): void
     {
-        $executionFactory = new JobExecutionFactory();
+        $executionFactory = new JobExecutionFactory(new UniqidJobExecutionIdGenerator());
 
         $executionWithoutConfig = $executionFactory->create('export');
         self::assertSame('export', $executionWithoutConfig->getJobName());