Skip to content

_stateMutator not running to completion in FiringMode.Queued #633

@RobinvdVeer

Description

@RobinvdVeer

When using async stateMutator, subsequent fire events are processed before the stateMutator is finished.
Example:


using System;
using Stateless;
using Stateless.Graph;
using System.Threading.Tasks;
namespace OnOffExample
{
    /// <summary>
    /// This example has a simple state machine with only two states. The state
    /// information is of type string, and the type of the trigger is char. 
    /// </summary>
    class Program
    {
        static void TransitionAnnounce(StateMachine<string, char>.Transition transition)
        {
            Console.WriteLine($"State Machine Transitioning from '{transition.Source}' to '{transition.Destination}'");
        }
        private static string _state = "Off";
        static void Main(string[] args)
        {
            const string on = "On";
            const string off = "Off";
            const char space = ' ';
                
            // Instantiate a new state machine in the 'off' state
            var onOffSwitch = new StateMachine<string, char>(()=>_state, async (s)=>{
                Console.WriteLine("State changing to: " + s);
                _state=s;
                await Task.Delay(2000);
                Console.WriteLine("State changed to: " + s);
                }, FiringMode.Queued);

            // Configure state machine with the Configure method, supplying the state to be configured as a parameter
            onOffSwitch.Configure(off).Permit(space, on).OnEntryAsync(async ()=>{
                Console.WriteLine("Transitioning to Off");
                await Task.Delay(1000);
                await onOffSwitch.FireAsync(space);
                Console.WriteLine("Transitioned to Off");
            });
            onOffSwitch.Configure(on).Permit(space, off).OnEntryAsync(async ()=>{
                Console.WriteLine("Transitioning to On");
                await Task.Delay(1000);
                await onOffSwitch.FireAsync(space);
                Console.WriteLine("Transitioned to On");
            });

            Console.WriteLine("Press <space> to toggle the switch. Any other key will exit the program.");

            while (true)
            {
                var pressed = Console.ReadKey(true).KeyChar;

                // Check if user wants to exit
                if (pressed != space)
                {
                    // Before exiting this is how you can safely register and unregister from transition events.
                    // Keys 'r' or 'R' = Register for transition events with double subscription prevention built-in.
                    // Keys 'u' or 'U' = Unregister from transition events to prevent memory leaks in long running applications.
                    switch (pressed)
                    {
                        case 'r':
                        case 'R':
                            onOffSwitch.OnTransitioned(TransitionAnnounce);
                            Console.WriteLine("Now subscribed to transition events..");
                            continue;

                        case 'u':
                        case 'U':
                            onOffSwitch.OnTransitionedUnregister(TransitionAnnounce);
                            Console.WriteLine("Successfully unsubscribed from transition events..");
                            continue;
                    }

                    Console.WriteLine("Exiting program");
                    break;
                }

                // Use the Fire method with the trigger as payload to supply the state machine with an event.
                // The state machine will react according to its configuration.
                onOffSwitch.FireAsync(pressed);
            }
        }
    }
}

Output (after pressing space):

State changing to: On
Transitioning to On
Transitioned to On
State changing to: Off
Transitioning to Off
State changed to: On
Transitioned to Off
State changing to: On
Transitioning to On

The state mutator (because of the longer delay), was still running while the next trigger was already being processed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions