feat: pass context into fsm (#167)

* feat: pass context into fsm

Signed-off-by: Guillaume Belanger <[email protected]>

* chore: bump version

Signed-off-by: Guillaume Belanger <[email protected]>

* chore: move context to be first arg

Signed-off-by: Guillaume Belanger <[email protected]>

* chore: move context to be first arg

Signed-off-by: Guillaume Belanger <[email protected]>

* chore: instantiate only 1 context

Signed-off-by: Guillaume Belanger <[email protected]>

* chore: apply recommended quality improvements

Signed-off-by: Guillaume Belanger <[email protected]>

---------

Signed-off-by: Guillaume Belanger <[email protected]>

Author: gruyaume

VERSION

@@ -1 +1 @@
-1.3.3-dev
+1.4.0

fsm/fsm.go

@@ -5,6 +5,7 @@
 package fsm
 
 import (
+	"context"
 	"fmt"
 	"os"
 	"strings"
@@ -14,11 +15,11 @@ import (
 
 type (
 	EventType string
-	ArgsType  map[string]interface{}
+	ArgsType  map[string]any
 )
 
 type (
-	Callback  func(*State, EventType, ArgsType)
+	Callback  func(context.Context, *State, EventType, ArgsType)
 	Callbacks map[StateType]Callback
 )
 
@@ -89,7 +90,7 @@ func NewFSM(transitions Transitions, callbacks Callbacks) (*FSM, error) {
 //   - on exit callback: call when fsm leave one state, with ExitEvent event
 //   - event callback: call when user trigger a user-defined event
 //   - on entry callback: call when fsm enter one state, with EntryEvent event
-func (fsm *FSM) SendEvent(state *State, event EventType, args ArgsType) error {
+func (fsm *FSM) SendEvent(ctx context.Context, state *State, event EventType, args ArgsType) error {
 	key := eventKey{
 		From:  state.Current(),
 		Event: event,
@@ -99,25 +100,25 @@ func (fsm *FSM) SendEvent(state *State, event EventType, args ArgsType) error {
 		logger.FsmLog.Infof("handle event[%s], transition from [%s] to [%s]", event, trans.From, trans.To)
 
 		// event callback
-		fsm.callbacks[trans.From](state, event, args)
+		fsm.callbacks[trans.From](ctx, state, event, args)
 
 		// exit callback
 		if trans.From != trans.To {
-			fsm.callbacks[trans.From](state, ExitEvent, args)
+			fsm.callbacks[trans.From](ctx, state, ExitEvent, args)
 		}
 
 		// entry callback
 		if trans.From != trans.To {
 			state.Set(trans.To)
-			fsm.callbacks[trans.To](state, EntryEvent, args)
+			fsm.callbacks[trans.To](ctx, state, EntryEvent, args)
 		}
 		return nil
 	} else {
 		return fmt.Errorf("unknown transition[From: %s, Event: %s]", state.Current(), event)
 	}
 }
 
-// ExportDot export fsm in dot format to outfile, which can be visualize by graphviz
+// ExportDot export fsm in dot format to outfile, which can be visualized by graphviz
 func ExportDot(fsm *FSM, outfile string) error {
 	dot := `digraph FSM {
 	rankdir=LR

fsm/fsm_test.go

@@ -5,6 +5,7 @@
 package fsm
 
 import (
+	"context"
 	"fmt"
 	"testing"
 
@@ -34,16 +35,17 @@ func TestState(t *testing.T) {
 }
 
 func TestFSM(t *testing.T) {
+	ctx := context.Background()
 	f, err := NewFSM(Transitions{
 		{Event: Open, From: Closed, To: Opened},
 		{Event: Close, From: Opened, To: Closed},
 		{Event: Open, From: Opened, To: Opened},
 		{Event: Close, From: Closed, To: Closed},
 	}, Callbacks{
-		Opened: func(state *State, event EventType, args ArgsType) {
+		Opened: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
-		Closed: func(state *State, event EventType, args ArgsType) {
+		Closed: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
 	})
@@ -52,12 +54,12 @@ func TestFSM(t *testing.T) {
 
 	assert.Nil(t, err, "NewFSM() failed")
 
-	assert.Nil(t, f.SendEvent(s, Open, ArgsType{"TestArg": "test arg"}), "SendEvent() failed")
-	assert.Nil(t, f.SendEvent(s, Close, ArgsType{"TestArg": "test arg"}), "SendEvent() failed")
+	assert.Nil(t, f.SendEvent(ctx, s, Open, ArgsType{"TestArg": "test arg"}), "SendEvent() failed")
+	assert.Nil(t, f.SendEvent(ctx, s, Close, ArgsType{"TestArg": "test arg"}), "SendEvent() failed")
 	assert.True(t, s.Is(Closed), "Transition failed")
 
 	fakeEvent := EventType("fake event")
-	assert.EqualError(t, f.SendEvent(s, fakeEvent, nil),
+	assert.EqualError(t, f.SendEvent(ctx, s, fakeEvent, nil),
 		fmt.Sprintf("unknown transition[From: %s, Event: %s]", s.Current(), fakeEvent))
 }
 
@@ -72,10 +74,10 @@ func TestFSMInitFail(t *testing.T) {
 		{Event: Open, From: Opened, To: Opened},
 		{Event: Close, From: Closed, To: Closed},
 	}, Callbacks{
-		Opened: func(state *State, event EventType, args ArgsType) {
+		Opened: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
-		Closed: func(state *State, event EventType, args ArgsType) {
+		Closed: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
 	})
@@ -90,13 +92,13 @@ func TestFSMInitFail(t *testing.T) {
 		{Event: Open, From: Opened, To: Opened},
 		{Event: Close, From: Closed, To: Closed},
 	}, Callbacks{
-		Opened: func(state *State, event EventType, args ArgsType) {
+		Opened: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
-		Closed: func(state *State, event EventType, args ArgsType) {
+		Closed: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
-		fakeState: func(state *State, event EventType, args ArgsType) {
+		fakeState: func(ctx context.Context, state *State, event EventType, args ArgsType) {
 			fmt.Printf("event [%+v] at state [%+v]\n", event, state.Current())
 		},
 	})