release: 0.26, changed NULL_OUTPUT to [], and imposing now that updates be an array, just like outputs. Updated all tests

Author: b

TODO.md

@@ -1,4 +1,7 @@
 # Now
+// TODO: major change maybe brek all tests: change action identity in kingly to outputs: [], and updates: []
+// TODO: document, state updates MUST be an array if using the compiler or yed converter, outputs MUST be an array or null
+  - zero values are used for action identity, and those are ([] and null), maybe future version add an option to change that
 // TODO: Courtesan: in content-courtesan.js change .kuker to .courtesan (but last)
 // TODO: Courtesan devtool: Ben hyperlink schneidermann - information seeking mantra
    - overview first

package.json

@@ -1,7 +1,7 @@
 {
   "name": "kingly",
   "sideEffects": false,
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "Extended Hierarchical State Transducer library",
   "repository": {
     "type": "git",

src/helpers.js

@@ -770,6 +770,10 @@ export function destructureEvent(obj) {
   return {eventName, eventData}
 }
 
+export function formatUndefinedInJSON(obj){
+  return JSON.stringify(obj, (key,value)=> {if (value === undefined) return "undefined"; else return value})
+}
+
 export class KinglyError extends Error {
   // TODO: do something with the tracer too
   constructor(m, console, tracer) {

src/properties.js

@@ -13,7 +13,8 @@ export const STATE_PROTOTYPE_NAME = 'State'; // !!must be the function name for
 // i.e. State
 export const NO_STATE_UPDATE = [];
 // NOTE : this really cannot be anything else than a falsy value, beware
-export const NO_OUTPUT = null;
+// TODO: check consequences of moving it to empty array
+export const NO_OUTPUT = [];
 export const ACTION_IDENTITY = function ACTION_IDENTITY(){
   return {
     outputs : NO_OUTPUT,

src/synchronous_fsm.js

@@ -228,9 +228,8 @@ export function createStateMachine(fsmDef, settings) {
       tracer({
         type: MACHINE_CREATION_ERROR_MSG,
         trace: {
-          error: e,
+          info: e.errors,
           message: e.message,
-          info: {fsmDef, settings},
           machineState: {cs: INIT_STATE, es: extendedState, hs: history}
         }
       });
@@ -318,7 +317,7 @@ export function createStateMachine(fsmDef, settings) {
       });
       console.warn(`The external event INIT_EVENT can only be sent when starting the machine!`)
 
-      return NO_OUTPUT
+      return null
     }
 
     const outputs = process_event(
@@ -391,7 +390,7 @@ export function createStateMachine(fsmDef, settings) {
       // CASE : There is no transition associated to that event from that state
       console.warn(`There is no transition associated to the event |${event}| in state |${current_state}|!`);
 
-      return NO_OUTPUT;
+      return null;
     }
   }
 
@@ -500,7 +499,7 @@ export function createStateMachine(fsmDef, settings) {
           const condition_checking_fn = function (extendedState_, event_data, current_state) {
             from = current_state || from;
             const predicate = guard.predicate || alwaysTrue;
-            const predicateName = predicate.name || predicate.displayName || "";
+            const predicateName = predicate.name || predicate.displayName || "<anonymous>";
             const to = guard.to;
             const shouldTransitionBeTaken = ((extendedState, event_data, settings) => {
               try {
@@ -605,7 +604,7 @@ export function createStateMachine(fsmDef, settings) {
                   machineState: {cs: current_state, es: extendedState, hs: history}
                 }
               });
-              return {stop: false, outputs: NO_OUTPUT};
+              return {stop: false, outputs: null};
             }
           };
           // TODO: remove that, I don't need that anymore
@@ -621,7 +620,7 @@ export function createStateMachine(fsmDef, settings) {
         };
       },
       function dummy() {
-        return {stop: false, outputs: NO_OUTPUT};
+        return {stop: false, outputs: null};
       }
     );
   });
@@ -634,9 +633,8 @@ export function createStateMachine(fsmDef, settings) {
     tracer({
       type: MACHINE_CREATION_ERROR_MSG,
       trace: {
-        error: e,
         message: e.message,
-        info: {fsmDef, settings},
+        info: {fsmDef, settings, error: e},
         machineState: {cs: INIT_STATE, es: extendedState, hs: history}
       }
     });
@@ -719,7 +717,7 @@ export function makeWebComponentFromFsm({name, eventHandler, fsm, commandHandler
       const el = this;
       this.eventSubject = eventHandler;
       this.options = Object.assign({}, options);
-      const NO_ACTION = this.options.NO_ACTION || NO_OUTPUT;
+      const NO_ACTION = this.options.NO_ACTION || null;
 
       // Set up execution of commands
       this.eventSubject.subscribe({

test/contracts.specs.js

@@ -121,40 +121,6 @@ QUnit.test("fsmContracts(fsmDef): compound states - no init transition", functio
   ], message);
 });
 
-// NOTE: we canceled the contract about not having guards in initial transitions for compound states
-QUnit.skip("fsmContracts(fsmDef): compound states - invalid init transition", function exec_test(assert) {
-  const fsmDef = {
-    states: { A: { B: '' }, C: '' },
-    events: ['ev'],
-    transitions: [
-      { from: INIT_STATE, to: 'A', event: INIT_EVENT, action: ACTION_IDENTITY },
-      { from: 'C', to: 'B', event: 'ev', action: ACTION_IDENTITY },
-      { from: 'A', event: INIT_EVENT, guards: [{ to: 'B', action: ACTION_IDENTITY, predicate: () => true }] }
-    ],
-    initialExtendedState: {},
-    updateState: applyJSONpatch,
-  };
-
-  const { isFulfilled, failingContracts } = fsmContractChecker(fsmDef, settings, fsmContracts);
-  const failureInfo = failingContracts.find(x => x.name === validInitialTransitionForCompoundState.name);
-  const { message, info } = failureInfo;
-  const { entryTransitions } = info;
-  assert.deepEqual(isFulfilled, false, `Fails at least one contract`);
-  assert.deepEqual(entryTransitions.map(formatResult), [
-    {
-      "event": "init",
-      "from": "A",
-      "guards": [
-        {
-          "action": "ACTION_IDENTITY",
-          "predicate": "predicate",
-          "to": "B"
-        }
-      ]
-    }
-  ], message);
-});
-
 QUnit.test("fsmContracts(fsmDef): compound states - invalid init transition - target states not within" +
   " hierarchy", function exec_test(assert) {
   const fsmDef = {