Skip to content

Fixed an issue in JsonSerializer where JsonSerializerSettings.NullValueHandling was being set to NullValueHandling.Ignore after custom settings were applied. #1788

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

Merged
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 @@ -9,7 +9,7 @@
<AssemblyName>Amazon.Lambda.Serialization.Json</AssemblyName>
<PackageId>Amazon.Lambda.Serialization.Json</PackageId>
<PackageTags>AWS;Amazon;Lambda</PackageTags>
<VersionPrefix>2.2.2</VersionPrefix>
<VersionPrefix>2.2.3</VersionPrefix>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
using System;
using System.IO;
using System.Collections.Generic;
using Amazon.Lambda.Core;
using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;

namespace Amazon.Lambda.Serialization.Json
{
/// <summary>
/// Custom ILambdaSerializer implementation which uses Newtonsoft.Json
/// for serialization that includes null values.
///
/// <para>
/// If the environment variable LAMBDA_NET_SERIALIZER_DEBUG is set to true the JSON coming
/// in from Lambda and being sent back to Lambda will be logged.
/// </para>
/// </summary>
public class JsonIncludeNullValueSerializer : JsonSerializer
{
/// <summary>
/// Constructs instance of serializer.
/// </summary>
public JsonIncludeNullValueSerializer()
: base(CreateCustomizer())
{ }

private static Action<JsonSerializerSettings> CreateCustomizer()
{
return (JsonSerializerSettings customSerializerSettings) =>
{
customSerializerSettings.NullValueHandling = NullValueHandling.Include;
};
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace Amazon.Lambda.Serialization.Json
{
/// <summary>
/// Custom ILambdaSerializer implementation which uses Newtonsoft.Json 9.0.1
/// Custom ILambdaSerializer implementation which uses Newtonsoft.Json
/// for serialization.
///
/// <para>
Expand Down Expand Up @@ -41,8 +41,8 @@ public JsonSerializer(Action<JsonSerializerSettings> customizeSerializerSettings
public JsonSerializer(Action<JsonSerializerSettings> customizeSerializerSettings, NamingStrategy namingStrategy)
{
JsonSerializerSettings settings = new JsonSerializerSettings();
settings.NullValueHandling = NullValueHandling.Ignore;
customizeSerializerSettings(settings);


// Set the contract resolver *after* the custom callback has been
// invoked. This makes sure that we always use the good resolver.
Expand All @@ -52,7 +52,6 @@ public JsonSerializer(Action<JsonSerializerSettings> customizeSerializerSettings
resolver.NamingStrategy = namingStrategy;
};
settings.ContractResolver = resolver;
settings.NullValueHandling = NullValueHandling.Ignore;

serializer = Newtonsoft.Json.JsonSerializer.Create(settings);

Expand Down
23 changes: 23 additions & 0 deletions Libraries/test/EventsTests.Shared/EventTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace Amazon.Lambda.Tests
using Amazon.Lambda.LexV2Events;
using Amazon.Lambda.MQEvents;
using Amazon.Lambda.S3Events;
using Amazon.Lambda.Serialization.Json;
using Amazon.Lambda.SimpleEmailEvents;
using Amazon.Lambda.SNSEvents;
using Amazon.Lambda.SQSEvents;
Expand Down Expand Up @@ -3879,6 +3880,28 @@ public void CloudWatchTranslateParallelDataStateChangeUpdate(Type serializerType

}
}

[Fact]
public void TestJsonIncludeNullValueSerializer()
{
var serializer = new JsonIncludeNullValueSerializer();

var response = new ClassUsingPascalCase
{
SomeValue = 123,
SomeOtherValue = null
};

MemoryStream ms = new MemoryStream();
serializer.Serialize(response, ms);
ms.Position = 0;
var json = new StreamReader(ms).ReadToEnd();

var serialized = JObject.Parse(json);
Assert.Equal(123, serialized["SomeValue"]);
Assert.Equal(JTokenType.Null, serialized["SomeOtherValue"].Type); // System.NullReferenceException is thrown if value is missing.
}

class ClassUsingPascalCase
{
public int SomeValue { get; set; }
Expand Down
Loading