WIP on supporting batches, chains

Author: mpbarlow

.gitignore

@@ -1,3 +1,4 @@
-/vendor
 composer.lock
 /.idea
+.phpunit.result.cache
+/vendor

src/Contracts/CacheKeyProvider.php

@@ -5,12 +5,11 @@
 
 
 use Closure;
-use Illuminate\Foundation\Bus\Dispatchable;
 
 interface CacheKeyProvider
 {
     /**
-     * @param Dispatchable|Closure $job
+     * @param \Illuminate\Foundation\Bus\Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|Closure $job
      * @return string
      */
     public function getKey($job): string;

src/Debouncer.php

@@ -5,11 +5,8 @@
 
 
 use Closure;
-use DateInterval;
-use DateTimeInterface;
 use Illuminate\Bus\Queueable;
 use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Foundation\Bus\PendingDispatch;
 use Illuminate\Support\Facades\Cache;
 use Mpbarlow\LaravelQueueDebouncer\Contracts\CacheKeyProvider;
 use Mpbarlow\LaravelQueueDebouncer\Contracts\UniqueIdentifierProvider;
@@ -34,10 +31,24 @@ public function __construct(
         $this->factory = $factory;
     }
 
+    public function usingCacheKeyProvider(CacheKeyProvider $provider): self
+    {
+        $this->keyProvider = $provider;
+
+        return $this;
+    }
+
+    public function usingUniqueIdentifierProvider(UniqueIdentifierProvider $provider): self
+    {
+        $this->idProvider = $provider;
+
+        return $this;
+    }
+
     /**
-     * @param Dispatchable|Closure $job
-     * @param DateTimeInterface|DateInterval|int|null $wait
-     * @return PendingDispatch
+     * @param Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|Closure $job
+     * @param \DateTimeInterface|\DateInterval|int|null $wait
+     * @return \Illuminate\Foundation\Bus\PendingDispatch
      */
     public function __invoke($job, $wait)
     {
@@ -52,9 +63,9 @@ public function __invoke($job, $wait)
     }
 
     /**
-     * @param Dispatchable|Closure $job
-     * @param DateTimeInterface|DateInterval|int|null $wait
-     * @return PendingDispatch
+     * @param Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|Closure $job
+     * @param \DateTimeInterface|\DateInterval|int|null $wait
+     * @return \Illuminate\Foundation\Bus\PendingDispatch
      */
     public function debounce($job, $wait)
     {

src/DispatcherFactory.php

@@ -5,10 +5,11 @@
 
 
 use Closure;
-use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Support\Facades\Cache;
 
 use function dispatch;
+use function get_class;
+use function in_array;
 
 class DispatcherFactory
 {
@@ -18,7 +19,7 @@ class DispatcherFactory
      * If we used a class as the dispatcher, we would have to check whether the job is a closure ourselves, and
      * serialise it if it was.
      *
-     * @param Dispatchable|Closure $job
+     * @param \Illuminate\Foundation\Bus\Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|Closure $job
      * @param string $key
      * @param string $identifier
      * @return Closure
@@ -29,8 +30,25 @@ public function makeDispatcher($job, $key, $identifier): Closure
             if (Cache::get($key) == $identifier) {
                 Cache::forget($key);
 
-                dispatch($job);
+                if ($this->hasDispatchMethod($job)) {
+                    $job->dispatch();
+                } else {
+                    dispatch($job);
+                }
             }
         };
     }
+
+    /**
+     * @param \Illuminate\Foundation\Bus\Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|Closure $job
+     * @return bool
+     */
+    protected function hasDispatchMethod($job)
+    {
+        // PendingBatch is not available in Laravel < 8.0, hence the string comparison.
+        return in_array(
+            get_class($job),
+            ['\Illuminate\Foundation\Bus\PendingChain', '\Illuminate\Bus\PendingBatch']
+        );
+    }
 }

src/Facade/Debouncer.php

