fix(replay): Fix canvas replays when seeking without actively playing #68646
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This fixes loading a canvas replay when the replay is not actively playing. Previously we had assumed that when seeking, prior events do not matter, but this assumption is wrong when there are more than one canvases. We also need to queue up events to be processed until after `onBuild` is called, as the target event node will not exist in the mirror DOM yet.
github-actions
bot
added
the
Scope: Frontend
Bundle ReportChanges will increase total bundle size by 10.04kB ⬆️
|
billyvg
commented
Apr 10, 2024
Comment on lines
209
to
243
| const source = replayer.getMirror().getNode(e.data.id); | ||
| const target = | ||
| canvases.get(e.data.id) || | ||
| (source && cloneCanvas(e.data.id, source as HTMLCanvasElement)); | ||
|
|
||
| // No canvas found for id... this isn't reliably reproducible and not | ||
| // exactly sure why it flakes. Saving as metric to keep an eye on it. | ||
| if (!target) { | ||
| Sentry.metrics.increment('replay.canvas_player.no_canvas_id'); | ||
| return; | ||
| } | ||
|
|
||
| await canvasMutation({ | ||
| event: e, | ||
| mutation: e.data, | ||
| target, | ||
| imageMap, | ||
| canvasEventMap, | ||
| errorHandler: (err: unknown) => { | ||
| if (err instanceof Error) { | ||
| Sentry.captureException(err); | ||
| } else { | ||
| Sentry.metrics.increment('replay.canvas_player.error_canvas_mutation'); | ||
| } | ||
| }, | ||
| }); | ||
|
|
||
| const img = containers.get(e.data.id); | ||
| if (img) { | ||
| img.src = target.toDataURL(); | ||
| img.style.maxWidth = '100%'; | ||
| img.style.maxHeight = '100%'; | ||
| } | ||
|
|
||
| prune(e); |
billyvg
commented
Apr 10, 2024
Comment on lines
266
to
276
| // See comments at definition of `handleQueue` | ||
| const queue = handleQueue.get(id); | ||
| handleQueue.set(id, []); | ||
| while (queue?.length) { | ||
| const queueItem = queue.shift(); | ||
| if (!queueItem) { | ||
| return; | ||
| } | ||
| const [event, replayer] = queueItem; | ||
| processEvent(event, {shouldPreload: false, replayer}); | ||
| } |
There was a problem hiding this comment.
Logic is as follows:
- User seeks somewhere in the timeline
- below handler is called with the events before that spot in timeline with
isSync = truefor all the events - create a list of canvas mutation events, indexed by its node id
- wait until
onBuildis called with an indexed node id (this happens as rrweb is processing events normally) - process events for the node id that was just built
There was a problem hiding this comment.
New Logic:
- User seeks somewhere in the timeline
- below handler is called with the events before that spot in timeline with isSync = true for all the events
- keep latest event, indexed by its node id
- we want to process the indexed events after all of the isSync events are handled. We do this by calling a debounced function that will attempt to process the latest event for each canvas id. we only remove from queue if event was successfully processed, otherwise ...
- wait until onBuild is called with an indexed node id (this happens as rrweb is processing events normally) a nd process events for the node id that was just built
|
The video seems to play at some spots when seeking even though it's paused. Screen.Recording.2024-04-11.at.10.47.38.AM.mov |
|
Ah good catch, I suppose we don't want to drain the entire queue, but only the latest one (per id), otherwise it'll look like it's animating. |
c298lee
approved these changes
Apr 15, 2024
billyvg
deleted the
fix-replay-canvas-load-process-previous-canvas-events
branch
Suspect IssuesThis pull request was deployed and Sentry observed the following issues:
Did you find this useful? React with a 👍 or 👎 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes loading a canvas replay when the replay is not actively playing. Previously we had assumed that when seeking, prior events do not matter, but this assumption is wrong when there are more than one canvases. We also need to queue up events to be processed until after
onBuildis called, as the target event node will not exist in the mirror DOM yet.Closes https://github.com/getsentry/team-replay/issues/415