Add rrweb event logging to console for debugging#1173
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a debugging feature to log rrweb events in a readable JSON format, particularly useful when diagnosing replay behavior.
- Introduces a new debug configuration (logEmits) in the defaults file.
- Implements a _logEvent method in Recorder to safely stringify events with circular references.
- Updates the checkout interval to a more readable expression.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/browser/replay/recorder.js | Adds _logEvent method and integrates conditional logging of events. |
| src/browser/replay/defaults.js | Introduces new debug configuration for logging events. |
Comments suppressed due to low confidence (1)
src/browser/replay/recorder.js:188
- [nitpick] Consider refining the log message formatting to avoid extra spacing when isCheckout is false, such as outputting 'Recorder: event' consistently.
`Recorder: ${isCheckout ? 'checkout' : ''} event\n`,
waltjones
approved these changes
Apr 18, 2025
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of the change
debugconfiguration option insrc/browser/replay/defaults.jsto enable or disable logging of emitted events. (logEmitsis set tofalseby default)._logEventmethod insrc/browser/replay/recorder.jsto log emitted events in a readable JSON format, handling circular references gracefully. This method is invoked whenlogEmitsis enabled in the debug configuration.Type of change
Related issues