Check if cookies have been accepted before tracking the page (#915)

* Update fathom script

* Update heap

* Update hotjar

* Update mixpanel

* Update plausible

* Update posthog

* Update REO

* Add changeset

* Move cookie check out of function call

* Move cookies check to function instead of variable

Author: addisonschultz

.changeset/five-birds-post.md

@@ -0,0 +1,11 @@
+---
+'@gitbook/integration-plausible': minor
+'@gitbook/integration-mixpanel': minor
+'@gitbook/integration-posthog': minor
+'@gitbook/integration-fathom': minor
+'@gitbook/integration-hotjar': minor
+'@gitbook/integration-heap': minor
+'@gitbook/integration-reo.dev': minor
+---
+
+Add check to see if cookies should be disabled or not

integrations/fathom/src/fathomScript.raw.js

@@ -5,9 +5,30 @@
     element.setAttribute('data-site', siteId);
     element.setAttribute('data-spa', 'auto');
     element.src = 'https://cdn.usefathom.com/script.js';
+    const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+    function getCookie(cname) {
+        const name = `${cname}=`;
+        const decodedCookie = decodeURIComponent(document.cookie);
+        const ca = decodedCookie.split(';');
+        for (let i = 0; i < ca.length; i++) {
+            let c = ca[i];
+            while (c.charAt(0) === ' ') {
+                c = c.substring(1);
+            }
+            if (c.indexOf(name) === 0) {
+                return c.substring(name.length, c.length);
+            }
+        }
+        return '';
+    }
 
     // Function to track external links
     function trackExternalLink(event) {
+        if (getCookie(GRANTED_COOKIE) !== 'yes') {
+            return;
+        }
+
         var item = event.target.closest('a');
         if (!item) return;
 

integrations/heap/src/script.raw.js

@@ -1,5 +1,27 @@
 (function (win, doc) {
     const trackingID = '<TO_REPLACE>';
+    const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+    function getCookie(cname) {
+        const name = `${cname}=`;
+        const decodedCookie = decodeURIComponent(document.cookie);
+        const ca = decodedCookie.split(';');
+        for (let i = 0; i < ca.length; i++) {
+            let c = ca[i];
+            while (c.charAt(0) === ' ') {
+                c = c.substring(1);
+            }
+            if (c.indexOf(name) === 0) {
+                return c.substring(name.length, c.length);
+            }
+        }
+        return '';
+    }
+
+    if (getCookie(GRANTED_COOKIE) !== 'yes') {
+        return;
+    }
+
     win.heap = win.heap || [];
     heap.load = function (e, t) {
         (win.heap.appid = e), (win.heap.config = t = t || {});

integrations/hotjar/src/script.raw.js

@@ -1,5 +1,27 @@
 (function (h, o, t, j, a, r) {
     const trackingID = '<TO_REPLACE>';
+    const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+    function getCookie(cname) {
+        const name = `${cname}=`;
+        const decodedCookie = decodeURIComponent(document.cookie);
+        const ca = decodedCookie.split(';');
+        for (let i = 0; i < ca.length; i++) {
+            let c = ca[i];
+            while (c.charAt(0) === ' ') {
+                c = c.substring(1);
+            }
+            if (c.indexOf(name) === 0) {
+                return c.substring(name.length, c.length);
+            }
+        }
+        return '';
+    }
+
+    if (getCookie(GRANTED_COOKIE) !== 'yes') {
+        return;
+    }
+
     h.hj =
         h.hj ||
         function () {

integrations/mixpanel/src/script.raw.js

@@ -1,4 +1,26 @@
 (function (f, b) {
+    const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+    function getCookie(cname) {
+        const name = `${cname}=`;
+        const decodedCookie = decodeURIComponent(document.cookie);
+        const ca = decodedCookie.split(';');
+        for (let i = 0; i < ca.length; i++) {
+            let c = ca[i];
+            while (c.charAt(0) === ' ') {
+                c = c.substring(1);
+            }
+            if (c.indexOf(name) === 0) {
+                return c.substring(name.length, c.length);
+            }
+        }
+        return '';
+    }
+
+    if (getCookie(GRANTED_COOKIE) !== 'yes') {
+        return;
+    }
+
     if (!b.__SV) {
         var e, g, i, h;
         window.mixpanel = b;

integrations/plausible/src/plausibleScript.raw.js

@@ -6,11 +6,33 @@
     const apiUrl = '<api>' || 'https://plausible.io/api/event';
     const domain = '<domain>';
 
+    const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+    function getCookie(cname) {
+        const name = `${cname}=`;
+        const decodedCookie = decodeURIComponent(document.cookie);
+        const ca = decodedCookie.split(';');
+        for (let i = 0; i < ca.length; i++) {
+            let c = ca[i];
+            while (c.charAt(0) === ' ') {
+                c = c.substring(1);
+            }
+            if (c.indexOf(name) === 0) {
+                return c.substring(name.length, c.length);
+            }
+        }
+        return '';
+    }
+
     function logIgnoredEvent(event) {
         console.warn('Ignoring Event: ' + event);
     }
 
     function trackEvent(eventName, options) {
+        if (getCookie(GRANTED_COOKIE) !== 'yes') {
+            return;
+        }
+
         if (
             /^localhost$|^127(\.[0-9]+){0,2}\.[0-9]+$|^\[::1?\]$/.test(currentUrl.hostname) ||
             'file:' === currentUrl.protocol

integrations/posthog/src/script.raw.js

@@ -1,7 +1,28 @@
 const projectApiKey = '<ph_project_api_key>';
 const instanceAddress = '<ph_instance_address>';
+const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+function getCookie(cname) {
+    const name = `${cname}=`;
+    const decodedCookie = decodeURIComponent(document.cookie);
+    const ca = decodedCookie.split(';');
+    for (let i = 0; i < ca.length; i++) {
+        let c = ca[i];
+        while (c.charAt(0) === ' ') {
+            c = c.substring(1);
+        }
+        if (c.indexOf(name) === 0) {
+            return c.substring(name.length, c.length);
+        }
+    }
+    return '';
+}
 
 !(function (t, e) {
+    if (getCookie(GRANTED_COOKIE) !== 'yes') {
+        return;
+    }
+
     var o, n, p, r;
     e.__SV ||
         ((window.posthog = e),

integrations/reo/src/script.raw.js

@@ -1,6 +1,27 @@
 const trackingID = '<TO_REPLACE>';
+const GRANTED_COOKIE = '__gitbook_cookie_granted';
+
+function getCookie(cname) {
+    const name = `${cname}=`;
+    const decodedCookie = decodeURIComponent(document.cookie);
+    const ca = decodedCookie.split(';');
+    for (let i = 0; i < ca.length; i++) {
+        let c = ca[i];
+        while (c.charAt(0) === ' ') {
+            c = c.substring(1);
+        }
+        if (c.indexOf(name) === 0) {
+            return c.substring(name.length, c.length);
+        }
+    }
+    return '';
+}
 
 (function (r, e, o) {
+    if (getCookie(GRANTED_COOKIE) !== 'yes') {
+        return;
+    }
+
     var t, c, n;
     c = { clientID: trackingID };
     t = function () {