TODO pending isolating the portion only related to testing

| Describe events progressing the machine| Get your tests generated for you! |
|:---:|:---:|
| !password selector test generation| |

!Contributions welcome

Table of Contents

- Features
- Examples
- Motivation
- The link between state machines and user interfaces
- Install
- Tests
- Integration with React
- API
* API design
* General concepts
* Transducer semantics
* createStateMachine :: FSM_Def -> Settings -> FSM
* traceFSM :: Env -> FSM_Def -> FSM_Def
* generateTestSequences :: FSM_Def -> Generators -> GenSettings -> Array
- Possible API extensions
- Visualization tools
- References
- Roadmap
- Who else uses state machines
- Annex
* So what is an Extended Hierarchical State Transducer ?
* Terminology

Features

- small size : tree-shakeable implementation, 5k for the core, 9k including tracing and testing
- small API : one function for the state machine, one function for the test generation, one
function for tracing
- just a function! : easy to integrate into any framework
- automatic test generation! : write the machine, how to progress from one state to another,
and let the computer generate hundreds of tests for you

Examples

- password meter component
- movie database search interface
- wizard forms

Motivation

Time and again we have to implement computations which, while they cannot be modelized by pure
functions, however have the following interesting properties :

- they transform an input into an output, depending only on the present and past inputs
- they do not perform any effects
- the algorithm for the computation involves a finite, parameterizable set of rules, coalescing
around a finite, fixed set of control states

These computations can be modelized by a class of state machines called
hierarchical extended state transducer.
This library offers a way to define, and use such class of state machines. Most of the time, we
will call them just state machines instead of the more accurate state transducer term.

Now, the whole thing can sound very abstract but the major motivation for this library has been the
specification and implementation of user interfaces. As a matter of fact, to every user
interface can be associated a computation
relating inputs to the user interface to an action to be performed on the interfaced systems. That
computation often has a logic organized around a limited set of control states. Exactly what
we just wrote about. Jump to the examples.

This library is born from :

- the desire to apply such tool for both specification and implementation of user interfaces
- the absence of existing javascript libraries which satisfy our design criteria
- mostly, we want the state machine library API design to be as close as possible from the
mathematical object denoting it. This should allow us to reason about it, compose and reuse
it easily.
- most libraries we found either do not feature hierarchy in their state machines, or use a
rather imperative API, or impose a concurrency model on top of the state machine's control flow

This is a work in progress, however the main API for the v1.0 should be relatively
stable. Changes for the test API are to be expected though.

It works nicely and have already been used succesfully for user-interfaces as well as in other
contexts:

- in multi-steps workflows: see an example here, a constant feature of enterprise software today
- for 'smart' synchronous streams, which
tracks computation state to avoid useless re-computations
- to implement cross-domain communication protocols, to coordinate iframes with a main window

In such cases, we were able to modelize our computation with an Extended Hierarchical State Transducer
in a way that :

- is economical (complexity of the transducer proportional to complexity of the computation)
- is reasonably easy to reason about and communicate (the transducer can
be visually represented, supporting both internal and external communication, and design
specification and documentation)
- supports step-wise refinement and iterative development (control states can be refined into a
hierarchy of nested states)

The link between state machines and user interfaces

In short :

- a user interface can be specified by a relation between events received by the user
interfaces and actions to be performed as a result on the interfaced system.
- Because to the same triggering event, there may be different actions to perform on the
interfaced system (depending for instance on when the event did occur, or which other events
occured before), we use state to represent that variability, and specify the user interface with
a function f such that actions = f(state, event). We call here f the reactive function for the user interface.
- The previous expression suffices to specify the user interface's behaviour, but is not enough
to deduce an implementation. We then use a function g such that (actions_n, state_{n+1} = g
(state_n, event_n). That is, we explicitly include the modification of the state triggered by
events. Depending on the choice that is made for state_n, there is an infinite number of ways
to specify the user interface.
- a state machine specification is one of those ways with some nice properties (concise
specification, formal reasoning, easy visualization). It divides the state into control states and
extended state. For each control state, it specifies a reactive sub-function which returns an
updated state (i.e. a new control state, and a new extended state) and the actions to perform on
the interfaced system.

Let's take a very simple example to illustrate these equations. The user interface to
specify is a password selector. Visually, the user interface consists of a passowrd input field
and a submit password button. Its behaviour is the following :
- the user types
- for each new value of the password input, the input is displayed in green if the password is
strong (that will be, to remain simple if there are both letters and numbers in the password), and
in red otherwise
- if the password is not strong, the user click on set password button is ignored, otherwise
the password is set to the value of the password input

A f partial formulation :

|State|Event|Actions|
|---|---|---|
|{input: ""}|typed a|display input in red|
|{input: "a"}|typed 2|display input in green|
|{input: "a2"}|clicked submit|submit a2 password|
|{input: "a"}|typed b|display input in red|
|{input: "ab"}|clicked submit|---|

A g partial formulation :

|state_n|event|actions_n|state_{n+1}|
|---|---|---|---|
|{input: ""}|typed a|display input in red|{input: "a"}|
|{input: "a"}|typed 2|display input in green|{input: "a2"}|
|{input: "a2"}|clicked submit|submit a2 password|{input: "a2"}|
|{input: "a"}|typed b|display input in red|{input: "ab"}|
|{input: "ab"}|clicked submit|---|{input: "ab"}|

A state machine partial formulation :

|Control state|Extended state|Event|Actions|New control state|New extended state|
|---|---|---|---|---|---|
|Weak|input: ""|typed a|display input in red|Weak|input: "a"|
|Weak|input: "a"|typed 2|display input in green|Strong|input: "a2"|
|Strong|input: "a2"|clicked submit|submit a2 password|Done|input: "a2"|
|Weak|input: "a"|typed b|display input in red|Weak|input: "ab"|
|Weak|input: "ab"|clicked submit| - |Weak| input: "ab" |

The corresponding implementation is by a function fsm with an encapsulated internal state of
{control state : weak, extended state: {input : ''}} such that, if the user types 'a2' and
clicks submit :

``
fsm(typed 'a') = nothing
fsm(typed '2') = nothing
fsm(clicked submit) = submit a2 password
`

The corresponding visualization (actions are not represented) :

!password submit fsm

Note that we wrote only partial formulations in our table, as the sequence of inputs by the user
is potentially infinite (while this article is not). Our tables do not for instance give a
mapping for the following sequence of events : [typed 'a', typed '2', typed
'<-|']. Conversely, our state machine concisely represents the fact that whatever input we
receive in the Weak control state, it will only go to the Strong control state if some
pre-configured condition are fulfilled (both numbers and letters in the password). It will
only submit the password if the clicked submit event is received while it is in the Strong
state.
The starting state and these two assertions can be combined into a theorem : the machine will only
submit a password if the password is strong. In short, we are able to reason formally about the
machine and extract properties from its definition. This is just one of the many attractive properties of state
machines which makes it a tool of choice for robust and testable user interface's implementation.

For the modelization of a much more complex user interface, and more details on the benefits of state machine, I'll refer the reader to a detailed article I wrote on the subject.

Install

npm install state-transducer --save

Tests

Automated tests are close to completion. Contracts are so far not enforced. To run the
current automated tests, type in a terminal : npm run test

Integration with React

The machine is just a function. As such it is pretty easy to integrate in any framework. As of
today, we provide the following integrations :

- integration with React
- using state machines allows to use React mostly as a DOM library and eliminates the need for
state management, HOC, hooks and other react advanced concepts.

API

API design

The key objectives for the API was :

- generality, reusability and simplicity
- there is no explicit provision made to accommodate specific use cases or frameworks
- it must be possible to add a concurrency and/or communication mechanism on top of the current design
- it must be possible to integrate smoothly into React, Angular and your popular framework
- support for both interactive and reactive programming
- parallel and sequential composability of transducers

As a result of this, the following choices were made :

- functional interface : the transducer is just a function. As such, the
transducer is a black-box, and only its computed outputs can be observed
- complete encapsulation of the state of the transducer
- no effects performed by the machine
- no exit and entry actions, or activities as in other state machine formalisms
- there is no loss of generality as both entry and exit actions can be implemented with our
state transducer. There is simply no syntactic support for it in the core API. This can however be
provided through standard functional programming patterns (higher-order functions, etc.)
- every computation performed is synchronous (asynchrony is an effect)
- action factories return the updates to the extended state to avoid any
unwanted direct modification of the extended state (API user must provide such update function,
which in turn allows him to use any formalism to represent state - for instance immutable.js)
- no restriction is made on output of transducers, but inputs must follow some conventions (if a
machine's output match those conventions, two such machines can be sequentially composed
- parallel composition naturally occurs by feeding two state machines the same input(s))
- as a result, reactive programming is naturally enabled. If inputs is a stream of
well-formatted machine inputs, and f is the fsm, then the stream of outputs will be inputs.map
(f). It is so simple that we do not surface it at the API level

Concretely, our state transducer will be created by the factory function createStateMachine,
which returns a state transducer which :

- immediately positions itself in its configured initial control state
- will compute an output for any input that is sent to it since that

Let us insist again on the fact that the state transducer is not, in general, a pure function of
its inputs. However, a given output of the transducer depends exclusively on the sequence of inputs
it has received so far (causality property). This means that it is possible to associate to a state transducer another function which takes a sequence of inputs into a
sequence of outputs, in a way that that function is pure. This is what enables testing.

General concepts

There are a few things to be acquainted with :
- the state machine formalism
- its extension, including hierarchy (compound states), history states
- the library API

To familiarize the reader with these, we will be leveraging two examples. The first example is
the aforementioned password selector. This pretty simple example will serve to showcase the API
of the library, and standard state machine terminology. The second example modelizes the
behaviour of a CD player. It is more complex, and will feature a hierarchical state machine. For
this example, we will show a run of the machine, and by doing so, illustrate advanced concepts
such as compound states, and history states. We will not indigate into the implementation however. For a very advanced example, I invite the reader to refer to the wizard form demo.

We then present into more details the semantics of a state transducer and how it relates to its
configuration. Finally we present our API whose documentation relies on all previously introduced
concepts.

$3

We will be using as our base example the password selector we discussed previously. As a
reminder, its behaviour was described by the following state machine :

!password submit fsm

To specify our machine, we need :
- a list of control states the machine can be in
- a list of events accepted by the machine
- the initial state of the machine (initial control state, initial extended state)
- to describe transitions from a control state to another

The first three are clear from the graph. The last one can be deduced from the table (cf. above)
describing the behaviour of the password selector.

The fsm ends up being defined by:

`javascript
const initialExtendedState = {
input: ""
};
const states = {
[INIT]: "",
[STRONG]: "",
[WEAK]: "",
[DONE]: ""
};
const initialControlState = INIT;
const events = [TYPED_CHAR, CLICKED_SUBMIT, START];
const transitions = [
{ from: INIT, event: START, to: WEAK, action: displayInitScreen },
{ from: WEAK, event: CLICKED_SUBMIT, to: WEAK, action: NO_ACTIONS },
{
from: WEAK,
event: TYPED_CHAR,
guards: [
{ predicate: isPasswordWeak, to: WEAK, action: displayInputInRed },
{ predicate: isPasswordStrong, to: STRONG, action: displayInputInGreen }
]
},
{
from: STRONG,
event: TYPED_CHAR,
guards: [
{ predicate: isPasswordWeak, to: WEAK, action: displayInputInRed },
{ predicate: isPasswordStrong, to: STRONG, action: displayInputInGreen }
]
},
{
from: STRONG,
event: CLICKED_SUBMIT,
to: DONE,
action: displaySubmittedPassword
}
];

`

where action factories mapped to a transition compute two things :
- a list of updates to apply internally to the extended state
- an external output for the consumer of the state transducer

For instance :

`javascript
function displayInitScreen() {
return {
updates: NO_STATE_UPDATE,
outputs: [
{ command: RENDER, params: { screen: INIT_SCREEN, props: void 0 } }
]
};
}

`

The full runnable code is available here.

$3

This example is taken from Ian Horrock's seminal book on statecharts and is the specification of
a CD player. The behaviour of the CD player is pretty straight forward and understandable
immediately from the visualization. From a didactical point of view, the example serves to feature
advanced characteristics of hierarchical state machines, including history states, composite states,
transient states, automatic transitions, and entry points. For a deeper understanding of how the
transitions work in the case of a hierarchical machine, you can have a look at the
terminology and
sample run for the CD player machine.

!cd player state chart

The salient facts are :
- NO Cd loaded, CD_Paused are control states which are composite states : they are themselves state machines comprised on control states.
- The control state H is a pseudo-control state called shallow history state
- All composite states feature an entry point and an automatic transition. For instance
CD_Paused has the sixth control state as entry point, and the transition from CD_Paused into
that control state is called an automatic transition. Entering the CD_Paused control state
automatically triggers that transition.
- Closing CD drawer is a transient state. The machine will automatically transition away from
it, picking a path according to the guards configured on the available exiting transitions

$3

To illustrate the previously described transducer semantics, let's run the CD player example.

| Control state | Internal event | External event|
|--------------------|:-----------:|------------------|
| INIT_STATE | INIT_EVENT | |
| No Cd Loaded | INIT | |
| CD Drawer Closed | -- | |
| CD Drawer Closed | | Eject |
| CD Drawer Open | | Eject (put a CD) |
| Closing CD Drawer | eventless | |
| CD Loaded | INIT | |
| CD Loaded subgroup | INIT | |
| CD Stopped | -- | |
| CD stopped | | Play |
| CD playing | | Forward down |
| Stepping forwards | | Forward up |
| CD playing | -- | |

Note :

- the state entry semantics -- entering No Cd Loaded leads to enter CD Drawer Closed
- the guard -- because we put a CD in the drawer, the machine transitions from Closing CD Drawer to CD Loaded
- the eventless transition -- the latter is an eventless transition : the guards are
automatically evaluated to select a transition to progress the state machine (by contract, there
must be one)
- the hierarchy of states -- the Forward down event transitions the state machines to Stepping
forwards, as it applies to all atomic states nested in the CD Loaded subgroup control state
- the history semantics -- releasing the forward key on the CD player returns to CD Playing the
last atomic state for compound state CD Loaded subgroup.

Transducer semantics

We give here a quick summary of the behaviour of the state transducer :

Preconditions

- the machine is configured with a set of control states, an initial extended state,
transitions, guards, action factories, and user settings.
- the machine configuration is valid (cf. contracts)
- Input events have the shape {{[event_label]: event_data}}

Event processing

- Calling the machine factory creates a machine according to specifications and triggers the
reserved INIT_EVENT event which advances the state machine out of the reserved internal
initial control state towards the relevant user-configured initial control state
- the INIT_EVENT event carries the initial extended state as data
- if there is no initial transition, it is required to pass an initial control state
- if there is no initial control state, it is required to configure an initial transition
- an initial transition is a transition from the reserved INIT_STATE initial control state,
triggered by the reserved initial event INIT_EVENT
- Loop
- Search for a feasible transition in the configured transitions
- a feasible transition is a transition which is configured to deal with the received event, and
for which there is a fulfilled guard
- If there is no feasible transition :
- issue memorized output (NO_OUTPUT if none), extended state and control state do not change.
Break away from the loop
- If there is a feasible transition, select the first transition according to what follows :
- if there is an INIT transition, select that
- if there is an eventless transition, select that
- otherwise select the first transition whose guard is fulfilled (as ordered per array index)
- evaluate the selected transition
- if the target control state is an history state, replace it by the control state it
references (i.e. the last seen nested state for that compound state)
- update the extended state (with the updates produced by the action factory)
- aggregate and memorize the outputs (produced by the action factory)
- update the control state to the target control state
- update the history for the control state (applies only if control state is compound state)
- iterate on Loop
- _THE END_

A few interesting points :

- a machine always transitions towards an atomic state at the end of event processing
- on that path towards an atomic target state, all intermediary extended state updates are
performed. Guards and action factories on that path are thus receiving a possibly evolving extended
state. The computed outputs will be aggregated in an array of outputs.

The aforedescribed behaviour is loosely summarized here :

!event processing

History states semantics

An history state relates to the past configuration a compound state. There
are two kinds of history states : shallow history states (H), and deep history states (H*). A
picture being worth more than words, thereafter follows an illustration of both history states :

!deep and shallow history

Assuming the corresponding machine has had the following run [INIT, EVENT1, EVENT3, EVENT5,
EVENT4]:

- the configurations for the OUTER control state will have been [OUTER.A, INNER, INNER.S, INNER.T]
- the shallow history state for the OUTER control state will correspond to the INNER control
state (the last direct substate of OUTER), leading to an automatic transition to INNER_S
- the deep history state for the OUTER control state will correspond to the INNER.T control
state (the last substate of OUTER before exiting it)

In short the history state allows to short-circuit the default entry behaviour for a compound
state, which is to follow the transition triggered by the INIT event. When transitioning to the
history state, transition is towards the last seen state for the entered compound state.

$3

#### Format
- state names must be unique and conform to the same nomenclature than javascript variable
identifiers (cannot be empty strings, cannot start with a number, etc.)
- all transitions must be valid :
- all states referenced in the transitions data structure must be defined in the states data
structure
- the transition syntax must be followed (cf. types)
- all transitions must define an action (even if that action does not modify the extended state
or returns NO_OUTPUT)
- all action factories must fill in the updates and outputs property (no syntax sugar)
- NO_OUTPUT must be used to indicate the absence of outputs

#### Initial event and initial state
By initial transition, we mean the transition with origin the machine's default initial state.

- An initial transition must be configured :
- by way of a starting control state defined at configuration time
- by way of a initial transition at configuration time
- ~~the init event has the initial extended state as event data~~
- the initial event can only be sent internally (external initial events will be ignored, and the
machine will return NO_OUTPUT)
- the state machine starts in the reserved initial state
- there are no incoming transitions to the reserved initial state
- ~~The machine cannot stay blocked in the initial control state. This means that at least one
transition must be configured and be executed between the initial control state and another state
. This is turn means :~~
- ~~at least one non-reserved control state must be configured~~
- ~~at least one transition out of the initial control state must be configured~~
- ~~of all guards for such transitions, if any, at least one must be fulfilled to enable a
transition away from the initial control state~~
- there is exactly one initial transition, with unambiguous target state, whose only effect is to
determine the starting control state for the machine
- there is no guard on that transition
- the action on that transition is the identity action

#### Semantical contracts
- A transition evaluation must end
- eventless transitions must progress the state machine
- at least one guard must be fulfilled, otherwise we would remain forever in the same state
- eventless self-transitions are forbidden (while theoretically possible, the feature is of
little practical value, though being a possible source of ambiguity or infinite loops)
- ~~eventless self-transitions must modify the extended state~~
- ~~lest we loop forever (a real blocking infinite loop)~~
- ~~note that there is not really a strong rationale for eventless self-transition, I recommend
just staying away from it~~
- the machine is deterministic and unambiguous
- NOTE TO SELF: absolutely enforce that contract
- to a (from, event) couple, there can only correspond one row in the transitions array of the
state machine (but there can be several guards in that row)
- (particular case) eventless transitions must not be contradicted by event-ful transitions
- A -ev> B and A < OUTER_A with OUTER_A -ev>C !! : there are two valid transitions triggered by
ev. Such transitions would unduely complicate the input testing generation, and decrease
the readability of the machine so we forbid such transitions[^x]
- there cannot be two transitions with the same (from, event, predicate) - sameness defined for
predicate by referential equality
- no transitions from the history state (history state is only a target state)
- A transition evaluation must end in an atomic state
- Initial states must be defined for every compound state
- Every compound state must have eactly one INIT transition, i.e. a transition whose
triggering event is INIT_EVENT. That transition must have a target state which is a substate
of the compound state (no hierarchy crossing)
- Compound states must not have eventless transitions defined on them (would introduce
ambiguity with the INIT transition)
- (the previous conditions ensure that there is always a way down the hierarchy for compound
states, and that way is always taken when entering the compound state, and the descent
process always terminate)
- the machine does not perform any effects
- guards, action factories are pure functions
- as such exceptions while running those functions are fatal, and will not be caught
- updateState :: ExtendedState -> ExtendedStateUpdates -> ExtendedState must be a pure function
(this is important in particular for the tracing mechanism which triggers two execution of this
function with the same parameters)

[^x]: There are however semantics which allow such transitions, thus possibilitating event bubbling.



createStateMachine :: FSM_Def -> Settings -> FSM

$3

This FSM factory function takes the parameters defining the behaviour of the state transducer,
and returns the created state transducer. The created state transducer is a regular function called
with inputs which are passed to the internal state machine, and in return the computed outputs are
received. The syntax for an input is {{[eventLabel] : eventData}}, i.e. an input is an object with exactly one key, which is the event identifier, and the value matching the key is the event data.

The machine additionnally can carry over environment variables, which are accessible in guards,
and action factories. This helps maintaining such functions pure and testable. Environment
variables can also be used to parameterize the state machine's behaviour.

History states are generated by a factory returned by a helper makeHistoryStates :: FSM_States ->
HistoryStateFactory. An history state is coupled to a compound state, and has a type (deep or
shallow). Passing this information to the factory produdces the sought history state.

The settings.updateState property is mandatory, and specify how to update a model from the
.updates produced by an action factory. We used successfully JSON patch operations for model
updates, but you can choose to use the inmutable library of your choice or a simple reducer. The
important point is that the extended state should not be modified in place, i.e. updateState is
a pure function.

$3

- All previously mentioned contracts apply.
- The settings.updateState property is mandatory.
- The settings property should not be modified after being passed as parameter (i.e. should be
a constant): it is not cloned and is passed to all relevant functions (guards, etc.)
- The key types contracts
are summarized here :

`javascript
/**
* @typedef {Object} FSM_Def
* @property {FSM_States} states Object whose every key is a control state admitted by the
* specified state machine. The value associated to that key is unused in the present version of the library. The
* hierarchy of the states correspond to property nesting in the states object
* @property {Array} events A list of event monikers the machine is configured to react to
* @property {Array} transitions An array of transitions the machine is allowed to take
@property {} initialExtendedState The initial value for the machine's extended state
*/
/**
@typedef {Object.>} FSM_States
*/
/**
* @typedef {InconditionalTransition | ConditionalTransition} Transition
*/
/**
* @typedef {{from: ControlState, to: ControlState|HistoryState, event: EventLabel, action: ActionFactory}} InconditionalTransition
* Inconditional_Transition encodes transition with no guards attached. Every time the specified event occurs, and
* the machine is in the specified state, it will transition to the target control state, and invoke the action
* returned by the action factory
*/
/**
* @typedef {{from: ControlState, event: EventLabel, guards: Array}} ConditionalTransition Transition for the
* specified state is contingent to some guards being passed. Those guards are defined as an array.
*/
/**
* @typedef {{predicate: FSM_Predicate, to: ControlState|HistoryState, action: ActionFactory}} Condition On satisfying the
* specified predicate, the received event data will trigger the transition to the specified target control state
* and invoke the action created by the specified action factory, leading to an update of the internal state of the
* extended state machine and possibly an output to the state machine client.
*/
/**
* @typedef {function(ExtendedState, EventData, FSM_Settings) : Actions} ActionFactory
*/
/**
* @typedef {{updates: ExtendedStateUpdate, outputs: Array | NO_OUTPUT}} Actions The actions
* to be performed by the state machine in response to a transition. updates represents the state update for
* the variables of the extended state machine. output represents the output of the state machine passed to the
* API caller.
*/
/* @typedef {function (ExtendedState, EventData) : Boolean} FSM_Predicate /
/* @typedef {{updateState :: Function(ExtendedState, ExtendedStateUpdate) : ExtendedState, ...}} FSM_Settings /
/**
* @typedef {Object.} LabelledEvent extended state for a given state machine
*/
/**
* @typedef {function(historyType: HistoryType, controlState: ControlState): HistoryState} HistoryStateFactory
*/
/**
* @typedef {{type:{}, [HistoryType]: ControlState}} HistoryState
*/
/**
* @typedef {Object.} History history object containing deeep and shallow history states
* for all relevant control states
*/
/**
* @typedef {Object.} HistoryDict Maps a compound control state to its history state
*/
/**
* @typedef {DEEP | SHALLOW} HistoryType
*/
/* @typedef {String} ControlState Name of the control state /
/* @typedef {String} EventLabel /
/**
@typedef {} EventData
*/
/**
@typedef {} ExtendedState extended state for a given state machine
*/
/**
@typedef {} ExtendedStateUpdate
*/
/* @typedef { | NO_OUTPUT} MachineOutput well it is preferrable that that be an object instead of a primitive */
`

$3

We are going to show the definition for the following hierrchical state machine :

!state machine under test

The definition is as follows :

`javascript
const states = { [OUTER]: { [INNER]: { [INNER_S]: '', [INNER_T]: '' }, [OUTER_A]: '', [OUTER_B]: '' }, [Z]: '' };
const hs = makeHistoryStates(states);
const fsmDef = {
states,
events: [EVENT1, EVENT2, EVENT3, EVENT4, EVENT5],
initialExtendedState: { history: DEEP, counter: 0 },
transitions: [
{ from: INIT_STATE, event: INIT_EVENT, to: OUTER, action: ACTION_IDENTITY },
{ from: OUTER, event: INIT_EVENT, to: OUTER_A, action: ACTION_IDENTITY },
{ from: OUTER_A, event: EVENT1, to: INNER, action: ACTION_IDENTITY },
{ from: INNER, event: INIT_EVENT, to: INNER_S, action: ACTION_IDENTITY },
{ from: INNER_S, event: EVENT3, to: INNER_T, action: ACTION_IDENTITY },
{ from: INNER_T, event: EVENT3, to: INNER_S, action: ACTION_IDENTITY },
{ from: INNER, event: EVENT2, to: OUTER_B, action: ACTION_IDENTITY },
{ from: OUTER, event: EVENT5, to: Z, action: ACTION_IDENTITY },
{
from: Z, event: EVENT4, guards: [
{
predicate: function isDeep(x, e) {return x.history === DEEP},
to: hs.deep(OUTER),
action: incCounter
},
{
predicate: function isShallow(x, e) {return x.history !== DEEP},
to: hs.shallow(OUTER),
action: incCounter
}
]
},
],
};
`

Note in particular :
- the nesting of states in states
- the use of ACTION_IDENTITY when there is no action to be applied
- that action does not modify the extended state of the machine, and returns NO_OUTPUT
- how history states are included in the machine definition

There are plenty of additional examples in the test directory.

makeWebComponentFromFsm :: TODO -> ()

TODO for v1.0

Register the machine as a web component.

traceFSM :: Env -> FSM_Def -> FSM_Def

$3

This function converts a state machine A into a traced state machine T(A). The traced state
machine, on receiving an input I outputs the following information :

- outputs : the outputs A(I)
- updates : the update of the extended state of A to be performed as a consequence of receiving the input I
- extendedState : the extended state of A prior to receiving the input I
- newExtendedState : the extended state of A after receiving the input I and computing
the outputs
- controlState : the control state in which the machine is when receiving the input I
- event::{eventLabel, eventData} : the event label and event data corresponding to I
- settings : settings passed at construction time to A
- targetControlState : the target control state the machine has transitioned to as a consequence of receiving the input I
- predicate : the predicate (guard) corresponding to the transition that was taken to
targetControlState, as a consequence of receiving the input I
- actionFactory : the action factory which was executed as a consequence of receiving the
input I
- guardIndex : the index for the guard in the .guards array of a transition away from a
control state, triggered by an event
- transitionIndex : the index for the transition in the .transitions array which contain the
specifications for the machine's transition

Note that the trace functionality is obtained by wrapping over the action factories in A. As
such, all action factories will see their output wrapped. This means :

- transitions which do not lead to the execution of action factories are not traced
- when the machine cannot find any transition for an event, hence any action to execute,
the traced machine will simply return null.


Note also that env is not used for now, and could be used to parameterize the tracing.

$3

Types contracts, nothing special.

$3

Cf. tests

generateTestSequences :: FSM_Def -> Generators -> GenSettings -> Array

$3

The generateTestSequences method produce test cases from a state machine definition, and input
generators associated to each transition defined in the machine. The test generation strategy is
specified in genSettings.strategy (two common strategies are already defined in graph-adt
library and can be reused). Additionally the genSettings parameter can contain any relevant
parameters to be passed to the state machine when it is created.

Input generators (Generators) are coupled to a given state machine for which they generate an
input sequence. The structure of Generators hence replicates the structure of the transitions of
the state machine under test. Typically we recommend copy pasting transitions from FSM_Def,
and add a gen property for each transition definition (you can keep or remove any of the
other properties - they are ignored). That gen property is a
function, which must generate event data for the event defined in
the coupled transition, or signal impossibility of such generation. If the generator does
generate event data, then we have a candidate input for inclusion in the test input sequence.

The generators receive as input the extended state for the state machine, and the current value
of the input generation state. The input generation state is empty when the input generation
starts, and only generators have the possibility to update it. The generator thus computes and
returns three things :
- whether it can generate an input which makes the machine take the coupled transition
- the input that makes the machine take the coupled transition if any
- the updated input generation state

The input generation state is for instance used in the movie search app demo to ensure that
different movie searches are generated every time the user returns to the querying control state.

The generation strategy is determined by two predicates, isGoalReached and isTraversableEdge,
with the same signature :
- isGoalReached answers the question of whether an input sequence is
as good as finalized, and should be wrapped as a test case; or if alternatively the search should
continue, possibly increasing the input sequence or possibly failing to generate an input sequence.
Commonly, this function will test if a target control state is reached, as we often seek to
generate input sequences driving the machine to a given state.
- isTraversableEdge answers the question of whether a transition (edge of the graph
corresponding to the machine) should be taken, adding the generated input to the current input
sequence. isTraversableEdge is commonly used to fulfill a coverage criteria, for instance
All-transition (No test case can lead to a transition to be taken twice). As a matter of fact,
the input generation is an exhaustive enumeration of edge paths in the state machine graph, which isTraversableEdge filters down through its criteria.

There are two premade strategies which you can use, instead of configuring the generation
strategy by yourself :
- ALL_n_TRANSITIONS({ targetVertex: ..., maxNumberOfTraversals: ... })
- this strategy constructs the input sequences for which the machine ends in the target control
state targetVertex, and no transition taken as a result of applying the input sequence to
the machine is taken more than the maxNumberOfTraversals
- ALL_TRANSITIONS({ targetVertex: ... })
- this strategy is a particular case of the former strategy with maxNumberOfTraversals set to 1
- this strategy visits all the configured transitions of the state machine

Any generated test case fulfills the goal specified by isGoalReached, and fulfills the conditions
imposed by isTraversableEdge. The test case gathers the generated input sequence, together
with the outputs and control state sequences corresponding to running the generated input sequence
through the state machine.

Important caveats :
- The machine configuration generally specifies only those events which must be
reacted to. However it is implicitly part of the machine's specification that the events which are
not configured for the current control state to cause the machine to output NO_OUTPUT. A
complete specification of the machine would involve for every control state, an
explicit transition defining its behaviour for every event handled by the machine. For obvious
reasons of economy, we hardly ever write explicitly complete state machines
- For that reason, keep in mind that generateTestSequences generates what we would call valid or
interesting test sequences. Invalid or impossible input sequences are not generated by design. It is thus not
possible to use directly the test generator output to test against the behaviour of the machine
when facing an incorrect input sequence

$3

- the state machine is turned into a graph
- the machine is flattened : all outgoing transitions from a compound state are replaced by
the equivalent set of transitions whose origin state is an atomic substate... well, except for
the outgoing INIT transition, which remains identical
- [A < B < C, A < B < D], and A -ev-> B, is replaced by C -ev-> B, D -ev-> B
- a transition to a history state will be translated in a transition to any possible history
target, with an attached guard which only allows the transition if the history state is indeed
the attached control state
- the graph is searched starting with the initial state with the view to generate all possible
paths of the state machine, starting from the initial state
- if the graph is A -> B, B-> C, B -> D, then the graph search generates [A,B,C] and [A,B,D]
- At any point, the state of the search is the array of test cases already generated, and the
test case in process, starting from an initial state with empty test cases
- a test case is generated iteratively as follows :
- the machine starts in the initial state.
- the test case is initially empty
- the graph search produces a candidate edge (transition)
- if the edge is not traversable (isTraversableEdge) then the search branch is abandoned, no
input case is generated, the search backtracks and continues with investigating another path
sequence
- otherwise, the input generator generates an input exercising that transition or signals there is
no such input
- if no satisfying input can be generated, the search branch is abandoned, no input case is
generated, the search backtracks and continues with investigating another path sequence
- for instance, for the previous graph, if [A,B,C] fails to generate a case, then [A,B,D]
is tried next
- if an input trigerring the transition is generated, it is added to the test case in
progress, together with the corresponding outputs of the machine, the resulting control
state and the updated input generation state
- the candidate transition may result in a cascade of transitions, due to special
transitions (eventless, automatic transitions (for instance entering a compound state,
transition involving history states). The test case is adjusted accordingly.
- if the goal is reached (isGoalReached) with the updated test case, then that test case is
considered finalized and added to the current list of generated test case. the search
backtracks and continues with investigating another path sequence
- in summary, there are two reductions processes and two accumulators involved:
- the PathTraversalState, which gathers the path sequence and associated data (input
sequence, output sequence, control state sequence, and input generation state)
- the GraphTraversalState, which gathers the generated test cases
- when the search finished, the array of generated test cases is returned

$3

Type contracts apply.

`javascript
/**
* @typedef {Array} Generators An array of transitions associated to an input generator for
* the sut
*/
/**
* @typedef {{from: ControlState, event: Event, guards: Array}} GenTransitionFromState Transition for the
* specified state is contingent to some guards being passed. Those guards are defined as an array. The from and
* event properties are not used by the program, we kept them here to assist writing the input generator by having
* the transition it refers to at hand.
*/
/**
* @typedef {{predicate: Predicate, gen: InputGenerator, to: ControlState}} GenSpecs Specifies a generator gen
* which will be responsible for computing event data for events which pass the predicate, triggering a transition to
* to control state. The predicate and to properties are not used by the program, we kept them here to
* assist writing the input generator by having the transition it refers to at hand.
*/
/**
@typedef {function (ExtendedState) : {input: EventData, hasGeneratedInput: Boolean, generatorState:}} InputGenerator
* generator which knows how to generate event data for an event to trigger the related transition, taking into
* account the extended state of the machine under test, and the state of the input generation. In the event, it is not
* possible to generate the targeted transition of the state machine, the generator sets the returned property
* hasGeneratedInput to false. The generator may also update the state of the input generation.
*/
/**
* @typedef {{inputSequence: InputSequence, outputSequence:OutputSequence, controlStateSequence:ControlStateSequence}} TestCase
*/
/**
* @typedef {Array} InputSequence
*/
/**
* @typedef {Array} OutputSequence
*/
/**
* @typedef {Array} ControlStateSequence
*/
/**
* @typedef {function (Edge, Graph, PathTraversalState, GraphTraversalState) : Boolean} SearchPredicate Computes a
* boolean in function of the current visited edge, the current search path, and the previously accumulated results.
* In addition the graph ADT is available for querying graph entities (vertices, edges, etc).
*/
/**
* @typedef {{ isGoalReached : SearchPredicate, isTraversableEdge : SearchPredicate}} SearchStrategy
*/
/**
* @typedef {{strategy : SearchStrategy, updateState, ...}} GenSettings Must contain settings for the associated
* state machine under test (the ... part), and the search strategy for the associated graph. Most often, it will
* be enough to reuse premade search strategy : ALL_TRANSITIONS, ALL_n_TRANSITIONS, etc.
*/

`

$3

We are going to reuse here a former example :

!state machine under test

We remind here the machine definition:

`javascript
const states = { [OUTER]: { [INNER]: { [INNER_S]: '', [INNER_T]: '' }, [OUTER_A]: '', [OUTER_B]: '' }, [Z]: '' };
const hs = makeHistoryStates(states);
const fsmDef = {
states,
events: [EVENT1, EVENT2, EVENT3, EVENT4, EVENT5],
initialExtendedState: { history: DEEP, counter: 0 },
transitions: [
{ from: INIT_STATE, event: INIT_EVENT, to: OUTER, action: ACTION_IDENTITY },
{ from: OUTER, event: INIT_EVENT, to: OUTER_A, action: ACTION_IDENTITY },
{ from: OUTER_A, event: EVENT1, to: INNER, action: ACTION_IDENTITY },
{ from: INNER, event: INIT_EVENT, to: INNER_S, action: ACTION_IDENTITY },
{ from: INNER_S, event: EVENT3, to: INNER_T, action: ACTION_IDENTITY },
{ from: INNER_T, event: EVENT3, to: INNER_S, action: ACTION_IDENTITY },
{ from: INNER, event: EVENT2, to: OUTER_B, action: ACTION_IDENTITY },
{ from: OUTER, event: EVENT5, to: Z, action: ACTION_IDENTITY },
{
from: Z, event: EVENT4, guards: [
{
predicate: function isDeep(x, e) {return x.history === DEEP},
to: hs.deep(OUTER),
action: incCounter
},
{
predicate: function isShallow(x, e) {return x.history !== DEEP},
to: hs.shallow(OUTER),
action: incCounter
}
]
},
],
};
`

We are seeking to generate test cases which end with the machine in the state OUTER_B.

We are configuring our input generators by copy pasting the state machine under test and adding
the generators definition for each control state ;

`javascript
const genFsmDef = {
transitions: [
{
from: INIT_STATE, event: INIT_EVENT, to: OUTER,
gen: function genINITtoOUTER(extS) {return { input: extS, hasGeneratedInput: true }}
},
{ from: OUTER, event: INIT_EVENT, to: OUTER_A },
{
from: OUTER_A, event: EVENT1, to: INNER,
gen: function genOUTER_AtoINNER(extS) {return { input: null, hasGeneratedInput: true }}
},
{ from: INNER, event: INIT_EVENT, to: INNER_S },
{
from: INNER_S, event: EVENT3, to: INNER_T,
gen: function genINNER_StoINNER_T(extS) {return { input: null, hasGeneratedInput: true }}
},
{
from: INNER_T, event: EVENT3, to: INNER_S,
gen: function genINNER_TtoINNER_S(extS) {return { input: null, hasGeneratedInput: true }}
},
{
from: INNER, event: EVENT2, to: OUTER_B,
gen: function genINNERtoOUTER_B(extS) {return { input: null, hasGeneratedInput: true }}
},
{
from: OUTER, event: EVENT5, to: Z,
gen: function genOUTERtoZ(extS) {return { input: null, hasGeneratedInput: true }}
},
{
from: Z, event: EVENT4, guards: [
{
predicate: function isDeep(x, e) {return x.history === DEEP},
to: hs.deep(OUTER),
gen: function genZtoOUTER_DEEP_H(extS) {return { input: DEEP, hasGeneratedInput: extS.history === DEEP }},
},
{
predicate: function isShallow(x, e) {return x.history !== DEEP},
to: hs.shallow(OUTER),
gen: function genZtoOUTER_SHALLOW_H(extS) {
return {
input: SHALLOW,
hasGeneratedInput: extS.history !== DEEP
}
},
}
]
},
],
};
`

Note that :
- some events carry no event data (EVENT_1 for instance). The generator hence sets
null as generated event data.
- some events have no guards. The corresponding generators hence always have hasGeneratedInput =
true, as those events are always triggering a transition when they occur
- some events have guards. The corresponding generator will set hasGeneratedInput to false when
the guard cannot be satisfied. A guard is a function of the extended state extS and the event
data. The generator is passed the event data. According to the guard at end, the generator must
resolve the equation find extS so that for all eventData, guard(extS, eventData) = false. For
those extS, the hasGeneratedInput will be set to false : no matter the event, the guard can
never be satisfied. For the rest of the cases, the generator will pick an EventData which
satisfies the guard, if any.

We then define our extended state update method, our search strategy (All-transitions coverage) :

`javascript
const generators = genFsmDef.transitions;
const settings = { updateState: applyJSONpatch, strategy: ALL_TRANSITIONS({ targetVertex:
OUTER_B }) };
const results = generateTestSequences(fsmDef, generators, settings);
`

We then get the results back :

Test case inputs
`javascript
[
[
{ "init": { "counter": 0, "history": "deep" } },
{ "event1": null }, { "event3": null }, { "event3": null }, { "event2": null }
],
[
{ "init": { "counter": 0, "history": "deep" } },
{ "event1": null }, { "event3": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }
],
[
{ "init": { "counter": 0, "history": "deep" } },
{ "event1": null }, { "event3": null }, { "event2": null }
],
[
{ "init": { "counter": 0, "history": "deep" } },
{ "event1": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event2": null }
],
[
{ "init": { "counter": 0, "history": "deep" } },
{ "event1": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }
],
[
{ "init": { "counter": 0, "history": "deep" } },
{ "event1": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event1": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event3": null }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event3": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event3": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }],
[{
"init": { "counter": 0, "history": "deep" }
}, { "event5": null }, { "event4": "deep" }, { "event1": null }, { "event5": null }, { "event4": "deep" }, { "event2": null }]
]

`

Test case outputs

`javascript

[
[null, null, null, null, null],
[null, null, null, null, null, 0, null],
[null, null, null, null],
[null, null, null, null, 0, null, null],
[null, null, null, null, 0, null, null, 1, null],
[null, null, null, null, 0, null],
[null, null, null],
[null, null, null, 0, null, null, null],
[null, null, null, 0, null, null],
[null, null, null, 0, null, null, 1, null, null],
[null, null, null, 0, null, null, 1, null],
[null, null, null, 0, null],
[null, null, 0, null, null, null, null],
[null, null, 0, null, null, null, null, 1, null],
[null, null, 0, null, null, null],
[null, null, 0, null, null, null, 1, null, null],
[null, null, 0, null, null, null, 1, null, null, 2, null],
[null, null, 0, null, null, null, 1, null],
[null, null, 0, null, null],
[null, null, 0, null, null, 1, null, null, null],
[null, null, 0, null, null, 1, null, null],
[null, null, 0, null, null, 1, null, null, 2, null, null],
[null, null, 0, null, null, 1, null, null, 2, null],
[null, null, 0, null, null, 1, null]
]
`

Note that :
- to every input passed to the machine, there is an array of data produced as output. That array
is concatenated to constitute the output sequence.
- Here because that array of data only has one item, we can easily relate input from a given input
sequence to the matching output of the corresponding output sequence : they have the same index!
That would however not be the case in general.

The corresponding sequence of control states is as follows :

`javascript
[
["nok", "OUTER", "outer_a", "INNER", "inner_s", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "inner_t", "inner_s", "z", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "inner_t", "z", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "inner_t", "z", "inner_t", "inner_s", "z", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "inner_t", "z", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "z", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "z", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "INNER", "inner_s", "z", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "inner_t", "inner_s", "z", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "inner_t", "z", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "inner_t", "z", "inner_t", "inner_s", "z", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "inner_t", "z", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "z", "inner_t", "inner_s", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "z", "inner_s", "inner_t", "z", "inner_t", "outer_b"],
["nok", "OUTER", "outer_a", "z", "outer_a", "INNER", "inner_s", "z", "inner_s", "outer_b"]
]
``

Note that:
- we have exercised all poss