feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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
chargome merged 4 commits into from
Feb 11, 2025
Merged

feat(replay/feedback): Add experimental autoFlushOnFeedback option #15356

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bc9f29a
flush replay on api capture
chargome Feb 10, 2025
02b2070
add experimental autoflush on feedback
chargome Feb 10, 2025
e5ce59e
biome
chargome Feb 10, 2025
7cb2c82
add integration test
chargome Feb 10, 2025
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
20 changes: 20 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
import * as Sentry from '@sentry/browser';

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
flushMinDelay: 200,
flushMaxDelay: 200,
useCompression: false,
_experiments: {
autoFlushOnFeedback: true,
},
});

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

integrations: [window.Replay],
});
9 changes: 9 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
import * as Sentry from '@sentry/browser';

document.getElementById('open').addEventListener('click', () => {
Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
Sentry.getClient().emit('beforeSendFeedback');
});
11 changes: 11 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
</head>
<body>
<button id="send">Send feedback</button>
<button id="open">Open feedback</button>
<button id="something">Something</button>
</body>
</html>
46 changes: 46 additions & 0 deletions dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
import { expect } from '@playwright/test';

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
* In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
* We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
* buffered replay events, rather than waiting for the normal flush delay.
*/
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
if (shouldSkipReplayTest()) {
sentryTest.skip();
}

const reqPromise0 = waitForReplayRequest(page, 0);
const reqPromise1 = waitForReplayRequest(page, 1);
const reqPromise2 = waitForReplayRequest(page, 2);

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

await page.goto(url);
const replayEvent0 = getReplayEvent(await reqPromise0);
expect(replayEvent0).toEqual(getExpectedReplayEvent());

// Trigger one mouse click
void page.locator('#something').click();

// Open the feedback widget which should trigger an immediate flush
await page.locator('#open').click();

// This should be flushed immediately due to feedback widget being opened
const replayEvent1 = getReplayEvent(await reqPromise1);
expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

// trigger another click
void page.locator('#something').click();

// Send feedback via API which should trigger another immediate flush
await page.locator('#send').click();

// This should be flushed immediately due to feedback being sent
const replayEvent2 = getReplayEvent(await reqPromise2);
expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});
10 changes: 10 additions & 0 deletions packages/core/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
): () => void;

/**
* Register a callback when the feedback widget is opened in a user's browser
*/
public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

/**
* A hook for the browser tracing integrations to trigger a span start for a page load.
* @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
*/
public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

/**
* Fire a hook event for when the feedback widget is opened in a user's browser
*/
public emit(hook: 'openFeedbackWidget'): void;

/**
* Emit a hook event for browser tracing integrations to trigger a span start for a page load.
*/
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/types-hoist/feedback/sendFeedback.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
replay_id?: string;
url?: string;
associated_event_id?: string;
source?: string;
}

/**
Expand Down
3 changes: 2 additions & 1 deletion packages/feedback/src/modal/integration.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
open() {
renderContent(true);
options.onFormOpen?.();
getClient()?.emit('openFeedbackWidget');
originalOverflow = DOCUMENT.body.style.overflow;
DOCUMENT.body.style.overflow = 'hidden';
},
Expand Down
2 changes: 1 addition & 1 deletion packages/replay-internal/src/replay.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

// There is no way to remove these listeners, so ensure they are only added once
if (!this._hasInitializedCoreListeners) {
addGlobalListeners(this);
addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

this._hasInitializedCoreListeners = true;
}
Expand Down
1 change: 1 addition & 0 deletions packages/replay-internal/src/types/replay.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
captureExceptions: boolean;
traceInternals: boolean;
continuousCheckout: number;
autoFlushOnFeedback: boolean;
}>;
}

Expand Down
24 changes: 17 additions & 7 deletions packages/replay-internal/src/util/addGlobalListeners.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
* Add global listeners that cannot be removed.
*/
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
replay: ReplayContainer,
{ autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
// Listeners from core SDK //
const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
replay.lastActiveSpan = span;
});

