feature #90 - Add global logger service that logs in JobExecution (#116)

* feature #90 add global logger service that logs in job

* #90 code review - update documentation & psr/log required version

Author: guich25

composer.json

@@ -18,7 +18,8 @@
         "symfony/dependency-injection": "^6.4|^7.0",
         "symfony/http-kernel": "^6.4|^7.0",
         "symfony/framework-bundle": "^6.4|^7.0",
-        "yokai/batch": "^0.5.0"
+        "yokai/batch": "^0.5.0",
+        "psr/log": "^1.0|^2.0|^3.0"
     },
     "autoload": {
         "psr-4": {

docs/getting-started.md

@@ -104,6 +104,33 @@ The job launcher that will be injected depends on the packages you have installe
 - if `yokai/batch-symfony-console` is installed, you will receive a `Yokai\Batch\Bridge\Symfony\Console\RunCommandJobLauncher`
 - otherwise you will receive a `Yokai\Batch\Launcher\SimpleJobLauncher`
 
+
+## Use the batchLogger
+The aim of the batchLogger is to store log inside the jobExecution. 
+In a symfony project, you can use the batchLogger with the symfony autowiring by naming your variable as `$yokaiBatchLogger` 
+
+```php
+<?php
+
+namespace App;
+
+use Psr\Log\LoggerInterface;
+
+final readonly class YourService
+{
+    public function __construct(
+        private LoggerInterface $yokaiBatchLogger,
+    ) {
+    }
+    
+    public function method()
+    {
+        $this->yokaiBatchLogger->error(...);
+    }
+}
+```
+```
+
 ## On the same subject
 
 - [What is a job execution storage ?](https://github.com/yokai-php/batch/blob/0.x/docs/domain/job-execution-storage.md)

src/DependencyInjection/YokaiBatchExtension.php

@@ -5,6 +5,7 @@
 namespace Yokai\Batch\Bridge\Symfony\Framework\DependencyInjection;
 
 use Composer\InstalledVersions;
+use Psr\Log\LoggerInterface;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\Config\Loader as ConfigLoader;
@@ -71,6 +72,7 @@ public function load(array $configs, ContainerBuilder $container): void
             JobLauncherInterface::class,
             \array_keys(\array_filter($launchers))[0] ?? 'yokai_batch.job_launcher.simple'
         );
+        $container->registerAliasForArgument('yokai_batch.logger', LoggerInterface::class, 'yokaiBatchLogger');
     }
 
     private function installed(string $package): bool

src/Resources/services/global/logger.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <services>
+        <defaults public="false"/>
+
+        <service id="yokai_batch.logger" class="Yokai\Batch\Logger\BatchLogger">
+            <tag name="kernel.event_listener" method="onPreExecute" event="Yokai\Batch\Event\PreExecuteEvent"/>
+            <tag name="kernel.event_listener" method="onPostExecute" event="Yokai\Batch\Event\PostExecuteEvent"/>
+        </service>
+
+    </services>
+</container>