[9.x] Add methods to append and prepend jobs to existing chain (#42138)

* Add methods to append and prepend jobs to existing chain * Style fixes
laravel · Apr 26, 2022 · 7ac98bb · 7ac98bb
1 parent fc740b8
commit 7ac98bb
Show file tree

Hide file tree

Showing 2 changed files with 105 additions and 0 deletions.
diff --git a/src/Illuminate/Bus/Queueable.php b/src/Illuminate/Bus/Queueable.php
@@ -191,6 +191,32 @@ public function chain($chain)
         return $this;
     }
 
+    /**
+     * Prepend a job to the current chain so that it is run after the currently running job.
+     *
+     * @param  mixed  $job
+     * @return $this
+     */
+    public function prependToChain($job)
+    {
+        $this->chained = Arr::prepend($this->chained, $this->serializeJob($job));
+
+        return $this;
+    }
+
+    /**
+     * Append a job to the end of the current chain.
+     *
+     * @param  mixed  $job
+     * @return $this
+     */
+    public function appendToChain($job)
+    {
+        $this->chained = array_merge($this->chained, [$this->serializeJob($job)]);
+
+        return $this;
+    }
+
     /**
      * Serialize a job for queuing.
      *

diff --git a/tests/Integration/Queue/JobChainingTest.php b/tests/Integration/Queue/JobChainingTest.php
@@ -6,6 +6,7 @@
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Foundation\Bus\Dispatchable;
 use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Support\Carbon;
 use Illuminate\Support\Facades\Bus;
 use Illuminate\Support\Facades\Queue;
 use Orchestra\Testbench\TestCase;
@@ -211,6 +212,38 @@ public function testChainJobsUseDefaultConfig()
         $this->assertNull(JobChainingTestThirdJob::$usedQueue);
         $this->assertNull(JobChainingTestThirdJob::$usedConnection);
     }
+
+    public function testChainJobsCanBePrepended()
+    {
+        JobChainAddingPrependingJob::withChain([new JobChainAddingExistingJob])->dispatch();
+
+        $this->assertNotNull(JobChainAddingAddedJob::$ranAt);
+        $this->assertNotNull(JobChainAddingExistingJob::$ranAt);
+        $this->assertTrue(JobChainAddingAddedJob::$ranAt->isBefore(JobChainAddingExistingJob::$ranAt));
+    }
+
+    public function testChainJobsCanBePrependedWithoutExistingChain()
+    {
+        JobChainAddingPrependingJob::dispatch();
+
+        $this->assertNotNull(JobChainAddingAddedJob::$ranAt);
+    }
+
+    public function testChainJobsCanBeAppended()
+    {
+        JobChainAddingAppendingJob::withChain([new JobChainAddingExistingJob])->dispatch();
+
+        $this->assertNotNull(JobChainAddingAddedJob::$ranAt);
+        $this->assertNotNull(JobChainAddingExistingJob::$ranAt);
+        $this->assertTrue(JobChainAddingAddedJob::$ranAt->isAfter(JobChainAddingExistingJob::$ranAt));
+    }
+
+    public function testChainJobsCanBeAppendedWithoutExistingChain()
+    {
+        JobChainAddingAppendingJob::dispatch();
+
+        $this->assertNotNull(JobChainAddingAddedJob::$ranAt);
+    }
 }
 
 class JobChainingTestFirstJob implements ShouldQueue
@@ -293,3 +326,49 @@ public function handle()
         $this->fail();
     }
 }
+
+class JobChainAddingPrependingJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    public function handle()
+    {
+        $this->prependToChain(new JobChainAddingAddedJob);
+    }
+}
+
+class JobChainAddingAppendingJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    public function handle()
+    {
+        $this->appendToChain(new JobChainAddingAddedJob);
+    }
+}
+
+class JobChainAddingExistingJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    /** @var Carbon|null */
+    public static $ranAt = null;
+
+    public function handle()
+    {
+        static::$ranAt = now();
+    }
+}
+
+class JobChainAddingAddedJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable;
+
+    /** @var Carbon|null */
+    public static $ranAt = null;
+
+    public function handle()
+    {
+        static::$ranAt = now();
+    }
+}