Better event handling (#18)

# About
- Added new events for the pipeline lifecycle.

Author: michael-rubel

README.md

@@ -88,6 +88,8 @@ Usage of `withTransaction` method will enable a [`manual DB transaction`](https:
 Usage of `withEvents` method will enable [`Laravel Events`](https://laravel.com/docs/9.x/events#introduction) throughout the pipeline execution.
 
 #### Available events
+- [`PipelineStarted`](https://github.com/michael-rubel/laravel-enhanced-pipeline/blob/main/src/Events/PipelineStarted.php) - fired when the pipeline starts working;
+- [`PipelineFinished`](https://github.com/michael-rubel/laravel-enhanced-pipeline/blob/main/src/Events/PipelineFinished.php) - fired when the pipeline finishes its work;
 - [`PipeExecutionStarted`](https://github.com/michael-rubel/laravel-enhanced-pipeline/blob/main/src/Events/PipeExecutionStarted.php) - fired **before** execution of the pipe;
 - [`PipeExecutionFinished`](https://github.com/michael-rubel/laravel-enhanced-pipeline/blob/main/src/Events/PipeExecutionFinished.php) - fired **after** execution of the pipe.
 

src/Events/PipelineFinished.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MichaelRubel\EnhancedPipeline\Events;
+
+use Closure;
+
+class PipelineFinished
+{
+    /**
+     * @param  mixed  $passable
+     * @param  mixed  $result
+     */
+    public function __construct(
+        public Closure $destination,
+        public $passable,
+        public array $pipes,
+        public bool $useTransaction,
+        public $result,
+    ) {
+        //
+    }
+}

src/Events/PipelineStarted.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MichaelRubel\EnhancedPipeline\Events;
+
+use Closure;
+
+class PipelineStarted
+{
+    /**
+     * @param  mixed  $passable
+     */
+    public function __construct(
+        public Closure $destination,
+        public $passable,
+        public array $pipes,
+        public bool $useTransaction,
+    ) {
+        //
+    }
+}

src/Pipeline.php

@@ -11,6 +11,8 @@
 use Illuminate\Support\Traits\Conditionable;
 use MichaelRubel\EnhancedPipeline\Events\PipeExecutionFinished;
 use MichaelRubel\EnhancedPipeline\Events\PipeExecutionStarted;
+use MichaelRubel\EnhancedPipeline\Events\PipelineFinished;
+use MichaelRubel\EnhancedPipeline\Events\PipelineStarted;
 use MichaelRubel\EnhancedPipeline\Traits\HasDatabaseTransactions;
 use MichaelRubel\EnhancedPipeline\Traits\HasEvents;
 use RuntimeException;
@@ -137,6 +139,13 @@ public function via($method)
     public function then(Closure $destination)
     {
         try {
+            $this->fireEvent(PipelineStarted::class,
+                $destination,
+                $this->passable,
+                $this->pipes(),
+                $this->useTransaction,
+            );
+
             $this->beginTransaction();
 
             $pipeline = array_reduce(
@@ -145,7 +154,19 @@ public function then(Closure $destination)
                 $this->prepareDestination($destination)
             );
 
-            return $pipeline($this->passable);
+            $result = $pipeline($this->passable);
+
+            $this->commitTransaction();
+
+            $this->fireEvent(PipelineFinished::class,
+                $destination,
+                $this->passable,
+                $this->pipes(),
+                $this->useTransaction,
+                $result,
+            );
+
+            return $result;
         } catch (Throwable $e) {
             $this->rollbackTransaction();
 
@@ -252,14 +273,7 @@ protected function parsePipeString($pipe)
      */
     protected function pipes()
     {
-        return [
-            ...$this->pipes,
-            function ($passable, $next) {
-                $this->commitTransaction();
-
-                return $next($passable);
-            },
-        ];
+        return $this->pipes;
     }
 
     /**
@@ -293,7 +307,6 @@ public function setContainer(Container $container)
     /**
      * Set callback to be executed on failure pipeline.
      *
-     *
      * @return $this
      */
     public function onFailure(Closure $callback)

src/Traits/HasEvents.php

@@ -24,20 +24,14 @@ public function withEvents(): static
     /**
      * Fire the event if enabled.
      *
-     * @param  string|callable|mixed  $pipe
-     * @param  mixed  $passable
+     * @param  mixed  ...$params
      */
-    protected function fireEvent(string $event, $pipe, $passable): void
+    protected function fireEvent(string $event, ...$params): void
     {
         if (! $this->useEvents) {
             return;
         }
 
-        if (is_object($pipe)) {
-            /** @var object $pipe */
-            $pipe = $pipe::class;
-        }
-
-        event(new $event($pipe, $passable));
+        event(new $event(...$params));
     }
 }

tests/PipelineEventsTest.php

@@ -4,10 +4,13 @@
 
 namespace MichaelRubel\EnhancedPipeline\Tests;
 
+use Closure;
 use Illuminate\Support\Facades\Event;
 use MichaelRubel\EnhancedPipeline\EnhancedPipelineServiceProvider;
 use MichaelRubel\EnhancedPipeline\Events\PipeExecutionFinished;
 use MichaelRubel\EnhancedPipeline\Events\PipeExecutionStarted;
+use MichaelRubel\EnhancedPipeline\Events\PipelineFinished;
+use MichaelRubel\EnhancedPipeline\Events\PipelineStarted;
 use MichaelRubel\EnhancedPipeline\Pipeline;
 
 class PipelineEventsTest extends TestCase
@@ -19,7 +22,6 @@ public function setUp(): void
         Event::fake();
     }
 
-    /** @test */
     public function testMakesSureEventServiceProviderBoots()
     {
         app()->offsetUnset('events');
@@ -29,8 +31,42 @@ public function testMakesSureEventServiceProviderBoots()
         $this->assertTrue(app()->bound('events'));
     }
 
-    /** @test */
-    public function testFiresPipeStartedEvents()
+    public function testFiresPipelineStartedEvent()
+    {
+        app(Pipeline::class)
+            ->withEvents()
+            ->send('data')
+            ->thenReturn();
+
+        Event::assertDispatched(function (PipelineStarted $event) {
+            $this->assertInstanceOf(Closure::class, $event->destination);
+            $this->assertSame('data', $event->passable);
+            $this->assertSame([], $event->pipes);
+            $this->assertFalse($event->useTransaction);
+
+            return true;
+        });
+    }
+
+    public function testFiresPipelineFinishedEvent()
+    {
+        app(Pipeline::class)
+            ->withEvents()
+            ->send('data')
+            ->thenReturn();
+
+        Event::assertDispatched(function (PipelineFinished $event) {
+            $this->assertInstanceOf(Closure::class, $event->destination);
+            $this->assertSame('data', $event->passable);
+            $this->assertSame([], $event->pipes);
+            $this->assertFalse($event->useTransaction);
+            $this->assertSame('data', $event->result);
+
+            return true;
+        });
+    }
+
+    public function testFiresPipeExecutionStartedEvent()
     {
         app(Pipeline::class)
             ->withEvents()
@@ -49,8 +85,7 @@ public function testFiresPipeStartedEvents()
         }, 2);
     }
 
-    /** @test */
-    public function testFiresPipeStartedEventsButFailsToPass()
+    public function testFiresPipeExecutionStartedEventButFailsToFinish()
     {
         app(Pipeline::class)
             ->withEvents()
@@ -69,8 +104,7 @@ public function testFiresPipeStartedEventsButFailsToPass()
         Event::assertNotDispatched(PipeExecutionFinished::class);
     }
 
-    /** @test */
-    public function testFiresPipePassedEvents()
+    public function testFiresPipeExecutionFinishedEvent()
     {
         app(Pipeline::class)
             ->withEvents()
@@ -82,7 +116,7 @@ public function testFiresPipePassedEvents()
             ->thenReturn();
 
         Event::assertDispatched(function (PipeExecutionFinished $event) {
-            $this->assertInstanceOf(TestPipe::class, app($event->pipe));
+            $this->assertInstanceOf(TestPipe::class, $event->pipe);
             $this->assertSame('data', $event->passable);
 
             return true;