ModernUO/Projects/UOContent/Engines/Spawners/SpawnerJsonSerializer.cs
Kamron Batman bf31bceea4 refactor(spawners): Approach A→B swap — deserialize via SpawnerDto records (atomic)
Replace the shadow-property (Approach A) JSON mechanism with plain DTO records
so malformed files fail as GC-only and never leak live world Items.

Changes:
- Add Json/SpawnerDto.cs: abstract SpawnerDto + SpawnerDataDto / RegionSpawnerDto /
  ProximitySpawnerDto, each [JsonDiscoverableType("<name>")] with ToSpawner()
- Add BaseSpawner.Dto.cs: internal ApplyDto(SpawnerDto) + private-protected Dto*
  export helpers (DtoGuid, DtoMinDelay, etc.)
- Add Spawner.Dto.cs, RegionSpawner.Dto.cs, ProximitySpawner.Dto.cs: ToDto() overrides
- Add public abstract SpawnerDto ToDto() to BaseSpawner
- Retarget SpawnerJsonSerializer: discovery filter BaseSpawner→SpawnerDto; polymorphism
  gate typeof(SpawnerDto); remove PruneToJsonProperties + AddOnDeserialized modifiers
- Delete BaseSpawner.Json.cs, Spawner.Json.cs, RegionSpawner.Json.cs,
  ProximitySpawner.Json.cs (Approach A shadow-property partials)
- Remove [JsonDiscoverableType] + [JsonConstructor] from Spawner/RegionSpawner/ProximitySpawner
- Rewire ExportSpawnersCommand: build List<SpawnerDto> via spawner.ToDto()
- Rewire ImportSpawnersCommand: Deserialize<List<SpawnerDto>> then dto.ToSpawner();
  map-null check now fires before ToSpawner(), so no orphan Items on bad map
- Delete 3 Approach-A round-trip tests; add SpawnerDtoRoundTripTests (4 cases)
- Update ExportImportFileTests + LegacyHomeRangeTests to use DTO path
- Add Import_MalformedFile_LeaksNoWorldItems to ImportCleanupTests

Build: dotnet build ModernUO.slnx → 0 errors, 0 warnings
Tests: dotnet test UOContent.Tests → 478/478 pass

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-25 15:46:47 -07:00

138 lines
5.1 KiB
C#

/*************************************************************************
* ModernUO *
* Copyright 2019-2026 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: SpawnerJsonSerializer.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Text.Json.Serialization;
using System.Text.Json.Serialization.Metadata;
using Server.Json;
using Server.Logging;
namespace Server.Engines.Spawners;
public static class SpawnerJsonSerializer
{
private static readonly ILogger logger = LogFactory.GetLogger(typeof(SpawnerJsonSerializer));
private static JsonDerivedType[] _derivedTypes = Array.Empty<JsonDerivedType>();
private static JsonSerializerOptions _options;
/// <summary>
/// Invoked automatically during the Configure bootstrap phase
/// (AssemblyHandler.Invoke("Configure")). Discovers every concrete SpawnerDto subclass
/// marked with [JsonDiscoverableType] and registers it for STJ polymorphism.
/// </summary>
public static void Configure()
{
var discovered = new List<JsonDerivedType>();
var byDiscriminator = new Dictionary<string, Type>();
foreach (var asm in AssemblyHandler.Assemblies)
{
Collect(AssemblyHandler.GetTypeCache(asm).Types, discovered, byDiscriminator);
}
Collect(AssemblyHandler.GetTypeCache(Core.Assembly).Types, discovered, byDiscriminator);
_derivedTypes = discovered.ToArray();
_options = null; // force rebuild with the discovered types
logger.Information("Discovered {Count} spawner JSON type(s)", _derivedTypes.Length);
}
private static void Collect(Type[] types, List<JsonDerivedType> discovered, Dictionary<string, Type> byDiscriminator)
{
for (var i = 0; i < types.Length; i++)
{
var type = types[i];
if (type.IsAbstract || !type.IsAssignableTo(typeof(SpawnerDto)))
{
continue;
}
var attr = (JsonDiscoverableTypeAttribute)Attribute.GetCustomAttribute(
type, typeof(JsonDiscoverableTypeAttribute), false);
if (attr == null)
{
continue;
}
if (!IsJsonConstructible(type))
{
throw new Exception(
$"SpawnerDto type '{type.FullName}' is marked [JsonDiscoverableType] but System.Text.Json cannot construct it. " +
"Add a public parameterless constructor or use a record with init-only properties."
);
}
var discriminator = attr.Discriminator ?? type.Name;
if (byDiscriminator.TryGetValue(discriminator, out var existing))
{
throw new Exception(
$"Spawner JSON discriminator '{discriminator}' is claimed by both '{existing.FullName}' and " +
$"'{type.FullName}'. Set an explicit discriminator via [JsonDiscoverableType(\"...\")] on one."
);
}
byDiscriminator[discriminator] = type;
discovered.Add(new JsonDerivedType(type, discriminator));
}
}
private static bool IsJsonConstructible(Type type)
{
foreach (var ctor in type.GetConstructors())
{
if (ctor.GetParameters().Length == 0)
{
return true;
}
if (Attribute.IsDefined(ctor, typeof(JsonConstructorAttribute)))
{
return true;
}
}
return false;
}
public static JsonSerializerOptions Options =>
_options ??= new JsonSerializerOptions(JsonConfig.GetOptions(new TextDefinitionConverterFactory()))
{
TypeInfoResolver = new DefaultJsonTypeInfoResolver
{
Modifiers =
{
AddPolymorphism
}
}
};
private static void AddPolymorphism(JsonTypeInfo typeInfo)
{
if (typeInfo.Type != typeof(SpawnerDto))
{
return;
}
typeInfo.PolymorphismOptions = new JsonPolymorphismOptions();
for (var i = 0; i < _derivedTypes.Length; i++)
{
typeInfo.PolymorphismOptions.DerivedTypes.Add(_derivedTypes[i]);
}
}
}