rrweb คืออะไร ไลบรารีที่อยู่เบื้องหลัง Session Replay

rrweb เป็นไลบรารี JavaScript แบบ open source ที่แปลงหน้าเว็บเป็นข้อมูล จดทุกการเปลี่ยนแปลงเป็น event ที่มีเวลากำกับ แล้วประกอบหน้าเว็บกลับขึ้นมาใน iframe ตอนเล่น เครื่องมือ Session Replay อย่าง PostHog และ Sentry ใช้เป็นแกน

เผยแพร่
เวลาอ่าน
5 นาที
แท็ก
#Frontend#Tools
ในโพสต์นี้ 8 หัวข้อ
  1. rrweb แยกงานเป็นสามส่วน
  2. แปลง DOM ทั้งหน้าเป็นข้อมูลก้อนเดียว
  3. ทุกอย่างหลังจากนั้นเป็น event ที่มีเวลากำกับ
  4. ตัวบันทึกรวมการเปลี่ยนแปลงเป็นชุดก่อนจด
  5. ตัวเล่นประกอบหน้าเว็บกลับใน iframe
  6. ลองใช้ rrweb เองในไม่กี่บรรทัด
  7. ค่าเริ่มต้นของ rrweb ซ่อนแค่ช่องรหัสผ่าน
  8. สิ่งที่ rrweb ไม่บันทึกโดยค่าเริ่มต้น

ในโพสต์ Session Replay คืออะไร เราเห็นแล้วว่าเครื่องมือส่วนใหญ่เก็บโครงหน้าเว็บกับสิ่งที่เปลี่ยนไปแทนการอัดวิดีโอ โพสต์นี้ลงไปดูไลบรารีที่ทำงานส่วนนั้นจริง ๆ คือ rrweb ว่าแปลงหน้าเว็บเป็นข้อมูลยังไง ข้อมูลหน้าตาแบบไหน และตอนเล่นย้อนหลังประกอบหน้าเว็บกลับมาได้ยังไง

rrweb เป็น open source แบบ MIT มีคนกดดาวบน GitHub ราว 20,000 ดวง README ของโปรเจกต์เองระบุว่า PostHog, Sentry, Datadog, Mixpanel และ New Relic อยู่ในรายชื่อผู้ใช้ ถ้าเคยเปิด replay ในเครื่องมือเหล่านี้ เบื้องหลังก็มักเป็น rrweb

rrweb แยกงานเป็นสามส่วน

แพ็กเกจ หน้าที่
rrweb-snapshot แปลง DOM เป็นข้อมูลที่เก็บได้ และสร้าง DOM กลับจากข้อมูลนั้น
@rrweb/record ตัวบันทึก เก็บ snapshot แรก แล้วจดทุกการเปลี่ยนแปลงต่อจากนั้น
@rrweb/replay ตัวเล่น ประกอบหน้าเว็บจาก snapshot แล้วใส่ event ตามเวลา
rrweb-player หน้าจอเล่นสำเร็จรูป มีปุ่มหยุด เร่งความเร็ว และแถบเลื่อนเวลา

แพ็กเกจชื่อ rrweb ตัวเดิมยังใช้ได้ แต่คู่มือของ rrweb ระบุว่า deprecated แล้ว โปรเจกต์ใหม่ให้ใช้ @rrweb/record กับ @rrweb/replay แยกกัน หน้าที่บันทึกจะได้โหลดแค่ตัวบันทึก

แปลง DOM ทั้งหน้าเป็นข้อมูลก้อนเดียว

ขั้นแรกของการบันทึกคือ full snapshot rrweb-snapshot เดินไปทุก node ในหน้า ทั้ง element, ข้อความ และ comment แล้วแปลงเป็น object ที่แปลงเป็น JSON ได้ ทุก node ได้ id ประจำตัว เช่น ปุ่มบันทึกหนึ่งปุ่มจะออกมาประมาณนี้

{
  "type": 2,
  "tagName": "button",
  "attributes": { "class": "btn btn-primary" },
  "childNodes": [
    { "type": 3, "textContent": "บันทึก", "id": 43 }
  ],
  "id": 42
}

type ตรงนี้คือชนิดของ node (2 คือ element, 3 คือข้อความ) ส่วน id คือหัวใจของ rrweb ทั้งฝั่งบันทึกและฝั่งเล่นเก็บตารางจับคู่ id กับ node ที่ตรงกันไว้ตลอด rrweb เรียกตารางนี้ว่า mirror ทุก event หลังจากนี้จึงอ้างแค่ "node 42" ไม่ต้องเก็บ element ซ้ำ

