chore(state-machine): Panic in the case of non-handled non-deferred e…

…vents

This just loops through the event-queue at the end of an iteration, and if
there are non-deferred events left in the queue -> panic.

This is a serious logic error if true, and hence will lead to non-defined
behaviour. Thus we simply panic in this case

Signed-off-by: Ole Petter <[email protected]>

src/common/state_machine.hpp

@@ -223,6 +223,21 @@ class StateMachineRunner : virtual public EventPoster<EventType> {
 			// actionable until at least one state machine reaches a different state.
 			PostToEventLoop();
 		}
+
+		// Check if there are any non-deferred events in the queue - then fail if
+		queue<EventType> queue_copy = event_queue_;
+		while (not queue_copy.empty()) {
+			// If we have no more states, but there is still an event left in the
+			// queue which is not deferred, then we have a serious logic problem. Panic!
+			EventType event = queue_copy.front();
+			queue_copy.pop();
+			for (auto machine : machines_) {
+				if (machine->deferred_events_.find(event) == machine->deferred_events_.end()) {
+					log::Fatal(
+						"The state machine has an unprocessed non-deferred event in the queue. This is a programming error!");
+				}
+			}
+		}
 	}
 
 	void PostToEventLoop() {