Merge pull request #26 from spatie/job-middleware

Add support for job middleware

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-queueable-actions` will be documented in this file
 
+## 2.7.1 - 2020-10-02
+
+- Add support for job middleware
+
 ## 2.7.0 - 2020-09-29
 
 - Add `Spatie\QueueableAction\Testing\QueueableActionFake` class with test helpers (#27)

README.md

@@ -159,6 +159,23 @@ class CustomTagsAction
 }
 ```
 
+### Job Middleware
+
+Middleware where action job passes through can be added by overriding the `middleware()` function.
+
+``` php
+class CustomTagsAction
+{
+    use QueueableAction;
+
+    // ...
+
+    public function middleware() {
+        return [new RateLimited()];
+    }
+}
+```
+
 ### What is the difference between actions and jobs?
 
 In short: constructor injection allows for much more flexibility. 

src/ActionJob.php

@@ -32,6 +32,9 @@ public function __construct($action, array $parameters = [])
 
         if (is_object($action)) {
             $this->tags = $action->tags();
+            $this->middleware = $action->middleware();
+
+            $this->middleware = $action->middleware();
 
             if (method_exists($action, 'failed')) {
                 $this->onFailCallback = [$action, 'failed'];
@@ -51,6 +54,11 @@ public function tags()
         return $this->tags;
     }
 
+    public function middleware()
+    {
+        return $this->middleware;
+    }
+
     public function failed(Exception $exception)
     {
         if ($this->onFailCallback) {

src/QueueableAction.php

@@ -12,6 +12,7 @@ public function onQueue(?string $queue = null)
         /** @var self $class */
         $class = new class($this, $queue) {
             protected $action;
+
             protected $queue;
 
             public function __construct(object $action, ?string $queue)
@@ -47,4 +48,9 @@ public function tags(): array
     {
         return ['action_job'];
     }
+
+    public function middleware(): array
+    {
+        return [];
+    }
 }

tests/QueueableActionTest.php

@@ -7,8 +7,10 @@
 use Spatie\QueueableAction\ActionJob;
 use Spatie\QueueableAction\Tests\TestClasses\ActionWithFailedMethod;
 use Spatie\QueueableAction\Tests\TestClasses\ComplexAction;
+use Spatie\QueueableAction\Tests\TestClasses\ContinueMiddleware;
 use Spatie\QueueableAction\Tests\TestClasses\DataObject;
 use Spatie\QueueableAction\Tests\TestClasses\FailingAction;
+use Spatie\QueueableAction\Tests\TestClasses\MiddlewareAction;
 use Spatie\QueueableAction\Tests\TestClasses\SimpleAction;
 use Spatie\QueueableAction\Tests\TestClasses\TaggedAction;
 
@@ -129,13 +131,13 @@ public function an_action_can_have_custom_job_tags()
         });
     }
 
-    /** @test */
     public function an_action_can_have_a_custom_failed_callback()
     {
         Queue::fake();
 
         $action = new ActionWithFailedMethod();
 
+
         $action->onQueue()->execute();
 
         Queue::assertPushed(ActionJob::class, function ($action) {
@@ -158,4 +160,20 @@ public function the_failed_callback_is_executed_on_failure()
 
         unset($_SERVER['_test_failed_message']); // cleanup
     }
+
+    /** @test */
+    public function an_action_can_have_job_middleware()
+    {
+        Queue::fake();
+
+        $action = new MiddlewareAction();
+
+        $action->onQueue()->execute();
+
+        Queue::assertPushed(ActionJob::class, function ($action) {
+            return is_array($action->middleware())
+                && count($action->middleware()) === 1
+                && $action->middleware[0] instanceof ContinueMiddleware;
+        });
+    }
 }

tests/TestClasses/ContinueMiddleware.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Spatie\QueueableAction\Tests\TestClasses;
+
+class ContinueMiddleware
+{
+    public function handle($job, $next)
+    {
+        $next($job);
+    }
+}

tests/TestClasses/MiddlewareAction.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Spatie\QueueableAction\Tests\TestClasses;
+
+use Spatie\QueueableAction\QueueableAction;
+
+class MiddlewareAction
+{
+    use QueueableAction;
+
+    public function execute()
+    {
+        //
+    }
+
+    public function middleware()
+    {
+        return [new ContinueMiddleware()];
+    }
+}