com.wallstop-studios.unity-helpers 2.0.0-rc81.9 → 2.0.1

package/Tests/Runtime/Performance/SpatialTree3DPerformanceTests.cs

@@ -265,7 +265,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Performance
             BenchmarkReadmeUpdater.UpdateSection(
                 "SPATIAL_TREE_3D_BENCHMARKS",
                 finalReadmeLines,
-                "SPATIAL_TREE_3D_PERFORMANCE.md"
+                "Docs/SPATIAL_TREE_3D_PERFORMANCE.md"
             );
 
             yield break;
@@ -389,6 +389,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Performance
                 return lines;
             }
 
+            // Add an intermediate heading so tab headers (####) increment correctly from h3.
+            lines.Add("### Datasets");
+            lines.Add(string.Empty);
             lines.Add("<!-- tabs:start -->");
             lines.Add(string.Empty);
             foreach ((DatasetSpec dataset, List<string> datasetLines) in datasetOutputs)

package/Tests/Runtime/Serialization/JsonConverterAdditionalTests.cs

@@ -0,0 +1,30 @@
+namespace WallstopStudios.UnityHelpers.Tests.Serialization
+{
+    using System.Text.Json;
+    using NUnit.Framework;
+    using UnityEngine;
+    using WallstopStudios.UnityHelpers.Core.Serialization;
+    using WallstopStudios.UnityHelpers.Tests.TestUtils;
+
+    public sealed class JsonConverterAdditionalTests : CommonTestBase
+    {
+        [Test]
+        public void GameObjectConverterWritesStructuredJson()
+        {
+            GameObject go = Track(new GameObject("ConverterTestObject"));
+            int expectedId = go.GetInstanceID();
+            string json = Serializer.JsonStringify(go);
+            Assert.IsFalse(string.IsNullOrWhiteSpace(json));
+
+            using JsonDocument doc = JsonDocument.Parse(json);
+            JsonElement root = doc.RootElement;
+            Assert.AreEqual(JsonValueKind.Object, root.ValueKind);
+            Assert.True(root.TryGetProperty("name", out JsonElement name));
+            Assert.True(root.TryGetProperty("type", out JsonElement type));
+            Assert.True(root.TryGetProperty("instanceId", out JsonElement id));
+            Assert.AreEqual("ConverterTestObject", name.GetString());
+            StringAssert.Contains("UnityEngine.GameObject", type.GetString());
+            Assert.AreEqual(expectedId, id.GetInt32());
+        }
+    }
+}

package/Tests/Runtime/Serialization/JsonConverterAdditionalTests.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: a5049c1d54ff58a4fa4c706458f8e2bf
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Tests/Runtime/Serialization/JsonConverterTests.cs

@@ -7,9 +7,10 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
     using UnityEngine.Rendering;
     using UnityEngine.SceneManagement;
     using WallstopStudios.UnityHelpers.Core.Serialization;
+    using WallstopStudios.UnityHelpers.Tests.TestUtils;
 
     [TestFixture]
