Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Change ByteListFormatter behaviour to keep binary compatibility for List<byte> #2139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 27, 2025
Merged

Change ByteListFormatter behaviour to keep binary compatibility for List<byte> #2139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
51973d3
remove ByteListFormatter to keep binary compatibility for List<byte>
neuecc Jan 24, 2025
99ad5e9
add compatible list formatter
neuecc Jan 24, 2025
bea2337
fix duplicate registration
neuecc Jan 24, 2025
ca95d84
Merge branch 'master' into fix-listbyte-formatter
neuecc Jan 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions src/MessagePack/Formatters/CollectionFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,46 @@ public ArraySegment<byte> Deserialize(ref MessagePackReader reader, MessagePackS
}
}

// special formatter to maintain compatibility due to bugs, https://github.com/MessagePack-CSharp/MessagePack-CSharp/issues/2134
public sealed class ByteListFormatter : IMessagePackFormatter<List<byte>?>
{
public static readonly ByteListFormatter Instance = new ByteListFormatter();

private static readonly ListFormatter<byte> InnerFormatter = new ListFormatter<byte>();

public void Serialize(ref MessagePackWriter writer, List<byte>? value, MessagePackSerializerOptions options)
{
InnerFormatter.Serialize(ref writer, value, options);
}

public List<byte>? Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
{
if (reader.NextMessagePackType == MessagePackType.Array)
{
return InnerFormatter.Deserialize(ref reader, options);
}
else
{
var sequence = reader.ReadBytes();
if (sequence == null)
{
return null;
}

#if NET8_0_OR_GREATER
int len = checked((int)sequence.Value.Length);
var list = new List<byte>(len);
CollectionsMarshal.SetCount(list, len);
var span = CollectionsMarshal.AsSpan(list);
sequence.Value.CopyTo(span);
return list;
#else
return new List<byte>(sequence.Value.ToArray());
#endif
}
}
}

[Preserve]
public sealed class MemoryFormatter<T> : IMessagePackFormatter<Memory<T>>
{
Expand Down
80 changes: 10 additions & 70 deletions src/MessagePack/Formatters/PrimitiveFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ public void Serialize(ref MessagePackWriter writer, List<Int16>? value, MessageP
return list;
}
}

#endif

public sealed class Int32Formatter : IMessagePackFormatter<Int32>
Expand Down Expand Up @@ -329,6 +330,7 @@ public void Serialize(ref MessagePackWriter writer, List<Int32>? value, MessageP
return list;
}
}

#endif

public sealed class Int64Formatter : IMessagePackFormatter<Int64>
Expand Down Expand Up @@ -485,6 +487,7 @@ public void Serialize(ref MessagePackWriter writer, List<Int64>? value, MessageP
return list;
}
}

#endif

public sealed class UInt16Formatter : IMessagePackFormatter<UInt16>
Expand Down Expand Up @@ -641,6 +644,7 @@ public void Serialize(ref MessagePackWriter writer, List<UInt16>? value, Message
return list;
}
}

#endif

public sealed class UInt32Formatter : IMessagePackFormatter<UInt32>
Expand Down Expand Up @@ -797,6 +801,7 @@ public void Serialize(ref MessagePackWriter writer, List<UInt32>? value, Message
return list;
}
}

#endif

public sealed class UInt64Formatter : IMessagePackFormatter<UInt64>
Expand Down Expand Up @@ -953,6 +958,7 @@ public void Serialize(ref MessagePackWriter writer, List<UInt64>? value, Message
return list;
}
}

#endif

public sealed class SingleFormatter : IMessagePackFormatter<Single>
Expand Down Expand Up @@ -1109,6 +1115,7 @@ public void Serialize(ref MessagePackWriter writer, List<Single>? value, Message
return list;
}
}

#endif

public sealed class DoubleFormatter : IMessagePackFormatter<Double>
Expand Down Expand Up @@ -1265,6 +1272,7 @@ public void Serialize(ref MessagePackWriter writer, List<Double>? value, Message
return list;
}
}

#endif

public sealed class BooleanFormatter : IMessagePackFormatter<Boolean>
Expand Down Expand Up @@ -1513,76 +1521,6 @@ public void Serialize(ref MessagePackWriter writer, Byte? value, MessagePackSeri
}
}

