Throw exception when baoName is not found #20696
Merged
Conversation
This file contains 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
|
(Standard links)
|
colemanw
reviewed
Jun 23, 2021
Civi/Api4/Generic/DAOGetAction.php
Outdated
| public function _run(Result $result) { | ||
| // Early return if table doesn't exist yet due to pending upgrade | ||
| $baoName = $this->getBaoName(); | ||
| if (!$baoName) { | ||
| // In some cases (eg. site spin-up) the code may attempt to call the api before the entity name is registered. | ||
| throw new \API_Exception("BAO for {$this->getEntityName()}is not available. This could be a load-order issue"); |
There was a problem hiding this comment.
Can you add a space after the entity name?
|
This can be merged when @colemanw 's comment / issue is resolved |
It the BAO name is not found at this point we currently get a fatal error. This makes it more recoverable. The specific case I'm hitting at the moment relates to monolog - the caching of the symfony container means it persists between builds and is accessed before the extension is installed. However the entity is not yet registered. Historically I have hit this fatal in other scenarios but I can't recall the details.
|
This is a valuable step forward - issues relating to The mechanisms are outside my current understanding but am happy to test future PRs now that we've started to isolate the issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
Throw exception when baoName is not found in v4 api get requests
Before
If a race condition arises where the entity is called before it is registered a fatal error results
After
In same situation an exception is thrown.
Technical Details
An exception is more recoverable than a fatal error.
The specific case I'm hitting at the moment relates to monolog - the
caching of the symfony container means it persists between builds and is
accessed before the extension is installed. However the entity is not
yet registered via entityTypes hook. Interestingly my call to apiv4.getEntities
does find it to be available.
Historically I have hit this fatal in other scenarios but I can't recall the details.
Comments