Skip to content
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.

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

Fix regression in dictionary key serialization when registering custom primitive converters. #57138

Merged
5 commits merged into from
Aug 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ protected internal override bool OnWriteResume(
{
state.Current.PropertyState = StackFramePropertyState.Name;
TKey key = enumerator.Current.Key;
_keyConverter.WriteWithQuotes(writer, key, options, ref state);
_keyConverter.WriteAsPropertyName(writer, key, options, ref state);
}

TValue element = enumerator.Current.Value;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ protected internal override bool OnWriteResume(
do
{
TKey key = enumerator.Current.Key;
_keyConverter.WriteWithQuotes(writer, key, options, ref state);
_keyConverter.WriteAsPropertyName(writer, key, options, ref state);
_valueConverter.Write(writer, enumerator.Current.Value, options);
} while (enumerator.MoveNext());
}
Expand All @@ -80,7 +80,7 @@ protected internal override bool OnWriteResume(
state.Current.PropertyState = StackFramePropertyState.Name;

TKey key = enumerator.Current.Key;
_keyConverter.WriteWithQuotes(writer, key, options, ref state);
_keyConverter.WriteAsPropertyName(writer, key, options, ref state);
}

TValue element = enumerator.Current.Value;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,13 @@ protected internal override bool OnWriteResume(Utf8JsonWriter writer, TDictionar
if (key is string keyString)
{
_keyConverter ??= GetConverter<string>(typeInfo.KeyTypeInfo!);
_keyConverter.WriteWithQuotes(writer, keyString, options, ref state);
_keyConverter.WriteAsPropertyName(writer, keyString, options, ref state);
}
else
{
// IDictionary is a special case since it has polymorphic object semantics on serialization
// but needs to use JsonConverter<string> on deserialization.
_valueConverter.WriteWithQuotes(writer, key, options, ref state);
_valueConverter.WriteAsPropertyName(writer, key, options, ref state);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ TKey ReadDictionaryKey(ref Utf8JsonReader reader, ref ReadStack state)
else
{
_keyConverter ??= GetConverter<TKey>(state.Current.JsonTypeInfo.KeyTypeInfo!);
key = _keyConverter.ReadWithQuotes(ref reader);
key = _keyConverter.ReadAsPropertyName(ref reader, typeToConvert, options);
unescapedPropertyNameAsString = reader.GetString()!;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public override void Write(Utf8JsonWriter writer, bool value, JsonSerializerOpti
writer.WriteBooleanValue(value);
}

internal override bool ReadWithQuotes(ref Utf8JsonReader reader)
internal override bool ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
ReadOnlySpan<byte> propertyName = reader.GetSpan();
if (Utf8Parser.TryParse(propertyName, out bool value, out int bytesConsumed)
Expand All @@ -29,7 +29,7 @@ internal override bool ReadWithQuotes(ref Utf8JsonReader reader)
throw ThrowHelper.GetFormatException(DataType.Boolean);
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, bool value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, bool value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ public override void Write(Utf8JsonWriter writer, byte value, JsonSerializerOpti
writer.WriteNumberValue(value);
}

internal override byte ReadWithQuotes(ref Utf8JsonReader reader)
internal override byte ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetByteWithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, byte value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, byte value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ public override void Write(Utf8JsonWriter writer, char value, JsonSerializerOpti
);
}

internal override char ReadWithQuotes(ref Utf8JsonReader reader)
=> Read(ref reader, default!, default!);
internal override char ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
=> Read(ref reader, typeToConvert, options);

internal override void WriteWithQuotes(Utf8JsonWriter writer, char value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, char value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(
#if BUILDING_INBOX_LIBRARY
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializer
writer.WriteStringValue(value);
}

internal override DateTime ReadWithQuotes(ref Utf8JsonReader reader)
internal override DateTime ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetDateTimeNoValidation();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ public override void Write(Utf8JsonWriter writer, DateTimeOffset value, JsonSeri
writer.WriteStringValue(value);
}

internal override DateTimeOffset ReadWithQuotes(ref Utf8JsonReader reader)
internal override DateTimeOffset ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetDateTimeOffsetNoValidation();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, DateTimeOffset value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ public override void Write(Utf8JsonWriter writer, decimal value, JsonSerializerO
writer.WriteNumberValue(value);
}

internal override decimal ReadWithQuotes(ref Utf8JsonReader reader)
internal override decimal ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetDecimalWithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, decimal value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, decimal value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ public override void Write(Utf8JsonWriter writer, double value, JsonSerializerOp
writer.WriteNumberValue(value);
}

internal override double ReadWithQuotes(ref Utf8JsonReader reader)
internal override double ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetDoubleWithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, double value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, double value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public override T Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerial
return default;
}

return ReadWithQuotes(ref reader);
return ReadAsPropertyName(ref reader, typeToConvert, options);
}

if (token != JsonTokenType.Number || !_converterOptions.HasFlag(EnumConverterOptions.AllowNumbers))
Expand Down Expand Up @@ -304,7 +304,7 @@ private string FormatEnumValueToString(string value, JavaScriptEncoder? encoder)
return converted;
}

internal override T ReadWithQuotes(ref Utf8JsonReader reader)
internal override T ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
string? enumString = reader.GetString();

Expand All @@ -318,7 +318,7 @@ internal override T ReadWithQuotes(ref Utf8JsonReader reader)
return value;
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, T value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, T value, JsonSerializerOptions options, ref WriteStack state)
{
// An EnumConverter that invokes this method
// can only be created by JsonSerializerOptions.GetDictionaryKeyConverter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@ public override void Write(Utf8JsonWriter writer, Guid value, JsonSerializerOpti
writer.WriteStringValue(value);
}

internal override Guid ReadWithQuotes(ref Utf8JsonReader reader)
internal override Guid ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetGuidNoValidation();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, Guid value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, Guid value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ public override void Write(Utf8JsonWriter writer, short value, JsonSerializerOpt
writer.WriteNumberValue((long)value);
}

internal override short ReadWithQuotes(ref Utf8JsonReader reader)
internal override short ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetInt16WithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, short value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, short value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ public override void Write(Utf8JsonWriter writer, int value, JsonSerializerOptio
writer.WriteNumberValue((long)value);
}

internal override int ReadWithQuotes(ref Utf8JsonReader reader)
internal override int ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetInt32WithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, int value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, int value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ public override void Write(Utf8JsonWriter writer, long value, JsonSerializerOpti
writer.WriteNumberValue(value);
}

internal override long ReadWithQuotes(ref Utf8JsonReader reader)
internal override long ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetInt64WithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, long value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, long value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ public override void Write(Utf8JsonWriter writer, object? value, JsonSerializerO
writer.WriteEndObject();
}

internal override object ReadWithQuotes(ref Utf8JsonReader reader)
internal override object ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
ThrowHelper.ThrowNotSupportedException_DictionaryKeyTypeNotSupported(TypeToConvert, this);
return null!;
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, object? value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, object? value, JsonSerializerOptions options, ref WriteStack state)
{
// This converter does not handle nulls.
Debug.Assert(value != null);
Expand All @@ -48,7 +48,7 @@ internal override void WriteWithQuotes(Utf8JsonWriter writer, object? value, Jso
ThrowHelper.ThrowNotSupportedException_DictionaryKeyTypeNotSupported(runtimeType, this);
}

runtimeConverter.WriteWithQuotesAsObject(writer, value, options, ref state);
runtimeConverter.WriteAsPropertyNameAsObject(writer, value, options, ref state);
}