#if NET8_0_OR_GREATER
public sealed class ByteListFormatter : IMessagePackFormatter<List<Byte>?>
{
public static readonly ByteListFormatter Instance = new ByteListFormatter();

private ByteListFormatter()
{
}

public void Serialize(ref MessagePackWriter writer, List<Byte>? value, MessagePackSerializerOptions options)
{
if (value == null)
{
writer.WriteNil();
}
else
{
writer.Write(CollectionsMarshal.AsSpan(value));
}
}

public List<Byte>? Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
{
if (reader.NextMessagePackType == MessagePackType.Array)
{
int len = reader.ReadArrayHeader();
if (len == 0)
{
return [];
}

var list = new List<byte>(len);
options.Security.DepthStep(ref reader);
try
{
CollectionsMarshal.SetCount(list, len);
var span = CollectionsMarshal.AsSpan(list);
for (int i = 0; i < len; i++)
{
reader.CancellationToken.ThrowIfCancellationRequested();
span[i] = reader.ReadByte();
}
}
finally
{
reader.Depth--;
}

return list;
}
else
{
var sequence = reader.ReadBytes();
if (sequence == null)
{
return null;
}

int len = checked((int)sequence.Value.Length);
var list = new List<byte>(len);
CollectionsMarshal.SetCount(list, len);
var span = CollectionsMarshal.AsSpan(list);
sequence.Value.CopyTo(span);
return list;
}
}
}

#endif

public sealed class SByteFormatter : IMessagePackFormatter<SByte>
{
public static readonly SByteFormatter Instance = new SByteFormatter();
Expand Down Expand Up @@ -1737,6 +1675,7 @@ public void Serialize(ref MessagePackWriter writer, List<SByte>? value, MessageP
return list;
}
}

#endif

public sealed class CharFormatter : IMessagePackFormatter<Char>
Expand Down Expand Up @@ -1893,6 +1832,7 @@ public void Serialize(ref MessagePackWriter writer, List<Char>? value, MessagePa
return list;
}
}

#endif

public sealed class DateTimeFormatter : IMessagePackFormatter<DateTime>
Expand Down
77 changes: 3 additions & 74 deletions src/MessagePack/Formatters/PrimitiveFormatter.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,79 +95,7 @@ namespace MessagePack.Formatters
}
}
}
<# if(t.Name == "Byte") { #>

#if NET8_0_OR_GREATER
public sealed class <#= t.Name #>ListFormatter : IMessagePackFormatter<List<<#= t.Name #>>?>
{
public static readonly <#= t.Name #>ListFormatter Instance = new <#= t.Name #>ListFormatter();

private <#= t.Name #>ListFormatter()
{
}

public void Serialize(ref MessagePackWriter writer, List<<#= t.Name #>>? value, MessagePackSerializerOptions options)
{
if (value == null)
{
writer.WriteNil();
}
else
{
writer.Write(CollectionsMarshal.AsSpan(value));
}
}

public List<<#= t.Name #>>? Deserialize(ref MessagePackReader reader, MessagePackSerializerOptions options)
{
if (reader.NextMessagePackType == MessagePackType.Array)
{
int len = reader.ReadArrayHeader();
if (len == 0)
{
return [];
}

var list = new List<byte>(len);
options.Security.DepthStep(ref reader);
try
{
CollectionsMarshal.SetCount(list, len);
var span = CollectionsMarshal.AsSpan(list);
for (int i = 0; i < len; i++)
{
reader.CancellationToken.ThrowIfCancellationRequested();
span[i] = reader.ReadByte();
}
}
finally
{
reader.Depth--;
}

return list;
}
else
{
var sequence = reader.ReadBytes();
if (sequence == null)
{
return null;
}

int len = checked((int)sequence.Value.Length);
var list = new List<byte>(len);
CollectionsMarshal.SetCount(list, len);
var span = CollectionsMarshal.AsSpan(list);
sequence.Value.CopyTo(span);
return list;
}
}
}

#endif
<# } #>
<# else if(t.Name == "DateTime") { #>
<# if(t.Name == "DateTime") { #>

public sealed class <#= t.Name #>ArrayFormatter : IMessagePackFormatter<<#= t.Name #>[]?>
{
Expand Down Expand Up @@ -360,7 +288,7 @@ namespace MessagePack.Formatters
}
#endif
<# } #>
<# else { #>
<# else if(t.Name != "Byte") { #>

public sealed class <#= t.Name #>ArrayFormatter : IMessagePackFormatter<<#= t.Name #>[]?>
{
Expand Down Expand Up @@ -464,6 +392,7 @@ namespace MessagePack.Formatters
return list;
}
}

