[WPT] BFCache: service worker clients #31082

chromium-wpt-export-bot · 2021-10-04T00:22:36Z

This CL adds service worker tests for BFCache:

navigator.serviceWorker.controller
Fetch interception
Clients.claim()
Clients.matchAll() and
unregister().

Expected behavior:

Controlled pages should remain controlled after
restored from BFCache, i.e.
navigator.serviceWorker.controller should remain non-null
and fetch should be intercepted.
Clients.claim() should evict pages
that would be affected from BFCache.
Clients.matchAll() shouldn't list pages in BFCache.
unregister() should evict controlled pages from BFCache.

Failing tests:

service-worker-clients-claim.https.html:
On Safari/Firefox, Clients.claim() doesn't evict pages from BFCache.
service-worker-controlled-after-restore.https.html:
On Firefox, fetches are not intercepted after restored from
BFCache while navigator.serviceWorker.controller is non-null.
service-worker-unregister.https.html:
Controlled pages aren't evicted by unregister() (all browsers).

Bug: 1107415, 1204228, w3c/ServiceWorker#1594
Change-Id: I73233cf917e31dd91b974823d5490d0190f0eade
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3201011
Reviewed-by: Rakina Zata Amni <rakina@chromium.org>
Reviewed-by: Ben Kelly <wanderview@chromium.org>
Commit-Queue: Hiroshige Hayashizaki <hiroshige@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1008327}

wpt-pr-bot

The review process for this patch is being conducted in the Chromium project.

html/browsers/browsing-the-web/back-forward-cache/service-worker-unregister.https.html

smaug---- · 2022-02-15T11:16:18Z

html/browsers/browsing-the-web/back-forward-cache/service-worker-unregister.https.html

+  await pageA.execute_script(waitForPageShow);
+  await assert_bfcached(pageA);
+
+  // `pageA` should be still controlled after restored from BFCache.


Hmm, is this the behavior we want?

Given https://w3c.github.io/ServiceWorker/#navigator-service-worker-unregister
the registration would be there until bfcache entry is evicted or page brought back to foreground?

@rakina, any thoughts?

cc @rubberyuzu @wanderview @fergald as they have a better idea about SW interaction with bfcache

Friendly ping. Any thoughts?

In my understanding, according to the current https://w3c.github.io/ServiceWorker/#navigator-service-worker-unregister the registration is removed so that subsequent navigation are no longer controlled by the service worker, while the page in BFCache still remains controlled (as "currently controlled service worker client's active service worker's containing service worker registration is effective"), but not sure.
This also aligns with Firefox/Chrome/Safari's behavior.

I don't think it matters here what browsers do here, since bfcache + SW is largely undefined. But it would be, IMO, rather odd to keep the page registered while you can't still communicate with it. So I would expect unregister to evict any bfcached pages (well, that is what UAs can do anyhow, since eviction may happen at any point).

Oh, interesting. I think service worker unregistration actually already triggers eviction of the controllees in Chrome's implementation: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/service_worker/service_worker_container_host.cc;l=643;drc=b24429781c133fd2482edbb4d0c8c8305031b082

Not sure if this test is testing a different case, or is somehow not testing what it should be. But I guess eviction makes sense in the case linked above?

@hiroshige-g, let's update the test to expect eviction after service worker unregistration. @smaug---- , do you have other concerns for the tests? Maybe we can add a Client.postMessage() test too, but I don't think that's blocking the rest of the tests here from landing?

I think service worker unregistration actually already triggers eviction of the controllees in Chrome's implementation:

Probably Comments 7 and 8 of https://bugs.chromium.org/p/chromium/issues/detail?id=1204228 is the explanation for this. Because there are still active controlled pages at the time of unregister(), the full eviction code doesn't run.

Anyway I updated the test to expect eviction from BFCache on unregister().

smaug---- · 2022-05-05T22:23:18Z

How should Client.postMessage behave if the other side is in bfcache? I guess evict the other side from bfcache.

rakina · 2022-05-06T05:34:15Z

How should Client.postMessage behave if the other side is in bfcache? I guess evict the other side from bfcache.

