forked from stateforward/go-hsm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhsm.go
1898 lines (1764 loc) · 52.1 KB
/
hsm.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package hsm
import (
"context"
"errors"
"fmt"
"hash/crc32"
"log/slog"
"path"
"runtime"
"sort"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/runpod/hsm/elements"
"github.com/runpod/hsm/kind"
)
var (
Kinds = kind.Kinds()
ErrNilHSM = errors.New("hsm is nil")
ErrInvalidState = errors.New("invalid state")
ErrMissingHSM = errors.New("missing hsm in context")
ErrInvalidPattern = errors.New("invalid pattern")
)
// Package hsm provides a powerful hierarchical state machine (HSM) implementation for Go.
// It enables modeling complex state-driven systems with features like hierarchical states,
// entry/exit actions, guard conditions, and event-driven transitions.
//
// Basic usage:
//
// type MyHSM struct {
// hsm.HSM
// counter int
// }
//
// model := hsm.Define(
// "example",
// hsm.State("foo"),
// hsm.State("bar"),
// hsm.Transition(
// hsm.Trigger("moveToBar"),
// hsm.Source("foo"),
// hsm.Target("bar")
// ),
// hsm.Initial("foo")
// )
//
// sm := hsm.Start(context.Background(), &MyHSM{}, &model)
// sm.Dispatch(hsm.Event{Name: "moveToBar"})
/******* Element *******/
type element struct {
kind uint64
qualifiedName string
id string
}
func (element *element) Kind() uint64 {
if element == nil {
return 0
}
return element.kind
}
func (element *element) Owner() string {
if element == nil || element.qualifiedName == "/" {
return ""
}
return path.Dir(element.qualifiedName)
}
func (element *element) Id() string {
if element == nil {
return ""
}
return element.id
}
func (element *element) Name() string {
if element == nil {
return ""
}
return path.Base(element.qualifiedName)
}
func (element *element) QualifiedName() string {
if element == nil {
return ""
}
return element.qualifiedName
}
/******* Model *******/
// Element represents a named element in the state machine hierarchy.
// It provides basic identification and naming capabilities.
type Element = elements.NamedElement
// Model represents the complete state machine model definition.
// It contains the root state and maintains a namespace of all elements.
type Model struct {
state
namespace map[string]elements.NamedElement
elements []RedefinableElement
}
func (model *Model) Namespace() map[string]elements.NamedElement {
return model.namespace
}
func (model *Model) push(partial RedefinableElement) {
model.elements = append(model.elements, partial)
}
// RedefinableElement is a function type that modifies a Model by adding or updating elements.
// It's used to build the state machine structure in a declarative way.
type RedefinableElement = func(model *Model, stack []elements.NamedElement) elements.NamedElement
/******* Vertex *******/
type vertex struct {
element
transitions []string
}
func (vertex *vertex) Transitions() []string {
return vertex.transitions
}
/******* State *******/
type state struct {
vertex
initial string
entry string
exit string
activities []string
deferred []string
}
func (state *state) Entry() string {
return state.entry
}
func (state *state) Activities() []string {
return state.activities
}
func (state *state) Exit() string {
return state.exit
}
/******* Transition *******/
type paths struct {
enter []string
exit []string
}
type transition struct {
element
source string
target string
guard string
effect string
events []Event
paths map[string]paths
}
func (transition *transition) Guard() string {
return transition.guard
}
func (transition *transition) Effect() string {
return transition.effect
}
func (transition *transition) Events() []Event {
return transition.events
}
func (transition *transition) Source() string {
return transition.source
}
func (transition *transition) Target() string {
return transition.target
}
/******* Behavior *******/
type behavior[T Context] struct {
element
method func(ctx context.Context, hsm T, event Event)
}
/******* Constraint *******/
type constraint[T Context] struct {
element
expression func(ctx context.Context, hsm T, event Event) bool
}
/******* Events *******/
// Event represents a trigger that can cause state transitions in the state machine.
// Events can carry data and have completion tracking through the Done channel.
type Event = elements.Event
var InitialEvent = Event{}
type DecodedEvent[T any] struct {
Event
Data T
}
func DecodeEvent[T any](event Event) (DecodedEvent[T], bool) {
data, ok := event.Data.(T)
return DecodedEvent[T]{
Event: event,
Data: data,
}, ok
}
var closedChannel = func() chan struct{} {
done := make(chan struct{})
close(done)
return done
}()
var noevent = Event{
Done: closedChannel,
}
type queue struct {
mutex sync.RWMutex
events []Event
}
// func (q *queue) len() int {
// q.mutex.RLock()
// defer q.mutex.RUnlock()
// return len(q.events)
// }
func (q *queue) pop() (Event, bool) {
q.mutex.Lock()
defer q.mutex.Unlock()
if len(q.events) == 0 {
return noevent, false
}
event := q.events[0]
q.events = q.events[1:]
return event, true
}
func (q *queue) push(events ...Event) {
for _, event := range events {
if kind.IsKind(event.Kind, kind.CompletionEvent) {
q.mutex.Lock()
q.events = append([]Event{event}, q.events...)
q.mutex.Unlock()
} else {
q.mutex.Lock()
q.events = append(q.events, event)
q.mutex.Unlock()
}
}
}
func apply(model *Model, stack []elements.NamedElement, partials ...RedefinableElement) {
for _, partial := range partials {
partial(model, stack)
}
}
// Define creates a new state machine model with the given name and elements.
// The first argument can be either a string name or a RedefinableElement.
// Additional elements are added to the model in the order they are specified.
//
// Example:
//
// model := hsm.Define(
// "traffic_light",
// hsm.State("red"),
// hsm.State("yellow"),
// hsm.State("green"),
// hsm.Initial("red")
// )
func Define[T interface{ RedefinableElement | string }](nameOrRedefinableElement T, redefinableElements ...RedefinableElement) Model {
name := "/"
switch any(nameOrRedefinableElement).(type) {
case string:
name = path.Join(name, any(nameOrRedefinableElement).(string))
case RedefinableElement:
redefinableElements = append([]RedefinableElement{any(nameOrRedefinableElement).(RedefinableElement)}, redefinableElements...)
}
model := Model{
state: state{
vertex: vertex{element: element{kind: kind.State, qualifiedName: "/", id: name}, transitions: []string{}},
},
elements: redefinableElements,
}
model.namespace = map[string]elements.NamedElement{
"/": &model.state,
}
stack := []elements.NamedElement{&model.state}
for len(model.elements) > 0 {
elements := model.elements
model.elements = []RedefinableElement{}
apply(&model, stack, elements...)
}
if model.initial == "" {
panic(fmt.Errorf("initial state is required for state machine %s", model.Id()))
}
if model.entry != "" {
panic(fmt.Errorf("entry actions are not allowed on top level state machine %s", model.Id()))
}
if model.exit != "" {
panic(fmt.Errorf("exit actions are not allowed on top level state machine %s", model.Id()))
}
return model
}
func find(stack []elements.NamedElement, maybeKinds ...uint64) elements.NamedElement {
for i := len(stack) - 1; i >= 0; i-- {
if kind.IsKind(stack[i].Kind(), maybeKinds...) {
return stack[i]
}
}
return nil
}
func traceback(maybeError ...error) func(err error) {
_, file, line, _ := runtime.Caller(2)
fn := func(err error) {
panic(fmt.Sprintf("%s:%d: %v", file, line, err))
}
if len(maybeError) > 0 {
fn(maybeError[0])
}
return fn
}
func get[T elements.NamedElement](model *Model, name string) T {
var zero T
if name == "" {
return zero
}
if element, ok := model.namespace[name]; ok {
typed, ok := element.(T)
if ok {
return typed
}
}
return zero
}
var counter atomic.Uint64
const (
idTimestampBits = 48
idCounterBits = 16 // 64 - timestampBits
idTimestampMask = uint64((1 << idTimestampBits) - 1)
idCounterMask = uint64((1 << idCounterBits) - 1)
)
// id generates a uint64 ID with configurable bits for timestamp
// timestampBits must be between 1 and 63
func id() string {
// Get timestamp and truncate to specified bits
timestamp := uint64(time.Now().UnixMilli()) & idTimestampMask
// Get count and truncate to remaining bits
counter := counter.Add(1) & idCounterMask
// Combine timestamp and counter
return strconv.FormatUint((timestamp<<idCounterBits)|counter, 32)
}
func hasWildcard(events ...Event) bool {
for _, event := range events {
if strings.Contains(event.Name, "*") {
return true
}
}
return false
}
// State creates a new state element with the given name and optional child elements.
// States can have entry/exit actions, activities, and transitions.
//
// Example:
//
// hsm.State("active",
// hsm.Entry(func(ctx context.Context, hsm *MyHSM, event Event) {
// log.Println("Entering active state")
// }),
// hsm.Activity(func(ctx context.Context, hsm *MyHSM, event Event) {
// // Long-running activity
// }),
// hsm.Exit(func(ctx context.Context, hsm *MyHSM, event Event) {
// log.Println("Exiting active state")
// })
// )
func State(name string, partialElements ...RedefinableElement) RedefinableElement {
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.StateMachine, kind.State)
if owner == nil {
traceback(fmt.Errorf("state \"%s\" must be called within Define() or State()", name))
}
element := &state{
vertex: vertex{element: element{kind: kind.State, qualifiedName: path.Join(owner.QualifiedName(), name)}, transitions: []string{}},
}
model.namespace[element.QualifiedName()] = element
stack = append(stack, element)
apply(model, stack, partialElements...)
model.push(func(model *Model, stack []elements.NamedElement) elements.NamedElement {
// Sort transitions so wildcard events are at the end
sort.SliceStable(element.transitions, func(i, j int) bool {
transitionI := get[*transition](model, element.transitions[i])
if transitionI == nil {
traceback(fmt.Errorf("missing transition \"%s\" for state \"%s\"", element.transitions[i], element.QualifiedName()))
return false
}
transitionJ := get[*transition](model, element.transitions[j])
if transitionJ == nil {
traceback(fmt.Errorf("missing transition \"%s\" for state \"%s\"", element.transitions[j], element.QualifiedName()))
return false // because the linter doesn't know that traceback will panic
}
// If j has wildcard and i doesn't, i comes first
hasWildcardI := hasWildcard(transitionI.events...)
hasWildcardJ := hasWildcard(transitionJ.events...)
return !hasWildcardI && hasWildcardJ
})
return element
})
return element
}
}
// LCA finds the Lowest Common Ancestor between two qualified state names in a hierarchical state machine.
// It takes two qualified names 'a' and 'b' as strings and returns their closest common ancestor.
//
// For example:
// - LCA("/s/s1", "/s/s2") returns "/s"
// - LCA("/s/s1", "/s/s1/s11") returns "/s/s1"
// - LCA("/s/s1", "/s/s1") returns "/s/s1"
func LCA(a, b string) string {
// if both are the same the lca is the parent
if a == b {
return path.Dir(a)
}
// if one is empty the lca is the other
if a == "" {
return b
}
if b == "" {
return a
}
// if the parents are the same the lca is the parent
if path.Dir(a) == path.Dir(b) {
return path.Dir(a)
}
// if a is an ancestor of b the lca is a
if IsAncestor(a, b) {
return a
}
// if b is an ancestor of a the lca is b
if IsAncestor(b, a) {
return b
}
// otherwise the lca is the lca of the parents
return LCA(path.Dir(a), path.Dir(b))
}
func IsAncestor(current, target string) bool {
current = path.Clean(current)
target = path.Clean(target)
if current == target || current == "." || target == "." {
return false
}
if current == "/" {
return true
}
parent := path.Dir(target)
for parent != "/" {
if parent == current {
return true
}
parent = path.Dir(parent)
}
return false
}
// Transition creates a new transition between states.
// Transitions can have triggers, guards, and effects.
//
// Example:
//
// hsm.Transition(
// hsm.Trigger("submit"),
// hsm.Source("draft"),
// hsm.Target("review"),
// hsm.Guard(func(ctx context.Context, hsm *MyHSM, event Event) bool {
// return hsm.IsValid()
// }),
// hsm.Effect(func(ctx context.Context, hsm *MyHSM, event Event) {
// log.Println("Transitioning from draft to review")
// })
// )
func Transition[T interface{ RedefinableElement | string }](nameOrPartialElement T, partialElements ...RedefinableElement) RedefinableElement {
name := ""
switch any(nameOrPartialElement).(type) {
case string:
name = any(nameOrPartialElement).(string)
case RedefinableElement:
partialElements = append([]RedefinableElement{any(nameOrPartialElement).(RedefinableElement)}, partialElements...)
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.Vertex)
if name == "" {
name = fmt.Sprintf("transition_%d", len(model.namespace))
}
if owner == nil {
traceback(fmt.Errorf("transition \"%s\" must be called within a State() or Define()", name))
}
transition := &transition{
events: []Event{},
element: element{
kind: kind.Transition,
qualifiedName: path.Join(owner.QualifiedName(), name),
},
source: ".",
paths: map[string]paths{},
}
model.namespace[transition.QualifiedName()] = transition
stack = append(stack, transition)
apply(model, stack, partialElements...)
if transition.source == "." || transition.source == "" {
transition.source = owner.QualifiedName()
}
sourceElement, ok := model.namespace[transition.source]
if !ok {
traceback(fmt.Errorf("missing source \"%s\" for transition \"%s\"", transition.source, transition.QualifiedName()))
}
switch source := sourceElement.(type) {
case *state:
source.transitions = append(source.transitions, transition.QualifiedName())
case *vertex:
source.transitions = append(source.transitions, transition.QualifiedName())
}
if len(transition.events) == 0 && !kind.IsKind(sourceElement.Kind(), kind.Pseudostate) {
// TODO: completion transition
// qualifiedName := path.Join(transition.source, ".completion")
// transition.events = append(transition.events, &event{
// element: element{kind: kind.CompletionEvent, qualifiedName: qualifiedName},
// })
traceback(fmt.Errorf("completion transition not implemented"))
}
if transition.target == transition.source {
transition.kind = kind.Self
} else if transition.target == "" {
transition.kind = kind.Internal
} else if IsAncestor(transition.source, transition.target) {
transition.kind = kind.Local
} else {
transition.kind = kind.External
}
enter := []string{}
entering := transition.target
lca := LCA(transition.source, transition.target)
for entering != lca && entering != "/" && entering != "" {
enter = append([]string{entering}, enter...)
entering = path.Dir(entering)
}
if kind.IsKind(transition.kind, kind.Self) {
enter = append(enter, sourceElement.QualifiedName())
}
if kind.IsKind(sourceElement.Kind(), kind.Initial) {
transition.paths[path.Dir(sourceElement.QualifiedName())] = paths{
enter: enter,
exit: []string{sourceElement.QualifiedName()},
}
} else {
model.push(func(model *Model, stack []elements.NamedElement) elements.NamedElement {
if transition.source == model.QualifiedName() && transition.target != "" {
traceback(fmt.Errorf("top level transitions must have a source and target, or no source and target"))
}
if kind.IsKind(transition.kind, kind.Internal) && transition.effect == "" {
traceback(fmt.Errorf("internal transitions require an effect"))
}
// precompute transition paths for the source state and nested states
for qualifiedName, element := range model.namespace {
if strings.HasPrefix(qualifiedName, transition.source) && kind.IsKind(element.Kind(), kind.Vertex, kind.StateMachine) {
exit := []string{}
if transition.kind != kind.Internal {
exiting := element.QualifiedName()
for exiting != lca && exiting != "" {
exit = append(exit, exiting)
if exiting == "/" {
break
}
exiting = path.Dir(exiting)
}
}
transition.paths[element.QualifiedName()] = paths{
enter: enter,
exit: exit,
}
}
}
return transition
})
}
return transition
}
}
// Source specifies the source state of a transition.
// It can be used within a Transition definition.
//
// Example:
//
// hsm.Transition(
// hsm.Source("idle"),
// hsm.Target("running")
// )
func Source[T interface{ RedefinableElement | string }](nameOrPartialElement T) RedefinableElement {
// Capture the stack depth for use in traceback
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.Transition)
if owner == nil {
traceback(fmt.Errorf("hsm.Source() must be called within a hsm.Transition()"))
}
transition := owner.(*transition)
if transition.source != "." && transition.source != "" {
traceback(fmt.Errorf("transition \"%s\" already has a source \"%s\"", transition.QualifiedName(), transition.source))
}
var name string
switch any(nameOrPartialElement).(type) {
case string:
name = any(nameOrPartialElement).(string)
if !path.IsAbs(name) {
if ancestor := find(stack, kind.State); ancestor != nil {
name = path.Join(ancestor.QualifiedName(), name)
}
}
// push a validation step to ensure the source exists after the model is built
model.push(func(model *Model, stack []elements.NamedElement) elements.NamedElement {
if _, ok := model.namespace[name]; !ok {
traceback(fmt.Errorf("missing source \"%s\" for transition \"%s\"", name, transition.QualifiedName()))
}
return owner
})
case RedefinableElement:
element := any(nameOrPartialElement).(RedefinableElement)(model, stack)
if element == nil {
traceback(fmt.Errorf("transition \"%s\" source is nil", transition.QualifiedName()))
}
name = element.QualifiedName()
}
transition.source = name
return owner
}
}
func Defer[T interface{ string | *Event | Event }](events ...T) RedefinableElement {
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
state, ok := find(stack, kind.State).(*state)
if !ok {
traceback(fmt.Errorf("defer must be called within a State"))
}
for _, event := range events {
switch evt := any(event).(type) {
case string:
state.deferred = append(state.deferred, evt)
case *Event:
state.deferred = append(state.deferred, evt.Name)
case Event:
state.deferred = append(state.deferred, evt.Name)
default:
traceback(fmt.Errorf("defer must be called with a string, *Event, or Event"))
}
}
return state
}
}
// Target specifies the target state of a transition.
// It can be used within a Transition definition.
//
// Example:
//
// hsm.Transition(
// hsm.Source("idle"),
// hsm.Target("running")
// )
func Target[T interface{ RedefinableElement | string }](nameOrPartialElement T) RedefinableElement {
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.Transition)
if owner == nil {
traceback(fmt.Errorf("Target() must be called within Transition()"))
}
transition := owner.(*transition)
if transition.target != "" {
traceback(fmt.Errorf("transition \"%s\" already has target \"%s\"", transition.QualifiedName(), transition.target))
}
var qualifiedName string
switch target := any(nameOrPartialElement).(type) {
case string:
qualifiedName = target
if !path.IsAbs(qualifiedName) {
if ancestor := find(stack, kind.State); ancestor != nil {
qualifiedName = path.Join(ancestor.QualifiedName(), qualifiedName)
}
}
// push a validation step to ensure the target exists after the model is built
model.push(func(model *Model, stack []elements.NamedElement) elements.NamedElement {
if _, exists := model.namespace[qualifiedName]; !exists {
traceback(fmt.Errorf("missing target \"%s\" for transition \"%s\"", target, transition.QualifiedName()))
}
return transition
})
case RedefinableElement:
targetElement := target(model, stack)
if targetElement == nil {
traceback(fmt.Errorf("transition \"%s\" target is nil", transition.QualifiedName()))
}
qualifiedName = targetElement.QualifiedName()
}
transition.target = qualifiedName
return transition
}
}
// Effect defines an action to be executed during a transition.
// The effect function is called after exiting the source state and before entering the target state.
//
// Example:
//
// hsm.Effect(func(ctx context.Context, hsm *MyHSM, event Event) {
// log.Printf("Transitioning with event: %s", event.Name)
// })
func Effect[T Context](fn func(ctx context.Context, hsm T, event Event), maybeName ...string) RedefinableElement {
name := ".effect"
if len(maybeName) > 0 {
name = maybeName[0]
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.Transition)
if owner == nil {
traceback(fmt.Errorf("effect must be called within a Transition"))
}
behavior := &behavior[T]{
element: element{kind: kind.Behavior, qualifiedName: path.Join(owner.QualifiedName(), name)},
method: fn,
}
model.namespace[behavior.QualifiedName()] = behavior
owner.(*transition).effect = behavior.QualifiedName()
return owner
}
}
// Guard defines a condition that must be true for a transition to be taken.
// If multiple transitions are possible, the first one with a satisfied guard is chosen.
//
// Example:
//
// hsm.Guard(func(ctx context.Context, hsm *MyHSM, event Event) bool {
// return hsm.counter > 10
// })
func Guard[T Context](fn func(ctx context.Context, hsm T, event Event) bool, maybeName ...string) RedefinableElement {
name := ".guard"
if len(maybeName) > 0 {
name = maybeName[0]
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.Transition)
if owner == nil {
traceback(fmt.Errorf("guard must be called within a Transition"))
}
constraint := &constraint[T]{
element: element{kind: kind.Constraint, qualifiedName: path.Join(owner.QualifiedName(), name)},
expression: fn,
}
model.namespace[constraint.QualifiedName()] = constraint
owner.(*transition).guard = constraint.QualifiedName()
return owner
}
}
// Initial defines the initial state for a composite state or the entire state machine.
// When a composite state is entered, its initial state is automatically entered.
//
// Example:
//
// hsm.State("operational",
// hsm.State("idle"),
// hsm.State("running"),
// hsm.Initial("idle")
// )
func Initial[T interface{ string | RedefinableElement }](elementOrName T, partialElements ...RedefinableElement) RedefinableElement {
name := ".initial"
switch any(elementOrName).(type) {
case string:
name = any(elementOrName).(string)
case RedefinableElement:
partialElements = append([]RedefinableElement{any(elementOrName).(RedefinableElement)}, partialElements...)
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.State)
if owner == nil {
traceback(fmt.Errorf("initial must be called within a State or Model"))
}
initial := &vertex{
element: element{kind: kind.Initial, qualifiedName: path.Join(owner.QualifiedName(), name)},
}
owner.(*state).initial = initial.QualifiedName()
if model.namespace[initial.QualifiedName()] != nil {
traceback(fmt.Errorf("initial \"%s\" state already exists for \"%s\"", initial.QualifiedName(), owner.QualifiedName()))
}
model.namespace[initial.QualifiedName()] = initial
stack = append(stack, initial)
transition := (Transition(Source(initial.QualifiedName()), append(partialElements, Trigger(InitialEvent))...)(model, stack)).(*transition)
// validation logic
if transition.guard != "" {
traceback(fmt.Errorf("initial \"%s\" cannot have a guard", initial.QualifiedName()))
}
if transition.events[0].Name != "" {
traceback(fmt.Errorf("initial \"%s\" cannot have triggers", initial.QualifiedName()))
}
if !strings.HasPrefix(transition.target, owner.QualifiedName()) {
traceback(fmt.Errorf("initial \"%s\" must target a nested state not \"%s\"", initial.QualifiedName(), transition.target))
}
if len(initial.transitions) > 1 {
traceback(fmt.Errorf("initial \"%s\" cannot have multiple transitions %v", initial.QualifiedName(), initial.transitions))
}
return transition
}
}
// Choice creates a pseudo-state that enables dynamic branching based on guard conditions.
// The first transition with a satisfied guard condition is taken.
//
// Example:
//
// hsm.Choice(
// hsm.Transition(
// hsm.Target("approved"),
// hsm.Guard(func(ctx context.Context, hsm *MyHSM, event Event) bool {
// return hsm.score > 700
// })
// ),
// hsm.Transition(
// hsm.Target("rejected")
// )
// )
func Choice[T interface{ RedefinableElement | string }](elementOrName T, partialElements ...RedefinableElement) RedefinableElement {
name := ""
switch any(elementOrName).(type) {
case string:
name = any(elementOrName).(string)
case RedefinableElement:
partialElements = append([]RedefinableElement{any(elementOrName).(RedefinableElement)}, partialElements...)
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.State, kind.Transition)
if owner == nil {
traceback(fmt.Errorf("you must call Choice() within a State or Transition"))
} else if kind.IsKind(owner.Kind(), kind.Transition) {
transition := owner.(*transition)
source := transition.source
owner = model.namespace[source]
if owner == nil {
traceback(fmt.Errorf("transition \"%s\" targetting \"%s\" requires a source state when using Choice()", transition.QualifiedName(), transition.target))
} else if kind.IsKind(owner.Kind(), kind.Pseudostate) {
// pseudostates aren't a namespace, so we need to find the containing state
owner = find(stack, kind.State)
if owner == nil {
traceback(fmt.Errorf("you must call Choice() within a State"))
}
}
}
if name == "" {
name = fmt.Sprintf("choice_%d", len(model.elements))
}
qualifiedName := path.Join(owner.QualifiedName(), name)
element := &vertex{
element: element{kind: kind.Choice, qualifiedName: qualifiedName},
}
model.namespace[qualifiedName] = element
stack = append(stack, element)
apply(model, stack, partialElements...)
if len(element.transitions) == 0 {
traceback(fmt.Errorf("you must define at least one transition for choice \"%s\"", qualifiedName))
}
if defaultTransition := get[elements.Transition](model, element.transitions[len(element.transitions)-1]); defaultTransition != nil {
if defaultTransition.Guard() != "" {
traceback(fmt.Errorf("the last transition of choice state \"%s\" cannot have a guard", qualifiedName))
}
}
return element
}
}
// Entry defines an action to be executed when entering a state.
// The entry action is executed before any internal activities are started.
//
// Example:
//
// hsm.Entry(func(ctx context.Context, hsm *MyHSM, event Event) {
// log.Printf("Entering state with event: %s", event.Name)
// })
func Entry[T Context](fn func(ctx context.Context, hsm T, event Event), maybeName ...string) RedefinableElement {
name := ".entry"
if len(maybeName) > 0 {
name = maybeName[0]
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner := find(stack, kind.State)
if owner == nil {
traceback(fmt.Errorf("entry must be called within a State"))
}
element := &behavior[T]{
element: element{kind: kind.Behavior, qualifiedName: path.Join(owner.QualifiedName(), name)},
method: fn,
}
model.namespace[element.QualifiedName()] = element
owner.(*state).entry = element.QualifiedName()
return element
}
}
// Activity defines a long-running action that is executed while in a state.
// The activity is started after the entry action and stopped before the exit action.
//
// Example:
//
// hsm.Activity(func(ctx context.Context, hsm *MyHSM, event Event) {
// for {
// select {
// case <-ctx.Done():
// return
// case <-time.After(time.Second):
// log.Println("Activity tick")
// }
// }
// })
func Activity[T Context](fn func(ctx context.Context, hsm T, event Event), maybeName ...string) RedefinableElement {
name := ".activity"
if len(maybeName) > 0 {
name = maybeName[0]
}
traceback := traceback()
return func(model *Model, stack []elements.NamedElement) elements.NamedElement {
owner, ok := find(stack, kind.State).(*state)
if !ok {
traceback(fmt.Errorf("activity must be called within a State"))
}
element := &behavior[T]{
element: element{kind: kind.Concurrent, qualifiedName: path.Join(owner.QualifiedName(), name)},
method: fn,
}
model.namespace[element.QualifiedName()] = element
owner.activities = append(owner.activities, element.QualifiedName())
return element
}
}
// Exit defines an action to be executed when exiting a state.
// The exit action is executed after any internal activities are stopped.
//
// Example:
//
// hsm.Exit(func(ctx context.Context, hsm *MyHSM, event Event) {
// log.Printf("Exiting state with event: %s", event.Name)
// })
func Exit[T Context](fn func(ctx context.Context, hsm T, event Event), maybeName ...string) RedefinableElement {