-
Notifications
You must be signed in to change notification settings - Fork 309
[do not merge] Add privacy-first tracking #1531
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.
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
ksen0
wants to merge
1
commit into
main
Choose a base branch
from
searchevent
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| import { useEffect, useRef } from "preact/hooks"; | ||
|
|
||
| const TIME_LABELS: Record<number, string> = { | ||
| 10000: "Focus 10s", | ||
| 30000: "Focus 30s", | ||
| 90000: "Focus 90s", | ||
| 300000: "Focus 5min", | ||
| 600000: "Focus 10min", | ||
| }; | ||
|
|
||
| const SCROLL_LABELS: Record<number, string> = { | ||
| 25: "Scroll 25%", | ||
| 50: "Scroll 50%", | ||
| 75: "Scroll 75%", | ||
| 100: "Scroll 100%", | ||
| }; | ||
|
|
||
| const track = (label: string) => { | ||
| // Fathom analytics does not use cookies. The data collected | ||
| // is aggregate and minimal. The scope is currently only on | ||
| // the Reference page, but it can be generalized in the future. | ||
| if (window.fathom && window.location.pathname.startsWith("/reference/")) { | ||
| window.fathom.trackEvent(label); | ||
| } | ||
| }; | ||
|
|
||
| const ReferenceTracker = ({ | ||
| timeThresholds, | ||
| scrollThresholds, | ||
| }: { | ||
| timeThresholds: number[]; | ||
| scrollThresholds: number[]; | ||
| }) => { | ||
| const hasFiredTime = useRef<Set<number>>(new Set()); | ||
| const hasFiredScroll = useRef<Set<number>>(new Set()); | ||
| const elapsed = useRef(0); | ||
|
|
||
| useEffect(() => { | ||
| const tick = () => { | ||
| if (document.hidden) return; | ||
| elapsed.current += 1000; | ||
| for (const ms of timeThresholds) { | ||
| if (elapsed.current >= ms && !hasFiredTime.current.has(ms)) { | ||
| hasFiredTime.current.add(ms); | ||
| track(TIME_LABELS[ms]); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const onScroll = () => { | ||
| const max = document.documentElement.scrollHeight - document.documentElement.clientHeight; | ||
| if (max <= 0) return; | ||
| const pct = Math.round((window.scrollY / max) * 100); | ||
| for (const t of scrollThresholds) { | ||
| if (pct >= t && !hasFiredScroll.current.has(t)) { | ||
| hasFiredScroll.current.add(t); | ||
| track(SCROLL_LABELS[t]); | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| const interval = setInterval(tick, 1000); | ||
| window.addEventListener("scroll", onScroll, { passive: true }); | ||
|
|
||
| return () => { | ||
| clearInterval(interval); | ||
| window.removeEventListener("scroll", onScroll); | ||
| }; | ||
| }, [timeThresholds, scrollThresholds]); | ||
|
|
||
| return null; | ||
| }; | ||
|
|
||
| export default ReferenceTracker; | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| interface Window { | ||
| fathom?: { | ||
| trackEvent(name: string, attrs?: Record<string, unknown>): void; | ||
| }; | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pathname check misses all localized reference pages. Non-default locales are served under
/[locale]/reference/...(e.g./es/reference/p5/line), sopathname.startsWith("/reference/")is false there and none of these events will ever fire on non-English reference pages — which likely skews the data toward English-speaking users. Consider stripping the locale prefix before testing, e.g. with the existingremoveLocalePrefixutil from@i18n/utils.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the catch!!