MessagePack 3.1 doesn't serialize or deserialize keys in custom collections
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 48/100
Rechercherichtung
Beginne mit der bereitgestellten NUnit-Konsolenreproduktion unter Verwendung von MessagePack 3.1.4 und vergleiche ihr Verhalten mit MessagePack 2.1. Untersuche die Entscheidung des Source Generators zwischen GenericCollectionFormatter und einem benutzerdefinierten Formatter für CustomDictionary<TKey, TValue>. Die Aufgabe ist abgeschlossen, wenn serialisierte benutzerdefinierte Felder, einschließlich CustomValue, die Deserialisierung überstehen, während die Dictionary-Einträge intakt bleiben und die Assertions der Reproduktion erfolgreich sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Bug description
The source generator does not create a formatter for custom collection types which have a default constructor even if that type has additional fields or properties that should be serialized.
MessagePack 2.1 code gen did support this, so this is impeding an upgrade where we need to maintain binary backwards compatibility.
Repro steps
Create a new console program dependent on NUnit and MessagePack v3
using System.Collections;
using System.Diagnostics.CodeAnalysis;
using MessagePack;
using NUnit.Framework;
CustomDictionary<int, int> dictionary = new()
{
{ 1, 2 },
{ 2, 3 }
};
dictionary.CustomValue = 12345;
MemoryStream memoryStream = new();
MessagePackSerializer.Serialize(memoryStream, dictionary);
memoryStream.Seek(0, SeekOrigin.Begin);
var clone = MessagePackSerializer.Deserialize<CustomDictionary<int, int>>(memoryStream);
Assert.That(clone.Count, Is.EqualTo(dictionary.Count), "Counts do not match");
Assert.That(clone.CustomValue, Is.EqualTo(dictionary.CustomValue), "Custom values do not match");
Console.WriteLine("Test Passed!");
[MessagePackObject]
public sealed class CustomDictionary<TKey, TValue> : IDictionary<TKey, TValue>
where TKey : notnull
{
private readonly Dictionary<TKey, TValue> m_actualDictionary = new();
[Key(0)] public IReadOnlyDictionary<TKey, TValue> ActualDictionary => m_actualDictionary;
[Key(1)] public int CustomValue { get; set; }
public int Count => m_actualDictionary.Count;
public bool IsReadOnly => false;
public ICollection<TKey> Keys => m_actualDictionary.Keys;
public ICollection<TValue> Values => m_actualDictionary.Values;
public TValue this[TKey key]
{
get => m_actualDictionary[key];
set => m_actualDictionary[key] = value;
}
public CustomDictionary()
{
}
[SerializationConstructor]
public CustomDictionary(IReadOnlyDictionary<TKey, TValue> actualDictionary, int customValue)
{
m_actualDictionary = new Dictionary<TKey, TValue>(actualDictionary);
CustomValue = customValue;
}
public IEnumerator<KeyValuePair<TKey, TValue>> GetEnumerator() => m_actualDictionary.GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => m_actualDictionary.GetEnumerator();
public void Add(KeyValuePair<TKey, TValue> item) => m_actualDictionary.Add(item.Key, item.Value);
public void Add(TKey key, TValue value) => m_actualDictionary.Add(key, value);
public void Clear() => m_actualDictionary.Clear();
public bool Contains(KeyValuePair<TKey, TValue> item) => m_actualDictionary.Contains(item);
public bool ContainsKey(TKey key) => m_actualDictionary.ContainsKey(key);
public void CopyTo(KeyValuePair<TKey, TValue>[] array, int arrayIndex) =>
(m_actualDictionary as IDictionary<TKey, TValue>).CopyTo(array, arrayIndex);
public bool Remove(KeyValuePair<TKey, TValue> item) => m_actualDictionary.Remove(item.Key);
public bool Remove(TKey key) => m_actualDictionary.Remove(key);
public bool TryGetValue(TKey key, [MaybeNullWhen(false)] out TValue value) =>
m_actualDictionary.TryGetValue(key, out value);
}
Expected behavior
The source generator should use a custom formatter instead of using GenericCollectionFormatter for types with other keys.
Actual behavior
The source generator uses GenericCollectionFormatter for the type. This causes deserialization of any content saved using MessagePack 2.1 to become corrupted since it's not including the additional serialized fields.
- Version used: 3.1.4
- Runtime: .NET 6.0
Additional context
This worked okay using the code generator for MessagePack 2.1
- Vorherrschende Sprache
- C#
- Sterne
- 6.8k
- Forks
- 778
- Ø Merge
- 22 Std. 8 Min.
- Gemergte PRs (30 T.)
- 2
Entwicklungsumgebung
Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus MessagePack-CSharp/MessagePack-CSharp
-
SerializableMemberTypeAnalyzer throws AD0001 when any referenced assembly has an assembly-level attribute with a single array argumentEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 76/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
MessagePack-CSharp/MessagePack-CSharp#2276 · 2 Kommentare ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
MessagePack-CSharp/MessagePack-CSharp#2252 · 3 Kommentare ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 52/100
Alle Issues in MessagePack-CSharp/MessagePack-CSharp
Ähnliche Issues
-
kind/bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
unoplatform/uno#26555 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Listenarrs/Listenarr#1173 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
CactuseSecurity/firewall-orchestrator#5739 ·
Maintainer antworten meist innerhalb von 1 Tag
-
chore project-system small
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
vikramlearning/blazorbootstrap#1388 ·
Maintainer antworten meist innerhalb von 1 Tag