fix(events): the pagesetup event timing is more like 1.x #9440
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
| @@ -329,6 +330,32 @@ protected function fileExists($path) { | |||
| } | |||
|
|
|||
| /** | |||
| * Trigger the system "pagesetup" event just before the 1st view rendering, or the 2nd if the 1st | |||
| * view starts with "resources/". | |||
There was a problem hiding this comment.
Might be best to add a short explanation why it is being done like this.
|
LGTM |
In 1.x, the event was triggered just before the first view was rendered and it was assumed that some global state, particularly context, had been set by this time in page-specific code. In 2.0 this assumption is wrong because the page-specific code that sets state like context often runs *within* a resource view. Hence the event is triggered too early, before the page-specific state has been set up. Here we delay the `pagesetup` event if the first view is a resource view. This allows plugins to move all page-specific logic like context setting into a resource view with more confidence that that state will be available in their `pagesetup` event handlers. This likely fixes a class of undiscovered bugs like Elgg#9271 and Elgg#9322. Refs Elgg#8374
mrclay
added a commit
that referenced
this pull request
Mar 5, 2016
fix(events): the pagesetup event timing is more like 1.x
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.
In 1.x, the event was triggered just before the first view was rendered and it was assumed that some global state, particularly context, had been set by this time in page-specific code.
In 2.0 this assumption is wrong because the page-specific code that sets state like context often runs within a resource view. Hence the event is triggered too early, before the page-specific state has been set up.
Here we delay the
pagesetupevent if the first view is a resource view.This allows plugins to move all page-specific logic like context setting into a resource view with more confidence that that state will be available in their
pagesetupevent handlers. This likely fixes a class of undiscovered bugs like #9271 and #9322.Refs #8374