Add ability to cancel batched job spawning

[bencroker]

The way that batched queue jobs currently work, cancelling a batched job has little or no effect, as the next job is spawned within the execute() method.

cms/src/queue/BaseBatchedJob.php

Lines 153 to 160 in 6a13d27

	// Spawn another job if there are more items
	if ($this->itemOffset < $this->totalItems()) {
	$nextJob = clone $this;
	$nextJob->batchIndex++;
	QueueHelper::push($nextJob, $this->priority, 0, $this->ttr, $queue);
	} else {
	$this->after();
	}

The only way to truly cancel a batched job is to cancel the queue job and kill the process running it.

This has resulted in several support requests in which people have been confused about why cancelling long-running, batched queue jobs has no effect. For example:

One thing I am noticing during my testing (currently debugging an access issue preventing the cache from generating in these queue jobs) is that subsequent jobs aren't added to the queue until the current batch has completed. So trying to cancel everything is pretty tedious: cancel the current batch, hit OK, refresh, repeat. Is it possible to have them all added at once so they could be released at the same time?

Source: putyourlightson/craft-blitz#537 (comment)

I think what I'm looking for in regards to the UX is less batching and more having them all added at once but as separate jobs. Using those screenshots as examples, it would add 24 separate jobs all at once while still only running one at a time (assuming I only have one process running). But I'd also be able to release them all at once instead of individually.

Source: putyourlightson/craft-blitz#537 (comment)

I’m not sure if and how you’d consider addressing this. One option might be to add a check to the execute() method that ensures that the queue job still exists in the DB before spawning a new one. Any thoughts on this?

[russback]

+1 for this - for large sites this can be problematic. A preflight check as @bencroker suggests sounds like a good idea, or something else that checks whether that 'Release all Jobs' button has been hit since the initial queue request was made.

[brandonkelly]

Thanks for pointing that out! As of Craft 4.10 and 5.2, batched jobs will start ensuring they are still reserved before moving onto the next step or spawning an additional batch job. (6505856)

[bencroker]

Great, thanks!

[brandonkelly]

Craft 4.10.0-beta.1 and 5.2.0-beta.1 are out with that change.