Skip to content

feat(record): Allow callbackWrapper to attach a __source__ property to exceptions #111

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

Closed
billyvg wants to merge 2 commits into from
Closed

feat(record): Allow callbackWrapper to attach a __source__ property to exceptions #111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c8c5df
feat(record): Allow `callbackWrapper` to attach a `__source__` proper…
billyvg Oct 12, 2023
dc3eeaf
Apply formatting changes
billyvg Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion packages/rrweb/src/record/error-handler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ export function unregisterErrorHandler() {
/**
* Wrap callbacks in a wrapper that allows to pass errors to a configured `errorHandler` method.
*/
export const callbackWrapper = <T extends Callback>(cb: T): T => {
export const callbackWrapper = <T extends Callback>(
cb: T,
errorSource?: string,
): T => {
if (!errorHandler) {
return cb;
}
Expand All @@ -24,6 +27,13 @@ export const callbackWrapper = <T extends Callback>(cb: T): T => {
try {
return cb(...rest);
} catch (error) {
// Some libraries (styled-components) rely on an exception to be thrown.
// Attach an optional property here to allow `errorHandler` to make
// additional decisions (e.g. to re-throw).
if (errorSource) {
error.__source__ = errorSource;
}
Comment on lines +33 to +35
Copy link
Copy Markdown
Member Author

@billyvg billyvg Oct 12, 2023

Choose a reason for hiding this comment

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

Since this only happens if we have errorHandler defined, this probably only affects us. I opted to make this generic so that errorHandler be the source of truth vs attaching a meta property like __allowThrow__


if (errorHandler && errorHandler(error) === true) {
return () => {
// This will get called by `record()`'s cleanup function
Expand Down
2 changes: 2 additions & 0 deletions packages/rrweb/src/record/observer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -724,6 +724,7 @@ function initStyleSheetObserver(
}
return target.apply(thisArg, argumentsList);
},
'CSSStyleSheet.insertRule',
),
});

Expand Down Expand Up @@ -891,6 +892,7 @@ function initStyleSheetObserver(
}
return target.apply(thisArg, argumentsList);
},
'CSSStyleSheet.insertRule',
),
},
);
Expand Down