ตอนแปลง rrweb ปรับข้อมูลบางอย่างไปด้วย หน้าจะได้เล่นซ้ำได้อย่างปลอดภัยและหน้าตาถูกต้อง

  • แทน <script> ด้วย <noscript> เก็บผลที่ script ทำกับหน้าแทนตัวโค้ด
  • เปลี่ยน URL แบบ relative เป็น absolute ทั้งใน attribute และใน CSS เพราะตอนเล่น หน้าเว็บอยู่ใน iframe คนละที่อยู่กับต้นฉบับ
  • อ่าน stylesheet ภายนอกมาเก็บเป็น CSS ในตัว หน้าเล่นย้อนหลังจะได้หน้าตาเหมือนตอนนั้น
  • เก็บค่าในช่องกรอกเป็น attribute value ซึ่งเป็นเหตุผลที่ต้องตั้งเรื่องซ่อนข้อมูลให้ดี (ดูหัวข้อท้าย ๆ)

ทุกอย่างหลังจากนั้นเป็น event ที่มีเวลากำกับ

ผลของการบันทึกคือ array ของ event เรียงตามเวลา แต่ละตัวมี type, data และ timestamp ชนิดของ event ที่เจอบ่อยมีไม่กี่ตัว

type ชื่อ เก็บอะไร
4 Meta URL และขนาดหน้าต่าง
2 FullSnapshot DOM ทั้งหน้าแบบในหัวข้อก่อน
3 IncrementalSnapshot สิ่งที่เปลี่ยนหลังจากนั้น
5 Custom event ที่เราใส่เอง เช่น error หรือจุดที่อยากจดไว้

IncrementalSnapshot แยกย่อยด้วย data.source อีกชั้น เช่น 0 คือ DOM เปลี่ยน (mutation), 1 คือเมาส์ขยับ, 2 คือการคลิกหรือ focus, 3 คือเลื่อนหน้า, 4 คือเปลี่ยนขนาดหน้าต่าง และ 5 คือการพิมพ์ในช่องกรอก การคลิกปุ่มในตัวอย่างข้างบนจึงหน้าตาแบบนี้

{
  "type": 3,
  "data": { "source": 2, "type": 2, "id": 42, "x": 310, "y": 188 },
  "timestamp": 1763366400000
}

อ่านได้ว่า "ณ เวลานี้ มีการคลิก (type: 2 ใน source 2) ที่ node 42 ตรงพิกัดนี้" ไม่มีภาพหน้าจอสักเฟรม ไฟล์จึงเล็กและบีบอัดได้ดี

ตัวบันทึกรวมการเปลี่ยนแปลงเป็นชุดก่อนจด

rrweb ใช้ MutationObserver ซึ่งเป็น API ของ browser ที่แจ้งการเปลี่ยนแปลงของ DOM มาเป็นชุด ตามเอกสารของ rrweb ตัวบันทึกจะเก็บ node ที่เพิ่มเข้ามาทั้งหมดในชุดนั้นก่อน ตัดตัวซ้ำออก แล้วค่อยแปลงเป็นข้อมูลตอนท้าย ถ้า node ไหนเพิ่มเข้ามาแล้วหายไปในชุดเดียวกัน ตัวบันทึกก็ข้ามไปเลย ส่วน attribute ที่เปลี่ยนหลายรอบก็จดแค่ค่าสุดท้าย ผลที่ได้คือ event หนึ่งตัวที่บอกว่ามี node ไหนเพิ่ม ลบ เปลี่ยนข้อความ หรือเปลี่ยน attribute

เหตุการณ์อื่นก็มีวิธีคุมปริมาณข้อมูลเหมือนกัน

  • เมาส์ขยับ จดตำแหน่งอย่างมากทุก 20 มิลลิวินาที และส่งออกเป็นชุดอย่างมากทุก 500 มิลลิวินาที
  • การพิมพ์ ฟัง event input กับ change ของ browser ส่วนค่าที่ JavaScript ใส่ให้ช่องกรอกเอง (ซึ่ง browser ไม่แจ้ง event) rrweb ดักไว้ที่ property setter ของช่องนั้นแทน

ตัวเล่นประกอบหน้าเว็บกลับใน iframe

