Skip to content

Adding aggregated engagement tracking to snowplow.js #1290

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
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Adding aggregated engagement tracking to snowplow.js #1290

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
557157c
Adding aggregated engagement tracking to snowplow.js
jrpeck1989 Jun 19, 2025
5c3cbd9
Adding the keepalive option to the config
jrpeck1989 Jun 19, 2025
65814c1
Updated the vendor for the 'page_view_aggregated' self-describing event
jrpeck1989 Jun 20, 2025
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
76 changes: 73 additions & 3 deletions snowplow.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import {
addGlobalContexts,
enableActivityTracking,
disableAnonymousTracking,
trackSelfDescribingEvent,
enableActivityTrackingCallback,
} from '@snowplow/browser-tracker'
import {
LinkClickTrackingPlugin,
Expand All @@ -25,6 +27,39 @@ import { reloadOnce } from './src/helpers/reloadOnce'
import { isEmpty, pickBy } from 'lodash'
import { SnowplowMediaPlugin } from '@snowplow/browser-plugin-media'

let aggregatedEvent = {
minXOffset: 0,
maxXOffset: 0,
minYOffset: 0,
maxYOffset: 0,
numEvents: 0,
}

const sendAggregatedEvent = () => {
if (aggregatedEvent.numEvents > 0) {
trackSelfDescribingEvent({
event: {
schema: 'iglu:com.snowplowanalytics/page_view_aggregated/jsonschema/1-0-0',
data: {
minXOffset: Math.max(0, Math.round(aggregatedEvent.minXOffset)),
maxXOffset: Math.max(0, Math.round(aggregatedEvent.maxXOffset)),
minYOffset: Math.max(0, Math.round(aggregatedEvent.minYOffset)),
maxYOffset: Math.max(0, Math.round(aggregatedEvent.maxYOffset)),
activeSeconds: aggregatedEvent.numEvents,
},
},
})
}
// Reset
aggregatedEvent = {
minXOffset: 0,
maxXOffset: 0,
minYOffset: 0,
maxYOffset: 0,
numEvents: 0,
}
}

const createTrackerConfig = (cookieName) => {
const appId = DOCS_SITE_URLS.includes(window.location.hostname)
? 'docs2'
Expand All @@ -43,6 +78,7 @@ const createTrackerConfig = (cookieName) => {
cookieDomain: `.${domain[1]}.${domain[0]}`,
cookieName,
cookieSameSite: 'Lax',
keepalive: true,
Copy link
Collaborator

Choose a reason for hiding this comment

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

what's this do?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is an important point. It uses the keep alive functionality of the Fetch API that means even after a window is closed or you've navigated away, the browser will still complete the request. This was the problem with the Beacon API which made this entire aggregated page ping logic so flaky, and why I want to try this method out.

contexts: {
webPage: true,
performanceTiming: true,
Expand All @@ -64,16 +100,18 @@ const createTrackerConfig = (cookieName) => {
const setupBrowserTracker = () => {
newTracker(
'snplow5',
'https://collector.snowplow.io',
// 'https://collector.snowplow.io',
Copy link
Collaborator

Choose a reason for hiding this comment

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

fix these commented out bits please

'com-snplow-sales-aws-prod1.collector.snplow.net',
createTrackerConfig('_sp5_')
)
newTracker('biz1', 'https://c.snowplow.io', createTrackerConfig('_sp_biz1_'))
// newTracker('biz1', 'https://c.snowplow.io', createTrackerConfig('_sp_biz1_'))

const selectedTabContext = () => {
const data = pickBy({
cloud: localStorage.getItem('docusaurus.tab.cloud'),
data_warehouse: localStorage.getItem('docusaurus.tab.warehouse'),
})
// @ts-ignore
if (!_.isEmpty(data))
return {
schema:
Expand All @@ -84,18 +122,49 @@ const setupBrowserTracker = () => {
addGlobalContexts([selectedTabContext])

enableLinkClickTracking()

enableActivityTracking({
heartbeatDelay: 10,
minimumVisitLength: 10,
}) // precise tracking for the unified log

enableActivityTrackingCallback({
minimumVisitLength: 1,
heartbeatDelay: 1,
callback: function (event) {
const newMinX =
aggregatedEvent.numEvents === 0
? event.minXOffset
: Math.min(aggregatedEvent.minXOffset, event.minXOffset)

const newMinY =
aggregatedEvent.numEvents === 0
? event.minYOffset
: Math.min(aggregatedEvent.minYOffset, event.minYOffset)

aggregatedEvent = {
minXOffset: newMinX,
maxXOffset: Math.max(aggregatedEvent.maxXOffset, event.maxXOffset),
minYOffset: newMinY,
maxYOffset: Math.max(aggregatedEvent.maxYOffset, event.maxYOffset),
numEvents: aggregatedEvent.numEvents + 1,
}
},
})

enableButtonClickTracking()
enableFormTracking()
}

if (ExecutionEnvironment.canUseDOM) {
setupBrowserTracker()

document.addEventListener('visibilitychange', () => {
if (document.visibilityState === 'hidden') {
sendAggregatedEvent()
}
})

onPreferencesChanged((preferences) => {
preferences.cookieOptions.forEach(({ id, isEnabled }) => {
if (id === 'analytics') {
Expand All @@ -108,7 +177,7 @@ if (ExecutionEnvironment.canUseDOM) {
} else {
const cookieKeys = document.cookie
.split(';')
.reduce((ac, str) => [...ac, str?.split('=')[0].trim()], [])
.map((str) => str.split('=')[0].trim())
const snowplowCookies = cookieKeys.filter((cookieKey) =>
cookieKey.startsWith('_sp5_')
)
Expand All @@ -126,6 +195,7 @@ if (ExecutionEnvironment.canUseDOM) {
const module = {
onRouteDidUpdate({ location, previousLocation }) {
if (location.pathname !== previousLocation?.pathname) {
sendAggregatedEvent()
// see https://github.com/facebook/docusaurus/pull/7424 regarding setTimeout
setTimeout(() => {
trackPageView()
Expand Down