Allow jobs to define their name using interface method in a Symfony framework context (#46)

* Allow jobs to define their name using interface method in a Symfony framework context

* Fixed use case : service without class

Author: yann-eugone

docs/getting-started.md

@@ -124,3 +124,7 @@ Then the job will be triggered with its service id:
 /** @var \Yokai\Batch\Launcher\JobLauncherInterface $launcher */
 $launcher->launch(\App\Job\ImportUsersJob::class);
 ```
+
+> **note**: when registering jobs with dedicated class, you can use the
+> [JobWithStaticNameInterface](../src/JobWithStaticNameInterface.php) interface
+> to be able to specify the job name of your service.

src/DependencyInjection/CompilerPass/RegisterJobsCompilerPass.php

@@ -7,7 +7,9 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
+use Yokai\Batch\Bridge\Symfony\Framework\JobWithStaticNameInterface;
 
 final class RegisterJobsCompilerPass implements CompilerPassInterface
 {
@@ -18,12 +20,30 @@ public function process(ContainerBuilder $container): void
     {
         $jobs = [];
         foreach ($container->findTaggedServiceIds('yokai_batch.job') as $serviceId => $tags) {
+            $serviceDefinition = $container->findDefinition($serviceId);
             foreach ($tags as $attributes) {
-                $jobs[$attributes['job'] ?? $serviceId] = new Reference($serviceId);
+                $jobs[$this->getJobName($serviceId, $serviceDefinition, $attributes)] = new Reference($serviceId);
             }
         }
 
         $container->getDefinition('yokai_batch.job_registry')
             ->setArgument('$jobs', ServiceLocatorTagPass::register($container, $jobs));
     }
+
+    /**
+     * @phpstan-param array<string, mixed> $attributes
+     */
+    private function getJobName(string $id, Definition $definition, array $attributes): string
+    {
+        if (isset($attributes['job'])) {
+            return (string)$attributes['job'];
+        }
+
+        $serviceClass = $definition->getClass();
+        if ($serviceClass !== null && \is_a($serviceClass, JobWithStaticNameInterface::class, true)) {
+            return $serviceClass::getJobName();
+        }
+
+        return $id;
+    }
 }

src/JobWithStaticNameInterface.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Bridge\Symfony\Framework;
+
+/**
+ * A job that implement this interface can define the associated job name via a static method.
+ * This is very useful if you are registering jobs using PSR services registering.
+ * Without implementing, the job name will be the service id,
+ * in the case of a PSR service registering : the job class.
+ */
+interface JobWithStaticNameInterface
+{
+    public static function getJobName(): string;
+}

tests/Fixtures/DummyJob.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Bridge\Symfony\Framework\Fixtures;
+
+use Yokai\Batch\Job\AbstractJob;
+use Yokai\Batch\JobExecution;
+
+final class DummyJob extends AbstractJob
+{
+    protected function doExecute(JobExecution $jobExecution): void
+    {
+        // dummy
+    }
+}

tests/Fixtures/DummyJobWithName.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Tests\Bridge\Symfony\Framework\Fixtures;
+
+use Yokai\Batch\Bridge\Symfony\Framework\JobWithStaticNameInterface;
+use Yokai\Batch\Job\AbstractJob;
+use Yokai\Batch\JobExecution;
+
+final class DummyJobWithName extends AbstractJob implements JobWithStaticNameInterface
+{
+    public static function getJobName(): string
+    {
+        return 'export_orders_job';
+    }
+
+    protected function doExecute(JobExecution $jobExecution): void
+    {
+        // dummy
+    }
+}

tests/YokaiBatchBundleTest.php

@@ -6,14 +6,11 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Definition;
 use Yokai\Batch\Bridge\Symfony\Framework\YokaiBatchBundle;
-use Yokai\Batch\Job\Item\ItemJob;
-use Yokai\Batch\Job\Item\Processor\NullProcessor;
-use Yokai\Batch\Job\Item\Reader\StaticIterableReader;
+use Yokai\Batch\Job\JobInterface;
 use Yokai\Batch\Registry\JobRegistry;
-use Yokai\Batch\Storage\NullJobExecutionStorage;
-use Yokai\Batch\Test\Job\Item\Writer\InMemoryWriter;
+use Yokai\Batch\Tests\Bridge\Symfony\Framework\Fixtures\DummyJob;
+use Yokai\Batch\Tests\Bridge\Symfony\Framework\Fixtures\DummyJobWithName;
 
 class YokaiBatchBundleTest extends TestCase
 {
@@ -23,27 +20,22 @@ public function testBuild(): void
         $container->register('yokai_batch.job_registry', JobRegistry::class)
             ->setPublic(true);
 
-        $this->job($container, 'job.named.with.service.id')
+        $container->register(DummyJobWithName::class, DummyJobWithName::class)
             ->addTag('yokai_batch.job');
-        $this->job($container, 'job.named.with.tag.attribute')
+        $container->register(DummyJob::class, DummyJob::class)
+            ->addTag('yokai_batch.job');
+        $container->register('job.named.with.service.id', DummyJob::class)
+            ->addTag('yokai_batch.job');
+        $container->register('job.named.with.tag.attribute', DummyJob::class)
             ->addTag('yokai_batch.job', ['job' => 'job.name.in.attribute']);
 
         (new YokaiBatchBundle())->build($container);
 
         $container->compile();
         $registry = $container->get('yokai_batch.job_registry');
-        self::assertInstanceOf(ItemJob::class, $registry->get('job.named.with.service.id'));
-        self::assertInstanceOf(ItemJob::class, $registry->get('job.name.in.attribute'));
-    }
-
-    private function job(ContainerBuilder $container, string $id): Definition
-    {
-        return $container->register($id, ItemJob::class)
-            ->setArgument('$batchSize', 100)
-            ->setArgument('$reader', (new Definition(StaticIterableReader::class))->setArgument('$items', []))
-            ->setArgument('$processor', new Definition(NullProcessor::class))
-            ->setArgument('$writer', new Definition(InMemoryWriter::class))
-            ->setArgument('$executionStorage', new Definition(NullJobExecutionStorage::class))
-        ;
+        self::assertInstanceOf(JobInterface::class, $registry->get('export_orders_job'));
+        self::assertInstanceOf(JobInterface::class, $registry->get(DummyJob::class));
+        self::assertInstanceOf(JobInterface::class, $registry->get('job.named.with.service.id'));
+        self::assertInstanceOf(JobInterface::class, $registry->get('job.name.in.attribute'));
     }
 }