#endif
<# } #>
<# } #>
Expand Down
3 changes: 1 addition & 2 deletions src/MessagePack/Resolvers/BuiltinResolver.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,6 @@ internal static class BuiltinResolverGetFormatterHelper
{ typeof(List<Single>), SingleListFormatter.Instance },
{ typeof(List<Double>), DoubleListFormatter.Instance },
{ typeof(List<Boolean>), BooleanListFormatter.Instance },
{ typeof(List<byte>), ByteListFormatter.Instance },
{ typeof(List<SByte>), SByteListFormatter.Instance },
{ typeof(List<Char>), CharListFormatter.Instance },
#else
Expand All @@ -144,12 +143,12 @@ internal static class BuiltinResolverGetFormatterHelper
{ typeof(List<Single>), new ListFormatter<Single>() },
{ typeof(List<Double>), new ListFormatter<Double>() },
{ typeof(List<Boolean>), new ListFormatter<Boolean>() },
{ typeof(List<byte>), new ListFormatter<byte>() },
{ typeof(List<SByte>), new ListFormatter<SByte>() },
{ typeof(List<Char>), new ListFormatter<Char>() },
#endif
{ typeof(List<DateTime>), new ListFormatter<DateTime>() },
{ typeof(List<string>), new ListFormatter<string>() },
{ typeof(List<Byte>), ByteListFormatter.Instance }, // special formatter to maintain compatibility due to bugs

{ typeof(object[]), new ArrayFormatter<object>() },
{ typeof(List<object>), new ListFormatter<object>() },
Expand Down
32 changes: 32 additions & 0 deletions tests/MessagePack.Tests/CollectionTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@

using System;
using System.Buffers;
using System.Buffers.Binary;
using System.Collections;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using MessagePack.Formatters;
using MessagePack.Resolvers;
using Xunit;

namespace MessagePack.Tests
Expand Down Expand Up @@ -313,6 +316,35 @@ public void CustomGenericReadOnlyDictionaryTest()
d2["foo"].Is(10);
d2["bar"].Is(20);
}

[Fact]
public void ByteListFormatterSerializeTest()
{
// ByteListFormatter and ListFormatter<byte> result must be same
var option1 = MessagePackSerializerOptions.Standard.WithResolver(CompositeResolver.Create([ByteListFormatter.Instance, ByteFormatter.Instance, new ListFormatter<byte>()]));
var option2 = MessagePackSerializerOptions.Standard.WithResolver(CompositeResolver.Create([ByteFormatter.Instance, new ListFormatter<byte>()]));

var bin1 = MessagePackSerializer.Serialize(new List<byte> { 1, 2, 3 }, option1);
var bin2 = MessagePackSerializer.Serialize(new List<byte> { 1, 2, 3 }, option2);

bin1.ShouldBe(bin2);
}

[Fact]
public void ByteListFormatterDeserializeTest()
{
var binary = MessagePackSerializer.Serialize(new byte[] { 1, 2, 3 });
var array = MessagePackSerializer.Serialize(new List<byte> { 1, 2, 3 });

MessagePackPrimitives.TryReadBinHeader(binary, out _, out _).ShouldBe(MessagePackPrimitives.DecodeResult.Success);
MessagePackPrimitives.TryReadArrayHeader(array, out _, out _).ShouldBe(MessagePackPrimitives.DecodeResult.Success);

var v1 = MessagePackSerializer.Deserialize<List<byte>>(binary);
var v2 = MessagePackSerializer.Deserialize<List<byte>>(array);

v1.ShouldBe([1, 2, 3]);
v2.ShouldBe([1, 2, 3]);
}
}

public class ImplNonGenericList : IList
Expand Down
Loading