[11.x] Allow for assertions against QueueFake::pushRaw()

src/Illuminate/Support/Testing/Fakes/QueueFake.php

@@ -11,6 +11,9 @@
 use Illuminate\Support\Traits\ReflectsClosures;
 use PHPUnit\Framework\Assert as PHPUnit;
 
+/**
+ * @phpstan-type RawPushType array{"payload": string, "queue": string|null, "options": array<array-key, mixed>}
+ */
 class QueueFake extends QueueManager implements Fake, Queue
 {
     use ReflectsClosures;
@@ -43,6 +46,13 @@ class QueueFake extends QueueManager implements Fake, Queue
      */
     protected $jobs = [];
 
+    /**
+     * All of the payloads that have been raw pushed.
+     *
+     * @var list<RawPushType>
+     */
+    protected $rawPushes = [];
+
     /**
      * Indicates if items should be serialized and restored when pushed to the queue.
      *
@@ -326,6 +336,19 @@ public function pushed($job, $callback = null)
         )->pluck('job');
     }
 
+    /**
+     * Get all of the raw pushes matching a truth-test callback.
+     *
+     * @param null|\Closure(string, ?string, array): bool  $callback
+     * @return \Illuminate\Support\Collection<int, RawPushType>
+     */
+    public function pushedRaw($callback = null)
+    {
+        $callback ??= static fn () => true;
+
+        return (new Collection($this->rawPushes))->filter(fn ($data) => $callback($data['payload'], $data['queue'], $data['options']));
+    }
+
     /**
      * Determine if there are any stored jobs for a given class.
      *
@@ -436,7 +459,11 @@ protected function shouldDispatchJob($job)
      */
     public function pushRaw($payload, $queue = null, array $options = [])
     {
-        //
+        $this->rawPushes[] = [
+            'payload' => $payload,
+            'queue' => $queue,
+            'options' => $options,
+        ];
     }
 
     /**
@@ -516,6 +543,16 @@ public function pushedJobs()
         return $this->jobs;
     }
 
+    /**
+     * Get the payloads that were pushed raw.
+     *
+     * @return list<RawPushType>
+     */
+    public function rawPushes()
+    {
+        return $this->rawPushes;
+    }
+
     /**
      * Specify if jobs should be serialized and restored when being "pushed" to the queue.
      *

tests/Support/SupportTestingQueueFakeTest.php

@@ -487,6 +487,44 @@ public function testAssertChainErrorHandling()
             $this->assertStringContainsString('The job has chained jobs.', $e->getMessage());
         }
     }
+
+    public function testGetRawPushes()
+    {
+        $this->fake->pushRaw('some-payload', null, ['options' => 'yeah']);
+        $this->fake->pushRaw('some-other-payload', 'my-queue', ['options' => 'also yeah']);
+
+        $actualPushedRaw = $this->fake->rawPushes();
+
+        $this->assertEqualsCanonicalizing([
+            ['payload' => 'some-payload', 'queue' => null, 'options' => ['options' => 'yeah']],
+            ['payload' => 'some-other-payload', 'queue' => 'my-queue', 'options' => ['options' => 'also yeah']],
+        ], $actualPushedRaw);
+    }
+
+    public function testPushedRaw()
+    {
+        $this->fake->pushRaw('some-payload', null, ['options' => 'yeah']);
+        $this->fake->pushRaw('some-other-payload', 'my-queue', ['options' => 'also yeah']);
+
+        $this->assertCount(2, $this->fake->pushedRaw());
+
+        $pushedRaw = $this->fake->pushedRaw(fn ($payload) => $payload === 'some-payload');
+        $this->assertCount(1, $pushedRaw);
+        $this->assertEqualsCanonicalizing(
+            ['payload' => 'some-payload', 'queue' => null, 'options' => ['options' => 'yeah']],
+            $pushedRaw[0]
+        );
+
+        $pushedRaw = $this->fake->pushedRaw(
+            fn ($payload, $queue, $options) => $payload === 'some-other-payload'
+                && $queue === 'my-queue'
+                && $options['options'] === 'also yeah'
+        );
+        $this->assertCount(1, $pushedRaw);
+
+        $pushedRaw = $this->fake->pushedRaw(fn ($payload, $queue, $options) => $options === []);
+        $this->assertCount(0, $pushedRaw);
+    }
 }
 
 class JobStub