Improvements to test documentation; with Justin's help for better com…

…prehension of why we are doing things this way
eoghanmurray · Dec 1, 2023 · 302f855 · 302f855
1 parent e9b0318
commit 302f855
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/packages/rrweb-snapshot/test/snapshot.test.ts b/packages/rrweb-snapshot/test/snapshot.test.ts
@@ -245,6 +245,10 @@ describe('form', () => {
   it('should record textarea values once', () => {
     const el = render(`<textarea>Lorem ipsum</textarea>`);
     const sel = serializeNode(el) as elementNode;
+
+    // we serialize according to where the DOM stores the value, not how
+    // the HTML stores it (this is so that maskInputValue can work over
+    // inputs/textareas/selects in a uniform way)
     expect(sel).toMatchObject({
       attributes: {
         value: 'Lorem ipsum',

diff --git a/packages/rrweb/test/events/bad-textarea.ts b/packages/rrweb/test/events/bad-textarea.ts
@@ -54,12 +54,12 @@ const events: eventWithTime[] = [
                     type: 2,
                     tagName: 'textarea',
                     attributes: {
-                      value: 'dupe',
+                      value: 'this value is used for replay',
                     },
                     childNodes: [
                       {
                         type: 3,
-                        textContent: 'dupe should ignore',
+                        textContent: 'this value is IGNORED for replay (but was present as a duplicte in legacy recordings)',
                         id: 7,
                       },
                     ],

diff --git a/packages/rrweb/test/replayer.test.ts b/packages/rrweb/test/replayer.test.ts
@@ -1106,6 +1106,6 @@ describe('replayer', function () {
     `);
     // If the custom element is not defined, the display value will be 'none'.
     // If the custom element is defined, the display value will be 'block'.
-    expect(displayValue).toEqual('dupe');
+    expect(displayValue).toEqual('this value is used for replay');
   });
 });