// We want to flush replay
client.on('beforeSendFeedback', (feedbackEvent, options) => {
// We want to attach the replay id to the feedback event
client.on('beforeSendFeedback', async (feedbackEvent, options) => {
const replayId = replay.getSessionId();
if (options?.includeReplay && replay.isEnabled() && replayId) {
// This should never reject
if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
// In case the feedback is sent via API and not through our widget, we want to flush replay
if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
}
feedbackEvent.contexts.feedback.replay_id = replayId;
}
});

if (autoFlushOnFeedback) {
client.on('openFeedbackWidget', async () => {
await replay.flush();
});
}
}
}
, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}

, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}

, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}

, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}

, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}

, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}

, '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
feat(replay/feedback): Add experimental autoFlushOnFeedback option#15356

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

chargome
merged 4 commits into

from

Feb 11, 2025
 Merged


feat(replay/feedback): Add experimental autoFlushOnFeedback option
#15356
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
bc9f29a

flush replay on api capture


chargome Feb 10, 2025
02b2070

add experimental autoflush on feedback


chargome Feb 10, 2025
e5ce59e

biome


chargome Feb 10, 2025
7cb2c82

add integration test


chargome Feb 10, 2025

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


20 changes: 20 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/init.js

View file


Open in desktop

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

window.Sentry = Sentry;
window.Replay = Sentry.replayIntegration({
 flushMinDelay: 200,
 flushMaxDelay: 200,
 useCompression: false,
 _experiments: {
 autoFlushOnFeedback: true,
 },
});

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

 integrations: [window.Replay],
});

9 changes: 9 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/subject.js

View file


Open in desktop

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

document.getElementById('open').addEventListener('click', () => {
 Sentry.getClient().emit('openFeedbackWidget');
});

document.getElementById('send').addEventListener('click', () => {
 Sentry.getClient().emit('beforeSendFeedback');
});

11 changes: 11 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
<!doctype html>
<html>
 <head>
 <meta charset="utf-8" />
 </head>
 <body>
 <button id="send">Send feedback</button>
 <button id="open">Open feedback</button>
 <button id="something">Something</button>
 </body>
</html>

46 changes: 46 additions & 0 deletions
dev-packages/browser-integration-tests/suites/replay/autoFlushOnFeedback/test.ts

View file


Open in desktop

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

import { sentryTest } from '../../../utils/fixtures';
import { getExpectedReplayEvent } from '../../../utils/replayEventTemplates';
import { getReplayEvent, shouldSkipReplayTest, waitForReplayRequest } from '../../../utils/replayHelpers';

/*
 * In this test we want to verify that replay events are automatically flushed when user feedback is submitted via API / opening the widget.
 * We emulate this by firing the feedback events directly, which should trigger an immediate flush of any
 * buffered replay events, rather than waiting for the normal flush delay.
 */
sentryTest('replay events are flushed automatically on feedback events', async ({ getLocalTestUrl, page }) => {
 if (shouldSkipReplayTest()) {
 sentryTest.skip();
 }

 const reqPromise0 = waitForReplayRequest(page, 0);
 const reqPromise1 = waitForReplayRequest(page, 1);
 const reqPromise2 = waitForReplayRequest(page, 2);

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

 await page.goto(url);
 const replayEvent0 = getReplayEvent(await reqPromise0);
 expect(replayEvent0).toEqual(getExpectedReplayEvent());

 // Trigger one mouse click
 void page.locator('#something').click();

 // Open the feedback widget which should trigger an immediate flush
 await page.locator('#open').click();

 // This should be flushed immediately due to feedback widget being opened
 const replayEvent1 = getReplayEvent(await reqPromise1);
 expect(replayEvent1).toEqual(getExpectedReplayEvent({ segment_id: 1, urls: [] }));

 // trigger another click
 void page.locator('#something').click();

 // Send feedback via API which should trigger another immediate flush
 await page.locator('#send').click();

 // This should be flushed immediately due to feedback being sent
 const replayEvent2 = getReplayEvent(await reqPromise2);
 expect(replayEvent2).toEqual(getExpectedReplayEvent({ segment_id: 2, urls: [] }));
});