@@ -8,7 +8,7 @@
 
 /**
  * @see \Mpbarlow\LaravelQueueDebouncer\Debouncer
- * @method static \Illuminate\Foundation\Bus\PendingDispatch debounce(\Illuminate\Foundation\Bus\Dispatchable|\Closure $job, \DateTimeInterface|\DateInterval|int|null $wait)
+ * @method static \Illuminate\Foundation\Bus\PendingDispatch debounce(\Illuminate\Foundation\Bus\Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|\Closure $job, \DateTimeInterface|\DateInterval|int|null $wait)
  */
 class Debouncer extends Facade
 {

src/Support/ParameterAwareCacheKeyProvider.php

@@ -0,0 +1,18 @@
+<?php
+
+
+namespace Mpbarlow\LaravelQueueDebouncer\Support;
+
+
+use Mpbarlow\LaravelQueueDebouncer\Contracts\CacheKeyProvider as CacheKeyProviderContract;
+
+use function config;
+use function sha1;
+
+class ParameterAwareCacheKeyProvider implements CacheKeyProviderContract
+{
+    public function getKey($job): string
+    {
+        return config('queue_debouncer.cache_prefix') . ':' . sha1(\Opis\Closure\serialize($job));
+    }
+}

src/Support/helpers.php

@@ -1,14 +1,12 @@
 <?php
 
-use Illuminate\Foundation\Bus\Dispatchable;
-use Illuminate\Foundation\Bus\PendingDispatch;
 use Mpbarlow\LaravelQueueDebouncer\Debouncer;
 
 if (! function_exists('debounce')) {
     /**
-     * @param Dispatchable|Closure $job
+     * @param \Illuminate\Foundation\Bus\Dispatchable|\Illuminate\Foundation\Bus\PendingChain|\Illuminate\Bus\PendingBatch|Closure $job
      * @param DateTimeInterface|DateInterval|int|null $wait
-     * @return PendingDispatch
+     * @return \Illuminate\Foundation\Bus\PendingDispatch
      */
     function debounce($job, $wait)
     {

tests/CacheKeyProviderTest.php

@@ -4,33 +4,14 @@
 namespace Mpbarlow\LaravelQueueDebouncer\Tests;
 
 
-use Illuminate\Foundation\Bus\Dispatchable;
 use Mpbarlow\LaravelQueueDebouncer\Support\CacheKeyProvider;
-use ReflectionFunction;
+use Mpbarlow\LaravelQueueDebouncer\Tests\Support\DummyJob;
 
-use function sha1;
 use function strlen;
 use function substr;
 
 class CacheKeyProviderTest extends TestCase
 {
-    /** @test */
-    public function it_applies_the_cache_prefix()
-    {
-        $this->app['config']->set('queue_debouncer.cache_prefix', $prefix = '__PREFIX__');
-
-        $provider = new CacheKeyProvider();
-
-        $closureJob = function () {};
-
-        $this->assertEquals($prefix . ':' . DummyJob::class, $provider->getKey(new DummyJob()));
-
-        $this->assertEquals(
-            $prefix . ':' . sha1((string)(new ReflectionFunction($closureJob))),
-            $provider->getKey($closureJob)
-        );
-    }
-
     /** @test */
     public function it_uses_the_class_name_for_job_classes()
     {
@@ -44,37 +25,4 @@ public function it_uses_the_class_name_for_job_classes()
             substr($provider->getKey(new DummyJob()), strlen($prefix) + 1)
         );
     }
-
-    /** @test */
-    public function it_generates_a_unique_key_for_closures()
-    {
-        $provider = new CacheKeyProvider();
-
-        $job1 = function () {};
-        $job2 = function () {};
-
-        $key1 = $provider->getKey($job1);
-        $key2 = $provider->getKey($job2);
-
-        // Assert different closures result in different keys.
-        $this->assertNotEquals($key1, $key2);
-    }
-
-    /** @test */
-    public function it_generates_a_consistent_key_for_closures()
-    {
-        $provider = new CacheKeyProvider();
-
-        $job = function () {};
-
-        $key1 = $provider->getKey($job);
-        $key2 = $provider->getKey($job);
-
-        // Assert the same closure results in the same key each time.
-        $this->assertEquals($key1, $key2);
-    }
-}
-
-class DummyJob {
-    use Dispatchable;
 }

tests/DebounceTest.php

@@ -4,16 +4,22 @@
 namespace Mpbarlow\LaravelQueueDebouncer\Tests;
 
 
-use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Bus\PendingBatch;
+use Illuminate\Foundation\Bus\PendingChain;
 use Illuminate\Queue\CallQueuedClosure;
 use Illuminate\Support\Facades\Bus;
 use Illuminate\Support\Facades\Cache;
 use Mpbarlow\LaravelQueueDebouncer\Debouncer;
 use Mpbarlow\LaravelQueueDebouncer\DispatcherFactory;
 use Mpbarlow\LaravelQueueDebouncer\Support\CacheKeyProvider;
+use Mpbarlow\LaravelQueueDebouncer\Support\ParameterAwareCacheKeyProvider;
 use Mpbarlow\LaravelQueueDebouncer\Support\UniqueIdentifierProvider;
+use Mpbarlow\LaravelQueueDebouncer\Tests\Support\CustomCacheKeyProvider;
+use Mpbarlow\LaravelQueueDebouncer\Tests\Support\CustomUniqueIdentifierProvider;
+use Mpbarlow\LaravelQueueDebouncer\Tests\Support\DummyJob;
 use ReflectionFunction;
 
+use function class_exists;
 
 class DebounceTest extends TestCase
 {
@@ -44,8 +50,10 @@ public function it_injects_the_configured_cache_key_provider_and_unique_identifi
      * @test
      * @dataProvider jobProvider
      */
-    public function it_debounces_jobs($job, $expectedDispatch)
+    public function it_debounces_jobs($provider)
     {
+        [$job, $expectedDispatch, $keyProvider] = $provider();
+
         // So this is pretty tricky to test. It's a job that dispatches another job, so when we're faking the bus we
         // have to get a bit creative.
         Bus::fake();
@@ -57,13 +65,14 @@ public function it_debounces_jobs($job, $expectedDispatch)
                 ->andReturn(1, 2, 3);
         });
 
-        $key = $this->app->make(CacheKeyProvider::class)->getKey($job);
+        $key = $this->app->make($keyProvider)->getKey($job);
         $debouncer = $this->app->make(Debouncer::class);
 
         // Then we call the debouncer three times, asserting that each time, it's setting the cache value correctly,
         // and dispatching a runner closure with the values we expect.
         foreach ([1, 2, 3] as $i) {
             $debouncer($job, PHP_INT_MAX);
+
             $this->assertEquals($i, Cache::get($key));
 
             Bus::assertDispatched(CallQueuedClosure::class, function ($dispatch) use ($job, $key, $i) {
@@ -101,19 +110,63 @@ public function it_debounces_jobs($job, $expectedDispatch)
 
     public function jobProvider(): array
     {
-        return [
-            [new Job(), Job::class],
-            [function () {}, CallQueuedClosure::class]
+        // Annoyingly we have to wrap each data set in a function as data providers run before the container is
+        // initialised. Each provides the job to debounce, the class we ultimately expect to be dispatched, and the
+        // cache key provider to use for the test.
+
+        // Closures and standard classes should work with both included cache key providers.
+        // Chains and batches only work with the serialisation-based key provider.
+        $jobTypes = [
+            [
+                function () {
+                    return [
+                        function () {
+                        },
+                        CallQueuedClosure::class,
+                        CacheKeyProvider::class
+                    ];
+                }
+            ],
+            [
+                function () {
+                    return [
+                        function () {
+                        },
+                        CallQueuedClosure::class,
+                        ParameterAwareCacheKeyProvider::class
+                    ];
+                }
+            ],
+            [
+                function () {
+                    return [new DummyJob(), DummyJob::class, CacheKeyProvider::class];
+                }
+            ],
+            [
+                function () {
+                    return [new DummyJob(), DummyJob::class, ParameterAwareCacheKeyProvider::class];
+                }
+            ],
+            [
+                function () {
+                    return [
+                        DummyJob::withChain([new DummyJob()]),
+                        PendingChain::class,
+                        ParameterAwareCacheKeyProvider::class
+                    ];
+                }
+            ]
         ];
-    }
-}
 
-class Job
-{
-    use Dispatchable;
+        // PendingBatch is only available in Laravel >= 8.0.
+        if (class_exists('\Illuminate\Bus\PendingBatch')) {
+            $jobTypes[] = [
+                function () {
+                    return [Bus::batch([new DummyJob()]), PendingBatch::class, ParameterAwareCacheKeyProvider::class];
+                }
+            ];
+        }
 
-    public function handle()
-    {
-        //
+        return $jobTypes;
     }
 }