mirror of
https://github.com/ElectronNET/Electron.NET.git
synced 2026-07-09 10:17:49 +00:00
d7e1a09880
* fix: correct ReleaseNotes deserialization for AutoUpdater (fixes #1039) - TypeScript normalize() now maps string releaseNotes to { note } objects and also handles arrays of strings (both cases were broken in PR #1041) - Added ReleaseNotesConverter (JsonConverter<ReleaseNoteInfo[]>) as defensive C# layer that handles all shapes: null, string, string[], object[] - Added [JsonConverter] attribute on UpdateInfo.ReleaseNotes - Added unit tests (no Electron required) covering all four input shapes * chore: sync generated autoUpdater.js and .map with updated TypeScript source * refactor: address Copilot PR review comments - Fix namespace: ElectronNET.Converter -> ElectronNET.API.Converter - Replace JsonDocument.ParseValue() with JsonSerializer.Deserialize<ReleaseNoteInfo>() for cleaner, allocation-free object array parsing - Fix Write(): empty ReleaseNoteInfo[] now serializes as [] instead of null - Use Array.Empty<ReleaseNoteInfo>() in UpdateInfo default initializer - Add tests: Serialize_WithEmptyReleaseNotes and Serialize_WithNullReleaseNotes
92 lines
3.3 KiB
C#
92 lines
3.3 KiB
C#
using ElectronNET.API.Entities;
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Text.Json;
|
|
using System.Text.Json.Serialization;
|
|
|
|
namespace ElectronNET.API.Converter;
|
|
|
|
/// <summary>
|
|
/// Handles the polymorphic shape of releaseNotes coming from electron-builder.
|
|
/// Depending on the updater.fullChangelog setting, electron-builder sends:
|
|
/// - null → when there are no notes
|
|
/// - "some string" → plain string (FullChangelog = false, default)
|
|
/// - ["note A", "note B"] → array of strings (after broken normalize in older TS)
|
|
/// - [{ version, note }, ...] → array of objects (FullChangelog = true)
|
|
/// All forms are normalised to ReleaseNoteInfo[] so the C# model stays clean.
|
|
/// See: https://github.com/ElectronNET/Electron.NET/issues/1039
|
|
/// </summary>
|
|
public class ReleaseNotesConverter : JsonConverter<ReleaseNoteInfo[]>
|
|
{
|
|
// Ensure the converter is called even when the JSON token is null,
|
|
// so we can return an empty array instead of null.
|
|
public override bool HandleNull => true;
|
|
|
|
public override ReleaseNoteInfo[] Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
|
|
{
|
|
switch (reader.TokenType)
|
|
{
|
|
case JsonTokenType.Null:
|
|
return Array.Empty<ReleaseNoteInfo>();
|
|
|
|
case JsonTokenType.String:
|
|
// Plain string: "Some release notes"
|
|
return new[] { new ReleaseNoteInfo { Note = reader.GetString() } };
|
|
|
|
case JsonTokenType.StartArray:
|
|
var list = new List<ReleaseNoteInfo>();
|
|
while (reader.Read() && reader.TokenType != JsonTokenType.EndArray)
|
|
{
|
|
if (reader.TokenType == JsonTokenType.String)
|
|
{
|
|
// Array of strings: ["Note A", "Note B"]
|
|
list.Add(new ReleaseNoteInfo { Note = reader.GetString() });
|
|
}
|
|
else if (reader.TokenType == JsonTokenType.StartObject)
|
|
{
|
|
// Array of objects: [{ "version": "1.0", "note": "..." }]
|
|
var entry = JsonSerializer.Deserialize<ReleaseNoteInfo>(ref reader, options) ?? new ReleaseNoteInfo();
|
|
list.Add(entry);
|
|
}
|
|
else
|
|
{
|
|
reader.Skip();
|
|
}
|
|
}
|
|
return list.ToArray();
|
|
|
|
default:
|
|
throw new JsonException($"Unexpected token {reader.TokenType} when reading releaseNotes.");
|
|
}
|
|
}
|
|
|
|
public override void Write(Utf8JsonWriter writer, ReleaseNoteInfo[] value, JsonSerializerOptions options)
|
|
{
|
|
if (value is null)
|
|
{
|
|
writer.WriteNullValue();
|
|
return;
|
|
}
|
|
|
|
if (value.Length == 0)
|
|
{
|
|
writer.WriteStartArray();
|
|
writer.WriteEndArray();
|
|
return;
|
|
}
|
|
|
|
writer.WriteStartArray();
|
|
foreach (var item in value)
|
|
{
|
|
writer.WriteStartObject();
|
|
if (item.Version is not null)
|
|
{
|
|
writer.WriteString("version", item.Version);
|
|
}
|
|
writer.WriteString("note", item.Note);
|
|
writer.WriteEndObject();
|
|
}
|
|
writer.WriteEndArray();
|
|
}
|
|
}
|