feat: Export `getCanvasManager` & allow passing it to `record()` by mydea · Pull Request #122 · getsentry/rrweb

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea · 2023-10-25T11:10:29Z

This PR exports a new getCanvasManager() method which can be used to dynamically pass a canvas manager, allowing tree shaking.

This also removes the __RRWEB_EXCLUDE_CANVAS__ build flag - canvas will always be excluded now by default.

Expected usage:

import{record,getCanvasManager}from'@sentry-internal/canvas';record({// other config...
getCanvasManager,});

The idea is that we can expose this somehow (?) from replay, so users can do e.g.:

import{Replay,getReplayCanvasManager}from'@sentry/browser';Sentry.init({integrations: [newReplay({canvasManager: getReplayCanvasManager()})]});

Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

billyvg

Can we make this default? (e.g. get rid of build flag?)

mydea · 2023-10-27T08:14:51Z

Can we make this default? (e.g. get rid of build flag?)

Yeah, I guess that makes sense here! 👍

github-actions · 2023-10-27T08:18:43Z

size-limit report 📦

Path	Size
rrweb - record only (gzipped)	16.6 KB (-26.27% 🔽)
rrweb - record only (min)	57.17 KB (-27.45% 🔽)
rrweb - record with treeshaking flags (gzipped)	15.35 KB (+0.22% 🔺)
rrweb - record & getCanvasManager only (gzipped)	22.54 KB (added)

Apply formatting changes

mydea · 2023-10-27T11:51:53Z

OK, I fixed the tests, seems good now. I ended up changing it so that you have to pass in a getCanvasManager method instead of the instance, which is a slightly "worse" API, but easier to implement because we need access to some of the parsed options from record, which we don't easily have otherwise 😬

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124)

- feat: Export getCanvasManager & allow passing it to record() [#122](getsentry/rrweb#122) - feat: Remove hooks related code, which is not used [#126](getsentry/rrweb#126) - feat: Remove plugins related code, which is not used [#123](getsentry/rrweb#123) - feat: Refactor module scope vars & export mirror & `takeFullSnapshot` directly [#113](getsentry/rrweb#113) - fix(rrweb): Fix rule.style being undefined [#121](getsentry/rrweb#121) - ref: Avoid unnecessary cloning of objects or arrays [#125](getsentry/rrweb#125) - ref: Avoid cloning events to add timestamp [#124](getsentry/rrweb#124) Note: With this update, canvas is _always_ excluded, unless we opt in by passing a `getCanvasManager` function to `record()`. We'll provide a way to do this once we have a fully formed canvas story. For now, this will reduce bundle size considerably for all SDK users.

This PR exports a new `getCanvasManager()` method which can be used to dynamically pass a canvas manager, allowing tree shaking. This also removes the `__RRWEB_EXCLUDE_CANVAS__` build flag - canvas will _always_ be excluded now by default. Expected usage: ```js import { record, getCanvasManager } from '@sentry-internal/canvas'; record({ // other config... getCanvasManager, }); ``` The idea is that we can expose this somehow (?) from replay, so users can do e.g.: ```js import { Replay, getReplayCanvasManager } from '@sentry/browser'; Sentry.init({ integrations: [ new Replay({ canvasManager: getReplayCanvasManager() }) ] }); ``` Or something like this, allowing people to opt-in to canvas recording at runtime, vs requiring a specific build step for it.

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

mydea requested a review from billyvg October 25, 2023 11:10

mydea self-assigned this Oct 25, 2023

billyvg reviewed Oct 25, 2023
View reviewed changes

mydea force-pushed the fn/custom-exports branch 2 times, most recently from 39ceb88 to c22a3e8Compare October 27, 2023 08:01

Base automatically changed from fn/custom-exports to sentry-v2October 27, 2023 08:10

mydea force-pushed the fn/export-canvas-manager branch from e7e0bc7 to 8352f64Compare October 27, 2023 08:14

mydea marked this pull request as ready for review October 27, 2023 08:14

mydea force-pushed the fn/export-canvas-manager branch from 3c1d07d to a77e2b9Compare October 27, 2023 08:53

mydea added 3 commits October 27, 2023 13:35

feat: Export getCanvasManager & allow passing it to record()
da099c7

exclude canvas by default (remove __RRWEB_EXCLUDE_CANVAS__)
21d07c7

fix tests
1f9f488

mydea force-pushed the fn/export-canvas-manager branch from 0c4a6cd to f757a63Compare October 27, 2023 11:35

ref to pass getCanvasManager directly to record
5c9398f
Apply formatting changes

mydea force-pushed the fn/export-canvas-manager branch from 968a2fc to 5c9398fCompare October 27, 2023 11:40

mydea requested a review from billyvg October 30, 2023 08:45

billyvg approved these changes Oct 30, 2023
View reviewed changes

mydea merged commit 850a14b into sentry-v2Oct 30, 2023

mydea deleted the fn/export-canvas-manager branch October 30, 2023 14:57

mydea mentioned this pull request Oct 31, 2023
feat(replay): Update rrweb to 2.2.0 getsentry/sentry-javascript#9414
Merged

Uh oh!

Conversation

mydea commented Oct 25, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

billyvg left a comment

Choose a reason for hiding this comment

Uh oh!

mydea commented Oct 27, 2023

Uh oh!

github-actionsBot commented Oct 27, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

mydea commented Oct 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mydea commented Oct 25, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

billyvg left a comment

Choose a reason for hiding this comment

Uh oh!

mydea commented Oct 27, 2023

Uh oh!

github-actionsBot commented Oct 27, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

mydea commented Oct 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mydea commented Oct 25, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

billyvg left a comment

Choose a reason for hiding this comment

Uh oh!

mydea commented Oct 27, 2023

Uh oh!

github-actionsBot commented Oct 27, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

mydea commented Oct 27, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mydea commented Oct 25, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

billyvg left a comment

Choose a reason for hiding this comment

Uh oh!

mydea commented Oct 25, 2023•
edited
Loading

github-actionsBot commented Oct 27, 2023•
edited
Loading

mydea commented Oct 25, 2023•
edited
Loading

github-actionsBot commented Oct 27, 2023•
edited
Loading

mydea commented Oct 25, 2023•
edited
Loading

github-actionsBot commented Oct 27, 2023•
edited
Loading

mydea commented Oct 25, 2023•
edited
Loading

github-actionsBot commented Oct 27, 2023•
edited
Loading

mydea commented Oct 25, 2023•
edited
Loading

github-actionsBot commented Oct 27, 2023•
edited
Loading