Avoid _doing_it_wrong() for Server-Timing in Optimization Detective when output buffering is not enabled#1194
Merged
westonruter merged 1 commit intotrunkfrom May 3, 2024
Conversation
…hen OB not enabled
westonruter
added
[Type] Bug
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
swissspidy
approved these changes
May 3, 2024
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
When Optimization Detective active, I noticed a
_doing_it_wrong()warning in Query Monitor:In the Server-Timing admin page, output buffering is not enabled:
The issue is that Performance Lab's Server-Timing functionality is not aware that Optimization Detective is doing output buffering of the template (although it used to be in #875, but it was backed out in #1082). So the PL functionality is sending the
Server-Timingheader after Optimization Detective starts buffering the output, but then when the buffer closes and the server timing wrapper attempts to then process the timing, it fails because the header has already been sent. So we need to add an additional check for whether the output buffering checkbox has been checked (via theperflab_server_timing_use_output_buffer()function).(If Performance Lab had been aware of the Optimization Detective output buffer, then it wouldn't need the checkbox at all since the
Server-Timingheader could be sent after the output buffer is closed.)