Do not use insights cookie if disabled (#3087)

Author: SamyPesse

.changeset/sour-countries-explode.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Do not set cookie to identify visitor for insights when disabled.

bun.lock

@@ -35,7 +35,7 @@
     },
     "packages/colors": {
       "name": "@gitbook/colors",
-      "version": "0.3.0",
+      "version": "0.3.1",
       "devDependencies": {
         "typescript": "^5.5.3",
       },
@@ -49,7 +49,7 @@
     },
     "packages/gitbook": {
       "name": "gitbook",
-      "version": "0.8.2",
+      "version": "0.9.2",
       "dependencies": {
         "@gitbook/api": "*",
         "@gitbook/cache-do": "workspace:*",
@@ -136,7 +136,7 @@
     },
     "packages/gitbook-v2": {
       "name": "gitbook-v2",
-      "version": "0.2.2",
+      "version": "0.2.3",
       "dependencies": {
         "@gitbook/api": "*",
         "@gitbook/cache-tags": "workspace:*",
@@ -180,7 +180,7 @@
     },
     "packages/openapi-parser": {
       "name": "@gitbook/openapi-parser",
-      "version": "2.1.1",
+      "version": "2.1.2",
       "dependencies": {
         "@scalar/openapi-parser": "^0.10.10",
         "@scalar/openapi-types": "^0.1.9",
@@ -234,7 +234,7 @@
     },
     "packages/react-openapi": {
       "name": "@gitbook/react-openapi",
-      "version": "1.1.6",
+      "version": "1.1.9",
       "dependencies": {
         "@gitbook/openapi-parser": "workspace:*",
         "@scalar/api-client-react": "^1.2.5",
@@ -262,7 +262,7 @@
   },
   "overrides": {
     "@codemirror/state": "6.4.1",
-    "@gitbook/api": "0.106.0",
+    "@gitbook/api": "0.108.0",
     "react": "18.3.1",
     "react-dom": "18.3.1",
   },
@@ -623,7 +623,7 @@
 
     "@fortawesome/fontawesome-svg-core": ["@fortawesome/[email protected]", "", { "dependencies": { "@fortawesome/fontawesome-common-types": "6.6.0" } }, "sha512-KHwPkCk6oRT4HADE7smhfsKudt9N/9lm6EJ5BVg0tD1yPA5hht837fB87F8pn15D8JfTqQOjhKTktwmLMiD7Kg=="],
 
-    "@gitbook/api": ["@gitbook/api@0.106.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-2qA/w18JwHe2fwR2A45q1pEdCZArxqUloegfNibu0xngDhea+iKTXSBrN94wD6Lwkh7cqBp9MvtxC+YMz3hx1g=="],
+    "@gitbook/api": ["@gitbook/api@0.108.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-OytauuT3IMf0zl6rBvIacQ7YphzNhpuNAvEVQbysCGo3BhGYD1xv+vXVmtkAGUnFEAclw2fg2VjWPt3sOlQsAg=="],
 
     "@gitbook/cache-do": ["@gitbook/cache-do@workspace:packages/cache-do"],
 

package.json

@@ -12,7 +12,7 @@
         "@codemirror/state": "6.4.1",
         "react": "18.3.1",
         "react-dom": "18.3.1",
-        "@gitbook/api": "0.106.0"
+        "@gitbook/api": "0.108.0"
     },
     "private": true,
     "scripts": {

packages/gitbook/e2e/util.ts

@@ -276,6 +276,9 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
         internationalization: {
             locale: CustomizationLocale.En,
         },
+        insights: {
+            trackingCookie: true,
+        },
         favicon: {},
         header: {
             preset: CustomizationHeaderPreset.Default,

packages/gitbook/src/components/Insights/InsightsProvider.tsx

@@ -63,17 +63,27 @@ type TrackEventCallback = <EventName extends InsightsEventName>(
 const InsightsContext = React.createContext<TrackEventCallback>(() => {});
 
 interface InsightsProviderProps extends InsightsEventContext {
+    /** If true, the events will be sent to the server. */
     enabled: boolean;
+
+    /** If true, the visitor cookie tracking will be used */
+    visitorCookieTrackingEnabled: boolean;
+
+    /** The URL of the app. */
     appURL: string;
+
+    /** The host of the API. */
     apiHost: string;
+
+    /** The children of the provider. */
     children: React.ReactNode;
 }
 
 /**
  * Wrap the content of the app with the InsightsProvider to track events.
  */
 export function InsightsProvider(props: InsightsProviderProps) {
-    const { enabled, appURL, apiHost, children, ...context } = props;
+    const { enabled, appURL, apiHost, children, visitorCookieTrackingEnabled, ...context } = props;
 
     const visitorIdRef = React.useRef<string | null>(null);
     const eventsRef = React.useRef<{
@@ -140,7 +150,8 @@ export function InsightsProvider(props: InsightsProviderProps) {
     });
 
     const flushBatchedEvents = useDebounceCallback(async () => {
-        const visitorId = visitorIdRef.current ?? (await getVisitorId(appURL));
+        const visitorId =
+            visitorIdRef.current ?? (await getVisitorId(appURL, visitorCookieTrackingEnabled));
         visitorIdRef.current = visitorId;
 
         flushEventsSync();
@@ -184,15 +195,15 @@ export function InsightsProvider(props: InsightsProviderProps) {
      * Get the visitor ID and store it in a ref.
      */
     React.useEffect(() => {
-        getVisitorId(appURL).then((visitorId) => {
+        getVisitorId(appURL, visitorCookieTrackingEnabled).then((visitorId) => {
             visitorIdRef.current = visitorId;
             // When the page is unloaded, flush all events, but only if the visitor ID is set
             window.addEventListener('beforeunload', flushEventsSync);
         });
         return () => {
             window.removeEventListener('beforeunload', flushEventsSync);
         };
-    }, [flushEventsSync, appURL]);
+    }, [flushEventsSync, appURL, visitorCookieTrackingEnabled]);
 
     return (
         <InsightsContext.Provider value={trackEvent}>

packages/gitbook/src/components/Insights/visitorId.ts

@@ -13,10 +13,13 @@ let pendingVisitorId: Promise<string> | null = null;
 /**
  * Return the current visitor identifier.
  */
-export async function getVisitorId(appURL: string): Promise<string> {
+export async function getVisitorId(
+    appURL: string,
+    visitorCookieTrackingEnabled: boolean
+): Promise<string> {
     if (!visitorId) {
         if (!pendingVisitorId) {
-            pendingVisitorId = fetchVisitorID(appURL).finally(() => {
+            pendingVisitorId = fetchVisitorID(appURL, visitorCookieTrackingEnabled).finally(() => {
                 pendingVisitorId = null;
             });
         }
@@ -30,10 +33,13 @@ export async function getVisitorId(appURL: string): Promise<string> {
 /**
  * Propose a visitor identifier to the GitBook.com server and get the devideId back.
  */
-async function fetchVisitorID(appURL: string): Promise<string> {
+async function fetchVisitorID(
+    appURL: string,
+    visitorCookieTrackingEnabled: boolean
+): Promise<string> {
     const withoutCookies = isCookiesTrackingDisabled();
 
-    if (withoutCookies) {
+    if (withoutCookies || !visitorCookieTrackingEnabled) {
         return generateRandomId();
     }
 

packages/gitbook/src/components/SpaceLayout/SpaceLayout.tsx

@@ -62,6 +62,7 @@ export function SpaceLayout(props: {
                 revisionId={context.revisionId}
                 spaceId={context.space.id}
                 visitorAuthClaims={visitorAuthClaims}
+                visitorCookieTrackingEnabled={context.customization.insights?.trackingCookie}
             >
                 <Announcement context={context} />
                 <Header withTopHeader={withTopHeader} context={context} />

packages/gitbook/src/lib/utils.ts

@@ -26,6 +26,9 @@ export function defaultCustomization(): api.SiteCustomizationSettings {
         internationalization: {
             locale: api.CustomizationLocale.En,
         },
+        insights: {
+            trackingCookie: true,
+        },
         favicon: {},
         header: {
             preset: api.CustomizationHeaderPreset.Default,