[9.x] Fake Batches

[taylorotwell]

It's currently hard to test things like if a batch was cancelled by a job or if a job added additional jobs to a batch. You have to create a FakeBatch manually and override the cancel / add methods, etc.

This solves that.

[$job, $batch] = (new TestJob)->withFakeBatch();

$job->handle();

$this->assertTrue($batch->cancelled());
$this->assertNotEmpty($batch->added);

[taylorotwell]

Tempting to make withFakeBatch return [$job, $batch] so that you can do:

[$job, $batch] = (new ExampleJob)->withFakeBatch();

Edit: ✅

[Wulfheart]

Maybe adding an array shape would help with autocomplete in IDEs?

[bhaustein]

What about good old call by reference:

$batch = new TestBatch();
$job = (new TestJob)->withFakeBatch($batch);

$job->handle();

$this->assertTrue($batch->cancelled());
$this->assertNotEmpty($batch->added);

[jasonmccreary]

Not to be grammar police, but isn't the job within a batch? So maybe withinFakeBatch()

[bhaustein]

Not to be grammar police, but isn't the job within a batch? So maybe withinFakeBatch($batch)

Yes, you are right. That Sounds better.

[njames]

Not to be grammar police, but isn't the job within a batch? So maybe withinFakeBatch($batch)

Grammar police are the best kind of police 🚓 @jasonmccreary

[jasonmccreary]

I don't think I can edit this directly, but the BusFake and BatchRepositoryFake should be updated to use this new BatchFake.

It'd also be nice if the Bus had a similar dispatchFakeBatch() helper method to easily create fake batches for testing batches outside of specific jobs.

[gustavo-ticto]

🚀

[RTippin]

Seems since this update, I have a few tests that fail now, due to calling $batch->add(...).

TypeError : array_merge(): Argument #2 must be of type array, Illuminate\Support\LazyCollection given

framework/src/Illuminate/Support/Testing/Fakes/BatchFake.php

Line 81 in abd4787

$this->added[] = array_merge($this->added, $jobs);

I have a batch created, and then use a lazy collection/chunk to add jobs to the batch.

private function addToBatch(Model $model, Batch $batch): void
{
    $model->relations()
        ->cursor()
        ->map(fn (Relation $relation): ThumbnailJob => $this->createThumbnailJob($relation))
        ->chunk(500)
        ->each(fn (LazyCollection $jobs) => $batch->add($jobs));
}

Wondering if I am going about this the wrong way, or should the BatchFake be updated?