-    public sealed class JsonConverterTests
+    public sealed class JsonConverterTests : CommonTestBase
     {
         [Test]
         public void QuaternionConverterSerializeAndDeserializeSuccess()
@@ -757,14 +758,12 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void GameObjectConverterSerializeValidGameObjectSuccess()
         {
-            GameObject original = new("TestObject");
+            GameObject original = Track(new GameObject("TestObject"));
             string json = Serializer.JsonStringify(original);
 
             Assert.IsFalse(string.IsNullOrWhiteSpace(json));
             Assert.IsTrue(json.Contains("TestObject"));
             Assert.IsTrue(json.Contains("UnityEngine.GameObject"));
-
-            UnityEngine.Object.DestroyImmediate(original);
         }
 
         [Test]
@@ -779,7 +778,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void GameObjectConverterSerializeDestroyedGameObjectReturnsEmptyObject()
         {
-            GameObject original = new("TestObject");
+            GameObject original = Track(new GameObject("TestObject"));
             UnityEngine.Object.DestroyImmediate(original);
 
             string json = Serializer.JsonStringify(original);
@@ -1088,10 +1087,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void BoundingSphereConverterSerializeAndDeserializeSuccess()
         {
-            UnityEngine.BoundingSphere original = new(new Vector3(1, 2, 3), 4f);
+            BoundingSphere original = new(new Vector3(1, 2, 3), 4f);
             string json = Serializer.JsonStringify(original);
-            UnityEngine.BoundingSphere deserialized =
-                Serializer.JsonDeserialize<UnityEngine.BoundingSphere>(json);
+            BoundingSphere deserialized = Serializer.JsonDeserialize<BoundingSphere>(json);
             Assert.AreEqual(original.position, deserialized.position);
             Assert.AreEqual(original.radius, deserialized.radius);
         }
@@ -1120,11 +1118,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void SceneConverterSerializeAndDeserializeSuccess()
         {
-            Scene scene = UnityEngine.SceneManagement.SceneManager.GetActiveScene();
+            Scene scene = SceneManager.GetActiveScene();
             string json = Serializer.JsonStringify(scene);
-            Scene deserialized = Serializer.JsonDeserialize<UnityEngine.SceneManagement.Scene>(
-                json
-            );
+            Scene deserialized = Serializer.JsonDeserialize<Scene>(json);
             Assert.IsTrue(deserialized.IsValid());
             Assert.AreEqual(scene.name, deserialized.name);
         }

package/Tests/Runtime/Serialization/JsonRoundtripComprehensiveTests.cs

@@ -31,14 +31,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void AdaptersCollectionsRoundTrip()
         {
-            List<FastVector3Int> list = new List<FastVector3Int>
-            {
-                new(1, 2, 3),
-                new(-4, 5, -6),
-                new(7, 0, -1),
-            };
+            List<FastVector3Int> list = new() { new(1, 2, 3), new(-4, 5, -6), new(7, 0, -1) };
 
-            Dictionary<string, FastVector2Int> map = new Dictionary<string, FastVector2Int>
+            Dictionary<string, FastVector2Int> map = new()
             {
                 ["a"] = new(9, -9),
                 ["b"] = new(0, 1),
@@ -76,7 +71,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void CompositePayloadRoundTrips()
         {
-            CompositePayload payload = new CompositePayload
+            CompositePayload payload = new()
             {
                 fv2 = new FastVector2Int(-3, 7),
                 fv3 = new FastVector3Int(1, -2, 3),
@@ -147,7 +142,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void CompositePayloadRoundTripsWithFastOptions()
         {
-            CompositePayload payload = new CompositePayload
+            CompositePayload payload = new()
             {
                 fv2 = new FastVector2Int(9, -4),
                 fv3 = new FastVector3Int(5, 6, -7),

package/Tests/Runtime/Serialization/JsonSerializationTest.cs

@@ -34,15 +34,24 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         public void UnityEngineObjectSerializationWorks()
         {
             GameObject testGo = new("Test GameObject", typeof(SpriteRenderer));
+            int expectedId = testGo.GetInstanceID();
             string json = testGo.ToJson();
             Assert.IsFalse(string.IsNullOrWhiteSpace(json), json);
             Assert.AreNotEqual("{}", json);
-            Assert.IsTrue(json.Contains("name = Test GameObject"), json);
-            Assert.IsTrue(json.Contains("type = UnityEngine.GameObject"), json);
+
+            using System.Text.Json.JsonDocument doc = System.Text.Json.JsonDocument.Parse(json);
+            System.Text.Json.JsonElement root = doc.RootElement;
+            Assert.AreEqual(System.Text.Json.JsonValueKind.Object, root.ValueKind);
+            Assert.True(root.TryGetProperty("name", out var name));
+            Assert.True(root.TryGetProperty("type", out var type));
+            Assert.True(root.TryGetProperty("instanceId", out var id));
+            Assert.AreEqual("Test GameObject", name.GetString());
+            StringAssert.Contains("UnityEngine.GameObject", type.GetString());
+            Assert.AreEqual(expectedId, id.GetInt32());
         }
 
-        [Test]
-        public void NullGameObjectSerializationWorks()
+        [UnityEngine.TestTools.UnityTest]
+        public System.Collections.IEnumerator NullGameObjectSerializationWorks()
         {
             GameObject testGo = null;
             string json = testGo.ToJson();
@@ -50,7 +59,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
 
             testGo = new GameObject();
             testGo.Destroy();
-            Assert.IsFalse(string.IsNullOrWhiteSpace(json), json);
+            yield return null; // allow Unity to nullify destroyed object
+            Assert.IsTrue(testGo == null);
+            json = testGo.ToJson();
             Assert.AreEqual("null", json);
         }
 

package/Tests/Runtime/Serialization/ProtoRoundtripComprehensiveTests.cs

@@ -38,7 +38,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void Vector2RoundTrip()
         {
-            Vector2 v = new Vector2(1.5f, -2.25f);
+            Vector2 v = new(1.5f, -2.25f);
             Vector2 again = RoundTrip(v);
             Assert.AreEqual(v.x, again.x, 0f, "Vector2 x should match");
             Assert.AreEqual(v.y, again.y, 0f, "Vector2 y should match");
@@ -47,7 +47,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void Vector3RoundTrip()
         {
-            Vector3 v = new Vector3(-1.5f, 2.75f, 3.25f);
+            Vector3 v = new(-1.5f, 2.75f, 3.25f);
             Vector3 again = RoundTrip(v);
             Assert.AreEqual(v.x, again.x, 0f, "Vector3 x should match");
             Assert.AreEqual(v.y, again.y, 0f, "Vector3 y should match");
@@ -57,12 +57,12 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void Vector2IntAndVector3IntRoundTrip()
         {
-            Vector2Int v2i = new Vector2Int(int.MinValue + 1, int.MaxValue - 1);
+            Vector2Int v2i = new(int.MinValue + 1, int.MaxValue - 1);
             Vector2Int v2iAgain = RoundTrip(v2i);
             Assert.AreEqual(v2i.x, v2iAgain.x, "Vector2Int x should match");
             Assert.AreEqual(v2i.y, v2iAgain.y, "Vector2Int y should match");
 
-            Vector3Int v3i = new Vector3Int(1, -2, 3);
+            Vector3Int v3i = new(1, -2, 3);
             Vector3Int v3iAgain = RoundTrip(v3i);
             Assert.AreEqual(v3i.x, v3iAgain.x, "Vector3Int x should match");
             Assert.AreEqual(v3i.y, v3iAgain.y, "Vector3Int y should match");
@@ -72,7 +72,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void QuaternionRoundTrip()
         {
-            Quaternion q = new Quaternion(0.1f, 0.2f, 0.3f, 0.9f);
+            Quaternion q = new(0.1f, 0.2f, 0.3f, 0.9f);
             Quaternion again = RoundTrip(q);
             Assert.AreEqual(q.x, again.x, 0f, "Quaternion x should match");
             Assert.AreEqual(q.y, again.y, 0f, "Quaternion y should match");
@@ -83,14 +83,14 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void ColorAndColor32RoundTrip()
         {
-            Color c = new Color(0.1f, 0.2f, 0.3f, 0.4f);
+            Color c = new(0.1f, 0.2f, 0.3f, 0.4f);
             Color cAgain = RoundTrip(c);
             Assert.AreEqual(c.r, cAgain.r, 0f, "Color r should match");
             Assert.AreEqual(c.g, cAgain.g, 0f, "Color g should match");
             Assert.AreEqual(c.b, cAgain.b, 0f, "Color b should match");
             Assert.AreEqual(c.a, cAgain.a, 0f, "Color a should match");
 
-            Color32 c32 = new Color32(10, 20, 30, 40);
+            Color32 c32 = new(10, 20, 30, 40);
             Color32 c32Again = RoundTrip(c32);
             Assert.AreEqual(c32.r, c32Again.r, "Color32 r should match");
             Assert.AreEqual(c32.g, c32Again.g, "Color32 g should match");
@@ -113,11 +113,11 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void RectAndRectIntRoundTrip()
         {
-            Rect r = new Rect(1.5f, 2.5f, 10f, 20f);
+            Rect r = new(1.5f, 2.5f, 10f, 20f);
             Rect rAgain = RoundTrip(r);
             Assert.AreEqual(r, rAgain, "Rect should round-trip by value");
 
-            RectInt ri = new RectInt(1, 2, 3, 4);
+            RectInt ri = new(1, 2, 3, 4);
             RectInt riAgain = RoundTrip(ri);
             Assert.AreEqual(ri, riAgain, "RectInt should round-trip by value");
         }
@@ -125,12 +125,12 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void BoundsAndBoundsIntRoundTrip()
         {
-            Bounds b = new Bounds(new Vector3(1, 2, 3), new Vector3(4, 5, 6));
+            Bounds b = new(new Vector3(1, 2, 3), new Vector3(4, 5, 6));
             Bounds bAgain = RoundTrip(b);
             Assert.AreEqual(b.center, bAgain.center, "Bounds center should round-trip");
             Assert.AreEqual(b.size, bAgain.size, "Bounds size should round-trip");
 
-            BoundsInt bi = new BoundsInt(new Vector3Int(1, 2, 3), new Vector3Int(4, 5, 6));
+            BoundsInt bi = new(new Vector3Int(1, 2, 3), new Vector3Int(4, 5, 6));
             BoundsInt biAgain = RoundTrip(bi);
             Assert.AreEqual(bi.position, biAgain.position, "BoundsInt position should round-trip");
             Assert.AreEqual(bi.size, biAgain.size, "BoundsInt size should round-trip");
@@ -139,7 +139,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void ResolutionRoundTrip()
         {
-            Resolution r = new Resolution { width = 800, height = 600 };
+            Resolution r = new() { width = 800, height = 600 };
             Resolution rAgain = RoundTrip(r);
             Assert.AreEqual(r.width, rAgain.width, "Resolution width should round-trip");
             Assert.AreEqual(r.height, rAgain.height, "Resolution height should round-trip");
@@ -219,7 +219,7 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
         [Test]
         public void CompositePayloadWithCollectionsRoundTrips()
         {
-            Composite payload = new Composite
+            Composite payload = new()
             {
                 fv2 = new FastVector2Int(-3, 7),
                 fv3 = new FastVector3Int(1, -2, 3),

package/Tests/Runtime/Serialization/SerializerAdditionalTests.cs

@@ -259,14 +259,18 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
                 Values = new List<int> { 1 },
             };
 
+#pragma warning disable CS0618 // Type or member is obsolete
             byte[] result = Serializer.Serialize(msg, SerializationType.SystemBinary);
+#pragma warning restore CS0618 // Type or member is obsolete
 
             Assert.NotNull(result);
             Assert.Greater(result.Length, 0);
 
             TestMessage deserialized = Serializer.Deserialize<TestMessage>(
                 result,
+#pragma warning disable CS0618 // Type or member is obsolete
                 SerializationType.SystemBinary
+#pragma warning restore CS0618 // Type or member is obsolete
             );
             Assert.AreEqual(msg.Id, deserialized.Id);
             Assert.AreEqual(msg.Name, deserialized.Name);
@@ -368,7 +372,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
             TestMessage msg = new() { Id = 111, Name = "BufferBinary" };
             byte[] buffer = null;
 
+#pragma warning disable CS0618 // Type or member is obsolete
             int length = Serializer.Serialize(msg, SerializationType.SystemBinary, ref buffer);
+#pragma warning restore CS0618 // Type or member is obsolete
 
             Assert.Greater(length, 0);
             Assert.NotNull(buffer);
@@ -377,7 +383,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
             byte[] data = buffer.Take(length).ToArray();
             TestMessage deserialized = Serializer.Deserialize<TestMessage>(
                 data,
+#pragma warning disable CS0618 // Type or member is obsolete
                 SerializationType.SystemBinary
+#pragma warning restore CS0618 // Type or member is obsolete
             );
             Assert.AreEqual(msg.Id, deserialized.Id);
         }
@@ -444,7 +452,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
             foreach (
                 SerializationType type in new[]
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     SerializationType.SystemBinary,
+#pragma warning restore CS0618 // Type or member is obsolete
                     SerializationType.Protobuf,
                     SerializationType.Json,
                 }
@@ -867,7 +877,9 @@ namespace WallstopStudios.UnityHelpers.Tests.Serialization
             foreach (
                 SerializationType type in new[]
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     SerializationType.SystemBinary,
+#pragma warning restore CS0618 // Type or member is obsolete
                     SerializationType.Protobuf,
                 }
             )

package/Tests/Runtime/Serialization/SerializerFileIoTests.cs

@@ -0,0 +1,105 @@
+namespace WallstopStudios.UnityHelpers.Tests.Serialization
+{
+    using System.IO;
+    using System.Threading;
+    using System.Threading.Tasks;
+    using NUnit.Framework;
+    using UnityEngine;
+    using WallstopStudios.UnityHelpers.Core.Serialization;
+    using WallstopStudios.UnityHelpers.Tests.TestUtils;
+
+    public sealed class SerializerFileIoTests : CommonTestBase
+    {
+        private string _dir;
+
+        [SetUp]
+        public void SetUp()
+        {
+            _dir = Path.Combine(Application.persistentDataPath, "SerializerFileIoTests");
+            if (Directory.Exists(_dir))
+            {
+                Directory.Delete(_dir, recursive: true);
+            }
+            Directory.CreateDirectory(_dir);
+        }
+
+        [TearDown]
+        public override void TearDown()
+        {
+            try
+            {
+                if (Directory.Exists(_dir))
+                {
+                    Directory.Delete(_dir, recursive: true);
+                }
+            }
+            catch { }
+            base.TearDown();
+        }
+
+        private sealed class Sample
+        {
+            public int a;
+            public string b;
+        }
+
+        [Test]
+        public void TryWriteAndTryReadRoundTrip()
+        {
+            string path = Path.Combine(_dir, "sample.json");
+            Sample s = new() { a = 7, b = "test" };
+
+            bool wrote = Serializer.TryWriteToJsonFile(s, path, pretty: true);
+            Assert.IsTrue(wrote, "Expected TryWriteToJsonFile to succeed.");
+            Assert.IsTrue(File.Exists(path), "Expected file to be created.");
+
+            bool read = Serializer.TryReadFromJsonFile(path, out Sample loaded);
+            Assert.IsTrue(read, "Expected TryReadFromJsonFile to succeed.");
+            Assert.NotNull(loaded);
+            Assert.AreEqual(7, loaded.a);
+            Assert.AreEqual("test", loaded.b);
+        }
+
+        [Test]
+        public void TryReadReturnsFalseWhenMissing()
+        {
+            string path = Path.Combine(_dir, "does_not_exist.json");
+            bool read = Serializer.TryReadFromJsonFile(path, out Sample loaded);
+            Assert.IsFalse(read);
+            Assert.IsNull(loaded);
+        }
+
+        [Test]
+        public void ReadAsyncHonorsCancellation()
+        {
+            string path = Path.Combine(_dir, "big.json");
+            // Create a moderately large file
+            File.WriteAllText(path, new string('x', 200_000));
+
+            using CancellationTokenSource cts = new();
+            cts.Cancel();
+            Assert.Throws<TaskCanceledException>(() =>
+                Serializer
+                    .ReadFromJsonFileAsync<Sample>(path, cts.Token)
+                    .ConfigureAwait(false)
+                    .GetAwaiter()
+                    .GetResult()
+            );
+        }
+
+        [Test]
+        public void WriteAsyncHonorsCancellation()
+        {
+            string path = Path.Combine(_dir, "out.json");
+            using CancellationTokenSource cts = new();
+            cts.Cancel();
+            Assert.Throws<TaskCanceledException>(() =>
+                Serializer
+                    .WriteToJsonFileAsync(new Sample { a = 1, b = "x" }, path, true, cts.Token)
+                    .ConfigureAwait(false)
+                    .GetAwaiter()
+                    .GetResult()
+            );
+        }
+    }
+}

package/Tests/Runtime/Serialization/SerializerFileIoTests.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: fe541467ea584bf4880dbf1d6d72e3ef
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: