[13.x] Do not allow new model instances to be created during boot #55685
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
willrowe
force-pushed
the
feature/disallow-model-instance-during-boot
branch
from
4c0ce5b to
57207f7
Compare
- A model class is removed from the `booting` array as soon as the boot process has completed.
- This infers that something in the boot process expected the boot to already be finished. - If we just ignore the call then the model class would be in an inconsistent state for whichever code called it.
willrowe
force-pushed
the
feature/disallow-model-instance-during-boot
branch
from
57207f7 to
ad7a45d
Compare
rodrigopedra
reviewed
May 9, 2025
| if (! isset(static::$booted[static::class])) { | ||
| static::$booted[static::class] = true; | ||
| if (isset(static::$booting[static::class])) { | ||
| throw new Exception('"'.__METHOD__.'" cannot be called on the "'.static::class.'" class while it is already being booted.'); |
There was a problem hiding this comment.
Shouldn't it be a LogicException?
Exception that represents error in the program logic. This kind of exception should lead directly to a fix in your code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does three things:
bootedto only be set after a model class has finished booting, as its name implies.bootingflag that is set totruewhen booting first begins and is removed when booting has finished.bootIfNotBootedis called while currently booting, since this implies nested booting.These changes allow issues with nested booting to be caught immediately and would have helped track down this very tricky bug much sooner.
Right now, if you create a new instance of a model while booting, whether that is in the
bootmethod for a model itself or theboot*method in a trait, the instance is created, but in an inconsistent state. This happens because the second call tobootIfNotBootedskips the boot process becausebootedis marked astruewhen starting to boot. This thankfully avoids a recursive stack overflow, however, it also means that the model class has not been completely booted yet and causing the inconsistent state. Anything done with the returned model instance then has the potential to work improperly, as was seen in #55286.This is a breaking change since existing code may be creating new model instances while booting, which would then trigger an exception where it did not before.