Merge pull request #10 from CoderGamester/develop

Release 0.5.2

Author: CoderGamester

CHANGELOG.md

@@ -4,10 +4,18 @@ All notable changes to this package will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.5.2] - 2020-09-27
+
+- Added *IStatechartEvent* data to the logs
+- Added logs to all possible trigger cases
+- Added logs to the *ITaskWaitState* and *IWaitState* waiting call method
+- Added exception catch to the *ITaskWaitState* and *IWaitState* waiting call method
+- Added the possibility to enable logs individually to each *IState*
+
 ## [0.5.1] - 2020-09-24
 
 **Fixed**
-- Fixed *ITaskWaitState* execution crash	
+- Fixed *ITaskWaitState* execution crash
 
 ## [0.5.0] - 2020-09-24
 

Runtime/IState.cs

@@ -10,6 +10,10 @@ namespace GameLovers.Statechart
 	/// </summary>
 	public interface IState
 	{
+		/// <summary>
+		/// Allows to show logs in the console to help debugging possible errors in this specific state
+		/// </summary>
+		bool LogsEnabled { get; set; }
 	}
 
 	#region Compositions

Runtime/Internal/StateInternal.cs

@@ -52,6 +52,8 @@ internal abstract class StateInternal : IStateInternal
 
 		private static uint _idRef;
 
+		/// <inheritdoc />
+		public bool LogsEnabled { get; set; }
 		/// <inheritdoc />
 		public uint Id { get; }
 		/// <inheritdoc />
@@ -61,6 +63,8 @@ internal abstract class StateInternal : IStateInternal
 		/// <inheritdoc />
 		public string CreationStackTrace { get; }
 