Yep we are already evicting in Chrome: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/service_worker/service_worker_version.cc;l=1448;drc=b24429781c133fd2482edbb4d0c8c8305031b082

This CL adds service worker tests for BFCache: - navigator.serviceWorker.controller - Fetch interception - Clients.claim() - Clients.matchAll() and - unregister(). Expected behavior: - Controlled pages should remain controlled after restored from BFCache, i.e. navigator.serviceWorker.controller should remain non-null and fetch should be intercepted. - Clients.claim() should evict pages that would be affected from BFCache. - Clients.matchAll() shouldn't list pages in BFCache. - unregister() should evict controlled pages from BFCache. Failing tests: - service-worker-clients-claim.https.html: On Safari/Firefox, Clients.claim() doesn't evict pages from BFCache. - service-worker-controlled-after-restore.https.html: On Firefox, fetches are not intercepted after restored from BFCache while `navigator.serviceWorker.controller` is non-null. - service-worker-unregister.https.html: Controlled pages aren't evicted by unregister() (all browsers). Bug: 1107415, 1204228, w3c/ServiceWorker#1594 Change-Id: I73233cf917e31dd91b974823d5490d0190f0eade Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3201011 Reviewed-by: Rakina Zata Amni <rakina@chromium.org> Reviewed-by: Ben Kelly <wanderview@chromium.org> Commit-Queue: Hiroshige Hayashizaki <hiroshige@chromium.org> Cr-Commit-Position: refs/heads/main@{#1008327}

smaug---- · 2022-06-06T15:15:38Z

html/browsers/browsing-the-web/back-forward-cache/service-worker-unregister.https.html

+<script src="/service-workers/service-worker/resources/test-helpers.sub.js"></script>
+<script>
+// When a service worker is unregistered when a controlled page is in BFCache,
+// the page can be still restored from BFCache and remain controlled by the


This comment looks now wrong. The assertion is "navigator.serviceWorker.controller === null" and assertion comment 'pageA should not be controlled'

smaug---- · 2022-06-06T15:18:28Z

Yep we are already evicting in Chrome

But there is no test for Client.postMessage?

smaug---- · 2022-06-15T07:51:47Z

I'm adding basic tests for Client.postMessage. Firefox and Chrome behave in those similarly (once I land some tweaks to Gecko)

smaug---- · 2022-06-21T11:49:37Z

Looks like the tests were reverted on chromium's side 40ac061 just when I had fixed something on Mozilla's side
https://bugzilla.mozilla.org/show_bug.cgi?id=1774475#c6

fergald · 2022-06-21T12:02:38Z

@hiroshige-g We should reland them but with flaky expectations and we can look at debugging them in the future.

smaug---- · 2022-06-21T14:13:55Z

That is happening here #34505, but looks like Chrome has still some issues with the tests.

jgraham · 2022-06-21T19:59:11Z

If we were to force merge #34505 (once it's on mozilla-central) would you set the flaky metadata in Chrome as part of the sync?

fergald · 2022-06-21T23:09:28Z

Yes, that'd be fine. Thanks.

chromium-wpt-export-bot added chromium-export do not merge yet labels Oct 4, 2021

wpt-pr-bot added the html label Oct 4, 2021

wpt-pr-bot approved these changes Oct 4, 2021

View reviewed changes

chromium-wpt-export-bot force-pushed the chromium-export-cl-3201011 branch 6 times, most recently from 40c13a9 to 89b57ab Compare October 14, 2021 03:56

hiroshige-g mentioned this pull request Oct 14, 2021

How does ServiceWorker interact with non-"fully active" documents? w3c/ServiceWorker#1594

Open

chromium-wpt-export-bot force-pushed the chromium-export-cl-3201011 branch from 89b57ab to 0dd142f Compare October 19, 2021 12:59

chromium-wpt-export-bot force-pushed the chromium-export-cl-3201011 branch from 0dd142f to 58615a8 Compare January 7, 2022 11:22

smaug---- reviewed Feb 15, 2022

View reviewed changes

html/browsers/browsing-the-web/back-forward-cache/service-worker-unregister.https.html Outdated Show resolved Hide resolved

smaug---- reviewed Feb 15, 2022

View reviewed changes

