[5.5] Add support for newQueryForRestoration from queues

[brendt]

When queueing models, there's the getQueueableIds method which allows you to override the ID value which is serialised to JSON.

It is however not possible to map the serialised ID back into the other direction when unserialising the model. This PR adds that method.

The need for using another ID when serialising models becomes clear when you're using binary UUIDs as primary keys. There are a few issues addressing the problem:

• [5.3] Notification using database queue storing as a payload of 0  #15272
• Queue Fails to Create Payload with Invalid Characters in Data #12194

When serialising a model, and json_encoding that serialised data, JSON fails when it encounters a binary field. To solve this problem, the binary ID could. eg. be stored as a base64 encoded string. However, when unserialising the model, you'll need a way to decode that string back to its binary form, to be able to query the database.

A concrete example in a model, using this functionality:

public function getQueueableId()
{
    return base64_encode($this->uuid);
}

public function newQueryForRestoration($id)
{
    return $this->newQueryWithoutScopes()->whereKey(base64_decode($this->uuid));
}

The default implementation of newQueryForRestoration is added in the Model class, and keeps the default functionality.

Note that by adding the newQueryForRestoration method, the need for the is_array($value->id) check in SerializesAndRestoresModelIdentifiers can easily be refactored. The check can now happen in the newQueryForRestoration instead. I didn't add this change though, because it would have made the diff more confusing. I'm willing to also refactor this, and add tests if needed.

[kohenkatz]

All of a sudden, I'm getting Exception message: Call to undefined method Illuminate\Database\Query\Builder::newQueryForRestoration() after upgrading to 5.5.22. Do I need to change anything because of this addition?

[kohenkatz]

Looks like something with OPCache holding partial old code and partial new code. Clearing OPCache fixes it.

[aaronhuisinga]

@brendt @taylorotwell it seems that this has broken some Queueable Notification classes for me.

If I pass an empty Collection or Eloquent Collection as a parameter into a Queueable Notification class, I'm now seeing the Exception "Symfony\Component\Debug\Exception\FatalThrowableError · Class name must be a valid object or a string". It's thrown from Illuminate/Queue/SerializesAndRestoresModelIdentifiers.php on line 51.

If I rollback to Laravel v5.5.21, this is fixed immediately. I can also convert the empty Collection to an array and it works properly.

[brendt]

I see why that happens.

Instead of doing this

$model = (new $value->class)->setConnection($value->connection);

return is_array($value->id)
    ? $this->restoreCollection($value)
    : $this->getQueryForModelRestoration($model, $value->id)
        ->useWritePdo()->firstOrFail();

It should be this

return is_array($value->id)
    ? $this->restoreCollection($value)
    : $this->getQueryForModelRestoration((new $value->class)->setConnection($value->connection), $value->id)
        ->useWritePdo()->firstOrFail();

Should I submit a new PR?

[stevebeyatte]

+1 on this breaking queueable notifications for me as well

[brendt]

I went ahead and opened a new PR with a fix.

[santoshachari]

Breaking queues for me as well.

[kyleridolfo]

Scratch that, the issue I ran into was that my supervisor wasn't automatically restarting after I pushed code. Once I restarted supervisor everything worked fine.

I'm seeing this break queues on v5.5.33 as well.

BadMethodCallException · Call to undefined method Illuminate\Database\Query\Builder::newQueryForRestoration()

[shadowgroundz]

@stevebeyatte how you fix it? I have some problem in toBroadcast function. I use
public function getQueueableId()
{
return base64_encode($this->uuid);
}

public function newQueryForRestoration($id)
{
return $this->newQueryWithoutScopes()->whereKey(base64_decode($this->uuid));
}

on Illuminate\Database\Eloquent\Model then how?