fix(pwa): only count clients in scope #760
Conversation
| }) | ||
| const filteredClientsList = await self.clients | ||
| .matchAll({ | ||
| includeUncontrolled: true, |
There was a problem hiding this comment.
would setting includeUncontrolled: false work here?
From https://developer.mozilla.org/en-US/docs/Web/API/Clients/matchAll:
includeUncontrolled: A boolean value — if set to true, the matching operation will return all service worker clients who share the same origin as the current service worker. Otherwise, it returns only the service worker clients controlled by the current service worker. The default is false.
It seems like client starting with the same scope would be the same as a client controlled by the current service worker?
There was a problem hiding this comment.
This is kind of a weird thing: we do sometimes want to include uncontrolled clients that are still in the scope of the service worker, because there are some cases where a client has an active service worker but the client is not controlled, for example during the first installation of the service worker in an app, or after a 'hard reload'. I have no idea why the includeUncontrolled option goes on to include all clients on that domain though, even outside the service worker scope 🤷
Just to be sure, I did an experiment and logged the different results of matchAll; here's what it looks like with one uncontrolled tab and another one right after a hard reload -- neither are controlled, but both are in scope and of interest to getClientsInfo:
(So in conclusion, we need the includeUncontrolled option, but that means we need to filter out the clients that are out of this SW's scope)
KaiVandivier
changed the title
## [10.1.6](v10.1.5...v10.1.6) (2022-11-24) ### Bug Fixes * **pwa:** only count clients in scope ([#760](#760)) ([41113c0](41113c0))
|
🎉 This PR is included in version 10.1.6 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 10.2.0-alpha.3 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
https://dhis2.atlassian.net/browse/LIBS-367
Results in correct client counts for PWA reloading purposes, otherwise all open tabs on this domain (even if they're not in scope of the SW) are returned