chromium-wpt-export-bot force-pushed the chromium-export-cl-3201011 branch 7 times, most recently from 09ba04a to 19d7086 Compare February 18, 2022 03:32

smaug---- mentioned this pull request May 5, 2022

Exposing back/forward cache blocking reasons to sites whatwg/html#7094

Open

jesup mentioned this pull request May 23, 2022

Interactions with the BFCache whatwg/fs#17

Open

chromium-wpt-export-bot force-pushed the chromium-export-cl-3201011 branch 2 times, most recently from 2986287 to 432f728 Compare May 27, 2022 02:41

chromium-wpt-export-bot force-pushed the chromium-export-cl-3201011 branch from 432f728 to 39f5f59 Compare May 27, 2022 18:12

chromium-wpt-export-bot removed the do not merge yet label May 27, 2022

chromium-wpt-export-bot merged commit e08e12d into master May 27, 2022

chromium-wpt-export-bot deleted the chromium-export-cl-3201011 branch May 27, 2022 19:34

moz-wptsync-bot added mozilla:gecko-blocked and removed mozilla:gecko-blocked labels May 27, 2022

smaug---- reviewed Jun 6, 2022

View reviewed changes

smaug---- mentioned this pull request Jun 21, 2022

[Gecko Bug 1774475] add missing await to the test to ensure loading a new page and going back have been processed #34505

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WPT] BFCache: service worker clients #31082

[WPT] BFCache: service worker clients #31082

chromium-wpt-export-bot commented Oct 4, 2021 •

edited

Loading

wpt-pr-bot left a comment

smaug---- Feb 15, 2022 •

edited

Loading

hiroshige-g Feb 17, 2022

rakina Feb 17, 2022

hiroshige-g Mar 11, 2022

hiroshige-g May 2, 2022 •

edited

Loading

smaug---- May 3, 2022

rakina May 6, 2022

rakina May 19, 2022

hiroshige-g May 27, 2022

smaug---- commented May 5, 2022

rakina commented May 6, 2022

smaug---- Jun 6, 2022 •

edited

Loading

smaug---- commented Jun 6, 2022

smaug---- commented Jun 15, 2022

smaug---- commented Jun 21, 2022

fergald commented Jun 21, 2022

smaug---- commented Jun 21, 2022 •

edited

Loading

jgraham commented Jun 21, 2022 •

edited

Loading

fergald commented Jun 21, 2022

[WPT] BFCache: service worker clients #31082

[WPT] BFCache: service worker clients #31082

Conversation

chromium-wpt-export-bot commented Oct 4, 2021 • edited Loading

wpt-pr-bot left a comment

Choose a reason for hiding this comment

smaug---- Feb 15, 2022 • edited Loading

Choose a reason for hiding this comment

hiroshige-g Feb 17, 2022

Choose a reason for hiding this comment

rakina Feb 17, 2022

Choose a reason for hiding this comment

hiroshige-g Mar 11, 2022

Choose a reason for hiding this comment

hiroshige-g May 2, 2022 • edited Loading

Choose a reason for hiding this comment

smaug---- May 3, 2022

Choose a reason for hiding this comment

rakina May 6, 2022

Choose a reason for hiding this comment

rakina May 19, 2022

Choose a reason for hiding this comment

hiroshige-g May 27, 2022

Choose a reason for hiding this comment

smaug---- commented May 5, 2022

rakina commented May 6, 2022

smaug---- Jun 6, 2022 • edited Loading

Choose a reason for hiding this comment

smaug---- commented Jun 6, 2022

smaug---- commented Jun 15, 2022

smaug---- commented Jun 21, 2022

fergald commented Jun 21, 2022

smaug---- commented Jun 21, 2022 • edited Loading

jgraham commented Jun 21, 2022 • edited Loading

fergald commented Jun 21, 2022

chromium-wpt-export-bot commented Oct 4, 2021 •

edited

Loading

smaug---- Feb 15, 2022 •

edited

Loading

hiroshige-g May 2, 2022 •

edited

Loading

smaug---- Jun 6, 2022 •

edited

Loading

smaug---- commented Jun 21, 2022 •

edited

Loading

jgraham commented Jun 21, 2022 •

edited

Loading