Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(pwa): only count clients in scope #760

Merged
merged 1 commit into from
Nov 24, 2022

Conversation

KaiVandivier
Copy link
Contributor

@KaiVandivier KaiVandivier commented Oct 18, 2022

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

@KaiVandivier KaiVandivier marked this pull request as ready for review October 18, 2022 13:17
@KaiVandivier KaiVandivier requested review from amcgee and a team October 18, 2022 14:57
})
const filteredClientsList = await self.clients
.matchAll({
includeUncontrolled: true,
Copy link
Member

@tomzemp tomzemp Nov 4, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@KaiVandivier KaiVandivier Nov 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Screen Shot 2022-11-05 at 1 37 41 PM

(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)

Copy link
Member

@amcgee amcgee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Weird that this isn't the default behavior, but agree we need to filter the uncontrolled clients to only those in scope. I've seen this happen when there are multiple tabs open but only one of them is the Dashboards app.

@KaiVandivier KaiVandivier changed the title fix(sw): only count clients in scope fix(pwa): only count clients in scope Nov 24, 2022
@KaiVandivier KaiVandivier enabled auto-merge (squash) November 24, 2022 13:30
@KaiVandivier KaiVandivier merged commit 41113c0 into master Nov 24, 2022
@KaiVandivier KaiVandivier deleted the libs-367-fix-clients-count branch November 24, 2022 13:31
dhis2-bot added a commit that referenced this pull request Nov 24, 2022
## [10.1.6](v10.1.5...v10.1.6) (2022-11-24)

### Bug Fixes

* **pwa:** only count clients in scope ([#760](#760)) ([41113c0](41113c0))
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 10.1.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

dhis2-bot added a commit that referenced this pull request Nov 30, 2022
# [10.2.0-alpha.3](v10.2.0-alpha.2...v10.2.0-alpha.3) (2022-11-30)

### Bug Fixes

* **deps:** bump platform deps and unpin ([bd2582f](bd2582f))
* **pwa:** only count clients in scope ([#760](#760)) ([41113c0](41113c0))
@dhis2-bot
Copy link
Contributor

🎉 This PR is included in version 10.2.0-alpha.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants