ModernUO/Projects/UOContent.Tests/Tests/Engines/Spawners/Json/BoundsEquivalenceTests.cs
Kamron Batman d8a64f3316
refactor(spawners): replace DynamicJson with typed SpawnerDto records (#2505)
## 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.
2026-06-25 23:24:45 -07:00

99 lines
3.4 KiB
C#

// Validates that the spawnBounds JSON emitted by tools/spawner-json-migrate/migrate.mjs
// deserializes to the SAME Rectangle3D that the runtime homeRange path produces.
// This test MUST pass before bulk-migrating the spawn data files.
//
// toBounds formula (from migrate.mjs):
// hr == 0 -> { x1:x, y1:y, z1:z, x2:x+1, y2:y+1, z2:z }
// hr > 0 -> { x1:x-hr, y1:y-hr, z1:-128, x2:x+hr+1, y2:y+hr+1, z2:128 }
//
// Rectangle3DConverter x1/y1/z1/x2/y2/z2 form creates Rectangle3D(Point3D(x1,y1,z1), Point3D(x2,y2,z2))
// where _start==(x1,y1,z1) and _end==(x2,y2,z2). Rectangle3D.End is exclusive.
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 BoundsEquivalenceTests
{
private const int LocX = 100;
private const int LocY = 200;
private const int LocZ = 5;
[Theory]
[InlineData(0)]
[InlineData(1)]
[InlineData(3)]
[InlineData(7)]
public void SpawnBoundsJson_EqualsHomeRangePath(int hr)
{
BaseSpawner fromHomeRange = null;
BaseSpawner fromSpawnBounds = null;
try
{
// Path A: legacy homeRange field -> ApplyDto sets SpawnBounds
var homeRangeJson = BuildHomeRangeJson(hr);
var dtosA = JsonSerializer.Deserialize<List<SpawnerDto>>(homeRangeJson, SpawnerJsonSerializer.Options);
fromHomeRange = Assert.Single(dtosA).ToSpawner();
var expected = Assert.IsType<Spawner>(fromHomeRange).SpawnBounds;
// Path B: migrated spawnBounds field -> SpawnerDataDto.ToSpawner sets SpawnBounds
var spawnBoundsJson = BuildSpawnBoundsJson(hr);
var dtosB = JsonSerializer.Deserialize<List<SpawnerDto>>(spawnBoundsJson, SpawnerJsonSerializer.Options);
fromSpawnBounds = Assert.Single(dtosB).ToSpawner();
var actual = Assert.IsType<Spawner>(fromSpawnBounds).SpawnBounds;
Assert.Equal(expected, actual);
}
finally
{
fromHomeRange?.Delete();
fromSpawnBounds?.Delete();
}
}
private static string BuildHomeRangeJson(int hr) => $$"""
[
{
"$type": "Spawner",
"location": [{{LocX}}, {{LocY}}, {{LocZ}}],
"map": "Felucca",
"count": 1,
"homeRange": {{hr}},
"entries": []
}
]
""";
private static string BuildSpawnBoundsJson(int hr)
{
int x1, y1, z1, x2, y2, z2;
if (hr == 0)
{
// hr==0: _start=(x,y,z), _end=(x+1,y+1,z) — single tile, depth 0
(x1, y1, z1, x2, y2, z2) = (LocX, LocY, LocZ, LocX + 1, LocY + 1, LocZ);
}
else
{
// hr>0: _start=(x-hr,y-hr,-128), _end=(x+hr+1,y+hr+1,128) — hr*2+1 wide, depth 256
(x1, y1, z1, x2, y2, z2) = (LocX - hr, LocY - hr, -128, LocX + hr + 1, LocY + hr + 1, 128);
}
return $$"""
[
{
"$type": "Spawner",
"location": [{{LocX}}, {{LocY}}, {{LocZ}}],
"map": "Felucca",
"count": 1,
"spawnBounds": { "x1": {{x1}}, "y1": {{y1}}, "z1": {{z1}}, "x2": {{x2}}, "y2": {{y2}}, "z2": {{z2}} },
"entries": []
}
]
""";
}
}