improve Segment.io retries #714
Merged
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
🦋 Changeset detectedLatest commit: f0b02ed The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
chrisradek
force-pushed
the
segment-retries
branch
from
60a71d5
to
59b8bd2
Compare
silesky
reviewed
Dec 9, 2022
| @@ -10,13 +10,13 @@ | |||
| export const onPageLeave = (cb: (...args: unknown[]) => void) => { | |||
| let unloaded = false // prevents double firing if both are supported | |||
|
|
|||
| // using document instead of window because of bug affecting browsers before safari 14 (detail in footnotes https://caniuse.com/?search=visibilitychange) | |||
| document.addEventListener('pagehide', () => { | |||
| window.addEventListener('pagehide', () => { | |||
silesky
reviewed
Dec 9, 2022
| // Buffer may already have items if they were previously stored in localStorage. | ||
| // Start flushing them immediately. | ||
| if (buffer.todo) { | ||
| scheduleFlush(flushing, buffer, segmentio, scheduleFlush) |
There was a problem hiding this comment.
nice! Not much code for a very nice improvement.
silesky
approved these changes
Dec 9, 2022
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.
This PR improves retry handling for the
Segment.ioplugin. It also fixes an issue wherePersistedPriorityQueuewas no longer storing events inlocalStorageonpagehide.Fix
PersistedPriorityQueueThe PersistedPriorityQueue listens for the
pagehideevent then stores all of its events in localStorage. Currently, it listens for thepagehideevent to be emitted ondocument, butpagehideis aWindowevent. This caused the queue to stop working withpagehide.Apply backoff to segment retries
Currently, when fetch errors are encountered events are pushed back onto the buffer via
buffer.push(ctx). This does not apply any backoff, so this is updated tobuffer.pushWithBackoff(ctx). This causes the event to be part of the buffer'stodolength. Theschedule-flushfunction already checksbuffer.todo > 0, so we're covered here.Store canceled events
In the scenario where the user navigates away from the page between while there are pending HTTP requests, those events are not currently persisted in localStorage. This change keeps track of events that are 'in-flight' and adds them to the persisted priority queue.
Testing
I was able to add tests for this using playwright. Also tested manually with Chrome and Firefox.
[x] I've included a changeset (psst. run
yarn changeset. Read about changesets here).