Exclude TargetSite from non-serializable Exception serialization (#1897)

This commit is contained in:
James Newton-King
2018-10-27 18:31:32 +13:00
committed by GitHub
parent 416cb4db0f
commit 998a0aca63
2 changed files with 117 additions and 0 deletions
@@ -0,0 +1,111 @@
#region License
// Copyright (c) 2007 James Newton-King
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Linq.JsonPath;
using System;
using System.Collections.Generic;
using Newtonsoft.Json.Converters;
using System.Reflection;
using System.Runtime.Versioning;
using Newtonsoft.Json.Serialization;
#if DNXCORE50
using Xunit;
using Test = Xunit.FactAttribute;
using Assert = Newtonsoft.Json.Tests.XUnitAssert;
#else
using NUnit.Framework;
#endif
namespace Newtonsoft.Json.Tests.Issues
{
[TestFixture]
public class Issue1798
{
public class NonSerializableException : Exception
{
}
[Test]
public void Test()
{
string nonSerializableJson = null;
string serializableJson = null;
try
{
throw new NonSerializableException();
}
catch (Exception ex)
{
nonSerializableJson = JsonConvert.SerializeObject(ex, new JsonSerializerSettings
{
Formatting = Formatting.Indented
});
}
try
{
throw new Exception();
}
catch (Exception ex)
{
serializableJson = JsonConvert.SerializeObject(ex, new JsonSerializerSettings
{
Formatting = Formatting.Indented
});
}
AssertNoTargetSite(nonSerializableJson);
AssertNoTargetSite(serializableJson);
}
[Test]
public void Test_DefaultContractResolver()
{
DefaultContractResolver resolver = new DefaultContractResolver();
var objectContract = (JsonObjectContract) resolver.ResolveContract(typeof(NonSerializableException));
Assert.IsFalse(objectContract.Properties.Contains("TargetSite"));
#if (PORTABLE40 || PORTABLE || NETSTANDARD1_3) && !NETSTANDARD2_0
objectContract = (JsonObjectContract) resolver.ResolveContract(typeof(Exception));
Assert.IsFalse(objectContract.Properties.Contains("TargetSite"));
#else
Assert.IsInstanceOf(typeof(JsonISerializableContract), resolver.ResolveContract(typeof(Exception)));
#endif
}
private void AssertNoTargetSite(string json)
{
JObject o = JObject.Parse(json);
if (o.ContainsKey("TargetSite"))
{
Assert.Fail("JSON has TargetSite property.");
}
}
}
}
@@ -273,6 +273,12 @@ namespace Newtonsoft.Json.Serialization
serializableMembers = serializableMembers.Where(ShouldSerializeEntityMember).ToList();
}
#endif
// don't include TargetSite on non-serializable exceptions
// MemberBase is problematic to serialize. Large, self referencing instances, etc
if (typeof(Exception).IsAssignableFrom(objectType))
{
serializableMembers = serializableMembers.Where(m => !string.Equals(m.Name, "TargetSite", StringComparison.Ordinal)).ToList();
}
}
else
{