clarity-js 0.7.4 → 0.7.6

package/build/clarity.module.js

@@ -143,11 +143,11 @@ function time(event) {
     var ts = event && event.timeStamp > 0 ? event.timeStamp : performance.now();
     return Math.max(Math.round(ts - startTime), 0);
 }
-function stop$C() {
+function stop$D() {
     startTime = 0;
 }
 
-var version$1 = "0.7.4";
+var version$1 = "0.7.6";
 
 // tslint:disable: no-bitwise
 function hash (input, precision) {
@@ -197,6 +197,7 @@ function text$1(value, hint, privacy, mangle) {
             case 3 /* Privacy.TextImage */:
                 switch (hint) {
                     case "*T" /* Layout.Constant.TextTag */:
+                    case "data-" /* Layout.Constant.DataAttribute */:
                         return mangle ? mangleText(value) : mask(value);
                     case "src":
                     case "srcset":
@@ -215,6 +216,7 @@ function text$1(value, hint, privacy, mangle) {
             case 4 /* Privacy.Exclude */:
                 switch (hint) {
                     case "*T" /* Layout.Constant.TextTag */:
+                    case "data-" /* Layout.Constant.DataAttribute */:
                         return mangle ? mangleText(value) : mask(value);
                     case "value":
                     case "input":
@@ -224,6 +226,25 @@ function text$1(value, hint, privacy, mangle) {
                     case "checksum":
                         return "" /* Data.Constant.Empty */;
                 }
+                break;
+            case 5 /* Privacy.Snapshot */:
+                switch (hint) {
+                    case "*T" /* Layout.Constant.TextTag */:
+                    case "data-" /* Layout.Constant.DataAttribute */:
+                        return scrub(value);
+                    case "value":
+                    case "input":
+                    case "click":
+                    case "change":
+                        return Array(5 /* Data.Setting.WordLength */).join("\u2022" /* Data.Constant.Mask */);
+                    case "checksum":
+                    case "src":
+                    case "srcset":
+                    case "alt":
+                    case "title":
+                        return "" /* Data.Constant.Empty */;
+                }
+                break;
         }
     }
     return value;
@@ -251,6 +272,10 @@ function mangleText(value) {
 function mask(value) {
     return value.replace(catchallRegex, "\u2022" /* Data.Constant.Mask */);
 }
+function scrub(value) {
+    regex(); // Initialize regular expressions
+    return value.replace(letterRegex, "\u25AA" /* Data.Constant.Letter */).replace(digitRegex, "\u25AB" /* Data.Constant.Digit */);
+}
 function mangleToken(value) {
     var length = ((Math.floor(value.length / 5 /* Data.Setting.WordLength */) + 1) * 5 /* Data.Setting.WordLength */);
     var output = "" /* Layout.Constant.Empty */;
@@ -259,13 +284,7 @@ function mangleToken(value) {
     }
     return output;
 }
-function redact(value) {
-    var spaceIndex = -1;
-    var gap = 0;
-    var hasDigit = false;
-    var hasEmail = false;
-    var hasWhitespace = false;
-    var array = null;
+function regex() {
     // Initialize unicode regex, if supported by the browser
     // Reference: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Unicode_Property_Escapes
     if (unicodeRegex && digitRegex === null) {
@@ -278,6 +297,15 @@ function redact(value) {
             unicodeRegex = false;
         }
     }
+}
+function redact(value) {
+    var spaceIndex = -1;
+    var gap = 0;
+    var hasDigit = false;
+    var hasEmail = false;
+    var hasWhitespace = false;
+    var array = null;
+    regex(); // Initialize regular expressions
     for (var i = 0; i < value.length; i++) {
         var c = value.charCodeAt(i);
         hasDigit = hasDigit || (c >= 48 /* Data.Character.Zero */ && c <= 57 /* Data.Character.Nine */); // Check for digits in the current word
@@ -389,7 +417,7 @@ function compute$c() {
         encode$1(4 /* Event.Baseline */);
     }
 }
-function stop$B() {
+function stop$C() {
     reset$q();
 }
 
@@ -400,7 +428,7 @@ var baseline = /*#__PURE__*/Object.freeze({
     reset: reset$q,
     start: start$F,
     get state () { return state$a; },
-    stop: stop$B,
+    stop: stop$C,
     track: track$7,
     visibility: visibility
 });
@@ -426,7 +454,7 @@ function start$E() {
     updates$3 = {};
     count$1(5 /* Metric.InvokeCount */);
 }
-function stop$A() {
+function stop$B() {
     data$i = {};
     updates$3 = {};
 }
@@ -504,7 +532,7 @@ function ping() {
         suspend();
     }
 }
-function stop$z() {
+function stop$A() {
     clearTimeout(timeout$6);
     last = 0;
     interval = 0;
@@ -515,14 +543,14 @@ var ping$1 = /*#__PURE__*/Object.freeze({
     get data () { return data$h; },
     reset: reset$o,
     start: start$D,
-    stop: stop$z
+    stop: stop$A
 });
 
 var data$g = null;
 function start$C() {
     data$g = {};
 }
-function stop$y() {
+function stop$z() {
     data$g = {};
 }
 function track$6(event, time) {
@@ -555,7 +583,7 @@ var summary = /*#__PURE__*/Object.freeze({
     get data () { return data$g; },
     reset: reset$n,
     start: start$C,
-    stop: stop$y,
+    stop: stop$z,
     track: track$6
 });
 
@@ -584,7 +612,7 @@ function upgrade(key) {
         encode$1(3 /* Event.Upgrade */);
     }
 }
-function stop$x() {
+function stop$y() {
     data$f = null;
 }
 
@@ -592,7 +620,7 @@ var upgrade$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     get data () { return data$f; },
     start: start$B,
-    stop: stop$x,
+    stop: stop$y,
     upgrade: upgrade
 });
 
@@ -632,7 +660,7 @@ function compute$9() {
 function reset$m() {
     data$e = {};
 }
-function stop$w() {
+function stop$x() {
     reset$m();
 }
 
@@ -644,7 +672,7 @@ var variable = /*#__PURE__*/Object.freeze({
     reset: reset$m,
     set: set,
     start: start$A,
-    stop: stop$w
+    stop: stop$x
 });
 
 /******************************************************************************
@@ -764,13 +792,13 @@ function start$z() {
     start$E();
     modules$1.forEach(function (x) { return measure(x.start)(); });
 }
-function stop$v() {
+function stop$w() {
     // Stop modules in the reverse order of their initialization
     // The ordering below should respect inter-module dependency.
     // E.g. if upgrade depends on upload, then upgrade needs to end before upload.
     // Similarly, if upload depends on metadata, upload needs to end before metadata.
     modules$1.slice().reverse().forEach(function (x) { return measure(x.stop)(); });
-    stop$A();
+    stop$B();
 }
 function compute$8() {
     compute$9();
@@ -920,7 +948,7 @@ function start$x() {
     reset$k();
     parse$1(document, true);
 }
-function stop$u() {
+function stop$v() {
     reset$k();
 }
 function reset$k() {
@@ -1267,7 +1295,7 @@ var dom = /*#__PURE__*/Object.freeze({
     parse: parse$1,
     sameorigin: sameorigin,
     start: start$x,
-    stop: stop$u,
+    stop: stop$v,
     update: update$1,
     updates: updates$2
 });
@@ -1378,7 +1406,7 @@ function restart$2(timer) {
         tracker[id].yield = y;
     }
 }
-function stop$t(timer) {
+function stop$u(timer) {
     var end = performance.now();
     var id = key(timer);
     var duration = end - tracker[id].start;
@@ -1398,7 +1426,7 @@ function suspend$1(timer) {
                 case 0:
                     id = key(timer);
                     if (!(id in tracker)) return [3 /*break*/, 2];
-                    stop$t(timer);
+                    stop$u(timer);
                     _a = tracker[id];
                     return [4 /*yield*/, wait()];
                 case 1:
@@ -1541,7 +1569,7 @@ function compute$7() {
         encode$4(8 /* Event.Document */);
     }
 }
-function end() {
+function stop$t() {
     reset$i();
 }
 
@@ -1676,7 +1704,7 @@ function str$1(input) {
     return input.toString(36);
 }
 function attribute(key, value, privacy) {
-    return "".concat(key, "=").concat(text$1(value, key, privacy));
+    return "".concat(key, "=").concat(text$1(value, key.indexOf("data-" /* Constant.DataAttribute */) === 0 ? "data-" /* Constant.DataAttribute */ : key, privacy));
 }
 
 var state$8 = [];
@@ -1849,7 +1877,7 @@ function stop$r() {
     reset$g();
 }
 
-function offset (element) {
+function offset(element) {
     var output = { x: 0, y: 0 };
     // Walk up the chain to ensure we compute offset distance correctly
     // In case where we may have nested IFRAMEs, we keep walking up until we get to the top most parent page
@@ -1922,6 +1950,18 @@ function handler$2(event, root, evt) {
         schedule$1(encode$3.bind(this, event));
     }
 }
+function link(node) {
+    while (node && node !== document) {
+        if (node.nodeType === Node.ELEMENT_NODE) {
+            var element = node;
+            if (element.tagName === "A") {
+                return element;
+            }
+        }
+        node = node.parentNode;
+    }
+    return null;
+}
 function text(element) {
     var output = null;
     if (element) {
@@ -2561,7 +2601,7 @@ function processNode (node, source) {
                 case "HEAD":
                     var head = { tag: tag, attributes: attributes };
                     var l = insideFrame && ((_a = node.ownerDocument) === null || _a === void 0 ? void 0 : _a.location) ? node.ownerDocument.location : location;
-                    head.attributes["*B" /* Constant.Base */] = l.protocol + "//" + l.hostname + l.pathname;
+                    head.attributes["*B" /* Constant.Base */] = l.protocol + "//" + l.host + l.pathname;
                     dom[call](node, parent, head, source);
                     break;
                 case "BASE":
@@ -2571,7 +2611,7 @@ function processNode (node, source) {
                         // We create "a" element so we can generate protocol and hostname for relative paths like "/path/"
                         var a = document.createElement("a");
                         a.href = attributes["href"];
-                        baseHead.data.attributes["*B" /* Constant.Base */] = a.protocol + "//" + a.hostname + a.pathname;
+                        baseHead.data.attributes["*B" /* Constant.Base */] = a.protocol + "//" + a.host + a.pathname;
                     }
                     break;
                 case "STYLE":
@@ -2659,7 +2699,7 @@ function getAttributes(element) {
 
 function traverse (root, timer, source) {
     return __awaiter(this, void 0, void 0, function () {
-        var queue, node, next, state, subnode;
+        var queue, entry, next, state, subnode;
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
@@ -2667,8 +2707,8 @@ function traverse (root, timer, source) {
                     _a.label = 1;
                 case 1:
                     if (!(queue.length > 0)) return [3 /*break*/, 4];
-                    node = queue.shift();
-                    next = node.firstChild;
+                    entry = queue.shift();
+                    next = entry.firstChild;
                     while (next) {
                         queue.push(next);
                         next = next.nextSibling;
@@ -2683,7 +2723,7 @@ function traverse (root, timer, source) {
                     if (state === 2 /* Task.Stop */) {
                         return [3 /*break*/, 4];
                     }
-                    subnode = processNode(node, source);
+                    subnode = processNode(entry, source);
                     if (subnode) {
                         queue.push(subnode);
                     }
@@ -2866,7 +2906,7 @@ function process$1() {
                     _b.sent();
                     return [3 /*break*/, 1];
                 case 8:
-                    stop$t(timer);
+                    stop$u(timer);
                     return [2 /*return*/];
             }
         });
@@ -2998,18 +3038,6 @@ function target(evt) {
     active$2(); // Mark active periods of time so mutations can continue uninterrupted
     return node.nodeType === Node.DOCUMENT_NODE ? node.documentElement : node;
 }
-function link(node) {
-    while (node && node !== document) {
-        if (node.nodeType === Node.ELEMENT_NODE) {
-            var element = node;
-            if (element.tagName === "A") {
-                return element;
-            }
-        }
-        node = node.parentNode;
-    }
-    return null;
-}
 function metadata$2(node, event, text) {
     if (text === void 0) { text = null; }
     // If the node is null, we return a reserved value for id: 0. Valid assignment of id begins from 1+.
@@ -3068,7 +3096,7 @@ function encode$3 (type, ts) {
                         entry = _c[_b];
                         cTarget = metadata$2(entry.data.target, entry.event, entry.data.text);
                         tokens = [entry.time, entry.event];
-                        cHash = cTarget.hash.join("." /* Constant.Dot */);
+                        cHash = cTarget.hash ? cTarget.hash.join("." /* Constant.Dot */) : "" /* Constant.Empty */;
                         tokens.push(cTarget.id);
                         tokens.push(entry.data.x);
                         tokens.push(entry.data.y);
@@ -3288,6 +3316,7 @@ function queue(tokens, transmit) {
                 discoverBytes += event_1.length;
             case 37 /* Event.Box */:
             case 6 /* Event.Mutation */:
+            case 43 /* Event.Snapshot */:
                 playbackBytes += event_1.length;
                 playback.push(event_1);
                 break;
@@ -3383,7 +3412,7 @@ function send(payload, zipped, sequence, beacon) {
     if (beacon === void 0) { beacon = false; }
     // Upload data if a valid URL is defined in the config
     if (typeof config$1.upload === "string" /* Constant.String */) {
-        var url = config$1.upload;
+        var url_1 = config$1.upload;
         var dispatched = false;
         // If it's the last payload, attempt to upload using sendBeacon first.
         // The advantage to using sendBeacon is that browser can decide to upload asynchronously, improving chances of success
@@ -3392,7 +3421,7 @@ function send(payload, zipped, sequence, beacon) {
         if (beacon && "sendBeacon" in navigator) {
             try {
                 // Navigator needs to be bound to sendBeacon before it is used to avoid errors in some browsers
-                dispatched = navigator.sendBeacon.bind(navigator)(url, payload);
+                dispatched = navigator.sendBeacon.bind(navigator)(url_1, payload);
                 if (dispatched) {
                     done(sequence);
                 }
@@ -3414,7 +3443,9 @@ function send(payload, zipped, sequence, beacon) {
                 transit[sequence] = { data: payload, attempts: 1 };
             }
             var xhr_1 = new XMLHttpRequest();
-            xhr_1.open("POST", url);
+            xhr_1.open("POST", url_1, true);
+            xhr_1.timeout = 15000 /* Setting.UploadTimeout */;
+            xhr_1.ontimeout = function () { report(new Error("".concat("Timeout" /* Constant.Timeout */, " : ").concat(url_1))); };
             if (sequence !== null) {
                 xhr_1.onreadystatechange = function () { measure(check$3)(xhr_1, sequence); };
             }
@@ -4259,7 +4290,7 @@ function report(e) {
             // Using POST request instead of a GET request (img-src) to not violate existing CSP rules
             // Since, Clarity already uses XHR to upload data, we stick with similar POST mechanism for reporting too
             var xhr = new XMLHttpRequest();
-            xhr.open("POST", url);
+            xhr.open("POST", url, true);
             xhr.send(JSON.stringify(payload));
             history$1.push(e.message);
         }
@@ -4381,7 +4412,7 @@ function stop$5() {
     reset$2();
     reset$1();
     reset$j();
-    stop$C();
+    stop$D();
     status = false;
 }
 function active() {
@@ -4470,7 +4501,7 @@ function discover() {
                     return [4 /*yield*/, encode$4(5 /* Event.Discover */, timer, ts)];
                 case 2:
                     _a.sent();
-                    stop$t(timer);
+                    stop$u(timer);
                     return [2 /*return*/];
             }
         });
@@ -4488,9 +4519,9 @@ function start$3() {
 }
 function stop$3() {
     stop$s();
-    stop$u();
+    stop$v();
     stop$f();
-    end();
+    stop$t();
 }
 
 var layout = /*#__PURE__*/Object.freeze({
@@ -4659,7 +4690,7 @@ function stop$2() {
 function host(url) {
     var a = document.createElement("a");
     a.href = url;
-    return a.hostname;
+    return a.host;
 }
 
 function start$1() {
@@ -4715,7 +4746,7 @@ function stop() {
     if (active()) {
         // Stop modules in the reverse order of their initialization and start queuing up items again
         modules.slice().reverse().forEach(function (x) { return measure(x.stop)(); });
-        stop$v();
+        stop$w();
         stop$5();
         setup();
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clarity-js",
-  "version": "0.7.4",
+  "version": "0.7.6",
   "description": "An analytics library that uses web page interactions to generate aggregated insights",
   "author": "Microsoft Corp.",
   "license": "MIT",

package/rollup.config.ts

@@ -46,11 +46,11 @@ export default [
     plugins: [
       alias({
         entries: [
-          { find: '@src/interaction/change', replacement: '@src/core/blank' },
-          { find: '@src/interaction/clipboard', replacement: '@src/core/blank' },
-          { find: '@src/interaction/input', replacement: '@src/core/blank' },
-          { find: '@src/interaction/pointer', replacement: '@src/core/blank' },
-          { find: '@src/interaction/selection', replacement: '@src/core/blank' }          
+          { find: '@src/layout/document', replacement: '@src/layout/document' },
+          { find: '@src/layout/encode', replacement: '@src/insight/encode' },
+          { find: /@src\/interaction\/(change|clipboard|input|pointer|selection)/, replacement: '@src/insight/blank' },
+          { find: /@src\/layout.*/, replacement: '@src/insight/snapshot' },
+          { find: /@src\/performance.*/, replacement: '@src/insight/blank' }
         ]
       }),
       resolve(),

package/src/core/report.ts

@@ -19,7 +19,7 @@ export function report(e: Error): Error {
             // Using POST request instead of a GET request (img-src) to not violate existing CSP rules
             // Since, Clarity already uses XHR to upload data, we stick with similar POST mechanism for reporting too
             let xhr = new XMLHttpRequest();
-            xhr.open("POST", url);
+            xhr.open("POST", url, true);
             xhr.send(JSON.stringify(payload));
             history.push(e.message);
         }

package/src/core/scrub.ts

@@ -30,6 +30,7 @@ export function text(value: string, hint: string, privacy: Privacy, mangle: bool
             case Privacy.TextImage:
                 switch (hint) {
                     case Layout.Constant.TextTag:
+                    case Layout.Constant.DataAttribute:
                         return mangle ? mangleText(value) : mask(value);
                     case "src":
                     case "srcset":
@@ -48,6 +49,7 @@ export function text(value: string, hint: string, privacy: Privacy, mangle: bool
             case Privacy.Exclude:
                 switch (hint) {
                     case Layout.Constant.TextTag:
+                    case Layout.Constant.DataAttribute:
                         return mangle ? mangleText(value) : mask(value);
                     case "value":
                     case "input":
@@ -57,6 +59,25 @@ export function text(value: string, hint: string, privacy: Privacy, mangle: bool
                     case "checksum":
                         return Data.Constant.Empty;
                 }
+                break;
+            case Privacy.Snapshot:
+                switch (hint) {
+                    case Layout.Constant.TextTag:
+                    case Layout.Constant.DataAttribute:
+                        return scrub(value);
+                    case "value":
+                    case "input":
+                    case "click":
+                    case "change":
+                        return Array(Data.Setting.WordLength).join(Data.Constant.Mask);
+                    case "checksum":
+                    case "src":
+                    case "srcset":
+                    case "alt":
+                    case "title":
+                        return Data.Constant.Empty;
+                }
+                break;
         }
     }
     return value;
@@ -83,11 +104,16 @@ function mangleText(value: string): string {
     }
     return value;
 }
-
+ 
 function mask(value: string): string {
     return value.replace(catchallRegex, Data.Constant.Mask);
 }
 
+function scrub(value: string): string {
+    regex(); // Initialize regular expressions
+    return value.replace(letterRegex, Data.Constant.Letter).replace(digitRegex, Data.Constant.Digit);
+}
+
 function mangleToken(value: string): string {
     let length = ((Math.floor(value.length / Data.Setting.WordLength) + 1) * Data.Setting.WordLength);
     let output: string = Layout.Constant.Empty;
@@ -97,14 +123,7 @@ function mangleToken(value: string): string {
     return output;
 }
 
-function redact(value: string): string {
-    let spaceIndex = -1;
-    let gap = 0;
-    let hasDigit = false;
-    let hasEmail = false;
-    let hasWhitespace = false;
-    let array = null;
-
+function regex(): void {
     // Initialize unicode regex, if supported by the browser
     // Reference: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Unicode_Property_Escapes
     if (unicodeRegex && digitRegex === null) {
@@ -114,6 +133,17 @@ function redact(value: string): string {
             currencyRegex = new RegExp("\\p{Sc}", "gu");
         } catch { unicodeRegex = false; }
     }
+}
+
+function redact(value: string): string {
+    let spaceIndex = -1;
+    let gap = 0;
+    let hasDigit = false;
+    let hasEmail = false;
+    let hasWhitespace = false;
+    let array = null;
+    
+    regex(); // Initialize regular expressions
 
     for (let i = 0; i < value.length; i++) {
         let c = value.charCodeAt(i);

package/src/core/version.ts

@@ -1,2 +1,2 @@
-let version = "0.7.4";
+let version = "0.7.6";
 export default version;

package/src/data/upload.ts

@@ -16,6 +16,7 @@ import * as ping from "@src/data/ping";
 import * as timeline from "@src/interaction/timeline";
 import * as region from "@src/layout/region";
 import * as extract from "@src/data/extract";
+import { report } from "@src/core/report";
 
 let discoverBytes: number = 0;
 let playbackBytes: number = 0;
@@ -48,7 +49,8 @@ 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:
                 playbackBytes += event.length;
                 playback.push(event);
                 break;
@@ -169,7 +171,9 @@ function send(payload: string, zipped: Uint8Array, sequence: number, beacon: boo
             // Not all browsers support compression API and the support for it in supported browsers is still experimental
             if (sequence in transit) { transit[sequence].attempts++; } else { transit[sequence] = { data: payload, attempts: 1 }; }
             let xhr = new XMLHttpRequest();
-            xhr.open("POST", url);
+            xhr.open("POST", url, true);
+            xhr.timeout = Setting.UploadTimeout;
+            xhr.ontimeout = () => { report(new Error(`${Constant.Timeout} : ${url}`)) };
             if (sequence !== null) { xhr.onreadystatechange = (): void => { measure(check)(xhr, sequence); }; }
             xhr.withCredentials = true;
             if (zipped) {

package/src/{core → insight}/blank.ts

@@ -4,6 +4,8 @@ export let data = null;
 /* Intentionally blank module with empty code */
 
 export function start(): void {}
-export function observe(): void {}
 export function reset(): void {}
 export function stop(): void {}
+export function log(): void {}
+export function observe(): void {}
+export function compute(): void {}