d8a64f3316
## Summary Removes the dated `DynamicJson` JSON helper and migrates spawner JSON (de)serialization to a polymorphic `record SpawnerDto` hierarchy. `DynamicJson` was the last remaining consumer (regions moved off it in #1400). The key correctness improvement: **System.Text.Json deserializes plain DTO records, never a live `Item`.** Previously, deserializing directly into an `Item` meant STJ constructed world-registered objects *before* the data was validated — a malformed/hand-edited spawn file could leave orphaned spawner Items in the world save. Now a parse failure is GC-only; `dto.ToSpawner()` constructs the spawner only from a fully-validated DTO and self-cleans on failure. ## What changed - **New:** `SpawnerDto` (abstract) + `SpawnerDataDto` / `RegionSpawnerDto` / `ProximitySpawnerDto`, each marked with a reusable `[JsonDiscoverableType]` opt-in attribute. Auto-discovered at the `Configure` phase — no manual registration list (avoids the regions `Register<T>()` footgun), open to custom spawner subtypes. - **Symmetric mapping:** `BaseSpawner.ToDto()` (export) ⇄ `SpawnerDto.ToSpawner()` (import). `ToSpawner()` deletes-and-rethrows on any failure, so the importer can never orphan an Item. - **`SpawnerJsonSerializer`** wires `$type` polymorphism on the `SpawnerDto` root with loud collision/constructibility validation. - **Import/export commands** rewired to the typed DTO path (reflection `FindTypeByName`/`CreateInstance` removed). - **Data migration:** the 109 `Distribution/Data/Spawns/**` files moved from `"type"`→`"$type"` and legacy `homeRange`→`spawnBounds`. The runtime still *reads* legacy `homeRange` for external files. The `homeRange→spawnBounds` formula is proven equivalent to the runtime conversion (`BoundsEquivalenceTests`, hr=0/1/3/7). - **Deleted:** `Projects/Server/Json/DynamicJson.cs`. Sparse export output matches the legacy `ToJson` (nullable DTO properties + `WhenWritingNull`). Binary world-save serialization is untouched. ## Tests - DTO round-trip per spawner type; sparse-default omission; legacy `homeRange` read; export/import file round-trip. - `Import_MalformedFile_LeaksNoWorldItems` — proves a mid-array parse failure constructs zero world Items. - `AllSpawnFilesLoadTests` — every migrated spawn file deserializes and builds. - Duplicate-discriminator validation. - UOContent.Tests 485/485, Server.Tests 710/710, build clean. ## Follow-up (not in this PR) `Rectangle3DConverter.Write` (in `Projects/Server/`) omits `z1/z2` when `Start.Z == -128`, so a future server-side export of a `homeRange`-style spawner round-trips depth 256→255. Pre-existing and out of scope here (Server change); the migrated data reads correctly. Worth a separate small converter PR.
74 lines
2 KiB
C#
74 lines
2 KiB
C#
using System.Collections.Generic;
|
|
using System.Text.Json;
|
|
using Server;
|
|
using Server.Engines.Spawners;
|
|
using Xunit;
|
|
|
|
namespace UOContent.Tests.Engines.Spawners.Json;
|
|
|
|
[Collection("Sequential UOContent Tests")]
|
|
public class LegacyHomeRangeTests
|
|
{
|
|
[Fact]
|
|
public void HomeRange_NoSpawnBounds_ProducesCenteredBounds()
|
|
{
|
|
const string legacy = """
|
|
[
|
|
{
|
|
"$type": "Spawner",
|
|
"guid": "3df0543a-373c-4673-a98b-8191686f4ab3",
|
|
"location": [100, 200, 5],
|
|
"map": "Felucca",
|
|
"count": 1,
|
|
"homeRange": 3,
|
|
"entries": [ { "name": "Fisherman", "maxCount": 1, "probability": 100 } ]
|
|
}
|
|
]
|
|
""";
|
|
|
|
var dtos = JsonSerializer.Deserialize<List<SpawnerDto>>(legacy, SpawnerJsonSerializer.Options);
|
|
var dto = Assert.Single(dtos);
|
|
var s = Assert.IsType<Spawner>(dto.ToSpawner());
|
|
|
|
try
|
|
{
|
|
// homeRange 3 -> Rectangle3D(100-3, 200-3, -128, 7, 7, 256)
|
|
Assert.Equal(new Rectangle3D(97, 197, -128, 7, 7, 256), s.SpawnBounds);
|
|
}
|
|
finally
|
|
{
|
|
s.Delete();
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void HomeRangeZero_ProducesSingleTileBounds()
|
|
{
|
|
const string legacy = """
|
|
[
|
|
{
|
|
"$type": "Spawner",
|
|
"location": [100, 200, 5],
|
|
"map": "Felucca",
|
|
"count": 1,
|
|
"homeRange": 0,
|
|
"entries": [ { "name": "Fisherman", "maxCount": 1, "probability": 100 } ]
|
|
}
|
|
]
|
|
""";
|
|
|
|
var dtos = JsonSerializer.Deserialize<List<SpawnerDto>>(legacy, SpawnerJsonSerializer.Options);
|
|
var dto = Assert.Single(dtos);
|
|
var s = Assert.IsType<Spawner>(dto.ToSpawner());
|
|
|
|
try
|
|
{
|
|
// homeRange 0 -> Rectangle3D(100, 200, 5, 1, 1, 0)
|
|
Assert.Equal(new Rectangle3D(100, 200, 5, 1, 1, 0), s.SpawnBounds);
|
|
}
|
|
finally
|
|
{
|
|
s.Delete();
|
|
}
|
|
}
|
|
}
|