#88 add helper method to log error without adding failure

Author: guich25

src/batch/src/JobExecution.php

@@ -8,6 +8,7 @@
 use DateTime;
 use DateTimeInterface;
 use Psr\Log\LoggerInterface;
+use Psr\Log\LogLevel;
 use Throwable;
 use Yokai\Batch\Exception\ImmutablePropertyException;
 use Yokai\Batch\Factory\JobExecutionIdGeneratorInterface;
@@ -379,4 +380,15 @@ public function getLogger(): LoggerInterface
     {
         return $this->logger;
     }
+
+    /**
+     * Log the error from a Throwable
+     * @param Throwable $error The error to log
+     * @param string|null $message The message to use while logging
+     * @param LogLevel::* $level The level to use while logging
+     */
+    public function logError(Throwable $error, string $message = null, string $level = LogLevel::ERROR): void
+    {
+        $this->logger->log($level, $message ?? 'An error occurred', ['error' => (string)$error]);
+    }
 }

tests/convention/Job/LoggerTest.php

@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Tucania project.
+ *
+ * Copyright (C) Tucania (https://www.tucania.com/) - All Rights Reserved
+ *
+ * For the full copyright and license information, please view the LICENSE file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Yokai\Batch\Sources\Tests\Convention\Job;
+
+use Exception;
+use PHPUnit\Framework\TestCase;
+use Yokai\Batch\Factory\JobExecutionFactory;
+use Yokai\Batch\Factory\UniqidJobExecutionIdGenerator;
+
+class LoggerTest extends TestCase
+{
+    private JobExecutionFactory $jobExecutionFactory;
+
+    public function setUp(): void
+    {
+        $idGenerator = new UniqidJobExecutionIdGenerator();
+        $this->jobExecutionFactory = new JobExecutionFactory($idGenerator);
+    }
+
+    public function testLogError()
+    {
+        $errorToLog = 'test assert logErrorMethod';
+        $jobExecution = $this->jobExecutionFactory->create('job-test');
+        $jobExecution->logError(new Exception(), $errorToLog);
+
+        self::assertStringContainsString($errorToLog, current(((array)$jobExecution->getLogs())));
+    }
+}