Skip to content

feat(replay): Expose rrweb recordCrossOriginIframes under _experiments #14916

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
merged 6 commits into from
Feb 19, 2025
Merged

feat(replay): Expose rrweb recordCrossOriginIframes under _experiments #14916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f4cd9ca
feat(replay): Expose rrweb recordCrossOriginIframes under _experiment…
dgavranic Jan 6, 2025
1aa3c96
Merge branch 'develop' into feature/experiment-cross-origin-iframes-r…
billyvg Feb 14, 2025
578332d
Apply suggestions from code review
billyvg Feb 14, 2025
928c63a
update tests
billyvg Feb 14, 2025
6bb656b
bump size limit
billyvg Feb 14, 2025
8123131
add note about considerations
billyvg Feb 18, 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
2 changes: 1 addition & 1 deletion .size-limit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ module.exports = [
path: 'packages/browser/build/npm/esm/index.js',
import: createImport('init', 'browserTracingIntegration', 'replayIntegration'),
gzip: true,
limit: '68 KB',
limit: '70 KB',
modifyWebpackConfig: function (config) {
const webpack = require('webpack');
const TerserPlugin = require('terser-webpack-plugin');
Expand Down
2 changes: 2 additions & 0 deletions packages/replay-internal/src/integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ export class Replay implements Integration {
// this can happen if the error is frozen or does not allow mutation for other reasons
}
},
// experimental support for recording iframes from different origins
recordCrossOriginIframes: Boolean(_experiments.recordCrossOriginIframes),
};

this._initialOptions = {
Expand Down
5 changes: 5 additions & 0 deletions packages/replay-internal/src/types/replay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,11 @@ export interface ReplayPluginOptions extends ReplayNetworkOptions {
captureExceptions: boolean;
traceInternals: boolean;
continuousCheckout: number;
/**
* Before enabling, please read the security considerations:
* https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/cross-origin-iframes.md#considerations
*/
recordCrossOriginIframes: boolean;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could leave a note here for security concerns and link to https://github.com/rrweb-io/rrweb/blob/master/docs/recipes/cross-origin-iframes.md

autoFlushOnFeedback: boolean;
}>;
}
Expand Down
1 change: 1 addition & 0 deletions packages/replay-internal/src/types/rrweb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ export type RrwebRecordOptions = {
maskTextSelector?: string;
blockSelector?: string;
maskInputOptions?: Record<string, boolean>;
recordCrossOriginIframes?: boolean;
} & Record<string, unknown>;

export interface CanvasManagerInterface {
Expand Down
3 changes: 3 additions & 0 deletions packages/replay-internal/test/integration/rrweb.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ describe('Integration | rrweb', () => {
"maskTextFn": undefined,
"maskTextSelector": ".sentry-mask,[data-sentry-mask]",
"onMutation": [Function],
"recordCrossOriginIframes": false,
"slimDOMOptions": "all",
"unblockSelector": "",
"unmaskTextSelector": "",
Expand Down Expand Up @@ -80,6 +81,7 @@ describe('Integration | rrweb', () => {
"maskTextFn": undefined,
"maskTextSelector": ".sentry-mask,[data-sentry-mask]",
"onMutation": [Function],
"recordCrossOriginIframes": false,
"slimDOMOptions": "all",
"unblockSelector": "",
"unmaskTextSelector": "",
Expand Down Expand Up @@ -131,6 +133,7 @@ describe('Integration | rrweb', () => {
"maskTextFn": undefined,
"maskTextSelector": ".sentry-mask,[data-sentry-mask]",
"onMutation": [Function],
"recordCrossOriginIframes": false,
"sampling": {
"mousemove": false,
},
Expand Down
Loading