add support for round-trip serialization of Factions by reference ins…

…ide MissionSites

src/game-lib-tests/GameStateFixtures.cs

@@ -1,3 +1,4 @@
+using Lib.Data;
 using UfoGameLib.Model;
 using UfoGameLib.State;
 
@@ -12,7 +13,15 @@ public static GameState Get()
         {
             var agent = new Agent(id: i, turnHired: 1, Agent.AgentState.Available);
             var terminatedAgent = new Agent(id: 100 + i, turnHired: 1, Agent.AgentState.Terminated);
-            var missionSite = new MissionSite(id: i, difficulty: 1, turnAppeared: 1, expiresIn: 1);
+            bool isExpired = i % 2 == 0;
+            var missionSite = new MissionSite(
+                id: i,
+                gs.Factions[i % gs.Factions.Count],
+                difficulty: 1,
+                turnAppeared: 1,
+                expiresIn: isExpired ? null : 1,
+                turnDeactivated: isExpired ? 2 : null,
+                expired: isExpired);
             var mission = new Mission(id: i, missionSite, agentsSent: 1);
             gs.Assets.Agents.Add(agent);
             gs.TerminatedAgents.Add(terminatedAgent);

src/game-lib-tests/GameStateTests.cs

@@ -171,4 +171,28 @@ public void DeserializeGameStateFromInitialGameStateJsonString()
 
         new JsonDiffAssertion(baseline: initialJsonString, target: deserializedJsonString).Assert();
     }
+
+    /// <summary>
+    /// Use this test to exercise correct behavior of serialization and deserialization of GameState with
+    /// GameState.StateJsonSerializerOptions which most importantly exercise
+    /// UfoGameLib.State.GameStateJsonConverter.
+    ///
+    /// This test DOES NOT assert hat data structures have not been duplicated in the serialization.
+    /// Inspect the resulting JSON in debugger to verify this.
+    /// </summary>
+    [Test]
+    public void RoundTripSerializationOnNontrivialGameState()
+    {
+        GameState gameState = GameStateFixtures.Get();
+
+        // Act: serialize using GameState.StateJsonSerializerOptions
+        string gameStateAsJsonString = gameState.ToJsonString();
+
+        // Act: deserialize using GameState.StateJsonSerializerOptions
+        GameState deserializedGameState = JsonSerializer.Deserialize<GameState>(gameStateAsJsonString, Opts)!;
+
+        string deserializedJsonString = deserializedGameState.ToJsonString();
+
+        new JsonDiffAssertion(baseline: gameStateAsJsonString, target: deserializedJsonString).Assert();
+    }
 }

src/game-lib/Controller/TimeAdvancementController.cs

@@ -219,7 +219,8 @@ private void CreateMissionSites(GameState state)
             int siteId = state.NextMissionSiteId;
             (int difficulty, int difficultyFromTurn, int roll) =
                 Ruleset.RollMissionSiteDifficulty(state.Timeline.CurrentTurn, _randomGen);
-            var site = new MissionSite(siteId, difficulty, turnAppeared: state.Timeline.CurrentTurn, expiresIn: 3);
+            // kja inject appropriate faction instead of state.Faction[0]
+            var site = new MissionSite(siteId, state.Factions[0], difficulty, turnAppeared: state.Timeline.CurrentTurn, expiresIn: 3);
             state.MissionSites.Add(site);
             _log.Info($"Add {site.LogString} : " +
                       $"difficulty: {difficulty,3}, " +

src/game-lib/Model/MissionSite.cs

@@ -14,6 +14,7 @@ public class MissionSite : IIdentifiable
 {
     public int Id { get; }
 
+    public readonly Faction Faction;
     public readonly int Difficulty;
     public readonly int TurnAppeared;
 
@@ -30,6 +31,7 @@ public class MissionSite : IIdentifiable
     [JsonConstructor]
     public MissionSite(
         int id,
+        Faction faction,
         int difficulty,
         int turnAppeared,
         int? expiresIn,
@@ -39,6 +41,7 @@ public MissionSite(
         Contract.Assert(Difficulty >= 0);
         Contract.Assert(ExpiresIn == null || ExpiresIn >= 0);
         Id = id;
+        Faction = faction;
         Difficulty = difficulty;
         TurnAppeared = turnAppeared;
         TurnDeactivated = turnDeactivated;

src/game-lib/State/GameStateJsonConverter.cs

@@ -102,6 +102,11 @@ public override void Write(Utf8JsonWriter writer, GameState value, JsonSerialize
             objJsonArrayName: nameof(Assets.Agents),
             propName: nameof(Agent.CurrentMission));
 
+        ReplaceArrayObjectsPropertiesWithRefs(
+            parent: gameStateNode,
+            objJsonArrayName: nameof(GameState.MissionSites),
+            propName: nameof(MissionSite.Faction));
+
         gameStateNode.WriteTo(writer, SerializationOptions);
     }
 
@@ -112,7 +117,22 @@ public override GameState Read(ref Utf8JsonReader reader, Type typeToConvert, Js
         int updateCount = DeserializeInt(gameStateNode, nameof(GameState.UpdateCount));
         Factions factions = Deserialize<Factions>(gameStateNode);
         Timeline timeline = Deserialize<Timeline>(gameStateNode);
-        MissionSites missionSites = Deserialize<MissionSites>(gameStateNode);
+
+        var missionSites = new MissionSites(
+            DeserializeObjArrayWithDepRefProps(
+                objJsonArray: JsonArray(gameStateNode, nameof(GameState.MissionSites)),
+                depRefPropName: nameof(MissionSite.Faction),
+                deps: factions,
+                (missionSiteObj, faction)
+                    => new MissionSite(
+                        id: DeserializeInt(missionSiteObj, nameof(MissionSite.Id)),
+                        faction: faction!,
+                        difficulty: DeserializeInt(missionSiteObj, nameof(MissionSite.Difficulty)),
+                        turnAppeared: DeserializeInt(missionSiteObj, nameof(MissionSite.TurnAppeared)),
+                        expiresIn: DeserializeIntOrNull(missionSiteObj, nameof(MissionSite.ExpiresIn)),
+                        turnDeactivated: DeserializeIntOrNull(missionSiteObj, nameof(MissionSite.TurnDeactivated)),
+                        expired: DeserializeBool(missionSiteObj, nameof(MissionSite.Expired)))));
+
         Agents terminatedAgents =
             Deserialize<List<Agent>>(gameStateNode, nameof(GameState.TerminatedAgents)).ToAgents(terminated: true);
 

src/lib/Json/JsonConverterSupportingReferences.cs

@@ -61,6 +61,9 @@ protected int Id(JsonNode node)
     protected int DeserializeInt(JsonNode node, string propName)
         => node[propName]!.GetValue<int>();
 
+    protected int? DeserializeIntOrNull(JsonNode node, string propName)
+        => node[propName]?.GetValue<int>();
+
     protected int? DeserializeNullableInt(JsonNode node, string propName)
     {
         JsonNode? propVal = node[propName];