Stream exceptions (#87)

* Add streamed exceptions
---------

Co-authored-by: Jérémy J. <jeremy@code-rhapsodie.fr>

Author: AUDUL

.github/workflows/build.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     permissions: read-all
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
       - uses: sonarsource/sonarqube-scan-action@master

.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
       - uses: php-actions/composer@v6 # or alternative dependency management
       - uses: php-actions/phpunit@v4
       - name: Run PHP CS Fixer

.php-cs-fixer.dist.php

@@ -9,6 +9,7 @@
 $config->setRules([
     '@Symfony' => true,
     '@Symfony:risky' => true,
+    '@PHP8x2Migration:risky' => true,
     '@PSR12' => true,
     'array_syntax' => [
         'syntax' => 'short',

CHANGELOG.md

@@ -1,3 +1,6 @@
+# Version 6.0.0
+* Add managing exceptions with a stream
+
 # Version 5.5.0
 * Added cleanup commands
 * Updated for PHP 8.2
@@ -6,7 +9,7 @@
 * Fix File Exceptions integration
 
 # Version 5.4.0
-* Add possibility to save exceptions in file
+* Add the possibility to save exceptions in the file
 
 # Version 5.3.1
 * Fix interface naming

README.md

@@ -5,6 +5,7 @@ providing an easy way to create import / export dataflow.
 
 | Dataflow | Symfony                  | Support |
 |----------|--------------------------|---------|
+| 6.x      | ^7.4                     | yes     |
 | 5.x      | ^7.3                     | yes     |
 | 4.x      | 3.4 \| 4.x \| 5.x \| 6.x | yes     |
 | 3.x      | 3.4 \| 4.x \| 5.x        | no      |

Tests/Processor/JobProcessorTest.php

@@ -7,6 +7,7 @@
 use CodeRhapsodie\DataflowBundle\Entity\Job;
 use CodeRhapsodie\DataflowBundle\Event\Events;
 use CodeRhapsodie\DataflowBundle\Event\ProcessingEvent;
+use CodeRhapsodie\DataflowBundle\ExceptionsHandler\ExceptionHandlerInterface;
 use CodeRhapsodie\DataflowBundle\Gateway\JobGateway;
 use CodeRhapsodie\DataflowBundle\Processor\JobProcessor;
 use CodeRhapsodie\DataflowBundle\Registry\DataflowTypeRegistryInterface;
@@ -22,15 +23,17 @@ class JobProcessorTest extends TestCase
     private DataflowTypeRegistryInterface|MockObject $registry;
     private EventDispatcherInterface|MockObject $dispatcher;
     private JobGateway|MockObject $jobGateway;
+    private ExceptionHandlerInterface|MockObject $exceptionHandler;
 
     protected function setUp(): void
     {
         $this->repository = $this->createMock(JobRepository::class);
         $this->registry = $this->createMock(DataflowTypeRegistryInterface::class);
         $this->dispatcher = $this->createMock(EventDispatcherInterface::class);
         $this->jobGateway = $this->createMock(JobGateway::class);
+        $this->exceptionHandler = $this->createMock(ExceptionHandlerInterface::class);
 
-        $this->processor = new JobProcessor($this->repository, $this->registry, $this->dispatcher, $this->jobGateway);
+        $this->processor = new JobProcessor($this->repository, $this->registry, $this->dispatcher, $this->jobGateway, $this->exceptionHandler);
     }
 
     public function testProcess()
@@ -64,7 +67,7 @@ public function testProcess()
             ->willReturn($dataflowType)
         ;
 
-        $bag = [new \Exception('message1')];
+        $bag = 1;
 
         $result = new Result('name', new \DateTimeImmutable(), $end = new \DateTimeImmutable(), $count = 10, $bag);
 
@@ -85,6 +88,6 @@ public function testProcess()
         $this->assertGreaterThanOrEqual($now, $job->getStartTime());
         $this->assertSame(Job::STATUS_COMPLETED, $job->getStatus());
         $this->assertSame($end, $job->getEndTime());
-        $this->assertSame($count - count($bag), $job->getCount());
+        $this->assertSame($count - $bag, $job->getCount());
     }
 }

composer.json

@@ -47,16 +47,16 @@
         "doctrine/doctrine-bundle": "^2.0",
         "monolog/monolog": "^2.0||^3.0",
         "psr/log": "^1.1||^2.0||^3.0",
-        "symfony/config": "^7.3",
-        "symfony/console": "^7.3",
-        "symfony/dependency-injection": "^7.3",
-        "symfony/event-dispatcher": "^7.3",
-        "symfony/http-kernel": "^7.3",
-        "symfony/lock": "^7.3",
-        "symfony/monolog-bridge": "^7.3",
-        "symfony/options-resolver": "^7.3",
-        "symfony/validator": "^7.3",
-        "symfony/yaml": "^7.3"
+        "symfony/config": "^7.4",
+        "symfony/console": "^7.4",
+        "symfony/dependency-injection": "^7.4",
+        "symfony/event-dispatcher": "^7.4",
+        "symfony/http-kernel": "^7.4",
+        "symfony/lock": "^7.4",
+        "symfony/monolog-bridge": "^7.4",
+        "symfony/options-resolver": "^7.4",
+        "symfony/validator": "^7.4",
+        "symfony/yaml": "^7.4"
     },
     "require-dev": {
         "amphp/amp": "^2.5",
@@ -65,7 +65,7 @@
         "phpunit/phpunit": "^11",
         "portphp/portphp": "^1.9",
         "rector/rector": "^2.0",
-        "symfony/messenger": "^7.3"
+        "symfony/messenger": "^7.4"
     },
     "suggest": {
         "amphp/amp": "Provide asynchronous steps for your dataflows",

src/DataflowType/AbstractDataflowType.php

@@ -5,12 +5,11 @@
 namespace CodeRhapsodie\DataflowBundle\DataflowType;
 
 use CodeRhapsodie\DataflowBundle\Repository\JobRepository;
-use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
-abstract class AbstractDataflowType implements DataflowTypeInterface, LoggerAwareInterface, AutoUpdateCountInterface
+abstract class AbstractDataflowType implements DataflowTypeInterface, AutoUpdateCountInterface
 {
     use LoggerAwareTrait;
 
@@ -36,7 +35,7 @@ public function process(array $options, ?int $jobId = null): Result
 
         $builder = $this->createDataflowBuilder();
         $builder->setName($this->getLabel());
-        $builder->addAfterItemProcessor(function (int|string $index, mixed $item, int $count) use ($jobId) {
+        $builder->addAfterItemProcessor(function (int|string $index, mixed $item, int $count) use ($jobId): void {
             if ($jobId === null || $this->saveDate > new \DateTime()) {
                 return;
             }
@@ -46,7 +45,7 @@ public function process(array $options, ?int $jobId = null): Result
         });
         $this->buildDataflow($builder, $options);
         $dataflow = $builder->getDataflow();
-        if ($dataflow instanceof LoggerAwareInterface && $this->logger instanceof LoggerInterface) {
+        if ($this->logger instanceof LoggerInterface) {
             $dataflow->setLogger($this->logger);
         }
 

src/DataflowType/Dataflow/AMPAsyncDataflow.php

@@ -16,10 +16,9 @@
 
 use CodeRhapsodie\DataflowBundle\DataflowType\Result;
 use CodeRhapsodie\DataflowBundle\DataflowType\Writer\WriterInterface;
-use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 
-class AMPAsyncDataflow implements DataflowInterface, LoggerAwareInterface
+class AMPAsyncDataflow implements DataflowInterface
 {
     use LoggerAwareTrait;
 
@@ -65,7 +64,7 @@ public function addWriter(WriterInterface $writer): self
     public function process(): Result
     {
         $count = 0;
-        $exceptions = [];
+        $countExceptions = 0;
         $startTime = new \DateTime();
 
         try {
@@ -82,7 +81,7 @@ public function process(): Result
                 }
             });
 
-            $watcherId = Loop::repeat($this->loopInterval, function () use ($deferred, &$resolved, $producer, &$count, &$exceptions) {
+            $watcherId = Loop::repeat($this->loopInterval, function () use ($deferred, &$resolved, $producer, &$count, &$countExceptions) {
                 if (yield $producer->advance()) {
                     $it = $producer->getCurrent();
                     [$index, $item] = $it;
@@ -93,7 +92,7 @@ public function process(): Result
                 }
 
                 foreach ($this->states as $state) {
-                    $this->processState($state, $count, $exceptions);
+                    $this->processState($state, $count, $countExceptions);
                 }
             });
 
@@ -104,18 +103,14 @@ public function process(): Result
                 $writer->finish();
             }
         } catch (\Throwable $e) {
-            $exceptions[] = $e;
+            ++$countExceptions;
             $this->logException($e);
         }
 
-        return new Result($this->name, $startTime, new \DateTime(), $count, $exceptions);
+        return new Result($this->name, $startTime, new \DateTime(), $count, $countExceptions);
     }
 
-    /**
-     * @param int   $count      internal count reference
-     * @param array $exceptions internal exceptions
-     */
-    private function processState(mixed $state, int &$count, array &$exceptions): void
+    private function processState(mixed $state, int &$count, int &$countExceptions): void
     {
         [$readIndex, $stepIndex, $item] = $state;
         if ($stepIndex < \count($this->steps)) {
@@ -127,9 +122,9 @@ private function processState(mixed $state, int &$count, array &$exceptions): vo
                 $this->stepsJobs[$stepIndex][$readIndex] = true;
                 /** @var Promise<void> $promise */
                 $promise = coroutine($step)($item);
-                $promise->onResolve(function (?\Throwable $exception = null, $newItem = null) use ($stepIndex, $readIndex, &$exceptions) {
+                $promise->onResolve(function (?\Throwable $exception = null, $newItem = null) use ($stepIndex, $readIndex, &$countExceptions): void {
                     if ($exception) {
-                        $exceptions[$stepIndex] = $exception;
+                        ++$countExceptions;
                         $this->logException($exception, (string) $stepIndex);
                     } elseif ($newItem === false) {
                         unset($this->states[$readIndex]);

src/DataflowType/Dataflow/Dataflow.php

@@ -6,10 +6,9 @@
 
 use CodeRhapsodie\DataflowBundle\DataflowType\Result;
 use CodeRhapsodie\DataflowBundle\DataflowType\Writer\WriterInterface;
-use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerAwareTrait;
 
-class Dataflow implements DataflowInterface, LoggerAwareInterface
+class Dataflow implements DataflowInterface
 {
     use LoggerAwareTrait;
 
@@ -73,7 +72,7 @@ public function setAfterItemProcessors(array $processors): self
     public function process(): Result
     {
         $count = 0;
-        $exceptions = [];
+        $countExceptions = 0;
         $startTime = new \DateTime();
 
         try {
@@ -91,10 +90,10 @@ public function process(): Result
                             $exceptionIndex = (string) ($this->customExceptionIndex)($item, $index);
                         }
                     } catch (\Throwable $e2) {
-                        $exceptions[$index] = $e2;
+                        ++$countExceptions;
                         $this->logException($e2, $index);
                     }
-                    $exceptions[$exceptionIndex] = $e;
+                    ++$countExceptions;
                     $this->logException($e, $exceptionIndex);
                 }
 
@@ -109,11 +108,11 @@ public function process(): Result
                 $writer->finish();
             }
         } catch (\Throwable $e) {
-            $exceptions[] = $e;
+            ++$countExceptions;
             $this->logException($e);
         }
 
-        return new Result($this->name, $startTime, new \DateTime(), $count, $exceptions);
+        return new Result($this->name, $startTime, new \DateTime(), $count, $countExceptions);
     }
 
     private function processItem(mixed $item): void