clarity-js 0.6.36 → 0.6.37

package/package.json

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

package/src/core/version.ts

@@ -1,2 +1,2 @@
-let version = "0.6.36";
+let version = "0.6.37";
 export default version;

package/src/layout/dom.ts

@@ -97,6 +97,7 @@ export function add(node: Node, parent: Node, data: NodeInfo, source: Source): v
         regionId = regionId === null ? parentValue.region : regionId;
         fragmentId = parentValue.fragment;
         fraudId = fraudId === null ? parentValue.metadata.fraud : fraudId;
+        privacyId = parentValue.metadata.privacy;
     }
 
     // If there's an explicit region attribute set on the element, use it to mark a region on the page

package/test/core.test.ts

@@ -1,4 +1,4 @@
-import { expect } from 'chai';
+import { assert } from 'chai';
 import { Browser, Page } from 'playwright';
 import { launch, markup, node, text } from './helper';
 import { Data, decode } from "clarity-decode";
@@ -33,15 +33,15 @@ describe('Core Tests', () => {
         let email = node(decoded, "attributes.id", "eml");
         let password = node(decoded, "attributes.id", "pwd");
         let search = node(decoded, "attributes.id", "search");
-
+        
         // Non-sensitive fields continue to pass through with sensitive bits masked off
-        expect(heading, "Thanks for your order •••••••••");
+        assert.equal(heading, "Thanks for your order •••••••••");
 
         // Sensitive fields, including input fields, are randomized and masked
-        expect(address, "•••••• ••••• ••••• ••••• ••••• •••••");
-        expect(email.attributes.value, "••••• •••• •••• ••••");
-        expect(password.attributes.value, "••••• ••••");
-        expect(search.attributes.value, "••••• •••• ••••");
+        assert.equal(address, "•••••• ••••• ••••• ••••• ••••• •••••");
+        assert.equal(email.attributes.value, "••••• •••• •••• ••••");
+        assert.equal(password.attributes.value, "••••• ••••");
+        assert.equal(search.attributes.value, "hello •••••");
     });
 
     it('should mask all text in strict mode', async () => {
@@ -54,14 +54,14 @@ describe('Core Tests', () => {
         let search = node(decoded, "attributes.id", "search");
 
         // All fields are randomized and masked
-        expect(heading, "• ••••• ••••• ••••• ••••• •••••");
-        expect(address, "•••••• ••••• ••••• ••••• ••••• •••••");
-        expect(email.attributes.value, "••••• •••• •••• ••••");
-        expect(password.attributes.value, "••••• ••••");
-        expect(search.attributes.value, "••••• •••• ••••");
+        assert.equal(heading, "• ••••• ••••• ••••• ••••• •••••");
+        assert.equal(address, "•••••• ••••• ••••• ••••• ••••• •••••");
+        assert.equal(email.attributes.value, "••••• •••• •••• ••••");
+        assert.equal(password.attributes.value, "••••• ••••");
+        assert.equal(search.attributes.value, "••••• •••• ••••");
     });
 
-    it('should mask all text in relaxed mode', async () => {
+    it('should unmask all 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");
@@ -71,12 +71,21 @@ describe('Core Tests', () => {
         let search = node(decoded, "attributes.id", "search");
 
         // Text flows through unmasked for non-sensitive fields, including input fields
-        expect(heading, "Thanks for your order #2AB700GH");
-        expect(address, "1 Microsoft Way, Redmond, WA - 98052");
-        expect(search.attributes.value, "hello world");
+        assert.equal(heading, "Thanks for your order #2AB700GH");
+        assert.equal(address, "1 Microsoft Way, Redmond, WA - 98052");
+        assert.equal(search.attributes.value, "hello w0rld");
 
         // Sensitive fields are still masked
-        expect(email.attributes.value, "••••• •••• •••• ••••");
-        expect(password.attributes.value, "••••• ••••");
+        assert.equal(email.attributes.value, "••••• •••• •••• ••••");
+        assert.equal(password.attributes.value, "••••• ••••");
+    });
+
+    it('should respect mask config even in relaxed mode', async () => {
+        let encoded: string[] = await markup(page, "core.html", { mask: ["#mask"], unmask: ["body"] });
+        let decoded = encoded.map(x => decode(x));
+        let subtree = text(decoded, "child");
+        
+        // Masked sub-trees continue to stay masked
+        assert.equal(subtree, "••••• •••••");
     });
 });

package/test/helper.ts

@@ -78,6 +78,10 @@ function config(override: Core.Config): string {
     const settings = {
         delay: 100,
         content: true,
+        fraud: [],
+        regions: [],
+        mask: [],
+        unmask: [],
         upload: payload => { window["payloads"].push(payload); window["clarity"]("upgrade", "test"); }
     }
 
@@ -100,6 +104,7 @@ function config(override: Core.Config): string {
             case "unmask":
             case "regions":
             case "cookies":
+            case "fraud":
                 output += `${JSON.stringify(key)}: ${JSON.stringify(settings[key])},`;
                 break;
             default:

package/test/html/core.html

@@ -8,10 +8,13 @@
     <h1 id="one">Thanks for your order #2AB700GH</h1>
     <p id="two" class="address-details">1 Microsoft Way, Redmond, WA - 98052</p>
   </div>
+  <div id="mask">
+    <span id="child">Hello World</span>
+  </div>
   <form name="login">
     <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 world">
+    <input type="search" id="search" title="Search" value="hello w0rld">
   </form>
 </body>
 </html>