[web-locks] Verify release during navigation #20258
Conversation
This test presumes that "termination" occurs during navigation.
| @@ -0,0 +1,51 @@ | |||
| <!DOCTYPE html> | |||
| <html> | |||
There was a problem hiding this comment.
nit: <html> <head> and <body> are optional in HTML5. The document will parse fine without them.
There was a problem hiding this comment.
It will parse fine, but without a body, the script will have nowhere to place the iframe. I'll keep that tag and remove the others.
| <script> | ||
| 'use strict'; | ||
| (async () => { | ||
| const [uuid, phase] = location.search.split('_'); |
There was a problem hiding this comment.
This works, but is a bit less clear than explicit query params. You could parse those using
const url = new URL(self.location.href);
const lockName = url.searchParams.get('lock');
const state = url.searchParams.get('state');| }, '*'); | ||
|
|
||
| if (phase === 'first') { | ||
| location.search = uuid + '_second'; |
There was a problem hiding this comment.
This would become
url.searchParams.set('state', 'second');
self.location = url;| (async () => { | ||
| const [uuid, phase] = location.search.split('_'); | ||
| const neverSettled = new Promise(() => {}); | ||
| navigator.locks.request(uuid, () => neverSettled); |
There was a problem hiding this comment.
A more robust version:
let firstRequestGranted = false;
navigator.locks.request(lockName, () => {
firstRequestGranted = true;
return neverSettled;
});
let secondRequestGranted = false;
navigator.locks.request(lockName, () => {
secondRequestGranted = true;
return neverSettled;
}); This doesn't depend on navigator.locks.query, which may have its own bugs. The frame would postMessage {firstRequestGranted, secondRequestGranted}.
There was a problem hiding this comment.
Hm, I spoke too soon. I think that the test would be more robust if we waited for the first request to be granted, then requested an unrelated lock and waited for that to be granted.
let firstRequestPromiseResolver;
const firstRequestPromise =
new Promise(resolve => { firstRequestPromiseResolver = resolve; });
navigator.locks.request(lockName, () => {
firstRequestPromiseResolver();
return neverSettled;
});
await firstRequestPromise;
// This request should never get granted.
let secondRequestGranted = false;
navigator.locks.request(lockName, () => {
secondRequestGranted = true;
return neverSettled;
});
let lastRequestPromiseResolver;
// Give the lock manager a chance to grant locks.
const lastRequestPromise =
new Promise(resolve => { lastRequestPromiseResolver = resolve; });
navigator.locks.request(token(), () => {
lastRequestPromiseResolver();
return neverSettled;
});
await lastRequestPromise;
self.parent.postMessage({ secondRequestGranted, state });
|
Thanks for the review, @pwnall! At the risk of starting a game of golf, I've iterated on your suggestion a bit. This latest revision combines your initial idea with your amended idea: it uses two booleans and three requests. However, it only waits on the third request. My rationale is that the expected sequence is still verifiable in this form (thanks to the single FIFO lock task queue), but it reduces the number of failure modes that require timing out (e.g. if the UA incorrectly refuses to grant the named lock following navigation, then the test will complete immediately, but it will still fail because flag for that request will be Also, I fixed a race condition in the |
| queue.push(event.data); | ||
| }); | ||
|
|
||
| async function getMessage(name) { |
This test presumes that "termination" occurs during navigation.