#13 Fix npe during state syncs.

Problem was undiscovered due to faulty tests which we successfully passing. Which has been resulted due to using exposed libraries while in game runtime libraries are not exposed. Fixed by copying original libraries to test output directory. As result 69 tests has failed. Applied fixes for those tests.
onimp · Jan 31, 2024 · 3c3e03f · 3c3e03f
1 parent 1cb64d1
commit 3c3e03f
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 28 deletions.
diff --git a/src/MultiplayerMod.Test/Directory.Build.targets b/src/MultiplayerMod.Test/Directory.Build.targets
@@ -1,4 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
     <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.targets', '$(MSBuildThisFileDirectory)../'))" />
+    <Target Name="AfterBuild">
+        <Copy SourceFiles="$(ManagedPath)\Assembly-CSharp.dll" DestinationFolder="$(OutputPath)"/>
+        <Copy SourceFiles="$(ManagedPath)\Assembly-CSharp-firstpass.dll" DestinationFolder="$(OutputPath)"/>
+    </Target>
 </Project>
diff --git a/src/MultiplayerMod.Test/Multiplayer/Commands/Chores/States/StartMoveTest.cs b/src/MultiplayerMod.Test/Multiplayer/Commands/Chores/States/StartMoveTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using MultiplayerMod.Core.Dependency;
 using MultiplayerMod.Core.Events;
+using MultiplayerMod.Core.Reflection;
 using MultiplayerMod.Game.Chores.States;
 using MultiplayerMod.Game.Chores.Types;
 using MultiplayerMod.ModRuntime;
@@ -54,7 +55,7 @@ StateTransitionConfig config
 
         command.Execute(new MultiplayerCommandContext(null, new MultiplayerCommandRuntimeAccessor(Runtime.Instance)));
 
-        var target = sm.GetType().GetField("stateTarget")!.GetValue(sm);
+        var target = sm.GetFieldValue("stateTarget");
         var navigator = (Navigator) target.GetType().GetMethod("Get")
             .MakeGenericMethod(typeof(Navigator))
             .Invoke(target, new object[] { smi });

diff --git a/src/MultiplayerMod.Test/Multiplayer/Commands/Chores/States/UpdateMoveTest.cs b/src/MultiplayerMod.Test/Multiplayer/Commands/Chores/States/UpdateMoveTest.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using MultiplayerMod.Core.Dependency;
 using MultiplayerMod.Core.Events;
+using MultiplayerMod.Core.Reflection;
 using MultiplayerMod.Game.Chores.States;
 using MultiplayerMod.Game.Chores.Types;
 using MultiplayerMod.ModRuntime;
@@ -49,7 +50,7 @@ StateTransitionConfig config
         command.Execute(new MultiplayerCommandContext(null, new MultiplayerCommandRuntimeAccessor(Runtime.Instance)));
 
         var sm = smi.stateMachine;
-        var target = sm.GetType().GetField("stateTarget")!.GetValue(sm);
+        var target = sm.GetFieldValue("stateTarget");
         var navigator = (Navigator) target.GetType().GetMethod("Get")
             .MakeGenericMethod(typeof(Navigator))
             .Invoke(target, new object[] { smi });

diff --git a/...ultiplayerMod.Test/Multiplayer/Patches/Chores/States/AdjustStateMachineTransitionsTest.cs b/...ultiplayerMod.Test/Multiplayer/Patches/Chores/States/AdjustStateMachineTransitionsTest.cs
@@ -223,12 +223,12 @@ private class FakeStatesManager : StatesManager {
         public readonly List<StateMachine.BaseState> WaitArgs = new();
         public readonly List<StateMachine.BaseState> ContinuationArgs = new();
 
-        public override void AddAndTransitToWaiStateUponEnter(StateMachine.BaseState stateToBeSynced) {
-            WaitArgs.Add(stateToBeSynced);
+        public override void AddAndTransitToWaiStateUponEnter(StateMachine.BaseState state) {
+            WaitArgs.Add(state);
         }
 
-        public override StateMachine.BaseState AddContinuationState(StateMachine.BaseState stateToBeSynced) {
-            ContinuationArgs.Add(stateToBeSynced);
+        public override StateMachine.BaseState AddContinuationState(StateMachine.BaseState state) {
+            ContinuationArgs.Add(state);
             return null!;
         }
     }

diff --git a/src/MultiplayerMod.Test/MultiplayerMod.Test.csproj b/src/MultiplayerMod.Test/MultiplayerMod.Test.csproj
@@ -17,7 +17,7 @@
     <ItemGroup>
         <PackageReference Include="Microsoft.CSharp" Version="4.7.0"/>
         <PackageReference Include="NUnit" Version="3.13.3"/>
-        <PackageReference Include="AssemblyExposer.MSBuild.Task" Version="0.1.5" Private="true" />
+        <PackageReference Include="AssemblyExposer.MSBuild.Task" Version="0.1.5" Private="true"/>
     </ItemGroup>
     <ItemGroup>
         <Reference Include="Assembly-CSharp" HintPath="$(ExposedLibrariesPath)\Assembly-CSharp.dll"/>

diff --git a/src/MultiplayerMod/Core/Reflection/ReflectionExtension.cs b/src/MultiplayerMod/Core/Reflection/ReflectionExtension.cs
@@ -0,0 +1,23 @@
+using System;
+using System.Reflection;
+
+namespace MultiplayerMod.Core.Reflection;
+
+public static class ReflectionExtension {
+
+    public static object GetFieldValue(this object obj, string fieldName) {
+        return GetFieldValue<object>(obj, fieldName);
+    }
+
+    public static T GetFieldValue<T>(this object obj, string fieldName) {
+        var type = obj.GetType();
+        while (type != typeof(object)) {
+            var field = type.GetField(fieldName, BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public);
+            if (field != null) {
+                return (T) field.GetValue(obj);
+            }
+            type = type.BaseType;
+        }
+        throw new Exception($"Field {fieldName} not found in {obj.GetType()}");
+    }
+}
diff --git a/src/MultiplayerMod/Game/Chores/States/ChoreStateEvents.cs b/src/MultiplayerMod/Game/Chores/States/ChoreStateEvents.cs
@@ -4,6 +4,7 @@
 using System.Reflection;
 using HarmonyLib;
 using JetBrains.Annotations;
+using MultiplayerMod.Core.Reflection;
 using MultiplayerMod.Game.Chores.Types;
 using MultiplayerMod.ModRuntime.Context;
 using MultiplayerMod.Multiplayer;
@@ -142,7 +143,7 @@ private static void UpdateHandlerCallback(StateTransitionConfig config, StateMac
 
     private static void EventHandlerCallback(StateTransitionConfig config, StateMachine.Instance smi) {
         var chore = (Chore) smi.GetMaster();
-        var goToStack = (Stack<StateMachine.BaseState>) smi.GetType().GetField("gotoStack").GetValue(smi);
+        var goToStack = GetGoToStack(smi);
         var newState = goToStack.FirstOrDefault();
         var args = config.ParameterName
             .ToDictionary(
@@ -163,10 +164,9 @@ private static void EventHandlerCallback(StateTransitionConfig config, StateMach
 
     private static void MoveEnterHandler(StateMachine.Instance smi) {
         var chore = (Chore) smi.GetMaster();
-        var goToStack = (Stack<StateMachine.BaseState>) smi.GetType().GetField("gotoStack").GetValue(smi);
+        var goToStack = GetGoToStack(smi);
         var newState = goToStack.FirstOrDefault();
-        var sm = smi.stateMachine;
-        var target = sm.GetType().GetField("stateTarget")!.GetValue(sm);
+        var target = GetStateTarget(smi);
         var navigator = (Navigator) target.GetType().GetMethod("Get")
             .MakeGenericMethod(typeof(Navigator))
             .Invoke(target, new object[] { smi });
@@ -177,10 +177,9 @@ private static void MoveEnterHandler(StateMachine.Instance smi) {
 
     private static void MoveUpdateHandler(StateMachine.Instance smi, float dt) {
         var chore = (Chore) smi.GetMaster();
-        var goToStack = (Stack<StateMachine.BaseState>) smi.GetType().GetField("gotoStack").GetValue(smi);
+        var goToStack = GetGoToStack(smi);
         var newState = goToStack.FirstOrDefault();
-        var sm = smi.stateMachine;
-        var target = sm.GetType().GetField("stateTarget")!.GetValue(sm);
+        var target = GetStateTarget(smi);
         var navigator = (Navigator) target.GetType().GetMethod("Get")
             .MakeGenericMethod(typeof(Navigator))
             .Invoke(target, new object[] { smi });
@@ -191,7 +190,7 @@ private static void MoveUpdateHandler(StateMachine.Instance smi, float dt) {
 
     private static void MoveExitHandler(StateMachine.Instance smi) {
         var chore = (Chore) smi.GetMaster();
-        var goToStack = (Stack<StateMachine.BaseState>) smi.GetType().GetField("gotoStack").GetValue(smi);
+        var goToStack = GetGoToStack(smi);
         var newState = goToStack.FirstOrDefault();
 
         OnExitMoveTo?.Invoke(new MoveToArgs(chore, newState.name, 0, null!));
@@ -210,4 +209,12 @@ private static int GetParameterIndex(StateMachine.Instance smi, string parameter
         var parameterContext = smi.parameterContexts[parameterIndex];
         return parameterContext.GetType().GetField("value").GetValue(parameterContext);
     }
+
+    private static object GetStateTarget(StateMachine.Instance smi) {
+        return smi.stateMachine.GetFieldValue("stateTarget");
+    }
+
+    private static Stack<StateMachine.BaseState> GetGoToStack(StateMachine.Instance smi) {
+        return smi.GetFieldValue<Stack<StateMachine.BaseState>>("gotoStack");
+    }
 }
diff --git a/src/MultiplayerMod/Multiplayer/Commands/Chores/States/StartMove.cs b/src/MultiplayerMod/Multiplayer/Commands/Chores/States/StartMove.cs
@@ -1,4 +1,5 @@
 using System;
+using MultiplayerMod.Core.Reflection;
 using MultiplayerMod.Game.Chores.States;
 using MultiplayerMod.Multiplayer.Objects;
 using MultiplayerMod.Multiplayer.States;
@@ -26,7 +27,7 @@ public override void Execute(MultiplayerCommandContext context) {
         smi.GoTo("root." + TargetState);
 
         var sm = smi.stateMachine;
-        var target = sm.GetType().GetField("stateTarget")!.GetValue(sm);
+        var target = sm.GetFieldValue("stateTarget");
         var navigator = (Navigator) target.GetType().GetMethod("Get")
             .MakeGenericMethod(typeof(Navigator))
             .Invoke(target, new object[] { smi });

diff --git a/src/MultiplayerMod/Multiplayer/Commands/Chores/States/UpdateMove.cs b/src/MultiplayerMod/Multiplayer/Commands/Chores/States/UpdateMove.cs
@@ -1,4 +1,5 @@
 using System;
+using MultiplayerMod.Core.Reflection;
 using MultiplayerMod.Game.Chores.States;
 using MultiplayerMod.Multiplayer.Objects;
 using MultiplayerMod.Multiplayer.States;
@@ -20,7 +21,7 @@ public override void Execute(MultiplayerCommandContext context) {
         var smi = context.Runtime.Dependencies.Get<StatesManager>().GetSmi(chore);
 
         var sm = smi.stateMachine;
-        var target = sm.GetType().GetField("stateTarget")!.GetValue(sm);
+        var target = sm.GetFieldValue("stateTarget");
         var navigator = (Navigator) target.GetType().GetMethod("Get")
             .MakeGenericMethod(typeof(Navigator))
             .Invoke(target, new object[] { smi });

diff --git a/src/MultiplayerMod/Multiplayer/Objects/StateMachineReferenceExtensions.cs b/src/MultiplayerMod/Multiplayer/Objects/StateMachineReferenceExtensions.cs
@@ -1,4 +1,4 @@
-using System.Reflection;
+using MultiplayerMod.Core.Reflection;
 using MultiplayerMod.Multiplayer.Objects.Reference;
 
 namespace MultiplayerMod.Multiplayer.Objects;
@@ -13,7 +13,5 @@ public static class StateMachineReferenceExtensions {
     // `controller` field is defined in StateMachine<,,,>.GenericInstance. However cast is impossible due to unknown
     // generic argument types. So reflection is the most handy way to get its value :(
     private static StateMachineController GetStateMachineController(StateMachine.Instance instance) =>
-        (StateMachineController) instance.GetType()
-            .GetField("controller", BindingFlags.Instance | BindingFlags.NonPublic)!
-            .GetValue(instance);
+        instance.GetFieldValue<StateMachineController>("controller");
 }
diff --git a/src/MultiplayerMod/Multiplayer/States/StatesManager.cs b/src/MultiplayerMod/Multiplayer/States/StatesManager.cs
@@ -3,6 +3,7 @@
 using System.Reflection;
 using JetBrains.Annotations;
 using MultiplayerMod.Core.Dependency;
+using MultiplayerMod.Core.Reflection;
 
 namespace MultiplayerMod.Multiplayer.States;
 
@@ -22,8 +23,8 @@ public virtual void AllowTransition(Chore chore, string? targetState, Dictionary
         );
     }
 
-    public virtual void AddAndTransitToWaiStateUponEnter(StateMachine.BaseState stateToBeSynced) {
-        var sm = (StateMachine) stateToBeSynced.GetType().GetField("sm").GetValue(stateToBeSynced);
+    public virtual void AddAndTransitToWaiStateUponEnter(StateMachine.BaseState state) {
+        var sm = GetSm(state);
         InjectWaitHostState(sm);
         var callbackType = typeof(StateMachine<,,,>)
             .GetNestedType("State")
@@ -34,16 +35,15 @@ public virtual void AddAndTransitToWaiStateUponEnter(StateMachine.BaseState stat
             BindingFlags.NonPublic | BindingFlags.Static
         )!;
         var callback = Delegate.CreateDelegate(callbackType, method);
-        stateToBeSynced.enterActions.Add(new StateMachine.Action("Transit to waiting state", callback));
+        state.enterActions.Add(new StateMachine.Action("Transit to waiting state", callback));
     }
 
-    public virtual StateMachine.BaseState AddContinuationState(StateMachine.BaseState stateToBeSynced) {
-        var sm = (StateMachine) stateToBeSynced.GetType().GetField("sm").GetValue(stateToBeSynced);
-
+    public virtual StateMachine.BaseState AddContinuationState(StateMachine.BaseState state) {
+        var sm = GetSm(state);
         var genericType = typeof(ContinuationState<,,,>).MakeGenericType(
             sm.GetType().BaseType.GetGenericArguments().Append(typeof(object))
         );
-        return (StateMachine.BaseState) Activator.CreateInstance(genericType, sm, stateToBeSynced);
+        return (StateMachine.BaseState) Activator.CreateInstance(genericType, sm, state);
     }
 
     public void InjectWaitHostState(StateMachine sm) {
@@ -62,6 +62,10 @@ public StateMachine.Instance GetSmi(Chore chore) {
             .GetValue(chore);
     }
 
+    private static StateMachine GetSm(StateMachine.BaseState state) {
+        return state.GetFieldValue<StateMachine>("sm");
+    }
+
     private static StateMachine.BaseState GetWaitHostState(StateMachine.Instance smi) =>
         smi.stateMachine.GetState("root." + WaitStateName);