clarity-js 0.6.40 → 0.6.42

package/package.json

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

package/src/core/config.ts

@@ -15,7 +15,8 @@ let config: Config = {
     report: null,
     upload: null,
     fallback: null,
-    upgrade: null
+    upgrade: null,
+    action: null
 };
 
 export default config;

package/src/core/version.ts

@@ -1,2 +1,2 @@
-let version = "0.6.40";
+let version = "0.6.42";
 export default version;

package/src/data/upload.ts

@@ -242,8 +242,8 @@ function delay(): number {
 }
 
 function response(payload: string): void {
-    let key = payload && payload.length > 0 ? payload.split(" ")[0] : Constant.Empty;
-    switch (key) {
+    let parts = payload && payload.length > 0 ? payload.split(" ") : [Constant.Empty];
+    switch (parts[0]) {
         case Constant.End:
             // Clear out session storage and end the session so we can start fresh the next time
             limit.trigger(Check.Server);
@@ -252,5 +252,9 @@ function response(payload: string): void {
             // Upgrade current session to send back playback information
             clarity.upgrade(Constant.Auto);
             break;
+        case Constant.Action:
+            // Invoke action callback, if configured and has a valid value
+            if (config.action && parts.length > 1) { config.action(parts[1]); }
+            break;
     }
 }

package/src/layout/dom.ts

@@ -92,8 +92,7 @@ export function add(node: Node, parent: Node, data: NodeInfo, source: Source): v
     let regionId = region.exists(node) ? id : null;
     let fragmentId = null;
     let fraudId = fraudMap.has(node) ? fraudMap.get(node) : null;
-    let privacyId = config.content ? Privacy.Sensitive : Privacy.Text
-
+    let privacyId = config.content ? Privacy.Sensitive : Privacy.TextImage
     if (parentId >= 0 && values[parentId]) {
         parentValue = values[parentId];
         parentValue.children.push(id);
@@ -243,21 +242,19 @@ function privacy(node: Node, value: NodeValue, parent: NodeValue): void {
             let tags : string[] = [Constant.StyleTag, Constant.TitleTag, Constant.SvgStyle];
             metadata.privacy = tags.includes(pTag) || override.some(x => pSelector.indexOf(x) >= 0) ? Privacy.None : current;
             break;
-        case Constant.Type in attributes:
-            // If this node has an explicit type assigned to it, go through masking rules to determine right privacy setting
-            metadata.privacy  = inspect(attributes[Constant.Type], maskInput, metadata);
-            break;
         case tag === Constant.InputTag && current === Privacy.None:
             // If even default privacy setting is to not mask, we still scan through input fields for any sensitive information
             let field: string = Constant.Empty;
             Object.keys(attributes).forEach(x => field += attributes[x].toLowerCase());
             metadata.privacy = inspect(field, maskInput, metadata);
             break;
-        case current === Privacy.Sensitive && tag === Constant.InputTag:
+        case tag === Constant.InputTag && current === Privacy.Sensitive:
             // Look through class names to aggressively mask content
             metadata.privacy = inspect(attributes[Constant.Class], maskText, metadata);
-            // If it's a button or an input option, make an exception to disable masking
-            metadata.privacy = maskDisable.indexOf(attributes[Constant.Type]) >= 0 ? Privacy.None : current;
+            // If this node has an explicit type assigned to it, go through masking rules to determine right privacy setting
+            metadata.privacy  = inspect(attributes[Constant.Type], maskInput, metadata);
+            // If it's a button or an input option, make an exception to disable masking in sensitive mode
+            metadata.privacy = maskDisable.indexOf(attributes[Constant.Type]) >= 0 ? Privacy.None : metadata.privacy;
             break;
         case current === Privacy.Sensitive:
             // In a mode where we mask sensitive information by default, look through class names to aggressively mask content

package/test/core.test.ts

@@ -33,21 +33,23 @@ describe('Core Tests', () => {
         let email = node(decoded, "attributes.id", "eml");
         let password = node(decoded, "attributes.id", "pwd");
         let search = node(decoded, "attributes.id", "search");
+        let card = node(decoded, "attributes.id", "cardnum");
         let click = clicks(decoded)[0];
         let input = inputs(decoded)[0];
         
         // Non-sensitive fields continue to pass through with sensitive bits masked off
-        assert.equal(heading, "Thanks for your order #••••••••");
+        assert.equal(heading, "Thanks for your order #▫▪▪▫▫▫▪▪");
 
         // Sensitive fields, including input fields, are randomized and masked
         assert.equal(address, "•••••• ••••• ••••• ••••• ••••• •••••");
         assert.equal(email.attributes.value, "••••• •••• •••• ••••");
         assert.equal(password.attributes.value, "••••• ••••");
-        assert.equal(search.attributes.value, "hello •••••");
+        assert.equal(search.attributes.value, "hello ▪▫▪▪▪");
+        assert.equal(card.attributes.value, "▫▫▫▫");
 
         // Clicked text and input value should be consistent with uber masking configuration
-        assert.equal(click.data.text, "Hello •••••");
-        assert.equal(input.data.value, "query with •••••••");
+        assert.equal(click.data.text, "Hello ▪▪▪▫▪");
+        assert.equal(input.data.value, "query with ▪▪▪▪▫▪▪");
     });
 
     it('should mask all text in strict mode', async () => {
@@ -58,6 +60,7 @@ describe('Core Tests', () => {
         let email = node(decoded, "attributes.id", "eml");
         let password = node(decoded, "attributes.id", "pwd");
         let search = node(decoded, "attributes.id", "search");
+        let card = node(decoded, "attributes.id", "cardnum");
         let click = clicks(decoded)[0];
         let input = inputs(decoded)[0];
 
@@ -67,13 +70,14 @@ describe('Core Tests', () => {
         assert.equal(email.attributes.value, "••••• •••• •••• ••••");
         assert.equal(password.attributes.value, "••••• ••••");
         assert.equal(search.attributes.value, "••••• •••• ••••");
+        assert.equal(card.attributes.value, "•••••");
 
         // Clicked text and input value should also be masked in strict mode
         assert.equal(click.data.text, "••••• •••• ••••");
         assert.equal(input.data.value, "••••• •••• •••• ••••");
     });
 
-    it('should unmask all text in relaxed mode', async () => {
+    it('should unmask non-sensitive text in relaxed mode', async () => {
         let encoded: string[] = await markup(page, "core.html", { unmask: ["body"] });
         let decoded = encoded.map(x => decode(x));
         let heading = text(decoded, "one");
@@ -81,6 +85,7 @@ describe('Core Tests', () => {
         let email = node(decoded, "attributes.id", "eml");
         let password = node(decoded, "attributes.id", "pwd");
         let search = node(decoded, "attributes.id", "search");
+        let card = node(decoded, "attributes.id", "cardnum");
         let click = clicks(decoded)[0];
         let input = inputs(decoded)[0];
 
@@ -92,6 +97,7 @@ describe('Core Tests', () => {
         // Sensitive fields are still masked
         assert.equal(email.attributes.value, "••••• •••• •••• ••••");
         assert.equal(password.attributes.value, "••••• ••••");
+        assert.equal(card.attributes.value, "•••••");
 
         // Clicked text and input value (non-sensitive) both come through without masking in relaxed mode
         assert.equal(click.data.text, "Hello Wor1d");

package/test/html/core.html

@@ -15,6 +15,7 @@
     <input type="email" id="eml" title="Email" value="random@email.test">
     <input type="password" id="pwd" title="Password" maxlength="16" value="passw0rd">
     <input type="search" id="search" title="Search" value="hello w0rld">
+    <input type="text" id="cardnum" title="CC" value="1234">
   </form>
 </body>
 </html>

package/types/core.d.ts

@@ -133,6 +133,7 @@ export interface Config {
     upload?: string | UploadCallback;
     fallback?: string;
     upgrade?: (key: string) => void;
+    action?: (key: string) => void;
 }
 
 export const enum Constant {

package/types/data.d.ts

@@ -244,12 +244,13 @@ export const enum Constant {
     Pipe = "|",
     End = "END",
     Upgrade = "UPGRADE",
+    Action = "ACTION",
     UserId = "userId",
     SessionId = "sessionId",
     PageId = "pageId",
     Mask = "•", // Placeholder character for explicitly masked content
-    Digit = "•", // Placeholder character for digits
-    Letter = "•", // Placeholder character for letters
+    Digit = "▫", // Placeholder character for digits
+    Letter = "▪", // Placeholder character for letters
     SessionStorage = "sessionStorage",
     Cookie = "cookie",
     Navigation = "navigation",