Better support for testing Listeners with Queue::fake()

[calebdw]

Laravel Version

9.52.x

PHP Version

8.1.x

Database Driver & Version

Postgres 14

Description

Hello!

It is very non-trivial to test Listeners with QueueFake at the moment; mostly because the Listeners are inside the CallQueuedListener job.

Therefore, asserting whether or not a Listener was pushed requires something like:

function assertListenerPushed(string $listener): void
{
    Queue::assertPushed(fn (CallQueuedListener $job) => $job->class === $listener);
}

function assertListenerNotPushed(string $listener): void
{
    Queue::assertNotPushed(fn (CallQueuedListener $job) => $job->class === $listener);
}

which either requires duplicated code or a custom function (which is not ideal).

The issue I'm running into at the moment is that I have several Listeners listening to a specific Event, and I want to fake all but one of them (the one I'm currently testing). However, doing the following does not work:

    Queue::fake()->except([
        <listener>
    ]);

as everything is faked because <listener> is not an actual job---I'm not sure if it's possible to actually fake a listener without overriding QueueFake::shouldDispatchJob().

All in all, it would be very helpful to include first class testing support for Listeners just like with Jobs.

Thanks!

Steps To Reproduce

n/a

[i-bajrai]

@calebdw I'm finding that I'm agreeing with your perspective here, using CallQueuedListener I feel is a workaround or a hack.

I used the following code to remove the event listeners I wasn't interested in testing, can anyone explain why this might be a bad idea or perhaps the approach is ok?

MY_JOB_TO_BE_QUEUED is inside of the CheckCreditSpentListener and will only be called if shouldQueue passes.

protected function isolateEventListener(): void
{
        Event::forget(TransactionWasCreated::class);
        Event::listen(TransactionWasCreated::class, CheckCreditSpentListener::class);
}

Queue::fake([
    MY_JOB_TO_BE_QUEUED::class,
]);

$this->isolateEventListener();

// Insert code to simulate the environment that the job will NOT be queued

$event = new TransactionWasCreated();

event($event);

Queue::assertNotPushed(MY_JOB_TO_BE_QUEUED::class);