ตอนเล่น Replayer สร้าง iframe ขึ้นมา สร้าง DOM จาก full snapshot ลงไปทั้งหน้า แล้วใส่ incremental event ทีละตัวตามเวลา โดยใช้ตาราง mirror หาว่า event นี้หมายถึง node ไหน

  • JavaScript ของหน้าเดิมไม่รันเลย iframe ตั้ง sandbox ไว้ ปุ่มที่เห็นใน replay จึงไม่ยิง request ไปที่ไหนอีก
  • เวลาเดินด้วย requestAnimationFrame แทน setTimeout ที่คลาดเคลื่อนได้ เอกสารบอกว่าส่วนใหญ่ช้าไม่เกินหนึ่งเฟรม ตัวจับเวลาเดียวกันนี้ทำให้เร่งความเร็วและกระโดดไปเวลาไหนก็ได้
  • hover จำลองด้วย class CSS ที่เขียนด้วย :hover จึงยังแสดงผลใน replay ได้
  • ข้ามช่วงที่ผู้ใช้ไม่ได้ทำอะไร ได้ด้วย option skipInactive

ลองใช้ rrweb เองในไม่กี่บรรทัด

ตัวบันทึกมี option บังคับตัวเดียวคือ emit ซึ่ง rrweb เรียกทุกครั้งที่มี event ใหม่ ที่เหลือเป็นเรื่องของเราว่าจะเก็บ event ไว้ที่ไหน ตัวอย่างนี้รวมไว้แล้วส่งขึ้น server ทุก 5 วินาที

import { record } from '@rrweb/record';

let events = [];

record({
  emit(event) {
    events.push(event);
  },
  maskAllInputs: true,
  checkoutEveryNms: 5 * 60 * 1000,
});

setInterval(() => {
  if (events.length === 0) {
    return;
  }

  fetch('/replay', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(events),
  });

  events = [];
}, 5000);

checkoutEveryNms สั่งให้เก็บ full snapshot ใหม่ทุก 5 นาที ตัวเล่นจะได้เริ่มจาก snapshot ล่าสุดก่อนเวลาที่อยากดู ไม่ต้องไล่ใส่ event ตั้งแต่ต้น session ที่ยาวเป็นชั่วโมง ส่วนของจริงบน production ควรบีบอัดก่อนส่ง และจำกัดขนาดที่ server รับด้วย

ค่าเริ่มต้นของ rrweb ซ่อนแค่ช่องรหัสผ่าน

เรื่องนี้ต่างจากเครื่องมือสำเร็จรูป ค่าเริ่มต้นของ rrweb ซ่อนเฉพาะ input[type="password"] ส่วน maskAllInputs เป็น false ถ้าใช้ rrweb ตรง ๆ แล้วไม่ตั้ง ค่าที่ผู้ใช้พิมพ์ในช่องอื่นจะไปอยู่ใน event ทั้งหมด Sentry จึงเปิดการซ่อนข้อความ ช่องกรอก และรูปภาพไว้ให้ตั้งแต่ต้น

ถ้าทำเอง ส่วนที่ต้องตั้งมีประมาณนี้

ตั้งที่ ผล
maskAllInputs: true ค่าในทุกช่องกรอกกลายเป็น *
class rr-mask หรือ maskTextSelector ข้อความใน element นั้นกลายเป็น * แต่ขนาดเท่าเดิม
class rr-block หรือ blockSelector ไม่บันทึก element นั้นเลย เล่นเป็นกล่องว่างขนาดเท่าเดิม
class rr-ignore ไม่จดการพิมพ์ในช่องนั้น

สิ่งที่ rrweb ไม่บันทึกโดยค่าเริ่มต้น

  • canvas กราฟหรือลายเซ็นที่วาดด้วย canvas ต้องเปิด recordCanvas เอง และฝั่งเล่นต้องเปิด UNSAFE_replayCanvas ซึ่งยอมให้ iframe รัน script ได้ ลดความปลอดภัยของ sandbox ลง
  • iframe ข้ามโดเมน เช่น หน้าชำระเงินที่ฝังมาจาก payment gateway ต้องเปิด recordCrossOriginIframes และฝัง rrweb ไว้ในหน้าลูกทุกหน้าด้วย ซึ่งปกติเราทำไม่ได้กับหน้าของคนอื่น
  • browser รุ่นเก่ามาก อย่าง IE11 ใช้ไม่ได้ เพราะไม่มี MutationObserver

ถ้าอยากได้ Session Replay ที่ใช้ได้เลยโดยไม่ต้องเขียนส่วนเก็บข้อมูลกับหน้าดูย้อนหลังเอง ลองดูเครื่องมือที่สรุปไว้ในโพสต์ Session Replay ได้ครับ ส่วนรูปแบบ event ในโพสต์นี้ก็ช่วยตอนต้องเปิดดู payload ของเครื่องมือพวกนั้นเวลาไล่ปัญหา

อ่านต่อ

ถูกอ้างถึงใน

ล่าสุด

ดูทั้งหมด →