ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mydea merged 2 commits into from
Nov 2, 2023
Merged

ref(replay): Use rrweb for slow click detection #9408

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
685d5d8
ref(replay): Use rrweb for slow click detection
mydea Oct 27, 2023
1e2b0b2
add tests
mydea Oct 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions packages/browser-integration-tests/suites/replay/slowClick/error/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
flushMinDelay: 200,
flushMaxDelay: 200,
minReplayDuration: 0,
slowClickTimeout: 3500,
});

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
sampleRate: 1,
replaysSessionSampleRate: 0.0,
replaysOnErrorSampleRate: 1.0,

integrations: [window.Replay],
});
22 changes: 22 additions & 0 deletions packages/browser-integration-tests/suites/replay/slowClick/error/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
</head>
<body>
<button id="buttonError">Trigger error</button>
<button id="buttonErrorMutation">Trigger error</button>

<script>
document.getElementById('buttonError').addEventListener('click', () => {
throw new Error('test error happened');
});

document.getElementById('buttonErrorMutation').addEventListener('click', () => {
document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

throw new Error('test error happened');
});
</script>
</body>
</html>
140 changes: 140 additions & 0 deletions packages/browser-integration-tests/suites/replay/slowClick/error/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
getCustomRecordingEvents,
getReplayEventFromRequest,
shouldSkipReplayTest,
waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
if (shouldSkipReplayTest()) {
sentryTest.skip();
}

await page.route('https://dsn.ingest.sentry.io/**/*', route => {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ id: 'test-id' }),
});
});

const url = await getLocalTestUrl({ testDir: __dirname });

await page.goto(url);

const [req0] = await Promise.all([
waitForReplayRequest(page, (_event, res) => {
const { breadcrumbs } = getCustomRecordingEvents(res);

return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
}),
page.click('#buttonError'),
]);

const { breadcrumbs } = getCustomRecordingEvents(req0);

const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

expect(slowClickBreadcrumbs).toEqual([
{
category: 'ui.slowClickDetected',
type: 'default',
data: {
endReason: 'timeout',
clickCount: 1,
node: {
attributes: {
id: 'buttonError',
},
id: expect.any(Number),
tagName: 'button',
textContent: '******* *****',
},
nodeId: expect.any(Number),
timeAfterClickMs: 3500,
url: 'http://sentry-test.io/index.html',
},
message: 'body > button#buttonError',
timestamp: expect.any(Number),
},
]);
});

sentryTest(
'click that triggers error & mutation is not captured',
async ({ getLocalTestUrl, page, forceFlushReplay }) => {
if (shouldSkipReplayTest()) {
sentryTest.skip();
}

await page.route('https://dsn.ingest.sentry.io/**/*', route => {
return route.fulfill({
status: 200,
contentType: 'application/json',
body: JSON.stringify({ id: 'test-id' }),
});
});

const url = await getLocalTestUrl({ testDir: __dirname });

await page.goto(url);

let slowClickCount = 0;

page.on('response', res => {
const req = res.request();

const event = getReplayEventFromRequest(req);

if (!event) {
return;
}

const { breadcrumbs } = getCustomRecordingEvents(res);

const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
slowClickCount += slowClicks.length;
});

const [req1] = await Promise.all([
waitForReplayRequest(page, (_event, res) => {
const { breadcrumbs } = getCustomRecordingEvents(res);

return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
}),
page.click('#buttonErrorMutation'),
]);

const { breadcrumbs } = getCustomRecordingEvents(req1);

expect(breadcrumbs).toEqual([
{
category: 'ui.click',
data: {
node: {
attributes: {
id: 'buttonErrorMutation',
},
id: expect.any(Number),
tagName: 'button',
textContent: '******* *****',
},
nodeId: expect.any(Number),
},
message: 'body > button#buttonErrorMutation',
timestamp: expect.any(Number),
type: 'default',
},
]);

// Ensure we wait for timeout, to make sure no slow click is created
// Waiting for 3500 + 1s rounding room
await new Promise(resolve => setTimeout(resolve, 4500));
await forceFlushReplay();

expect(slowClickCount).toBe(0);
},
);
18 changes: 17 additions & 1 deletion packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
await forceFlushReplay();

let slowClickCount = 0;

page.on('response', res => {
const { breadcrumbs } = getCustomRecordingEvents(res);

const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
slowClickCount += slowClicks.length;
});

