| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.Diagnostics.CodeAnalysis; |
| | | 4 | | using System.IO; |
| | | 5 | | using System.Text; |
| | | 6 | | using System.Text.Json; |
| | | 7 | | |
| | | 8 | | namespace Chronicler; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Serializes <see cref="IRecordable"/> state graphs to and from JSON through the chronicler API. |
| | | 12 | | /// </summary> |
| | | 13 | | public static class JsonRecordSerializer |
| | | 14 | | { |
| | 1 | 15 | | private static readonly JsonSerializerOptions _defaultOptions = CreateDefaultOptions(); |
| | | 16 | | |
| | | 17 | | /// <summary> |
| | | 18 | | /// Serializes the current state of a recordable instance into JSON. |
| | | 19 | | /// </summary> |
| | | 20 | | public static string Serialize(IRecordable target, bool writeIndented = false) |
| | 5 | 21 | | => Serialize(target, context: null, writeIndented); |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// Serializes the current state of a recordable instance into JSON. |
| | | 25 | | /// </summary> |
| | | 26 | | public static string Serialize(IRecordable target, ChronicleContext? context, bool writeIndented = false) |
| | | 27 | | { |
| | 29 | 28 | | if (target == null) |
| | 1 | 29 | | throw new ArgumentNullException(nameof(target)); |
| | | 30 | | |
| | 28 | 31 | | context ??= new ChronicleContext(); |
| | | 32 | | |
| | 28 | 33 | | JsonSerializerOptions options = writeIndented |
| | 28 | 34 | | ? CreateIndentedOptions() |
| | 28 | 35 | | : _defaultOptions; |
| | | 36 | | |
| | 28 | 37 | | var chronicler = new JsonRecordWriter(options, context); |
| | 28 | 38 | | target.RecordData(chronicler); |
| | 27 | 39 | | return chronicler.ToJson(); |
| | | 40 | | } |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// Loads JSON state into an existing recordable instance. |
| | | 44 | | /// </summary> |
| | | 45 | | public static void Populate(IRecordable target, string json) |
| | 7 | 46 | | => Populate(target, json, context: null); |
| | | 47 | | |
| | | 48 | | /// <summary> |
| | | 49 | | /// Loads JSON state into an existing recordable instance. |
| | | 50 | | /// </summary> |
| | | 51 | | public static void Populate(IRecordable target, string json, ChronicleContext? context) |
| | | 52 | | { |
| | 29 | 53 | | if (target == null) |
| | 1 | 54 | | throw new ArgumentNullException(nameof(target)); |
| | 28 | 55 | | if (string.IsNullOrWhiteSpace(json)) |
| | 3 | 56 | | throw new ArgumentException("Serialized JSON must not be null or empty.", nameof(json)); |
| | | 57 | | |
| | 25 | 58 | | context ??= new ChronicleContext(); |
| | | 59 | | |
| | 25 | 60 | | using var chronicler = new JsonRecordReader(json, _defaultOptions, context); |
| | 25 | 61 | | target.RecordData(chronicler); |
| | 22 | 62 | | context.ResolveDeferredLinks(); |
| | 40 | 63 | | } |
| | | 64 | | |
| | | 65 | | private static JsonSerializerOptions CreateDefaultOptions() |
| | | 66 | | { |
| | 1 | 67 | | return new JsonSerializerOptions() |
| | 1 | 68 | | { |
| | 1 | 69 | | IncludeFields = true |
| | 1 | 70 | | }; |
| | | 71 | | } |
| | | 72 | | |
| | | 73 | | private static JsonSerializerOptions CreateIndentedOptions() |
| | | 74 | | { |
| | 25 | 75 | | return new JsonSerializerOptions(_defaultOptions) |
| | 25 | 76 | | { |
| | 25 | 77 | | WriteIndented = true |
| | 25 | 78 | | }; |
| | | 79 | | } |
| | | 80 | | |
| | | 81 | | private sealed class JsonRecordWriter : IChronicler |
| | | 82 | | { |
| | 47 | 83 | | private readonly OrderedStringMap<string> _entries = new(8, StringComparer.Ordinal); |
| | | 84 | | private readonly JsonSerializerOptions _options; |
| | | 85 | | |
| | 47 | 86 | | public JsonRecordWriter(JsonSerializerOptions options, ChronicleContext context) |
| | | 87 | | { |
| | 47 | 88 | | _options = options; |
| | 47 | 89 | | Context = context ?? throw new ArgumentNullException(nameof(context)); |
| | 47 | 90 | | } |
| | | 91 | | |
| | | 92 | | public ChronicleContext Context { get; } |
| | | 93 | | |
| | 17 | 94 | | public SerializationMode Mode => SerializationMode.Saving; |
| | | 95 | | |
| | | 96 | | public void LookValue<T>(ref T value, string name, T? defaultValue = default) |
| | | 97 | | { |
| | 50 | 98 | | if (value is null || EqualityComparer<T>.Default.Equals(value, defaultValue!)) |
| | 10 | 99 | | return; |
| | | 100 | | |
| | 40 | 101 | | _entries[name] = JsonSerializer.Serialize(value, _options); |
| | 40 | 102 | | } |
| | | 103 | | |
| | | 104 | | public void LookDeep<T>(ref T value, string name) where T : class, IRecordable |
| | | 105 | | { |
| | 12 | 106 | | if (value == null) |
| | | 107 | | { |
| | 1 | 108 | | _entries[name] = "null"; |
| | 1 | 109 | | return; |
| | | 110 | | } |
| | | 111 | | |
| | 11 | 112 | | var nested = new JsonRecordWriter(_options, Context); |
| | 11 | 113 | | value.RecordData(nested); |
| | 11 | 114 | | _entries[name] = nested.ToJson(); |
| | 11 | 115 | | } |
| | | 116 | | |
| | | 117 | | public void LookDeepStruct<T>(ref T value, string name) where T : struct, IRecordable |
| | | 118 | | { |
| | 5 | 119 | | var nested = new JsonRecordWriter(_options, Context); |
| | 5 | 120 | | value.RecordData(nested); |
| | 5 | 121 | | _entries[name] = nested.ToJson(); |
| | 5 | 122 | | } |
| | | 123 | | |
| | | 124 | | public void LookNullableDeep<T>(ref T? value, string name) where T : struct, IRecordable |
| | | 125 | | { |
| | 5 | 126 | | if (!value.HasValue) |
| | 2 | 127 | | return; |
| | | 128 | | |
| | 3 | 129 | | T nestedValue = value.Value; |
| | 3 | 130 | | var nested = new JsonRecordWriter(_options, Context); |
| | 3 | 131 | | nestedValue.RecordData(nested); |
| | 3 | 132 | | _entries[name] = nested.ToJson(); |
| | 3 | 133 | | } |
| | | 134 | | |
| | | 135 | | public void LookLink<T>( |
| | | 136 | | ref T value, |
| | | 137 | | string name, |
| | | 138 | | string? slot = null, |
| | | 139 | | RecordLinkResolveMode resolveMode = RecordLinkResolveMode.Immediate, |
| | | 140 | | Action<T>? assignLoadedValue = null) |
| | | 141 | | { |
| | 12 | 142 | | string? id = null; |
| | 12 | 143 | | if (value is not null |
| | 12 | 144 | | && !Context.Links.TryGetReferenceId(value, out id, slot)) |
| | | 145 | | { |
| | 1 | 146 | | throw new InvalidOperationException( |
| | 1 | 147 | | $"Unable to save link '{name}' of type {typeof(T).Name} because no stable id could be produced{Forma |
| | | 148 | | } |
| | | 149 | | |
| | 11 | 150 | | _entries[name] = JsonSerializer.Serialize(id, _options); |
| | 11 | 151 | | } |
| | | 152 | | |
| | | 153 | | public string ToJson() |
| | | 154 | | { |
| | 46 | 155 | | using var stream = new MemoryStream(); |
| | 46 | 156 | | using (var writer = new Utf8JsonWriter(stream, new JsonWriterOptions() { Indented = _options.WriteIndented } |
| | | 157 | | { |
| | 46 | 158 | | writer.WriteStartObject(); |
| | | 159 | | |
| | 232 | 160 | | foreach (var entry in _entries) |
| | | 161 | | { |
| | 70 | 162 | | writer.WritePropertyName(entry.Key); |
| | 70 | 163 | | using var document = JsonDocument.Parse(entry.Value); |
| | 70 | 164 | | document.RootElement.WriteTo(writer); |
| | | 165 | | } |
| | | 166 | | |
| | 46 | 167 | | writer.WriteEndObject(); |
| | 46 | 168 | | } |
| | | 169 | | |
| | 46 | 170 | | return Encoding.UTF8.GetString(stream.ToArray()); |
| | 46 | 171 | | } |
| | | 172 | | } |
| | | 173 | | |
| | | 174 | | private sealed class JsonRecordReader : IChronicler, IDisposable |
| | | 175 | | { |
| | | 176 | | private readonly JsonDocument _document; |
| | | 177 | | private readonly JsonElement _root; |
| | | 178 | | private readonly JsonSerializerOptions _options; |
| | | 179 | | |
| | 46 | 180 | | public JsonRecordReader(string json, JsonSerializerOptions options, ChronicleContext context) |
| | | 181 | | { |
| | 46 | 182 | | _document = JsonDocument.Parse(json); |
| | 46 | 183 | | _root = _document.RootElement; |
| | 46 | 184 | | _options = options; |
| | 46 | 185 | | Context = context ?? throw new ArgumentNullException(nameof(context)); |
| | 46 | 186 | | } |
| | | 187 | | |
| | | 188 | | public ChronicleContext Context { get; } |
| | | 189 | | |
| | 13 | 190 | | public SerializationMode Mode => SerializationMode.Loading; |
| | | 191 | | |
| | | 192 | | public void LookValue<T>(ref T value, string name, T? defaultValue = default) |
| | | 193 | | { |
| | 49 | 194 | | if (!_root.TryGetProperty(name, out JsonElement entry)) |
| | | 195 | | { |
| | 24 | 196 | | value = defaultValue!; |
| | 24 | 197 | | return; |
| | | 198 | | } |
| | | 199 | | |
| | 25 | 200 | | if (entry.ValueKind == JsonValueKind.Null) |
| | | 201 | | { |
| | 1 | 202 | | value = defaultValue!; |
| | 1 | 203 | | return; |
| | | 204 | | } |
| | | 205 | | |
| | 24 | 206 | | T? loadedValue = JsonSerializer.Deserialize<T>(entry.GetRawText(), _options); |
| | 24 | 207 | | if (loadedValue is null) |
| | | 208 | | { |
| | 1 | 209 | | value = defaultValue!; |
| | 1 | 210 | | return; |
| | | 211 | | } |
| | | 212 | | |
| | 23 | 213 | | value = loadedValue; |
| | 23 | 214 | | } |
| | | 215 | | |
| | | 216 | | public void LookDeep<T>(ref T value, string name) where T : class, IRecordable |
| | | 217 | | { |
| | 11 | 218 | | if (!_root.TryGetProperty(name, out JsonElement entry) || entry.ValueKind == JsonValueKind.Null) |
| | 2 | 219 | | return; |
| | | 220 | | |
| | 9 | 221 | | if (value == null) |
| | 1 | 222 | | throw new InvalidOperationException( |
| | 1 | 223 | | $"Unable to load '{name}' because {typeof(T).Name} must already be instantiated for a deep chronicle |
| | | 224 | | |
| | 8 | 225 | | using var nested = new JsonRecordReader(entry.GetRawText(), _options, Context); |
| | 8 | 226 | | value.RecordData(nested); |
| | 16 | 227 | | } |
| | | 228 | | |
| | | 229 | | public void LookDeepStruct<T>(ref T value, string name) where T : struct, IRecordable |
| | | 230 | | { |
| | 5 | 231 | | value = CreateDefaultDeepStruct<T>(); |
| | | 232 | | |
| | 5 | 233 | | if (!_root.TryGetProperty(name, out JsonElement entry) || entry.ValueKind == JsonValueKind.Null) |
| | 1 | 234 | | return; |
| | | 235 | | |
| | 4 | 236 | | using var nested = new JsonRecordReader(entry.GetRawText(), _options, Context); |
| | 4 | 237 | | value.RecordData(nested); |
| | 8 | 238 | | } |
| | | 239 | | |
| | | 240 | | public void LookNullableDeep<T>(ref T? value, string name) where T : struct, IRecordable |
| | | 241 | | { |
| | 5 | 242 | | if (!_root.TryGetProperty(name, out JsonElement entry) || entry.ValueKind == JsonValueKind.Null) |
| | | 243 | | { |
| | 3 | 244 | | value = null; |
| | 3 | 245 | | return; |
| | | 246 | | } |
| | | 247 | | |
| | 2 | 248 | | T nestedValue = CreateDefaultDeepStruct<T>(); |
| | 2 | 249 | | using var nested = new JsonRecordReader(entry.GetRawText(), _options, Context); |
| | 2 | 250 | | nestedValue.RecordData(nested); |
| | 2 | 251 | | value = nestedValue; |
| | 4 | 252 | | } |
| | | 253 | | |
| | | 254 | | public void LookLink<T>( |
| | | 255 | | ref T value, |
| | | 256 | | string name, |
| | | 257 | | string? slot = null, |
| | | 258 | | RecordLinkResolveMode resolveMode = RecordLinkResolveMode.Immediate, |
| | | 259 | | Action<T>? assignLoadedValue = null) |
| | | 260 | | { |
| | 10 | 261 | | if (!TryReadLinkId(name, out string? id)) |
| | | 262 | | { |
| | 2 | 263 | | value = default!; |
| | 2 | 264 | | return; |
| | | 265 | | } |
| | | 266 | | |
| | 8 | 267 | | if (resolveMode == RecordLinkResolveMode.Deferred) |
| | | 268 | | { |
| | 5 | 269 | | LoadDeferredLink(ref value, name, id, slot, assignLoadedValue); |
| | 4 | 270 | | return; |
| | | 271 | | } |
| | | 272 | | |
| | 3 | 273 | | LoadImmediateLink(ref value, name, id, slot, assignLoadedValue); |
| | 2 | 274 | | } |
| | | 275 | | |
| | | 276 | | private bool TryReadLinkId(string name, [NotNullWhen(true)] out string? id) |
| | | 277 | | { |
| | 10 | 278 | | if (!_root.TryGetProperty(name, out JsonElement entry) |
| | 10 | 279 | | || entry.ValueKind == JsonValueKind.Null) |
| | | 280 | | { |
| | 2 | 281 | | id = null; |
| | 2 | 282 | | return false; |
| | | 283 | | } |
| | | 284 | | |
| | 8 | 285 | | id = JsonSerializer.Deserialize<string>(entry.GetRawText(), _options); |
| | 8 | 286 | | return id != null; |
| | | 287 | | } |
| | | 288 | | |
| | | 289 | | private void LoadDeferredLink<T>( |
| | | 290 | | ref T value, |
| | | 291 | | string name, |
| | | 292 | | string id, |
| | | 293 | | string? slot, |
| | | 294 | | Action<T>? assignLoadedValue) |
| | | 295 | | { |
| | 5 | 296 | | if (assignLoadedValue == null) |
| | 1 | 297 | | throw new InvalidOperationException( |
| | 1 | 298 | | $"Deferred link '{name}' of type {typeof(T).Name} requires an assignment callback."); |
| | | 299 | | |
| | 4 | 300 | | if (Context.Links.TryResolve(id, out T? deferredValue, slot)) |
| | | 301 | | { |
| | 1 | 302 | | value = deferredValue!; |
| | 1 | 303 | | assignLoadedValue(deferredValue!); |
| | 1 | 304 | | return; |
| | | 305 | | } |
| | | 306 | | |
| | 3 | 307 | | Context.QueueDeferredLink(name, id, slot, assignLoadedValue); |
| | 3 | 308 | | value = default!; |
| | 3 | 309 | | } |
| | | 310 | | |
| | | 311 | | private void LoadImmediateLink<T>( |
| | | 312 | | ref T value, |
| | | 313 | | string name, |
| | | 314 | | string id, |
| | | 315 | | string? slot, |
| | | 316 | | Action<T>? assignLoadedValue) |
| | | 317 | | { |
| | 3 | 318 | | if (!Context.Links.TryResolve(id, out T? resolvedValue, slot)) |
| | 1 | 319 | | throw new InvalidOperationException( |
| | 1 | 320 | | $"Unable to load link '{name}' of type {typeof(T).Name} with id '{id}'{FormatSlot(slot)}."); |
| | | 321 | | |
| | 2 | 322 | | value = resolvedValue!; |
| | 2 | 323 | | assignLoadedValue?.Invoke(resolvedValue!); |
| | 2 | 324 | | } |
| | | 325 | | |
| | | 326 | | public void Dispose() |
| | | 327 | | { |
| | 46 | 328 | | _document.Dispose(); |
| | 46 | 329 | | } |
| | | 330 | | |
| | | 331 | | private T CreateDefaultDeepStruct<T>() where T : struct, IRecordable |
| | | 332 | | { |
| | 7 | 333 | | T defaultValue = new(); |
| | 7 | 334 | | using var nested = new JsonRecordReader("{}", _options, Context); |
| | 7 | 335 | | defaultValue.RecordData(nested); |
| | 7 | 336 | | return defaultValue; |
| | 7 | 337 | | } |
| | | 338 | | } |
| | | 339 | | |
| | | 340 | | private static string FormatSlot(string? slot) |
| | | 341 | | { |
| | 2 | 342 | | return string.IsNullOrEmpty(slot) |
| | 2 | 343 | | ? string.Empty |
| | 2 | 344 | | : $" in slot '{slot}'"; |
| | | 345 | | } |
| | | 346 | | } |