Add ability to prime URL metrics #1850
+4,207
−23
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,6 +26,8 @@ const consoleLogPrefix = '[Optimization Detective]'; | |
|
|
||
| const storageLockTimeSessionKey = 'odStorageLockTime'; | ||
|
|
||
| let odPrimeUrlMetricsVerificationToken = ''; | ||
|
|
||
| /** | ||
| * Checks whether storage is locked. | ||
| * | ||
|
|
@@ -34,6 +36,10 @@ const storageLockTimeSessionKey = 'odStorageLockTime'; | |
| * @return {boolean} Whether storage is locked. | ||
| */ | ||
| function isStorageLocked( currentTime, storageLockTTL ) { | ||
| if ( '' !== odPrimeUrlMetricsVerificationToken ) { | ||
| return false; | ||
| } | ||
|
|
||
| if ( storageLockTTL === 0 ) { | ||
| return false; | ||
| } | ||
|
|
@@ -365,14 +371,29 @@ export default async function detect( { | |
| return; | ||
| } | ||
|
|
||
| /** @type {HTMLIFrameElement|null} */ | ||
| const urlPrimeIframeElement = win.parent.document.querySelector( | ||
| 'iframe#od-prime-url-metrics-iframe' | ||
| ); | ||
| if ( | ||
| urlPrimeIframeElement && | ||
| urlPrimeIframeElement.dataset.odPrimeUrlMetricsVerificationToken | ||
| ) { | ||
| odPrimeUrlMetricsVerificationToken = | ||
| urlPrimeIframeElement.dataset.odPrimeUrlMetricsVerificationToken; | ||
| } | ||
|
|
||
| // Abort if the client already submitted a URL Metric for this URL and viewport group. | ||
| const alreadySubmittedSessionStorageKey = | ||
| await getAlreadySubmittedSessionStorageKey( | ||
| currentETag, | ||
| currentUrl, | ||
| urlMetricGroupStatus | ||
| ); | ||
| if ( | ||
| '' === odPrimeUrlMetricsVerificationToken && | ||
| alreadySubmittedSessionStorageKey in sessionStorage | ||
| ) { | ||
| const previousVisitTime = parseInt( | ||
| sessionStorage.getItem( alreadySubmittedSessionStorageKey ), | ||
| 10 | ||
|
|
@@ -663,6 +684,14 @@ export default async function detect( { | |
|
|
||
| // Wait for the page to be hidden. | ||
| await new Promise( ( resolve ) => { | ||
| if ( '' !== odPrimeUrlMetricsVerificationToken ) { | ||
| window.parent.postMessage( | ||
| 'OD_PRIME_URL_METRICS_REQUEST_SUCCESS', | ||
| '*' | ||
| ); | ||
| resolve(); | ||
| } | ||
|
|
||
| win.addEventListener( 'pagehide', resolve, { once: true } ); | ||
| win.addEventListener( 'pageswap', resolve, { once: true } ); | ||
| doc.addEventListener( | ||
|
|
@@ -807,6 +836,13 @@ export default async function detect( { | |
| ); | ||
| } | ||
| url.searchParams.set( 'hmac', urlMetricHMAC ); | ||
| if ( '' !== odPrimeUrlMetricsVerificationToken ) { | ||
| url.searchParams.set( | ||
| 'prime_url_metrics_verification_token', | ||
| odPrimeUrlMetricsVerificationToken | ||
| ); | ||
| } | ||
|
There was a problem hiding this comment. Authentication for REST API
In #1835 PR, WP nonces are introduced for REST API requests for logged-in users. This may allow us to eliminate the custom token authentication if URL metrics are collected exclusively from logged-in users. |
||
|
|
||
| navigator.sendBeacon( | ||
| url, | ||
| new Blob( [ jsonBody ], { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Parent and
IFRAMEcommunication is handled via postMessage. A message is sent to the parent, and the promise resolves immediately.If the promise isn't resolved immediately, navigating to a new URL causes the code following the promise to never execute. This is because changing the
iframe.srcdoes not trigger events likepagehide,pageswap, orvisibilitychange.performance/plugins/optimization-detective/detect.js
Lines 568 to 569 in 6ca5c4b
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder. Do we even need to post a message here? As soon as the
iframeis destroyed won't it automatically cause the URL Metric to be sent, right?Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem is we need to signal the parent that we can move to next URL or breakpoint using
postMessageas theloadevent can't be used. Check this comment for detailed explanation #1850 (comment) .Will it makes sense to send the
postMessageafter thenavigator.sendBeaconthen?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I think it makes sense to send the message after the beacon is sent, definitely.