|
| 1 | +# End of Replay Beta |
| 2 | + |
| 3 | +Sentry Replay is now out of Beta. This means that the usual stability guarantees apply. |
| 4 | + |
| 5 | +Because of experimentation and rapid iteration, during the Beta period some bugs and problems came up which have since been fixed/improved. |
| 6 | +We **strongly** recommend anyone using Replay in a version before 7.39.0 to update to 7.39.0 or newer, in order to prevent running Replay with known problems that have since been fixed. |
| 7 | + |
| 8 | +Below you can find a list of relevant replay issues that have been resolved until 7.39.0: |
| 9 | + |
| 10 | +## New features / improvements |
| 11 | + |
| 12 | +- Remove `autoplay` attribute from audio/video tags ([#59](https://github.com/getsentry/rrweb/pull/59)) |
| 13 | +- Exclude fetching scripts that use `<link rel="modulepreload">` ([#52](https://github.com/getsentry/rrweb/pull/52)) |
| 14 | +- With maskAllText, mask the attributes: placeholder, title, `aria-label` |
| 15 | +- Lower the flush max delay from 15 seconds to 5 seconds (#6761) |
| 16 | +- Stop recording when retry fails (#6765) |
| 17 | +- Stop without retry when receiving bad API response (#6773) |
| 18 | +- Send client_report when replay sending fails (#7093) |
| 19 | +- Stop recording when hitting a rate limit (#7018) |
| 20 | +- Allow Replay to be used in Electron renderers with nodeIntegration enabled (#6644) |
| 21 | +- Do not renew session in error mode (#6948) |
| 22 | +- Remove default sample rates for replay (#6878) |
| 23 | +- Add `flush` method to integration (#6776) |
| 24 | +- Improve compression worker & fallback behavior (#6988, #6936, #6827) |
| 25 | +- Improve error handling (#7087, #7094, #7010, getsentry/rrweb#16, #6856) |
| 26 | +- Add more default block filters (#7233) |
| 27 | + |
| 28 | +## Fixes |
| 29 | + |
| 30 | +- Fix masking inputs on change when `maskAllInputs:false` ([#61](https://github.com/getsentry/rrweb/pull/61)) |
| 31 | +- More robust `rootShadowHost` check ([#50](https://github.com/getsentry/rrweb/pull/50)) |
| 32 | +- Fix duplicated textarea value ([#62](https://github.com/getsentry/rrweb/pull/62)) |
| 33 | +- Handle removed attributes ([#65](https://github.com/getsentry/rrweb/pull/65)) |
| 34 | +- Change LCP calculation (#7187, #7225) |
| 35 | +- Fix debounced flushes not respecting `maxWait` (#7207, #7208) |
| 36 | +- Fix svgs not getting unblocked (#7132) |
| 37 | +- Fix missing fetch/xhr requests (#7134) |
| 38 | +- Fix feature detection of PerformanceObserver (#7029) |
| 39 | +- Fix `checkoutEveryNms` (#6722) |
| 40 | +- Fix incorrect uncompressed recording size due to encoding (#6740) |
| 41 | +- Ensure dropping replays works (#6522) |
| 42 | +- Envelope send should be awaited in try/catch (#6625) |
| 43 | +- Improve handling of `maskAllText` selector (#6637) |
| 44 | + |
| 45 | +# Upgrading Replay from 7.34.0 to 7.35.0 - #6645 |
| 46 | + |
| 47 | +This release will remove the ability to change the default rrweb recording options (outside of privacy options). The following are the new configuration values all replays will use: |
| 48 | +`slimDOMOptions: 'all'` - Removes `script`, comments, `favicon`, whitespace in `head`, and a few `meta` tags in `head` |
| 49 | +`recordCanvas: false` - This option did not do anything as playback of recorded canvas means we would have to remove the playback sandbox (which is a security concern). |
| 50 | +`inlineStylesheet: true` - Inlines styles into the recording itself instead of attempting to fetch it remotely. This means that styles in the replay will reflect the styles at the time of recording and not the current styles of the remote stylesheet. |
| 51 | +`collectFonts: true` - Attempts to load custom fonts. |
| 52 | +`inlineImages: false` - Does not inline images to recording and instead loads the asset remotely. During playback, images may not load due to CORS (add sentry.io as an origin). |
| 53 | + |
| 54 | +Additionally, we have streamlined the privacy options. The following table lists the deprecated value, and what it is replaced by: |
| 55 | + |
| 56 | +| deprecated key | replaced by | description | |
| 57 | +| ---------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | |
| 58 | +| maskInputOptions | mask | Use CSS selectors in `mask` in order to mask all inputs of a certain type. For example, `input[type="address"]` | |
| 59 | +| blockSelector | block | The selector(s) can be moved directly in the `block` array. | |
| 60 | +| blockClass | block | Convert the class name to a CSS selector and add to `block` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | |
| 61 | +| maskClass | mask | Convert the class name to a CSS selector and add to `mask` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | |
| 62 | +| maskSelector | mask | The selector(s) can be moved directly in the `mask` array. | |
| 63 | +| ignoreClass | ignore | Convert the class name to a CSS selector and add to `ignore` array. For example, `first-name` becomes `.first-name`. Regexes can be moved as-is. | |
| 64 | + |
| 65 | +# Upgrading Replay from 7.31.0 to 7.32.0 |
| 66 | + |
| 67 | +In 7.32.0, we have removed the default values for the replay sample rates. |
| 68 | +Previously, they were: |
| 69 | + |
| 70 | +* `replaysSessionSampleRate: 0.1` |
| 71 | +* `replaysOnErrorSampleRate: 1.0` |
| 72 | + |
| 73 | +Now, you have to explicitly set the sample rates, otherwise they default to 0. |
| 74 | + |
| 75 | +# Upgrading Replay from 0.6.x to 7.24.0 |
| 76 | + |
| 77 | +The Sentry Replay integration was moved to the Sentry JavaScript SDK monorepo. Hence we're jumping from version 0.x to the monorepo's 7.x version which is shared across all JS SDK packages. |
| 78 | + |
| 79 | +## Replay sample rates are defined on top level (https://github.com/getsentry/sentry-javascript/issues/6351) |
| 80 | + |
| 81 | +Instead of defining the sample rates on the integration like this: |
| 82 | + |
| 83 | +```js |
| 84 | +Sentry.init({ |
| 85 | + dsn: '__DSN__', |
| 86 | + integrations: [ |
| 87 | + new Replay({ |
| 88 | + sessionSampleRate: 0.1, |
| 89 | + errorSampleRate: 1.0, |
| 90 | + }) |
| 91 | + ], |
| 92 | + // ... |
| 93 | +}); |
| 94 | +``` |
| 95 | + |
| 96 | +They are now defined on the top level of the SDK: |
| 97 | + |
| 98 | +```js |
| 99 | +Sentry.init({ |
| 100 | + dsn: '__DSN__', |
| 101 | + replaysSessionSampleRate: 0.1, |
| 102 | + replaysOnErrorSampleRate: 1.0, |
| 103 | + integrations: [ |
| 104 | + new Replay({ |
| 105 | + // other replay config still goes in here |
| 106 | + }) |
| 107 | + ], |
| 108 | +}); |
| 109 | +``` |
| 110 | + |
| 111 | +Note that the sample rate options inside of `new Replay({})` have been deprecated and will be removed in a future update. |
| 112 | + |
| 113 | +## Removed deprecated options (https://github.com/getsentry/sentry-javascript/pull/6370) |
| 114 | + |
| 115 | +Two options, which have been deprecated for some time, have been removed: |
| 116 | + |
| 117 | +* `replaysSamplingRate` - instead use `sessionSampleRate` |
| 118 | +* `captureOnlyOnError` - instead use `errorSampleRate` |
| 119 | + |
| 120 | +## New NPM package structure (https://github.com/getsentry/sentry-javascript/issues/6280) |
| 121 | + |
| 122 | +The internal structure of the npm package has changed. This is unlikely to affect you, unless you have imported something from e.g.: |
| 123 | + |
| 124 | +```js |
| 125 | +import something from '@sentry/replay/submodule'; |
| 126 | +``` |
| 127 | + |
| 128 | +If you only imported from `@sentry/replay`, this will not affect you. |
| 129 | + |
| 130 | +## Changed type name from `IEventBuffer` to `EventBuffer` (https://github.com/getsentry/sentry-javascript/pull/6416) |
| 131 | + |
| 132 | +It is highly unlikely to affect anybody, but the type `IEventBuffer` was renamed to `EventBuffer` for consistency. |
| 133 | +Unless you manually imported this and used it somewhere in your codebase, this will not affect you. |
| 134 | + |
| 135 | +## Session object is now a plain object (https://github.com/getsentry/sentry-javascript/pull/6417) |
| 136 | + |
| 137 | +The `Session` object exported from Replay is now a plain object, instead of a class. |
| 138 | +This should not affect you unless you specifically accessed this class & did custom things with it. |
| 139 | + |
| 140 | +## Reduce public API of Replay integration (https://github.com/getsentry/sentry-javascript/pull/6407) |
| 141 | + |
| 142 | +The result of `new Replay()` now has a much more limited public API. Only the following methods are exposed: |
| 143 | + |
| 144 | +```js |
| 145 | +const replay = new Replay(); |
| 146 | + |
| 147 | +replay.start(); |
| 148 | +replay.stop(); |
| 149 | +``` |
0 commit comments