Change default tracker initialization parameters for JS/Browser v4

#1144
snowplow · Sep 13, 2023 · 7bbb74a · 7bbb74a
1 parent 93a6b37
commit 7bbb74a
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 12 deletions.
diff --git a/...racker-core/feature-v4-change-default-initialization-params-browser_2023-01-26-08-53.json b/...racker-core/feature-v4-change-default-initialization-params-browser_2023-01-26-08-53.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/browser-tracker-core",
+      "comment": "Change default tracker initialization params (discoverRootDomain, cookieSameSite)",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/browser-tracker-core"
+}
diff --git a/...ipt-tracker/feature-v4-change-default-initialization-params-browser_2023-01-26-08-53.json b/...ipt-tracker/feature-v4-change-default-initialization-params-browser_2023-01-26-08-53.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@snowplow/javascript-tracker",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@snowplow/javascript-tracker"
+}
diff --git a/libraries/browser-tracker-core/src/tracker/index.ts b/libraries/browser-tracker-core/src/tracker/index.ts
@@ -238,11 +238,12 @@ export function Tracker(
       // First-party cookie domain
       // User agent defaults to origin hostname
       configCookieDomain = trackerConfiguration.cookieDomain ?? undefined,
+      discoverRootDomain = trackerConfiguration.discoverRootDomain || true,
       // First-party cookie path
       // Default is user agent defined.
       configCookiePath = '/',
       // First-party cookie samesite attribute
-      configCookieSameSite = trackerConfiguration.cookieSameSite ?? 'None',
+      configCookieSameSite = trackerConfiguration.cookieSameSite ?? 'Lax',
       // First-party cookie secure attribute
       configCookieSecure = trackerConfiguration.cookieSecure ?? true,
       // Do Not Track browser feature
@@ -320,7 +321,7 @@ export function Tracker(
       onSessionUpdateCallback = trackerConfiguration.onSessionUpdateCallback,
       manualSessionUpdateCalled = false;
 
-    if (trackerConfiguration.hasOwnProperty('discoverRootDomain') && trackerConfiguration.discoverRootDomain) {
+    if (discoverRootDomain && !configCookieDomain) {
       configCookieDomain = findRootDomain(configCookieSameSite, configCookieSecure);
     }
 

diff --git a/libraries/browser-tracker-core/src/tracker/types.ts b/libraries/browser-tracker-core/src/tracker/types.ts
@@ -93,7 +93,7 @@ export type TrackerConfiguration = {
   /**
    * The SameSite value for the cookie
    * {@link https://snowplowanalytics.com/blog/2020/09/07/pipeline-configuration-for-complete-and-accurate-data/}
-   * @defaultValue None
+   * @defaultValue Lax
    */
   cookieSameSite?: CookieSameSite;
   /**
@@ -172,7 +172,7 @@ export type TrackerConfiguration = {
    *
    * This sets cookies to try to determine the root domain, and some cookies may
    * fail to save. This is expected behavior.
-   * @defaultValue false
+   * @defaultValue true
    */
   discoverRootDomain?: boolean;
   /**

diff --git a/libraries/browser-tracker-core/test/helpers/index.ts b/libraries/browser-tracker-core/test/helpers/index.ts
@@ -60,7 +60,7 @@ export function createTestIdCookie(params: Partial<CreateTestIdCookie>) {
   const { domainHash } = cookieParams;
   // @ts-expect-error
   delete cookieParams.domainHash;
-  return `_sp_id.${domainHash}=${Object.values(cookieParams).join('.')}; Expires=; Path=/; SameSite=None; Secure;`;
+  return `_sp_id.${domainHash}=${Object.values(cookieParams).join('.')}; Expires=; Path=/; SameSite=Lax; Secure;`;
 }
 
 interface CreateTestSessionIdCookie {
@@ -72,7 +72,7 @@ interface CreateTestSessionIdCookie {
  */
 export function createTestSessionIdCookie(params?: CreateTestSessionIdCookie) {
   const domainHash = DEFAULT_DOMAIN_HASH || params?.domainHash;
-  return `_sp_ses.${domainHash}=*; Expires=; Path=/; SameSite=None; Secure;`;
+  return `_sp_ses.${domainHash}=*; Expires=; Path=/; SameSite=Lax; Secure;`;
 }
 
 export function createTracker(configuration?: TrackerConfiguration) {

diff --git a/trackers/javascript-tracker/test/pages/cookies.html b/trackers/javascript-tracker/test/pages/cookies.html
@@ -34,7 +34,6 @@
 
       snowplow('newTracker', 'sp1', 'snowplow-js-tracker.local:9090', {
         cookieName: '_sp_1',
-        cookieSameSite: 'Lax',
         cookieSecure: false,
       });
 
@@ -49,36 +48,31 @@
 
       snowplow('newTracker', 'sp3', 'snowplow-js-tracker.local:9090', {
         cookieName: '_sp_3',
-        cookieSameSite: 'Lax',
         cookieSecure: false,
         sessionCookieTimeout: 1,
         cookieLifetime: 1,
       });
 
       snowplow('newTracker', 'sp4', 'snowplow-js-tracker.local:9090', {
         cookieName: '_sp_4',
-        cookieSameSite: 'Lax',
         cookieSecure: false,
         anonymousTracking: true,
       });
 
       snowplow('newTracker', 'sp5', 'snowplow-js-tracker.local:9090', {
         cookieName: '_sp_5',
-        cookieSameSite: 'Lax',
         cookieSecure: false,
         stateStorageStrategy: 'localStorage',
       });
 
       snowplow('newTracker', 'sp6', 'snowplow-js-tracker.local:9090', {
         cookieName: '_sp_6',
-        cookieSameSite: 'Lax',
         cookieSecure: false,
         stateStorageStrategy: 'cookie',
       });
 
       snowplow('newTracker', 'sp7', 'snowplow-js-tracker.local:9090', {
         cookieName: '_sp_7',
-        cookieSameSite: 'Lax',
         cookieSecure: false,
         cookieDomain: '.google.com',
       });