fix: call sendBeacon synchronously #631
Merged
Conversation
This file contains hidden or 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
limhjgrace
approved these changes
Mar 27, 2025
ps863
approved these changes
Mar 27, 2025
williazz
added a commit
to williazz/aws-rum-web
that referenced
this pull request
Mar 29, 2025
williazz
added a commit
to williazz/aws-rum-web
that referenced
this pull request
Mar 31, 2025
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.
Summary
SendBeacon() is the industry standard way to report data AFTER the user closed the page. This thing has never worked for us before because we called it asynchronously inside a promise, meaning the browser rarely ever received the job.
In addition, this API is becoming increasingly important, because it is becoming a popular pattern to record events locally without ever publishing them to data analytical services (e.g. RUM) until the last possible moment.
To fix it, you need to call it synchronously so the browser can queue the job.
Reading
Testing
This is fairly hard do an integration test for. There is already coverage on page hide, but not for closing the page.
I manually verified this by recording INP event as a candidate but made sure PutRumEvents was never called by the browser.
After closing the page, I saw that my event was successfully ingested. (Tested this many times).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.