internal override object? ReadNumberWithCustomHandling(ref Utf8JsonReader reader, JsonNumberHandling handling, JsonSerializerOptions options)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ public override void Write(Utf8JsonWriter writer, sbyte value, JsonSerializerOpt
writer.WriteNumberValue(value);
}

internal override sbyte ReadWithQuotes(ref Utf8JsonReader reader)
internal override sbyte ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetSByteWithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, sbyte value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, sbyte value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ public override void Write(Utf8JsonWriter writer, float value, JsonSerializerOpt
writer.WriteNumberValue(value);
}

internal override float ReadWithQuotes(ref Utf8JsonReader reader)
internal override float ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetSingleWithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, float value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, float value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ public override void Write(Utf8JsonWriter writer, string? value, JsonSerializerO
}
}

internal override string ReadWithQuotes(ref Utf8JsonReader reader)
internal override string ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetString()!;
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, string value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, string value, JsonSerializerOptions options, ref WriteStack state)
{
if (options.DictionaryKeyPolicy != null && !state.Current.IgnoreDictionaryKeyPolicy)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ public override void Write(Utf8JsonWriter writer, ushort value, JsonSerializerOp
writer.WriteNumberValue((long)value);
}

internal override ushort ReadWithQuotes(ref Utf8JsonReader reader)
internal override ushort ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetUInt16WithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, ushort value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, ushort value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ public override void Write(Utf8JsonWriter writer, uint value, JsonSerializerOpti
writer.WriteNumberValue((ulong)value);
}

internal override uint ReadWithQuotes(ref Utf8JsonReader reader)
internal override uint ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetUInt32WithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, uint value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, uint value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ public override void Write(Utf8JsonWriter writer, ulong value, JsonSerializerOpt
writer.WriteNumberValue(value);
}

internal override ulong ReadWithQuotes(ref Utf8JsonReader reader)
internal override ulong ReadAsPropertyName(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return reader.GetUInt64WithQuotes();
}

internal override void WriteWithQuotes(Utf8JsonWriter writer, ulong value, JsonSerializerOptions options, ref WriteStack state)
internal override void WriteAsPropertyName(Utf8JsonWriter writer, ulong value, JsonSerializerOptions options, ref WriteStack state)
{
writer.WritePropertyName(value);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,9 +105,9 @@ internal bool ShouldFlush(Utf8JsonWriter writer, ref WriteStack state)
internal abstract bool WriteCoreAsObject(Utf8JsonWriter writer, object? value, JsonSerializerOptions options, ref WriteStack state);

/// <summary>
/// Loosely-typed WriteWithQuotes() that forwards to strongly-typed WriteWithQuotes().
/// Loosely-typed WriteToPropertyName() that forwards to strongly-typed WriteToPropertyName().
/// </summary>
internal abstract void WriteWithQuotesAsObject(Utf8JsonWriter writer, object value, JsonSerializerOptions options, ref WriteStack state);
internal abstract void WriteAsPropertyNameAsObject(Utf8JsonWriter writer, object value, JsonSerializerOptions options, ref WriteStack state);

// Whether a type (ConverterStrategy.Object) is deserialized using a parameterized constructor.
internal virtual bool ConstructorIsParameterized { get; }
Expand Down
Loading