Support for $deleteWhenMissingModels = true; in queued listeners, mailables and notifications

[turanjanin]

In job classes, we can add a new property private bool $deleteWhenMissingModels = true; that will instruct Laravel to automatically delete the job if ModelNotFoundException gets thrown during the deserialization process. If this property is not present, the job will be marked as failed if some of the models get deleted before the job is processed.

It would be good to have the same behavior in queued listeners, mailables, and notifications. Right now, the following listener will fail and end up in failed_jobs table if $file gets deleted in the meantime.

class FileUploaded
{
    use SerializesModels;

    public File $file;

    public function __construct(File $file)
    {
        $this->file = $file;
    }
}

class UpdateStats implements ShouldQueue
{
    private bool $deleteWhenMissingModels = true; // This doesn't have any effect.

    public function handle(FileUploaded $event)
    {
        // Handle complex stats update
    }
}

I know that the workaround is to have a synchronous listener that will dispatch the queued job, but it would be better if we could skip these extra steps.

[macropay-solutions]

You can also handle this like we do, by not letting the framework retrieve the model behind the scenes and handle the not found error.

[macropay-solutions]

Question is is that possible for queued listeners, mailables, and notifications?

Is it that simple to remove use SerializesModels; ?

[turanjanin]

Removing the SerializesModels trait can result in huge job payloads if you have a large number of columns and/or a large number of models stored as class properties.

[macropay-solutions]

You are right. We send only the primary key as payload to avoid the hidden logic and query the model in handle method. But for the queued listeners, mailables, and notifications, is there a way to do the same? To not let the framework dispatch the job with objects but with identifiers?