[9.x] Eloquent Strict Loading

[themsaid]

Update: Moved to the 8.x branch: #37363

---

This PR introduces a strict_load database connection configuration that when set to true throws an exception on lazy loading eloquent relations.

When the mode is turned on, the following will throw an exception:

$users = User::get();

$users[0]->posts

StrictLoadingViolationException: Trying to lazy load [posts] in model [User] is restricted

However, this will work:

$user = User::find(1);

$user->posts

[mfn]

Nice, reminds me a bit about #29089

[lancepioch]

Food for thought, it might be better to have this as a default Laravel config setting instead with the ability to override this. Otherwise, it's a simple and clean solution.

[cerbero90]

To avoid adding a new loop, would it be possible to set the strictLoading property when hydrating models? Something like:

public function hydrate(array $items)
{
    $instance = $this->newModelInstance();

    return $instance->newCollection(array_map(function ($item) use ($instance) {
        return tap($instance->newFromBuilder($item), function ($model) {
            $model->strictLoading = $model->getConnection() && $model->getConnection()->getConfig('strict_load');
        })
    }, $items));
}

[regiszanandrea]

but array map is not a loop?

[cerbero90]

It is, but it is already present in the Laravel codebase

[peterfox]

I like the idea, one thing of note is personally I'd rather this be on a per model basis. I could see it being more accessible to configure it in a service provider like User::StrictLoading() than having to set it across the connection.

[ahinkle]

Suggested change

	public $strictLoading;
	public $strictLoading = false;

[hkan]

It might be beneficial to have a configuration option to make it not throw an error but trigger an event in the app. So I can log the occurrences or send notifications to myself about it. Wouldn't be as strict, but still... I wouldn't want end users to see error pages just because my code wasn't optimized enough.

[negoziator]

I really like this idea.

Would it be possible to add something like Model::enableStrictLoading()
and Model::disableStrictLoading()

Just like with foreignkey checks?

[peterfox]

It might be beneficial to have a configuration option to make it not throw an error but trigger an event in the app. So I can log the occurrences or send notifications to myself about it. Wouldn't be as strict, but still... I wouldn't want end users to see error pages just because my code wasn't optimized enough.

I like this idea also.

If it was configured per model maybe there could be a callable parameter.

User::enableStrictLoading(function (string $relationship) {
    return true; // throws exception, return false or anything else, it'll continue as normal
});

Might be a bit clunky but then people can assign their own events etc.

[mathiasgrimm]

I think in the first version it could log a deprecation so that people can gradually fix it then on the next version you could throw an exception.

[mathiasgrimm]

That would also realize all places that needed to be changed. You might have forgotten some place it dont want to break production