tests/Queue/QueueListFailedCommandTest.php - 13.x - githubmirror/framework

tests/Queue/QueueListFailedCommandTest.php
176 строк6 KB
Jason McCreary
[13.x] Mockery cleanup (#61117)
10 авг 2026, 20:23
10 авг 2026, 20:232ee40ee
<?php

namespace Illuminate\Tests\Queue;

use Illuminate\Foundation\Application;
use Illuminate\Queue\Console\ListFailedCommand;
use Illuminate\Queue\Failed\FailedJobProviderInterface;
use Mockery;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\BufferedOutput;

class QueueListFailedCommandTest extends TestCase
{
    public function testQueuedListenerShowsUnderlyingListenerClassNotWrapper()
    {
        // CallQueuedListener is the wrapper class Laravel uses to dispatch
        // queued event listeners. The legacy regex matched the wrapper out
        // of data.command — payload.displayName carries the actual listener.
        $output = $this->runListFailedCommandWith([
            $this->fakeFailedJob([
                'displayName' => 'App\\Listeners\\HandleStripeWebhookHandled',
                'data' => [
                    'commandName' => 'Illuminate\\Events\\CallQueuedListener',
                    'command' => 'O:42:"Illuminate\\Events\\CallQueuedListener":3:{s:5:"class";s:43:"App\\Listeners\\HandleStripeWebhookHandled";s:6:"method";s:6:"handle";s:4:"data";a:0:{}}',
                ],
            ]),
        ]);

        $this->assertStringContainsString('App\\Listeners\\HandleStripeWebhookHandled', $output);
        $this->assertStringNotContainsString('CallQueuedListener', $output);
    }

    public function testRegularQueuedJobStillShowsJobClass()
    {
        // Regression: the common ShouldQueue path must keep showing the job class.
        $output = $this->runListFailedCommandWith([
            $this->fakeFailedJob([
                'displayName' => 'App\\Jobs\\ProcessPodcast',
                'data' => [
                    'commandName' => 'App\\Jobs\\ProcessPodcast',
                    'command' => 'O:25:"App\\Jobs\\ProcessPodcast":0:{}',
                ],
            ]),
        ]);

        $this->assertStringContainsString('App\\Jobs\\ProcessPodcast', $output);
    }

    public function testLegacyPayloadWithoutDisplayNameFallsBackToRegex()
    {
        // Pre-5.6 failed_jobs rows have no displayName. The legacy regex path
        // must still extract the first quoted class from data.command.
        $output = $this->runListFailedCommandWith([
            $this->fakeFailedJob([
                'data' => [
                    'commandName' => 'App\\Jobs\\LegacyJob',
                    'command' => 'O:18:"App\\Jobs\\LegacyJob":0:{}',
                ],
            ]),
        ]);

        $this->assertStringContainsString('App\\Jobs\\LegacyJob', $output);
    }

    public function testEncryptedJobShowsUnderlyingClass()
    {
        // Encrypted queue payloads store ciphertext in data.command, so the
        // legacy regex falls back to CallQueuedHandler@call (the value at
        // payload.job). displayName carries the real underlying class.
        $output = $this->runListFailedCommandWith([
            $this->fakeFailedJob([
                'displayName' => 'App\\Jobs\\ProcessOrder',
                'job' => 'Illuminate\\Queue\\CallQueuedHandler@call',
                'data' => [
                    'commandName' => 'Illuminate\\Queue\\CallEncryptedQueuedHandler',
                    'command' => 'eyJpdiI6IlhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFg9IiwidmFsdWUiOiJjaXBoZXJ0ZXh0LWJsb2Itd2l0aC1uby1jbGFzcy1uYW1lcyIsIm1hYyI6ImZha2UifQ==',
                ],
            ]),
        ]);

        $this->assertStringContainsString('App\\Jobs\\ProcessOrder', $output);
        $this->assertStringNotContainsString('CallQueuedHandler', $output);
    }

    public function testMalformedPayloadDoesNotThrow()
    {
        // Malformed JSON in the payload column must not bubble up an exception;
        // the row should render with an empty Class cell.
        $output = $this->runListFailedCommandWithRawPayload('not-json-at-all');

        $this->assertStringContainsString('1', $output);
    }

    /**
     * Build a fake failed_jobs row with an encoded JSON payload.
     *
     * @param  array  $payload
     * @return array
     */
    private function fakeFailedJob(array $payload): array
    {
        return [
            'id' => 1,
            'connection' => 'database',
            'queue' => 'default',
            'payload' => json_encode($payload + ['uuid' => 'fake-uuid']),
            'exception' => 'Exception: boom',
            'failed_at' => '2026-01-01 00:00:00',
        ];
    }

    /**
     * Build a row with a raw (possibly malformed) payload string.
     *
     * @param  string  $rawPayload
     * @return array
     */
    private function rawFailedJob(string $rawPayload): array
    {
        return [
            'id' => 1,
            'connection' => 'database',
            'queue' => 'default',
            'payload' => $rawPayload,
            'exception' => 'Exception: boom',
            'failed_at' => '2026-01-01 00:00:00',
        ];
    }

    /**
     * Run queue:failed with the given failed_jobs rows and return captured output.
     *
     * @param  array  $rows
     * @return string
     */
    private function runListFailedCommandWith(array $rows): string
    {
        return $this->executeCommand($rows);
    }

    /**
     * Run queue:failed with a single raw-payload row and return captured output.
     *
     * @param  string  $rawPayload
     * @return string
     */
    private function runListFailedCommandWithRawPayload(string $rawPayload): string
    {
        return $this->executeCommand([$this->rawFailedJob($rawPayload)]);
    }

    /**
     * Wire up a stub failer, run the command, and return the buffered output.
     *
     * @param  array  $rows
     * @return string
     */
    private function executeCommand(array $rows): string
    {
        $container = new Application;

        // The command resolves the failer via the queue.failer container binding.
        $failer = Mockery::mock(FailedJobProviderInterface::class);
        $failer->expects('all')->andReturn($rows);
        $container->instance('queue.failer', $failer);

        $command = new ListFailedCommand;
        $command->setLaravel($container);

        $output = new BufferedOutput;
        $command->run(new ArrayInput([]), $output);

        return $output->fetch();
    }
}