Reduce verbosity/redundancy of output of new pointerType attribute by…

… confining it only to clicks (and to a MouseDown/MouseUp from a PointerTypes.Pen, as these don't yet have a dedicated PendDown/PenUp)
rrweb-io · Apr 13, 2023 · 2b2bd03 · 2b2bd03
1 parent c6ecd79
commit 2b2bd03
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 76 deletions.
diff --git a/packages/rrweb/src/record/observer.ts b/packages/rrweb/src/record/observer.ts
@@ -270,6 +270,15 @@ function initMouseInteractionObserver({
       }
       if (pointerType !== null) {
         currentPointerType = pointerType;
+        if (
+          (thisEventKey.substring(0, 5) === 'Touch' &&
+            pointerType === PointerTypes.Touch) ||
+          (thisEventKey.substring(0, 5) === 'Mouse' &&
+            pointerType === PointerTypes.Mouse)
+        ) {
+          // don't output redundant info
+          pointerType = null;
+        }
       } else if (MouseInteractions[eventKey] === MouseInteractions.Click) {
         pointerType = currentPointerType;
         currentPointerType = null; // cleanup as we've used it

diff --git a/packages/rrweb/test/__snapshots__/integration.test.ts.snap b/packages/rrweb/test/__snapshots__/integration.test.ts.snap
@@ -1529,17 +1529,15 @@ exports[`record integration tests can record clicks 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 18,
-      \\"pointerType\\": 0
+      \\"id\\": 18
     }
   },
   {
     \\"type\\": 3,
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 18,
-      \\"pointerType\\": 0
+      \\"id\\": 18
     }
   },
   {
@@ -1556,17 +1554,15 @@ exports[`record integration tests can record clicks 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 7,
-      \\"id\\": 18,
-      \\"pointerType\\": 2
+      \\"id\\": 18
     }
   },
   {
     \\"type\\": 3,
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 9,
-      \\"id\\": 18,
-      \\"pointerType\\": 2
+      \\"id\\": 18
     }
   },
   {
@@ -1583,8 +1579,7 @@ exports[`record integration tests can record clicks 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 21,
-      \\"pointerType\\": 0
+      \\"id\\": 21
     }
   },
   {
@@ -1600,8 +1595,7 @@ exports[`record integration tests can record clicks 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 21,
-      \\"pointerType\\": 0
+      \\"id\\": 21
     }
   },
   {
@@ -2135,8 +2129,7 @@ exports[`record integration tests can record form interactions 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -2160,8 +2153,7 @@ exports[`record integration tests can record form interactions 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -2196,8 +2188,7 @@ exports[`record integration tests can record form interactions 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -2221,8 +2212,7 @@ exports[`record integration tests can record form interactions 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -2915,8 +2905,7 @@ exports[`record integration tests can record node mutations 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 26,
-      \\"pointerType\\": 0
+      \\"id\\": 26
     }
   },
   {
@@ -3373,8 +3362,7 @@ exports[`record integration tests can record node mutations 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 70,
-      \\"pointerType\\": 0
+      \\"id\\": 70
     }
   },
   {
@@ -3921,8 +3909,7 @@ exports[`record integration tests can use maskInputOptions to configure which ty
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -3946,8 +3933,7 @@ exports[`record integration tests can use maskInputOptions to configure which ty
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -3982,8 +3968,7 @@ exports[`record integration tests can use maskInputOptions to configure which ty
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -4007,8 +3992,7 @@ exports[`record integration tests can use maskInputOptions to configure which ty
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -4972,8 +4956,7 @@ exports[`record integration tests mutations should work when blocked class is un
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 42,
-      \\"pointerType\\": 0
+      \\"id\\": 42
     }
   },
   {
@@ -4989,8 +4972,7 @@ exports[`record integration tests mutations should work when blocked class is un
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 42,
-      \\"pointerType\\": 0
+      \\"id\\": 42
     }
   },
   {
@@ -5098,8 +5080,7 @@ exports[`record integration tests mutations should work when blocked class is un
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 68,
-      \\"pointerType\\": 0
+      \\"id\\": 68
     }
   },
   {
@@ -5123,8 +5104,7 @@ exports[`record integration tests mutations should work when blocked class is un
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 68,
-      \\"pointerType\\": 0
+      \\"id\\": 68
     }
   },
   {
@@ -5692,8 +5672,7 @@ exports[`record integration tests should mask password value attribute with mask
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 20,
-      \\"pointerType\\": 0
+      \\"id\\": 20
     }
   },
   {
@@ -5717,8 +5696,7 @@ exports[`record integration tests should mask password value attribute with mask
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 20,
-      \\"pointerType\\": 0
+      \\"id\\": 20
     }
   },
   {
@@ -5803,8 +5781,7 @@ exports[`record integration tests should mask password value attribute with mask
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 20,
-      \\"pointerType\\": 0
+      \\"id\\": 20
     }
   },
   {
@@ -5828,8 +5805,7 @@ exports[`record integration tests should mask password value attribute with mask
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 20,
-      \\"pointerType\\": 0
+      \\"id\\": 20
     }
   },
   {
@@ -8537,8 +8513,7 @@ exports[`record integration tests should not record input values if maskAllInput
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -8562,8 +8537,7 @@ exports[`record integration tests should not record input values if maskAllInput
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -8598,8 +8572,7 @@ exports[`record integration tests should not record input values if maskAllInput
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -8623,8 +8596,7 @@ exports[`record integration tests should not record input values if maskAllInput
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -10574,17 +10546,15 @@ exports[`record integration tests should record dynamic CSS changes 1`] = `
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 26,
-      \\"pointerType\\": 0
+      \\"id\\": 26
     }
   },
   {
     \\"type\\": 3,
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 26,
-      \\"pointerType\\": 0
+      \\"id\\": 26
     }
   },
   {
@@ -12255,8 +12225,7 @@ exports[`record integration tests should record input userTriggered values if us
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -12280,8 +12249,7 @@ exports[`record integration tests should record input userTriggered values if us
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 27,
-      \\"pointerType\\": 0
+      \\"id\\": 27
     }
   },
   {
@@ -12318,8 +12286,7 @@ exports[`record integration tests should record input userTriggered values if us
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {
@@ -12343,8 +12310,7 @@ exports[`record integration tests should record input userTriggered values if us
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 37,
-      \\"pointerType\\": 0
+      \\"id\\": 37
     }
   },
   {

diff --git a/packages/rrweb/test/record/__snapshots__/cross-origin-iframes.test.ts.snap b/packages/rrweb/test/record/__snapshots__/cross-origin-iframes.test.ts.snap
@@ -1667,8 +1667,7 @@ exports[`cross origin iframes form.html should map input events correctly 1`] =
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 39,
-      \\"pointerType\\": 0
+      \\"id\\": 39
     }
   },
   {
@@ -1692,8 +1691,7 @@ exports[`cross origin iframes form.html should map input events correctly 1`] =
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 39,
-      \\"pointerType\\": 0
+      \\"id\\": 39
     }
   },
   {
@@ -1728,8 +1726,7 @@ exports[`cross origin iframes form.html should map input events correctly 1`] =
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 1,
-      \\"id\\": 49,
-      \\"pointerType\\": 0
+      \\"id\\": 49
     }
   },
   {
@@ -1753,8 +1750,7 @@ exports[`cross origin iframes form.html should map input events correctly 1`] =
     \\"data\\": {
       \\"source\\": 2,
       \\"type\\": 0,
-      \\"id\\": 49,
-      \\"pointerType\\": 0
+      \\"id\\": 49
     }
   },
   {