const [req1] = await Promise.all([
waitForReplayRequest(page, (event, res) => {
waitForReplayRequest(page, (_event, res) => {
const { breadcrumbs } = getCustomRecordingEvents(res);

return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
type: 'default',
},
]);

// Ensure we wait for timeout, to make sure no slow click is created
// Waiting for 3500 + 1s rounding room
await new Promise(resolve => setTimeout(resolve, 4500));
await forceFlushReplay();

expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down
114 changes: 78 additions & 36 deletions packages/replay/src/coreHandlers/handleClick.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
RecordingEvent,
ReplayClickDetector,
ReplayContainer,
ReplayMultiClickFrame,
ReplaySlowClickFrame,
SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
type: typeof ReplayEventTypeIncrementalSnapshot;
data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
type: typeof ReplayEventTypeIncrementalSnapshot;
data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

/** Register click detection handlers on mutation or scroll. */
public addListeners(): void {
const mutationHandler = (): void => {
this._lastMutation = nowInSeconds();
};

const scrollHandler = (): void => {
this._lastScroll = nowInSeconds();
};

const cleanupWindowOpen = onWindowOpen(() => {
// Treat window.open as mutation
this._lastMutation = nowInSeconds();
});

const clickHandler = (event: MouseEvent): void => {
if (!event.target) {
return;
}

const node = getClickTargetNode(event);
if (node) {
this._handleMultiClick(node as HTMLElement);
}
};

const obs = new MutationObserver(mutationHandler);

obs.observe(WINDOW.document.documentElement, {
attributes: true,
characterData: true,
childList: true,
subtree: true,
});

WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
WINDOW.addEventListener('click', clickHandler, { passive: true });

this._teardown = () => {
WINDOW.removeEventListener('scroll', scrollHandler);
WINDOW.removeEventListener('click', clickHandler);
cleanupWindowOpen();

obs.disconnect();
this._clicks = [];
this._lastMutation = 0;
this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
}
}

/** Handle a click */
/** @inheritDoc */
public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
}
}

/** @inheritDoc */
public registerMutation(timestamp = Date.now()): void {
this._lastMutation = timestampToS(timestamp);
}

/** @inheritDoc */
public registerScroll(timestamp = Date.now()): void {
this._lastScroll = timestampToS(timestamp);
}

/** @inheritDoc */
public registerClick(element: HTMLElement): void {
const node = getClosestInteractive(element);
this._handleMultiClick(node as HTMLElement);
}

/** Count multiple clicks on elements. */
private _handleMultiClick(node: HTMLElement): void {
this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
try {
// note: We only consider incremental snapshots here
// This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
// E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
// in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
// Instead, by ignoring full snapshots, we have the risk that we generate a false positive
// (if a mutation _did_ happen but was "swallowed" by the full snapshot)
// But this should be more unlikely as we'd generally capture the incremental snapshot right away

if (!isIncrementalEvent(event)) {
return;
}

const { source } = event.data;
if (source === IncrementalSource.Mutation) {
clickDetector.registerMutation(event.timestamp);
}

if (source === IncrementalSource.Scroll) {
clickDetector.registerScroll(event.timestamp);
}

if (isIncrementalMouseInteraction(event)) {
const { type, id } = event.data;
const node = record.mirror.getNode(id);

if (node instanceof HTMLElement && type === MouseInteractions.Click) {
clickDetector.registerClick(node);
}
}
} catch {
// ignore errors here, e.g. if accessing something that does not exist
}
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
return event.data.source === IncrementalSource.MouseInteraction;
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
ref(replay): Use rrweb for slow click detection#9408

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 2 commits into

from

Nov 2, 2023
 Merged


ref(replay): Use rrweb for slow click detection
#9408
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


2 commits


Select commit
Hold shift + click to select a range
685d5d8

ref(replay): Use rrweb for slow click detection


mydea Oct 27, 2023
1e2b0b2

add tests


mydea Oct 31, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


18 changes: 18 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = new Sentry.Replay({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 minReplayDuration: 0,
 slowClickTimeout: 3500,
});

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 sampleRate: 1,
 replaysSessionSampleRate: 0.0,
 replaysOnErrorSampleRate: 1.0,

 integrations: [window.Replay],
});

22 changes: 22 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
<!DOCTYPE html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="buttonError">Trigger error</button>
 <button id="buttonErrorMutation">Trigger error</button>

 <script>
 document.getElementById('buttonError').addEventListener('click', () => {
 throw new Error('test error happened');
 });

 document.getElementById('buttonErrorMutation').addEventListener('click', () => {
 document.getElementById('buttonErrorMutation').innerText = 'Test error happened!';

 throw new Error('test error happened');
 });
 </script>
 </body>
</html>

140 changes: 140 additions & 0 deletions
packages/browser-integration-tests/suites/replay/slowClick/error/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../../utils/fixtures';
import {
 getCustomRecordingEvents,
 getReplayEventFromRequest,
 shouldSkipReplayTest,
 waitForReplayRequest,
} from '../../../../utils/replayHelpers';

