Allow Listeners to dynamically specify delay with withDelay (#48026)

Author: calebdw

src/Illuminate/Events/Dispatcher.php

@@ -579,16 +579,20 @@ protected function queueHandler($class, $method, $arguments)
         [$listener, $job] = $this->createListenerAndJob($class, $method, $arguments);
 
         $connection = $this->resolveQueue()->connection(method_exists($listener, 'viaConnection')
-                    ? (isset($arguments[0]) ? $listener->viaConnection($arguments[0]) : $listener->viaConnection())
-                    : $listener->connection ?? null);
+            ? (isset($arguments[0]) ? $listener->viaConnection($arguments[0]) : $listener->viaConnection())
+            : $listener->connection ?? null);
 
         $queue = method_exists($listener, 'viaQueue')
-                    ? (isset($arguments[0]) ? $listener->viaQueue($arguments[0]) : $listener->viaQueue())
-                    : $listener->queue ?? null;
+            ? (isset($arguments[0]) ? $listener->viaQueue($arguments[0]) : $listener->viaQueue())
+            : $listener->queue ?? null;
 
-        isset($listener->delay)
-                    ? $connection->laterOn($queue, $listener->delay, $job)
-                    : $connection->pushOn($queue, $job);
+        $delay = method_exists($listener, 'withDelay')
+            ? (isset($arguments[0]) ? $listener->withDelay($arguments[0]) : $listener->withDelay())
+            : $listener->delay ?? null;
+
+        is_null($delay)
+            ? $connection->pushOn($queue, $job)
+            : $connection->laterOn($queue, $delay, $job);
     }
 
     /**

tests/Events/QueuedEventsTest.php

@@ -85,6 +85,23 @@ public function testQueueIsSetByGetConnection()
         $d->dispatch('some.event', ['foo', 'bar']);
     }
 
+    public function testDelayIsSetByWithDelay()
+    {
+        $d = new Dispatcher;
+        $queue = m::mock(Queue::class);
+
+        $queue->shouldReceive('connection')->once()->with(null)->andReturnSelf();
+
+        $queue->shouldReceive('laterOn')->once()->with(null, 20, m::type(CallQueuedListener::class));
+
+        $d->setQueueResolver(function () use ($queue) {
+            return $queue;
+        });
+
+        $d->listen('some.event', TestDispatcherGetDelay::class.'@handle');
+        $d->dispatch('some.event', ['foo', 'bar']);
+    }
+
     public function testQueueIsSetByGetQueueDynamically()
     {
         $d = new Dispatcher;
@@ -127,6 +144,23 @@ public function testQueueIsSetByGetConnectionDynamically()
         ]);
     }
 
+    public function testDelayIsSetByWithDelayDynamically()
+    {
+        $d = new Dispatcher;
+        $queue = m::mock(Queue::class);
+
+        $queue->shouldReceive('connection')->once()->with(null)->andReturnSelf();
+
+        $queue->shouldReceive('laterOn')->once()->with(null, 60, m::type(CallQueuedListener::class));
+
+        $d->setQueueResolver(function () use ($queue) {
+            return $queue;
+        });
+
+        $d->listen('some.event', TestDispatcherGetDelayDynamically::class.'@handle');
+        $d->dispatch('some.event', [['useHighDelay' => true], 'bar']);
+    }
+
     public function testQueuePropagateRetryUntilAndMaxExceptions()
     {
         $d = new Dispatcher;
@@ -219,6 +253,21 @@ public function viaConnection()
     }
 }
 
+class TestDispatcherGetDelay implements ShouldQueue
+{
+    public $delay = 10;
+
+    public function handle()
+    {
+        //
+    }
+
+    public function withDelay()
+    {
+        return 20;
+    }
+}
+
 class TestDispatcherOptions implements ShouldQueue
 {
     public $maxExceptions = 1;
@@ -299,3 +348,22 @@ public function viaQueue($event)
         return 'p99';
     }
 }
+
+class TestDispatcherGetDelayDynamically implements ShouldQueue
+{
+    public $delay = 10;
+
+    public function handle()
+    {
+        //
+    }
+
+    public function withDelay($event)
+    {
+        if ($event['useHighDelay']) {
+            return 60;
+        }
+
+        return 20;
+    }
+}