feat: Add useBeacon config for visibilitychange dispatch behavior. #194
Conversation
This file contains 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
adebayor123
approved these changes
Aug 8, 2022
src/dispatch/Dispatch.ts
Outdated
| // case. However, ad-blockers prevent sendBeacon from functioning. | ||
| // We therefore have two bad options: | ||
| // | ||
| // (1) Use sendBeacon and accept missing data when ad blockers are |
There was a problem hiding this comment.
question: What does accept missing data mean?
| ); | ||
| document.addEventListener('pagehide', this.dispatchBeaconFailSilent); |
There was a problem hiding this comment.
question: Are we removing this since visibilitychange implies pagehide?
There was a problem hiding this comment.
If so, should we add a unit test case to verify pagehide is handled properly as intended?
There was a problem hiding this comment.
That was the idea, although as I look at the compatibility tables, pagehide is supported in older browser versions which the web client technically supports, so perhaps we should keep the event listener for pagehide.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
When the page transitions to a hidden state and fires the
visibilitychangeevent, the page may be in the process of unloading, so the web client flushes it's event cache. In this scenario, the approach recommended by MDN is to usesendBeaconso that the request will complete after the page is unloaded. However, ad blockers preventsendBeaconfrom functioning, so this request may not be sent.We therefore have two bad options:
A third option is to send both, however this would increase bandwidch and require deduping server side.
This change adds a config option that controls whether
fetchorsendBeaconis used in this scenario, so that application owners can select the behavior that best fits their application.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.