+		protected bool IsStateLogsEnabled => LogsEnabled || _stateFactory.Data.Statechart.LogsEnabled;
+
 		protected StateInternal(string name, IStateFactoryInternal stateFactory)
 		{
 			Id = ++_idRef;
@@ -80,25 +84,36 @@ public IStateInternal Trigger(IStatechartEvent statechartEvent)
 
 			if (transition == null)
 			{
+				if (IsStateLogsEnabled)
+				{
+					Debug.Log($"'{statechartEvent?.Name}' does not trigger any transition in state '{Name}'");
+				}
+				
 				return null;
 			}
 
 			var nextState = transition.TargetState;
 
 			if (Equals(nextState))
 			{
+				if (IsStateLogsEnabled)
+				{
+					Debug.Log($"'{statechartEvent?.Name}' event triggers the transition in state'{Name}' to" +
+					          $"itself because it's of type {GetType().UnderlyingSystemType.Name}");
+				}
+				
 				return nextState;
 			}
 
-			if (transition.TargetState == null)
+			if (nextState == null)
 			{
-				TriggerTransition(transition);
+				TriggerTransition(transition, statechartEvent?.Name);
 
 				return null;
 			}
 
 			TriggerExit();
-			TriggerTransition(transition);
+			TriggerTransition(transition, statechartEvent?.Name);
 			TriggerEnter(nextState);
 
 			return nextState;
@@ -141,9 +156,9 @@ private void TriggerEnter(IStateInternal state)
 		{
 			try
 			{
-				if (_stateFactory.Data.Statechart.LogsEnabled)
+				if (IsStateLogsEnabled)
 				{
-					Debug.LogFormat("Entering '{0}'", state.Name);
+					Debug.Log($"Entering '{state.Name}'");
 				}
 				state.Enter();
 			}
@@ -157,9 +172,9 @@ private void TriggerExit()
 		{
 			try
 			{
-				if(_stateFactory.Data.Statechart.LogsEnabled)
+				if(IsStateLogsEnabled)
 				{
-					Debug.LogFormat("Exiting '{0}'", Name);
+					Debug.LogFormat($"Exiting '{Name}'");
 				}
 				Exit();
 			}
@@ -169,14 +184,17 @@ private void TriggerExit()
 			}
 		}
 
-		private void TriggerTransition(ITransitionInternal transition)
+		private void TriggerTransition(ITransitionInternal transition, string eventName)
 		{
 			try
 			{
-				if (_stateFactory.Data.Statechart.LogsEnabled)
+				if (IsStateLogsEnabled)
 				{
-					Debug.Log($"Transition '{Name}' -> '{transition.TargetState?.Name}'");
+					var targetState = transition.TargetState?.Name ?? "only invokes OnTransition() without moving to new state";
+					
+					Debug.Log($"'{eventName}' event triggers the transition '{Name}' -> '{targetState}'");
 				}
+				
 				transition.TriggerTransition();
 			}
 			catch (Exception e)

Runtime/Internal/TaskWaitState.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Threading.Tasks;
+using UnityEngine;
 
 // ReSharper disable CheckNamespace
 
@@ -119,20 +120,34 @@ protected override ITransitionInternal OnTrigger(IStatechartEvent statechartEven
 
 			if (!_triggered)
 			{
-				InnerTaskAwait(_taskAwaitAction);
 				_triggered = true;
+				InnerTaskAwait(statechartEvent?.Name);
 			}
 
 			return _completed ? _transition : null;
 		}
 
-		private async void InnerTaskAwait(Func<Task> taskAwaitAction)
+		private async void InnerTaskAwait(string eventName)
 		{
 			var currentExecution = _executionCount;
 
 			_executionCount++;
-			
-			await taskAwaitAction();
+
+			try
+			{
+				if (IsStateLogsEnabled)
+				{
+					Debug.Log($"'{eventName}' event triggers the task wait method '{_taskAwaitAction.Method.Name}'" +
+					          $"from the object {_taskAwaitAction.Target} in the state {Name}");
+				}
+				
+				await _taskAwaitAction();
+			}
+			catch (Exception e)
+			{
+				throw new Exception($"Exception in the state '{Name}', when calling the task wait action {_taskAwaitAction.Method.Name}" +
+				                    $"from the object {_taskAwaitAction.Target}.\n" + CreationStackTrace, e);
+			}
 
 			_completed = true;
 

Runtime/Internal/WaitState.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using GameLovers.Statechart;
+using UnityEngine;
 
 // ReSharper disable CheckNamespace
 
@@ -129,13 +130,31 @@ protected override ITransitionInternal OnTrigger(IStatechartEvent statechartEven
 			if (!_triggered)
 			{
 				_triggered = true;
-				_waitingActivity.ExecutionCount = _executionCount;
-				_executionCount++;
-				
-				_waitAction(_waitingActivity);
+				InnerWait(statechartEvent?.Name);
 			}
 
 			return _waitingActivity.IsCompleted && _waitingActivity.ExecutionCount == _executionCount - 1 ? _transition : null;
 		}
+
+		private void InnerWait(string eventName)
+		{
+			_waitingActivity.ExecutionCount = _executionCount;
+			_executionCount++;
+
+			try
+			{
+				if (IsStateLogsEnabled)
+				{
+					Debug.Log($"'{eventName}' event triggers the wait method '{_waitAction.Method.Name}'" +
+					          $"from the object {_waitAction.Target} in the state {Name}");
+				}
+				_waitAction(_waitingActivity);
+			}
+			catch(Exception e)
+			{
+				throw new Exception($"Exception in the state '{Name}', when calling the wait action {_waitAction.Method.Name}" +
+				                    $"from the object {_waitAction.Target}.\n" + CreationStackTrace, e);
+			}
+		}
 	}
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.gamelovers.statechart",
   "displayName": "Statechart",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "unity": "2019.3",
   "description": "This package allows the use of Statecharts (Hierarchichal State Machine) within an Unity project.\n\nThe primary feature of Statecharts is that states can be organized in a hierarchy.\nA Statecharts is a state machine where each state in the state machine may define its own subordinate state machines, called substates.\nThose states can again define substates.\n\nFor more information: https://statecharts.github.io/what-is-a-statechart.html",
   "type": "library",