sentryTest('slow click that triggers error is captured', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 const [req0] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 }),
 page.click('#buttonError'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req0);

 const slowClickBreadcrumbs = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');

 expect(slowClickBreadcrumbs).toEqual([
 {
 category: 'ui.slowClickDetected',
 type: 'default',
 data: {
 endReason: 'timeout',
 clickCount: 1,
 node: {
 attributes: {
 id: 'buttonError',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 timeAfterClickMs: 3500,
 url: 'http://sentry-test.io/index.html',
 },
 message: 'body > button#buttonError',
 timestamp: expect.any(Number),
 },
 ]);
});

sentryTest(
 'click that triggers error & mutation is not captured',
 async ({ getLocalTestUrl, page, forceFlushReplay }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 await page.route('https://dsn.ingest.sentry.io/**/*', route => {
 return route.fulfill({
 status: 200,
 contentType: 'application/json',
 body: JSON.stringify({ id: 'test-id' }),
 });
 });

 const url = await getLocalTestUrl({ testDir: __dirname });

 await page.goto(url);

 let slowClickCount = 0;

 page.on('response', res => {
 const req = res.request();

 const event = getReplayEventFromRequest(req);

 if (!event) {
 return;
 }

 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
 }),
 page.click('#buttonErrorMutation'),
 ]);

 const { breadcrumbs } = getCustomRecordingEvents(req1);

 expect(breadcrumbs).toEqual([
 {
 category: 'ui.click',
 data: {
 node: {
 attributes: {
 id: 'buttonErrorMutation',
 },
 id: expect.any(Number),
 tagName: 'button',
 textContent: '******* *****',
 },
 nodeId: expect.any(Number),
 },
 message: 'body > button#buttonErrorMutation',
 timestamp: expect.any(Number),
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
 },
);

18 changes: 17 additions & 1 deletion
packages/browser-integration-tests/suites/replay/slowClick/mutation/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -141,8 +141,17 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 await Promise.all([waitForReplayRequest(page, 0), page.goto(url)]);
 await forceFlushReplay();

 let slowClickCount = 0;

 page.on('response', res => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 const slowClicks = breadcrumbs.filter(breadcrumb => breadcrumb.category === 'ui.slowClickDetected');
 slowClickCount += slowClicks.length;
 });

 const [req1] = await Promise.all([
 waitForReplayRequest(page, (event, res) => {
 waitForReplayRequest(page, (_event, res) => {
 const { breadcrumbs } = getCustomRecordingEvents(res);

 return breadcrumbs.some(breadcrumb => breadcrumb.category === 'ui.click');
Expand DownExpand Up@@ -171,6 +180,13 @@ sentryTest('immediate mutation does not trigger slow click', async ({ forceFlush
 type: 'default',
 },
 ]);

 // Ensure we wait for timeout, to make sure no slow click is created
 // Waiting for 3500 + 1s rounding room
 await new Promise(resolve => setTimeout(resolve, 4500));
 await forceFlushReplay();

 expect(slowClickCount).toBe(0);
});

sentryTest('inline click handler does not trigger slow click', async ({ forceFlushReplay, getLocalTestUrl, page }) => {
Expand Down

114 changes: 78 additions & 36 deletions
packages/replay/src/coreHandlers/handleClick.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
import { IncrementalSource, MouseInteractions, record } from '@sentry-internal/rrweb';
import type { Breadcrumb } from '@sentry/types';

import { WINDOW } from '../constants';
import type {
 RecordingEvent,
 ReplayClickDetector,
 ReplayContainer,
 ReplayMultiClickFrame,
 ReplaySlowClickFrame,
 SlowClickConfig,
} from '../types';
import { ReplayEventTypeIncrementalSnapshot } from '../types';
import { timestampToS } from '../util/timestamp';
import { addBreadcrumbEvent } from './util/addBreadcrumbEvent';
import { getClickTargetNode } from './util/domUtils';
import { getClosestInteractive } from './util/domUtils';
import { onWindowOpen } from './util/onWindowOpen';

type ClickBreadcrumb = Breadcrumb & {
Expand All@@ -26,6 +29,16 @@ interface Click {
 node: HTMLElement;
}

type IncrementalRecordingEvent = RecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { source: IncrementalSource };
};

type IncrementalMouseInteractionRecordingEvent = IncrementalRecordingEvent & {
 type: typeof ReplayEventTypeIncrementalSnapshot;
 data: { type: MouseInteractions; id: number };
};

/** Handle a click. */
export function handleClick(clickDetector: ReplayClickDetector, clickBreadcrumb: Breadcrumb, node: HTMLElement): void {
 clickDetector.handleClick(clickBreadcrumb, node);
Expand DownExpand Up@@ -70,48 +83,14 @@ export class ClickDetector implements ReplayClickDetector {

 /** Register click detection handlers on mutation or scroll. */
 public addListeners(): void {
 const mutationHandler = (): void => {
 this._lastMutation = nowInSeconds();
 };

 const scrollHandler = (): void => {
 this._lastScroll = nowInSeconds();
 };

 const cleanupWindowOpen = onWindowOpen(() => {
 // Treat window.open as mutation
 this._lastMutation = nowInSeconds();
 });

 const clickHandler = (event: MouseEvent): void => {
 if (!event.target) {
 return;
 }

 const node = getClickTargetNode(event);
 if (node) {
 this._handleMultiClick(node as HTMLElement);
 }
 };

 const obs = new MutationObserver(mutationHandler);

 obs.observe(WINDOW.document.documentElement, {
 attributes: true,
 characterData: true,
 childList: true,
 subtree: true,
 });

 WINDOW.addEventListener('scroll', scrollHandler, { passive: true });
 WINDOW.addEventListener('click', clickHandler, { passive: true });

 this._teardown = () => {
 WINDOW.removeEventListener('scroll', scrollHandler);
 WINDOW.removeEventListener('click', clickHandler);
 cleanupWindowOpen();

 obs.disconnect();
 this._clicks = [];
 this._lastMutation = 0;
 this._lastScroll = 0;
Expand All@@ -129,7 +108,7 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** Handle a click */
 /** @inheritDoc */
 public handleClick(breadcrumb: Breadcrumb, node: HTMLElement): void {
 if (ignoreElement(node, this._ignoreSelector) || !isClickBreadcrumb(breadcrumb)) {
 return;
Expand DownExpand Up@@ -158,6 +137,22 @@ export class ClickDetector implements ReplayClickDetector {
 }
 }

 /** @inheritDoc */
 public registerMutation(timestamp = Date.now()): void {
 this._lastMutation = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerScroll(timestamp = Date.now()): void {
 this._lastScroll = timestampToS(timestamp);
 }

 /** @inheritDoc */
 public registerClick(element: HTMLElement): void {
 const node = getClosestInteractive(element);
 this._handleMultiClick(node as HTMLElement);
 }

 /** Count multiple clicks on elements. */
 private _handleMultiClick(node: HTMLElement): void {
 this._getClicks(node).forEach(click => {
Expand DownExpand Up@@ -311,3 +306,50 @@ function isClickBreadcrumb(breadcrumb: Breadcrumb): breadcrumb is ClickBreadcrum
function nowInSeconds(): number {
 return Date.now() / 1000;
}

/** Update the click detector based on a recording event of rrweb. */
export function updateClickDetectorForRecordingEvent(clickDetector: ReplayClickDetector, event: RecordingEvent): void {
 try {
 // note: We only consider incremental snapshots here
 // This means that any full snapshot is ignored for mutation detection - the reason is that we simply cannot know if a mutation happened here.
 // E.g. think that we are buffering, an error happens and we take a full snapshot because we switched to session mode -
 // in this scenario, we would not know if a dead click happened because of the error, which is a key dead click scenario.
 // Instead, by ignoring full snapshots, we have the risk that we generate a false positive
 // (if a mutation _did_ happen but was "swallowed" by the full snapshot)
 // But this should be more unlikely as we'd generally capture the incremental snapshot right away

 if (!isIncrementalEvent(event)) {
 return;
 }

 const { source } = event.data;
 if (source === IncrementalSource.Mutation) {
 clickDetector.registerMutation(event.timestamp);
 }

 if (source === IncrementalSource.Scroll) {
 clickDetector.registerScroll(event.timestamp);
 }

 if (isIncrementalMouseInteraction(event)) {
 const { type, id } = event.data;
 const node = record.mirror.getNode(id);

 if (node instanceof HTMLElement && type === MouseInteractions.Click) {
 clickDetector.registerClick(node);
 }
 }
 } catch {
 // ignore errors here, e.g. if accessing something that does not exist
 }
}

function isIncrementalEvent(event: RecordingEvent): event is IncrementalRecordingEvent {
 return event.type === ReplayEventTypeIncrementalSnapshot;
}

function isIncrementalMouseInteraction(
 event: IncrementalRecordingEvent,
): event is IncrementalMouseInteractionRecordingEvent {
 return event.data.source === IncrementalSource.MouseInteraction;
}
Loading