Skip to content

[Tracker] Use ResizeObserver instead of polling for document height #6174

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.

Sign up for GitHub

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

Open
ukutaht wants to merge 5 commits into
base: master
Choose a base branch
from
+10 −21
Open

[Tracker] Use ResizeObserver instead of polling for document height #6174

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8758ce1
Use ResizeObserver instead of polling for document height
ukutaht Mar 18, 2026
fe96564
fix: avoid forced reflow in getCurrentScrollDepthPx
ukutaht Mar 18, 2026
37381e0
disable engagement tracking in compat mode
ukutaht Mar 18, 2026
1824094
Add changelog entry
ukutaht Mar 18, 2026
0e24d26
Bump tracker script version
ukutaht Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 4 additions & 18 deletions tracker/src/engagement.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,8 @@ function getDocumentHeight() {
}

function getCurrentScrollDepthPx() {
var body = document.body || {}
var el = document.documentElement || {}
var viewportHeight = window.innerHeight || el.clientHeight || 0
Copy link
Copy Markdown
Contributor Author

@ukutaht ukutaht Mar 18, 2026

Choose a reason for hiding this comment

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

By removing IE support for engagement tracking, these fallbacks are not necessary since window.scrollY and window.innerHeight are well-supported:

https://caniuse.com/mdn-api_window_innerheight
https://caniuse.com/mdn-api_window_scrolly

var scrollTop = window.scrollY || el.scrollTop || body.scrollTop || 0
var viewportHeight = window.innerHeight
var scrollTop = window.scrollY

return currentDocumentHeight <= viewportHeight
? currentDocumentHeight
Expand All @@ -151,23 +149,11 @@ export function init() {
currentDocumentHeight = getDocumentHeight()
maxScrollDepthPx = getCurrentScrollDepthPx()

window.addEventListener('load', function () {
new ResizeObserver(function () {
currentDocumentHeight = getDocumentHeight()

// Update the document height again after every 200ms during the
// next 3 seconds. This makes sure dynamically loaded content is
// also accounted for.
var count = 0
var interval = setInterval(function () {
Copy link
Copy Markdown
Contributor Author

@ukutaht ukutaht Mar 18, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

No need to poll the document for height changes during initial load. Any time DOM is loaded and updated, ResizeObserver will keep currentDocumentHeight variable in sync.

currentDocumentHeight = getDocumentHeight()
if (++count === 15) {
clearInterval(interval)
}
}, 200)
})
}).observe(document.documentElement)

document.addEventListener('scroll', function () {
currentDocumentHeight = getDocumentHeight()
Copy link
Copy Markdown
Contributor Author

@ukutaht ukutaht Mar 18, 2026

Choose a reason for hiding this comment

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

No need to recompute document height on every scroll event. If the document height changes at any point, ResizeObserver will keep it updated.

var currentScrollDepthPx = getCurrentScrollDepthPx()

if (currentScrollDepthPx > maxScrollDepthPx) {
Expand Down
4 changes: 3 additions & 1 deletion tracker/src/plausible.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ function init(overrides) {

initConfig(options)

initEngagementTracking()
if (!COMPILE_COMPAT) {
initEngagementTracking()
}

if (!COMPILE_MANUAL || (COMPILE_CONFIG && config.autoCapturePageviews)) {
initAutocapture(track)
Expand Down
Loading