feat: add option to capture pageviews on navigation history transitions #2435
+192
−3
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Size Change: +3.14 kB (+0.07%) Total Size: 4.84 MB
ℹ️ View Unchanged
|
lricoy
force-pushed
the
lricoy/pageleave-on-navigation
branch
from
03ad51c to
2148ad7
Compare
Add new 'on_navigation' option for capture_pageleave config that captures pageleave events on every SPA navigation (pushState, replaceState, popstate) in addition to window unload. This enables the expected behavior pattern for pure client-side navigation: - pageView A → (navigate) → pageLeave A + pageView B → (navigate) → pageLeave B + pageView C
lricoy
force-pushed
the
lricoy/pageleave-on-navigation
branch
from
2148ad7 to
0be6d6f
Compare
lricoy
changed the title
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
@lricoy what's the use case for this? |
@rafaeelaudibert This is mostly for people using SPA/Client side navigation that would expect to have the pageview/pageleave events matching the same behavior as non-SPAs (each non-first navigation has a pageleave from the previous page and a pageview on the new page). They could implement this themselves on each framework but I think we should have this config available since we're the ones controlling the SDK behavior. It is a recurrent question if people need the |
Yeah, but ultimately the answer is: "no, you don't need that", right? They can run the same analysis just by using the existing events. So that's why I'm playing bad cop here lol Will approve in case you still think strongly that this should be an option - make sure you add the right labels to this PR |
rafaeelaudibert
approved these changes
Oct 17, 2025
| if (this._instance._shouldCapturePageleaveOnNavigation()) { | ||
| const pageleaveProps = this._instance.pageViewManager.doPageLeave(new Date()) | ||
| // Only capture pageleave if there was a previous page ($prev_pageview_id will be present) | ||
| if (pageleaveProps.$prev_pageview_id) { |
There was a problem hiding this comment.
When could this not be the case? (prev_pageview_id is not present)
jabahamondes
approved these changes
Oct 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Changes
Adds a new
'on_navigation'option for thecapture_pageleaveconfig that captures pageleave events on every history navigation event (pushState, replaceState, popstate) in addition to window unload.This is an extension to the
capture:_pageview: 'history_change'option to allow people who rely on client-side navigation to have this behavior:When
capture_pageleave: 'on_navigation'is set:The regular
trueorif_capture_pageviewwould be:The pageleave event is captured before the new pageview during navigation and has a timestamp as well as all the other expected props because this PR only changes the trigger, everything is still handled by
PageViewManager.$pageleavebehavior.