-
Notifications
You must be signed in to change notification settings - Fork 11
Add consent-gated Conceptual Analytics pixel to dev docs #550
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
base: main
Are you sure you want to change the base?
Changes from all commits
2b3f9d5
05231c2
00f2bf5
e2a4b02
fd57bcc
f54f885
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /* | ||
| * Conceptual Analytics pixel. | ||
| * | ||
| * Mintlify loads every .js file in this directory on every docs page. The docs | ||
| * are served under www.kernel.sh/docs via a rewrite from the marketing site, so | ||
| * both the c15t consent cookie and the c15t API are same-origin here and the | ||
| * two halves of the site can share one consent decision. | ||
| */ | ||
| (function () { | ||
| var CONSENT_CATEGORY = "marketing"; | ||
| var PIXEL_KEY = | ||
| "acfc03eea265bec68ec3dfb5bc9f1bf6cda7644ceed3260980286b6f0b4098a3"; | ||
| var LOADER_SRC = | ||
| "https://plfalg.kernel.sh/analytics/loader-v1.js?key=" + | ||
| encodeURIComponent(PIXEL_KEY) + | ||
| "&v=1.1.0"; | ||
| var JURISDICTION_URL = "/api/c15t/show-consent-banner"; | ||
| var HANDOFF_PARAM = "ca_device_id"; | ||
| var HANDOFF_DOMAIN = "onkernel.com"; | ||
|
|
||
| // true granted, false declined, null no decision recorded yet. | ||
| // | ||
| // c15t omits false values from its cookie rather than writing them, so a | ||
| // decline is the absence of the key. Any stored consent record therefore | ||
| // means a decision was made, and a missing category in one means no. | ||
| function storedConsent() { | ||
| try { | ||
| var cookie = document.cookie.match(/(?:^|;\s*)c15t=([^;]*)/); | ||
| if (cookie && cookie[1]) { | ||
| return cookie[1].indexOf("c." + CONSENT_CATEGORY + ":1") !== -1; | ||
| } | ||
| } catch (e) {} | ||
|
|
||
| try { | ||
| var raw = localStorage.getItem("c15t"); | ||
| if (raw) { | ||
| var parsed = JSON.parse(raw); | ||
| if (parsed && parsed.consents) { | ||
| return parsed.consents[CONSENT_CATEGORY] === true; | ||
| } | ||
| } | ||
| } catch (e) {} | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| function load() { | ||
| if (window.ca) return; | ||
|
|
||
| // measure-v1.js reads __CA_CONFIG once at init, so it has to be set before | ||
| // the loader injects it. Both flags are off in the shipped pixel config. | ||
| // | ||
| // trackPageViews and trackUnload are what let the consent re-check below | ||
| // mean anything. Left on, the vendor emits a page view at init and installs | ||
| // scroll, click and form-submit listeners, all routed through its own | ||
| // internal track() rather than through ours — none of which we can gate. | ||
| // Off, the script emits nothing on its own and every event is one we sent. | ||
| // | ||
| // respectDNT takes effect: the pixel checks it before every event. | ||
| // anonymizeIP currently does not — the shipped script defines it and never | ||
| // reads it, and resolves the visitor's full address from the vendor's IP | ||
| // endpoint to send as client_ip regardless. It's set here so it applies if | ||
| // the vendor implements it; until then full-IP processing is what happens. | ||
| window.__CA_CONFIG = window.__CA_CONFIG || {}; | ||
| window.__CA_CONFIG.respectDNT = true; | ||
| window.__CA_CONFIG.anonymizeIP = true; | ||
| window.__CA_CONFIG.trackPageViews = false; | ||
| window.__CA_CONFIG.trackUnload = false; | ||
|
|
||
| window.ca = function () { | ||
| (window.ca.q = window.ca.q || []).push(arguments); | ||
| }; | ||
|
|
||
| var script = document.createElement("script"); | ||
| script.async = true; | ||
| script.src = LOADER_SRC; | ||
| document.head.appendChild(script); | ||
|
|
||
| // The vendor's own page view is off, so the landing one is ours to send. | ||
| window.ca("track", "page_view"); | ||
| } | ||
|
|
||
| // The pixel sends one page_view on init and has no router hooks, so docs | ||
| // navigation between pages is invisible unless we send it ourselves. | ||
| function trackNavigations() { | ||
| var lastPath = location.pathname + location.search; | ||
|
|
||
| function onNavigate() { | ||
| var path = location.pathname + location.search; | ||
| if (path === lastPath) return; | ||
| lastPath = path; | ||
| // Consent can be withdrawn on the marketing site while a docs page stays | ||
| // open. There's no consent UI here to react to, so every navigation | ||
| // re-reads the decision rather than trusting the one made at page load. | ||
| if (window.ca && storedConsent() !== false) window.ca("track", "page_view"); | ||
| } | ||
|
|
||
| ["pushState", "replaceState"].forEach(function (method) { | ||
| var original = history[method]; | ||
| history[method] = function () { | ||
| var result = original.apply(this, arguments); | ||
| onNavigate(); | ||
| return result; | ||
| }; | ||
| }); | ||
|
|
||
| window.addEventListener("popstate", onNavigate); | ||
| } | ||
|
|
||
| // The device ID is stored per-domain, and the docs link to dashboard sign-up | ||
| // in several places, so without this the ad click that led to a signup is | ||
| // never credited. Hand ours over on the way out; the dashboard reads it back. | ||
| function handOffDeviceIdOnNavigation() { | ||
| document.addEventListener( | ||
| "click", | ||
| function (event) { | ||
| var link = event.target.closest && event.target.closest("a[href]"); | ||
| if (!link || typeof window.ca.getDeviceId !== "function") return; | ||
| if (storedConsent() === false) return; | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Stale device ID after withdrawalMedium Severity The new decline check returns before rewriting the link, but a prior click already wrote Reviewed by Cursor Bugbot for commit fd57bcc. Configure here. |
||
|
|
||
| var url = new URL(link.href, window.location.href); | ||
| if ( | ||
| url.hostname !== HANDOFF_DOMAIN && | ||
| !url.hostname.endsWith("." + HANDOFF_DOMAIN) | ||
| ) { | ||
| return; | ||
| } | ||
|
|
||
| url.searchParams.set(HANDOFF_PARAM, window.ca.getDeviceId()); | ||
| link.href = url.toString(); | ||
| }, | ||
| { capture: true } | ||
| ); | ||
| } | ||
|
|
||
| function start() { | ||
| load(); | ||
| trackNavigations(); | ||
| handOffDeviceIdOnNavigation(); | ||
| } | ||
|
|
||
| var stored = storedConsent(); | ||
| if (stored !== null) { | ||
| if (stored) start(); | ||
| return; | ||
| } | ||
|
|
||
| // Nobody has decided yet, which is the normal case for a visitor whose first | ||
| // page is a docs page — the consent banner lives in the marketing site's app | ||
| // and never renders here. Apply the same rule c15t applies there: it only | ||
| // prompts in regulated jurisdictions and auto-grants everywhere else. Any | ||
| // failure leaves the pixel unloaded. | ||
| fetch(JURISDICTION_URL, { credentials: "same-origin" }) | ||
| .then(function (response) { | ||
| return response.ok ? response.json() : null; | ||
| }) | ||
| .then(function (data) { | ||
| if (data && data.showConsentBanner === false) start(); | ||
| }) | ||
| .catch(function () {}); | ||
| })(); | ||


Uh oh!
There was an error while loading. Please reload this page.