redux-bug-reporter
A bug reporting and playback tool for Redux applications that captures state and actions for easy reproduction.
What is redux-bug-reporter?
Redux Bug Reporter is a tool for Redux applications that simplifies bug reporting by capturing the entire Redux state and action history when a bug occurs. It provides a UI for users to submit bug reports and a playback feature for developers to recreate the exact application state at the time of the bug. This eliminates guesswork in debugging by providing reproducible scenarios.
Developers building applications with Redux who need efficient bug tracking and reproduction tools, particularly teams that want to collect detailed bug reports from users or testers.
It offers a seamless way to capture and replay Redux state changes, reducing the time spent on bug reproduction. Unlike generic error trackers, it is specifically designed for Redux, providing deep integration with the state management flow and customizable redaction for sensitive data.
Overview
:bug: A bug reporter and bug playback tool for redux. :bug:
Use Cases
Best For
- Debugging complex state-related issues in Redux applications
- Collecting detailed bug reports from end-users or QA testers
- Replaying user sessions to reproduce intermittent bugs
- Integrating bug reporting with existing issue trackers like Jira or GitHub
- Redacting sensitive data from Redux state before bug submission
- Testing and validating Redux state changes during development
Not Ideal For
- Applications not using Redux for state management (e.g., those with MobX, Context API, or no state library)
- High-traffic production apps where enabling client-side bug reporting could degrade performance or expose internal tools to users
- Projects with very large or frequent Redux actions (e.g., real-time data streams) that would cause significant memory bloat from state logging
- Teams needing a fully hosted, zero-configuration error monitoring service without backend setup or custom integrations
Pros & Cons
Pros
Automatically logs initial Redux state, all dispatched actions, and final state for each bug report, enabling precise bug reproduction as highlighted in the README's Redux logging feature.
Provides customizable hooks via the `redactStoreState` prop and action metadata to redact sensitive information before submission, ensuring privacy without altering live state.
Ships with ready-to-use integrations for Jira, GitHub Issues, Asana, Taiga, and Google Sheets, reducing backend development effort, as noted in the integration documentation.
Includes a global `bugReporterPlayback` function to replay reported bugs with adjustable delay, aiding developers in debugging complex state sequences interactively.
Cons
The README explicitly warns that keeping copies of all actions and state can lead to increased memory usage, especially in apps with heavy payloads or frequent actions, impacting performance.
Recommended to disable in production due to performance overhead and UI exposure, which restricts its utility for live bug reporting and monitoring in user-facing apps.
Tied exclusively to Redux; applications using alternative state management libraries cannot leverage its features, limiting its applicability in diverse tech stacks.
Requires configuring a backend service or custom integration for bug submission, adding complexity compared to plug-and-play hosted error tracking solutions.
Frequently Asked Questions
Related Projects
reselectSelector library for Redux
redux-loggerLogger for Redux
redux-ormNOT MAINTAINED – A small, simple and immutable ORM to manage relational data in your Redux store.
redux-undo:recycle: higher order reducer to add undo/redo functionality to redux state containers
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.