Skip to content

Lead-gen Group 4: first-party docs-behavior beacon (capture only) #402

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

Draft
JakeSCahill wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Lead-gen Group 4: first-party docs-behavior beacon (capture only) #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 50 additions & 0 deletions src/js/27-docs-activity.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/* global sessionStorage, fetch */
/**
* First-party docs-behavior beacon (lead capture).
*
* For SIGNED-IN docs users only (rp_docs_auth hint cookie), reports one
* pageview per navigation to the docs-site /docs-activity endpoint, which
* records it server-side against the user's account. Replaces anonymous
* third-party analytics (Plausible/Heap/Algolia) for lead purposes.
*
* Anonymous visitors send nothing. Same-origin, so the session cookie rides
* along automatically. Fire-and-forget; never blocks or throws into the page.
*/
;(function () {
'use strict'

// Only signed-in users are tracked (matches 26-docs-account.js).
if (!/(?:^|;\s*)rp_docs_auth=1(?:;|$)/.test(document.cookie)) return

var path = window.location.pathname
if (!path) return

// Beacon once per path per tab session — avoids duplicate writes on
// back/forward and re-renders. Keeps server write volume to real navigations.
try {
var key = 'docs-activity-seen'
var seen = (sessionStorage.getItem(key) || '').split('\n')
if (seen.indexOf(path) !== -1) return
seen.push(path)
sessionStorage.setItem(key, seen.slice(-200).join('\n'))
} catch (e) { /* private mode: proceed without dedupe */ }

// Antora component (product) exposed by the layout: <body data-component=…>
var component = (document.body && document.body.getAttribute('data-component')) || null

// Capture the search term on the standalone /search page (URL-driven).
var q = null
if (path.indexOf('/search') !== -1) {
try { q = new URLSearchParams(window.location.search).get('q') } catch (e) { /* ignore */ }
}

try {
fetch('/docs-activity', {
method: 'POST',
credentials: 'include',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ path: path, component: component, q: q }),
keepalive: true,
}).catch(function () { /* best-effort */ })
} catch (e) { /* never break the page */ }
})()
Loading