10 changes: 10 additions & 0 deletions
packages/core/src/client.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -561,6 +561,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 callback: (feedback: FeedbackEvent, options?: { includeReplay?: boolean }) => void,
 ): () => void;

 /**
 * Register a callback when the feedback widget is opened in a user's browser
 */
 public on(hook: 'openFeedbackWidget', callback: () => void): () => void;

 /**
 * A hook for the browser tracing integrations to trigger a span start for a page load.
 * @returns {() => void} A function that, when executed, removes the registered callback.
Expand DownExpand Up@@ -695,6 +700,11 @@ export abstract class Client<O extends ClientOptions = ClientOptions> {
 */
 public emit(hook: 'beforeSendFeedback', feedback: FeedbackEvent, options?: { includeReplay?: boolean }): void;

 /**
 * Fire a hook event for when the feedback widget is opened in a user's browser
 */
 public emit(hook: 'openFeedbackWidget'): void;

 /**
 * Emit a hook event for browser tracing integrations to trigger a span start for a page load.
 */
Expand Down

1 change: 1 addition & 0 deletions
packages/core/src/types-hoist/feedback/sendFeedback.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,6 +19,7 @@ interface FeedbackContext extends Record<string, unknown> {
 replay_id?: string;
 url?: string;
 associated_event_id?: string;
 source?: string;
}

/**
Expand Down

3 changes: 2 additions & 1 deletion
packages/feedback/src/modal/integration.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
import type { FeedbackFormData, FeedbackModalIntegration, IntegrationFn, User } from '@sentry/core';
import { h, render } from 'preact';
import * as hooks from 'preact/hooks';
Expand DownExpand Up@@ -51,6 +51,7 @@ export const feedbackModalIntegration = ((): FeedbackModalIntegration => {
 open() {
 renderContent(true);
 options.onFormOpen?.();
 getClient()?.emit('openFeedbackWidget');
 originalOverflow = DOCUMENT.body.style.overflow;
 DOCUMENT.body.style.overflow = 'hidden';
 },
Expand Down

2 changes: 1 addition & 1 deletion
packages/replay-internal/src/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -933,7 +933,7 @@ export class ReplayContainer implements ReplayContainerInterface {

 // There is no way to remove these listeners, so ensure they are only added once
 if (!this._hasInitializedCoreListeners) {
 addGlobalListeners(this);
 addGlobalListeners(this, { autoFlushOnFeedback: this._options._experiments.autoFlushOnFeedback });

 this._hasInitializedCoreListeners = true;
 }
Expand Down

1 change: 1 addition & 0 deletions
packages/replay-internal/src/types/replay.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -239,6 +239,7 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
 captureExceptions: boolean;
 traceInternals: boolean;
 continuousCheckout: number;
 autoFlushOnFeedback: boolean;
 }>;
}

Expand Down

24 changes: 17 additions & 7 deletions
packages/replay-internal/src/util/addGlobalListeners.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,10 @@ import type { ReplayContainer } from '../types';
/**
 * Add global listeners that cannot be removed.
 */
export function addGlobalListeners(replay: ReplayContainer): void {
export function addGlobalListeners(
 replay: ReplayContainer,
 { autoFlushOnFeedback }: { autoFlushOnFeedback?: boolean },
): void {
 // Listeners from core SDK //
 const client = getClient();

Expand DownExpand Up@@ -57,15 +60,22 @@ export function addGlobalListeners(replay: ReplayContainer): void {
 replay.lastActiveSpan = span;
 });

 // We want to flush replay
 client.on('beforeSendFeedback', (feedbackEvent, options) => {
 // We want to attach the replay id to the feedback event
 client.on('beforeSendFeedback', async (feedbackEvent, options) => {
 const replayId = replay.getSessionId();
 if (options?.includeReplay && replay.isEnabled() && replayId) {
 // This should never reject
 if (feedbackEvent.contexts?.feedback) {
feedbackEvent.contexts.feedback.replay_id = replayId;
 if (options?.includeReplay && replay.isEnabled() && replayId && feedbackEvent.contexts?.feedback) {
 // In case the feedback is sent via API and not through our widget, we want to flush replay
 if (feedbackEvent.contexts.feedback.source === 'api' && autoFlushOnFeedback) {
await replay.flush();
 }
 feedbackEvent.contexts.feedback.replay_id = replayId;
 }
 });

 if (autoFlushOnFeedback) {
 client.on('openFeedbackWidget', async () => {
 await replay.flush();
 });
 }
 }
}