fix(plausible): Prevent duplicate HTTP calls for read progress #16360
+1
−1
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.
DESCRIBE YOUR PR
This PR fixes issue DOCS-A7B by preventing duplicate HTTP calls to Plausible Analytics for 'Read Progress' events.
Root Cause:
The
useEffecthook within theReaderDepthTrackercomponent (src/components/track-reader-depth.tsx) was missing a dependency array. This caused the effect to run on every component re-render, leading to the accumulation of multiple scroll event listeners. Each listener would then independently trigger a 'Read Progress' event to Plausible, resulting in duplicate HTTP POST requests.Changes Made:
An empty dependency array (
[]) has been added to theuseEffecthook insrc/components/track-reader-depth.tsx. This ensures the effect runs only once when the component mounts, correctly registering a single scroll event listener and preventing the accumulation of duplicate listeners.Impact:
This fix addresses the issue of inflated analytics data for 'Read Progress' metrics and reduces unnecessary network traffic to Plausible, improving data accuracy and network efficiency without affecting the user experience.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES