FAQ for Managing Hierarchy of XState Actors in ReactMarch 18, 2020 at 7:05pm (Edited 7 months ago)
Reminder: Actors have completely private state and only communicate with messages.
How does this model fit into React and XState. Here are my recommendations right now from experimenting, as of
xstate-react 0.8.0. Please respond if you have found better solutions.. these are just a summary of my findings I thought I'd share.
tldr; Until actors in XState are more mature, the best way to communicate between shared services is not to use XState’s action types except for simple and shallow parent-child relationships. Instead, directly communicate with message passing between services managed by React components.
Should I spawn actors inside of XState or use the React model?
XState actor management is not mature enough to handle deep communication or other patterns like event busses. So, use React for now. Let React spawn actors and build the parent/child tree naturally by components.
- You can use React Context for referencing parent state.
- If a child needs to send a message to a parent, put that logic in callback props passed to the child i.e.
- If a parent needs to send a message to a child, the child machine should subscribe itself to the parent and configure how it reacts to parent events.
- If parallel actors needs to communicate with one another, they should all subscribe to a common event bus to configure how they respond. Then, the components can send events to the bus which will to forward them along to other parallel actors. You might need some helpers so that parallel actors can subscribe to only certain events from the event bus (like those with a certain ID).
How do I simplify sending messages to actors? Should I send to an event bus, Observable, actor, etc?
Do what Elixir does. They use actors in many of their libs, but most developers wouldn’t know it. They hide the message passing behind simple, straightforward APIs that handle the message passing for them. Do this with React hooks that use machines behind the scenes. Do this with React components by using callbacks.
How do I keep services decoupled but communicating? Where does all this wiring up happen?
Use decoupling strategies like event busses, Observables, and callbacks. Pass these into your machines. Keep actors ignorant of each other, and a channel (event bus) or API can be the smart one to hook them up. Custom React hooks can handle wiring up up these imports and translating prop changes into events.
What about deep message passing??
Use an event bus/channel that both top level and deep level actors subscribe to, and send your messages to the event bus to notify all relevant actors. XState machines can forward events to these channels, or an API level can redirect relevant events to the channels instead of the service.
What about deep state access i.e. user state deep in a screen??
XState does not have a great way of broadcasting state access to all children. Some ideas on how deep actors or components can access great-great-great-great-grandparent actor's context.
NOTE: most deep state access is for the purpose of UI, not state logic. If it is needed in state logic, the state and its updates can usually be represented by an event including the relevant state.
- Use React Context. Expose the top level actor/service through Context. Your child actors will need to be spawned by React instead of inside of XState, but that might be worth it until XState’s actor model matures. Since most state like this just needs to be used for display/rendering (not inside other machines), React will handle updates to it automatically. If you do need to update the state inside of a service, just use React hooks to send an UPDATE event when it changes.
- Use Observable streams. Instead of manually wiring up specific request/respond events, you can pass a stream around to always get the latest value. Instead of an event bus moderating, you’d use a stream. The parent component would hook up its context to the stream, and then the deep child component would import the stream through React context or a global registry like Redux/singleton.
- Use an event bus for requesting latest state. There would be some boilerplate, but you could hook up to an event bus that uses events to request a state from the publisher, and the publisher would send a response to all subscribers. Remember, the child would not know the state by default until it requested it. Since XState is not smart enough yet to communicate between services/actors started outside of XState, we can use an event bus and manually hook up the events. This is unfortunate boilerplate if the data is just used for rendering, but some helper code could simplify. NOTE: this could be an Observable to simplify.. see above.
- Use XState. Pass the state down through the actors. When the state is updated (like a User Setting change, you would manually propagate the USER_CHANGE event down through your child actors). However, this introduces the highest coupling, and it’s a poor representation of a much shallower relationship between the top-state and the child that needs it. Think about passing down an Observable hooked up to the parent's context if you’re limited to only managing machine through XState.
Show more messages
March 18, 2020 at 7:43pm
March 18, 2020 at 7:43pm
I think I agree with everything here. Observeables have been my favourite so far. If anyone is looking of an example of how you could do event buses, I've posted about that here:
XState actor management is not mature enough to handle deep communication
I'm not even convinced it ever should be.
Pass the state down through the actors.
I think it's "Pass the state up through the actors and down to the components." right?
By the way, I'm working on a much simpler "foundation" for using the actor model in JS that XState V5 will make use of (in some way). Ideally, the process should be:
- Use the actor-model library (which I'm currently working on) as a very thin abstraction for organizing code/logic via the actor model
- Refine actor behaviors with XState
That's great , thank you for your work on this! Hopefully this FAQ can help curb some questions until then 👍
I think the problem with XState actors and React is the fact that XState isn't in charge of rendering to the DOM. In a way React components are also actors, messaging data and events up and down. Dare I say the React Context API is an event bus. Private state is kept private. Shared state is communicated via messages (callback props). Fitting a whole different actor system on top of that is hard.
You could make it work if you made state machines produce React elements, share them with a parent machine that also produces a React element and combines it. E.g. a form machine could get all the input elements form child machines.