Remote DevTools for Redux.dart. This package connects a Dart Redux store to the Remote Devtools Server, allowing the developer to inspect changes to the Redux Store during runtime.
Package selection guidance compiled from public package information, community data, and project usage.
A Flutter/Dart package that enables remote debugging of Redux stores by connecting to a Remote DevTools Server. It allows developers to inspect state changes, actions, and middleware behavior in real time across multiple platforms. Ideal for debugging complex state management flows during development, it supports full integration with Redux.dart and provides a seamless experience across Android, iOS, Web, macOS, Windows, and Linux. The tool enhances developer productivity by offering live insights into the application's state evolution.
Use cases
Real-time state inspection
Debugging complex Redux logic
Cross-platform debugging
Live action tracking
Development workflow enhancement
Key features
Connects to Remote DevTools Server
Real-time state monitoring
Supports all major platforms
Integrates with Redux.dart
Action and state history tracking
Suitable for
Redux.dart developers
Frontend teams using state management
Debugging production-like scenarios
Teams collaborating on state logic
Developers needing detailed runtime insights
Considerations
Requires Remote DevTools Server setup
Not intended for production use
May impact performance during debugging
Needs network access for remote connection
Limited to Redux.dart ecosystem
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
Redux Remote Devtools for Dart and Flutter
Redux Remote Devtools support for Dart and Flutter.
Installation
Add the library to pubspec.yaml:
dependencies:redux_remote_devtools:^2.0.0
Middleware configuration
Add the middleware to your Redux configuration:
var remoteDevtools = RemoteDevToolsMiddleware('192.168.1.52:8000');
final store = newDevToolsStore<AppState>(searchReducer,
middleware: [
remoteDevtools,
]);
remoteDevtools.store = store;
await remoteDevtools.connect();
:warning: Using mutliple middleware?
If you use other middleware, RemoteDevTools must be put last. Otherwise,
actions and state updates will be out of sync
What's going on here?
Create a new instance of the devtools middleware. Specify the host and port to connect to.
Wait for devtools to connect to the remotedev server
Initialise your store. To take advantage of time travel, you should use a DevToolsStore. Pass in remoteDevTools with the rest of your middlware
The middleware needs a reference to the store you just created, so commands from devtools can be dispatched. So as a final step, set the reference.
Using remotedev
Use the Javascript Remote Devtools package. Start the remotedev server on your machine
Run your application. It will connect to the remotedev server. You can now debug your redux application by opening up http://localhost:8000 in a web browser.
Encoding Actions and State
In the Javascript world, Redux follows a convention that your redux state is a plain Javascript Object, and actions are also Javascript objects that have a type property. The JS Redux Devtools expect this. However, Redux.dart tries to take advantage of the strong typing available in Dart. To make Redux.dart work with the JS devtools, we need to convert actions and state instances to JSON before sending.
Remember that the primary reason for using devtools is to allow the developer to reason about what the app is doing. Therefore, exact conversion is not strictly necessary - it's more important for what appears in devtools to be meaningful to the developer.
Enconding Strategy for Actions
We use the class name as the action type for class based actions. For enum typed actions, we use the value of the action. For example:
When converted, these actions will be {"type": "Action1"} or {"type": "ClassAction"}, etc.
We also want to send the action properties over to devtools. To do this, we attempt to jsonEncode the entire Action, and attach this JSON data as a payload property. For example:
classClassAction{
int someValue;
toJson() {
return {'someValue': this.someValue};
}
}
Would appear in devtools as:
{
"type": "ClassAction",
"payload": {
"someValue": 5// or whatever someValue was set to
},
}
This of course means your Actions need to be json encodable. You can do what the example above does and write your own toJson method. However, a better approach is to use a generator like json_serializable to do it for you. If your action is not json encodable, the payload property will be missing in devtools.
Encoding strategy for State
For state, we simply attempt to jsonEncode the entire thing. If your state cannot be converted, then state updates will not appear in devtools.
Overriding these strategies
The strategy described above should work for most cases. However, if you want to do something different, you can replace the ActionEncoder and StateEncoder with your own implementations:
var remoteDevtools = RemoteDevToolsMiddleware('192.168.1.52:8000', actionEncoder: MyCoolActionEncoder);
Making your actions and state json encodable
You can either write your own toJson methods for each of your actions and your state class. However, this quickly becomes cumbersome and error prone. Instead, the recommended way is to make use of the json_annotation package to automatically generate toJson functions for you.
Dispatching Actions from DevTools
You are able to dispatch actions from the Devtools UI and have these processed by the redux implementation in your Flutter app.
In order for this to work, you need to implement an ActionDecoder. ActionDecoder's job is to take the JSON data received from the Devtools UI, and return an action that your reducers know how to use. For example if we dispatch an action:
{"type":"INCREMENT"}
We would implement an ActionDecoder like so:
ActionDecoder myDecoder = (dynamic payload) {
final map = payload asMap<String, dynamic>;
if (map['type'] == 'INCREMENT') {
returnIncrementAction();
}
};
Essentially, you need to map every JSON action type into an action that can be used by your reducers.
Please get in touch if you have any awesome ideas for how to make this process smoother.
Example Apps
This repo includes remote-devtools enabled versions of the flutter-redux example apps: