chore(spawners): migrate spawn data to $type discriminator

- Rename "type" -> "$type" (first key, required for STJ polymorphism) in
  all 109 spawn JSON files (5,612 records).
- Convert "homeRange" + "location" -> "spawnBounds" object, dropping homeRange.
  Runtime keeps reading homeRange so un-migrated/external files still load.
- Add BoundsEquivalenceTests (hr=0/1/3/7) validating that the script's toBounds
  formula produces the same Rectangle3D as the runtime homeRange path.
- Add MigratedDataLoadTests loading a real migrated file as List<SpawnerDto>
  and round-tripping each DTO through ToSpawner().
- Add tools/spawner-json-migrate/migrate.mjs (offline Node script).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Kamron Batman 2026-06-25 16:17:35 -07:00
parent ede4bcc718
commit 2f8a7afa57
112 changed files with 198936 additions and 40949 deletions

View file

@ -0,0 +1,99 @@
// 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": []
}
]
""";
}
}

View file

@ -0,0 +1,47 @@
// Regression guard: verifies that a real migrated spawn file (post-uoml/felucca/Vendors.json)
// can be deserialized as List<SpawnerDto> and each DTO produces a valid spawner via ToSpawner().
// Exercises the $type discriminator path introduced by the data migration.
using System.Collections.Generic;
using System.IO;
using System.Text.Json;
using Server;
using Server.Engines.Spawners;
using Xunit;
namespace UOContent.Tests.Engines.Spawners.Json;
[Collection("Sequential UOContent Tests")]
public class MigratedDataLoadTests
{
[Fact]
public void MigratedFile_LoadsWithDollarType()
{
var path = Path.Combine(Core.BaseDirectory, "Data", "Spawns", "post-uoml", "felucca", "Vendors.json");
if (!File.Exists(path))
{
return; // distribution data not present in this checkout
}
var dtos = JsonSerializer.Deserialize<List<SpawnerDto>>(File.ReadAllText(path), SpawnerJsonSerializer.Options);
Assert.NotEmpty(dtos);
var spawners = new List<BaseSpawner>(dtos.Count);
try
{
foreach (var dto in dtos)
{
spawners.Add(dto.ToSpawner());
}
Assert.Equal(dtos.Count, spawners.Count);
}
finally
{
foreach (var s in spawners)
{
s?.Delete();
}
}
}
}