Improve track flag

packages/clarity-js/src/data/metadata.ts

@@ -1,5 +1,5 @@
 import { Time } from "@clarity-types/core";
-import { BooleanFlag, Constant, Dimension, Metadata, MetadataCallback, MetadataCallbackOptions, Metric, Session, User, Setting } from "@clarity-types/data";
+import { BooleanFlag, Constant, Dimension, Metadata, MetadataCallback, MetadataCallbackOptions, Metric, Session, User, Setting, Event } from "@clarity-types/data";
 import * as clarity from "@src/clarity";
 import * as core from "@src/core";
 import config from "@src/core/config";
@@ -8,6 +8,7 @@ import * as scrub from "@src/core/scrub";
 import * as dimension from "@src/data/dimension";
 import * as metric from "@src/data/metric";
 import { set } from "@src/data/variable";
+import encode from "@src/data/encode";
 
 export let data: Metadata = null;
 export let callbacks: MetadataCallbackOptions[] = [];
@@ -62,10 +63,12 @@ export function start(): void {
     metric.max(Metric.ColorDepth, Math.round(screen.colorDepth));
   }
 
-  // Read cookies specified in configuration
-  for (let key of config.cookies) {
-    let value = getCookie(key);
-    if (value) { set(key, value); }
+  if (config.track) {
+    let sync = window['sync'];
+    if (sync) {
+      sync();
+    }
+    read();
   }
 
   // Track ids using a cookie if configuration allows it
@@ -120,6 +123,9 @@ export function consent(status: boolean = true): void {
   if (core.active()) {
     config.track = true;
     track(user(), BooleanFlag.True);
+    save();
+    read();
+    encode(Event.Consent);
   }
 }
 
@@ -128,6 +134,14 @@ export function clear(): void {
   setCookie(Constant.SessionKey, Constant.Empty, 0);
 }
 
+function read(): void {
+  // Read cookies specified in configuration
+  for (let key of config.cookies) {
+    let value = getCookie(key);
+    if (value) { set(key, value); }
+  }
+}
+
 function tab(): string {
   let id = shortid();
   if (config.track && supported(window, Constant.SessionStorage)) {
@@ -142,10 +156,14 @@ export function save(): void {
   let ts = Math.round(Date.now());
   let upload = config.upload && typeof config.upload === Constant.String ? (config.upload as string).replace(Constant.HTTPS, Constant.Empty) : Constant.Empty;
   let upgrade = config.lean ? BooleanFlag.False : BooleanFlag.True;
-  processCallback(upgrade);
   setCookie(Constant.SessionKey, [data.sessionId, ts, data.pageNum, upgrade, upload].join(Constant.Pipe), Setting.SessionExpire);
 }
 
+export function callback(): void {
+  let upgrade = config.lean ? BooleanFlag.False : BooleanFlag.True;
+  processCallback(upgrade);
+}
+
 function processCallback(upgrade: BooleanFlag) {
   if (callbacks.length > 0) {
     callbacks.forEach(x => {
@@ -251,11 +269,11 @@ function getCookie(key: string): string {
           // * Cookie was previously not encoded by Clarity and browser encoded it once or more
           // * Cookie was previously encoded by Clarity and browser did not encode it
           let [isEncoded, decodedValue] = decodeCookieValue(pair[1]);
-          
+
           while (isEncoded) {
             [isEncoded, decodedValue] = decodeCookieValue(decodedValue);
           }
-        
+
           return decodedValue;
         }
       }

packages/clarity-js/src/data/upgrade.ts

@@ -22,6 +22,7 @@ export function upgrade(key: string): void {
         data = { key };
 
         // Update metadata to track we have upgraded this session
+        metadata.callback();
         metadata.save();
 
         // Callback upgrade handler, if configured

packages/clarity-js/src/data/upload.ts

@@ -51,7 +51,7 @@ export function queue(tokens: Token[], transmit: boolean = true): void {
             case Event.Discover:
                 discoverBytes += event.length;
             case Event.Box:
-            case Event.Mutation:                
+            case Event.Mutation:
             case Event.Snapshot:
             case Event.StyleSheetAdoption:
             case Event.StyleSheetUpdate:
@@ -125,7 +125,7 @@ async function upload(final: boolean = false): Promise<void> {
     let a = `[${analysis.join()}]`;
 
     let p = sendPlaybackBytes ? `[${playback.join()}]` : Constant.Empty;
-    let encoded: EncodedPayload = {e, a, p};
+    let encoded: EncodedPayload = { e, a, p };
 
     // Get the payload ready for sending over the wire
     // We also attempt to compress the payload if it is not the last payload and the browser supports it
@@ -241,7 +241,10 @@ function check(xhr: XMLHttpRequest, sequence: number): void {
 
 function done(sequence: number): void {
     // If we everything went successfully, and it is the first sequence, save this session for future reference
-    if (sequence === 1) { metadata.save(); }
+    if (sequence === 1) {
+        metadata.callback();
+        metadata.save();
+    }
 }
 
 function delay(): number {
@@ -253,8 +256,7 @@ function delay(): number {
 
 function response(payload: string): void {
     let lines = payload && payload.length > 0 ? payload.split("\n") : [];
-    for (var line of lines)
-    {
+    for (var line of lines) {
         let parts = line && line.length > 0 ? line.split(/ (.*)/) : [Constant.Empty];
         switch (parts[0]) {
             case Constant.End:
@@ -275,6 +277,12 @@ function response(payload: string): void {
             case Constant.Signal:
                 if (parts.length > 1) { signalsEvent(parts[1]); }
                 break;
+            case Constant.Sync:
+                let sync = window['sync'];
+                if (sync) {
+                    sync();
+                }
+                break;
         }
     }
 }

packages/clarity-js/types/data.d.ts

@@ -68,7 +68,8 @@ export const enum Event {
     Snapshot = 43,
     Animation = 44,
     StyleSheetAdoption = 45,
-    StyleSheetUpdate = 46
+    StyleSheetUpdate = 46,
+    Consent = 47
 }
 
 export const enum Metric {
@@ -283,6 +284,7 @@ export const enum Constant {
     Action = "ACTION",
     Signal = "SIGNAL",
     Extract = "EXTRACT",
+    Sync = "SYNC",
     UserHint = "userHint",
     UserType = "userType",
     UserId = "userId",