Skip to content

Commit

Permalink
-Fixed serializing FileInfo/DirectoryInfo on .NET Core with JsonConve…
Browse files Browse the repository at this point in the history
…rter
  • Loading branch information
JamesNK committed Feb 22, 2018
1 parent f2b6ea4 commit 8bb337d
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 7 deletions.
86 changes: 86 additions & 0 deletions Src/Newtonsoft.Json.Tests/Issues/Issue1619.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
#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 System;
using System.IO;
#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 Issue1619 : TestFixtureBase
{
[Test]
public void Test()
{
Foo value = new Foo
{
Bar = new DirectoryInfo(@"c:\temp")
};

string json = JsonConvert.SerializeObject(value, new DirectoryInfoJsonConverter());
Assert.AreEqual(@"{""Bar"":""c:\\temp""}", json);
}

public class Foo
{
public DirectoryInfo Bar { get; set; }
}

public class DirectoryInfoJsonConverter : JsonConverter
{
public override bool CanConvert(Type objectType)
{
return objectType == typeof(DirectoryInfo);
}

public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
if (reader.Value is string s)
{
return new DirectoryInfo(s);
}

throw new ArgumentOutOfRangeException(nameof(reader));
}

public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
if (!(value is DirectoryInfo directoryInfo))
{
throw new ArgumentOutOfRangeException(nameof(value));
}

writer.WriteValue(directoryInfo.FullName);
}
}
}
}
19 changes: 12 additions & 7 deletions Src/Newtonsoft.Json/Serialization/DefaultContractResolver.cs
Original file line number Diff line number Diff line change
Expand Up @@ -313,13 +313,6 @@ private bool ShouldSerializeEntityMember(MemberInfo memberInfo)
/// <returns>A <see cref="JsonObjectContract"/> for the given type.</returns>
protected virtual JsonObjectContract CreateObjectContract(Type objectType)
{
// serializing DirectoryInfo without ISerializable will stackoverflow
// https://github.com/JamesNK/Newtonsoft.Json/issues/1541
if (Array.IndexOf(BlacklistedTypeNames, objectType.FullName) != -1)
{
throw new JsonSerializationException("Unable to serialize instance of '{0}'.".FormatWith(CultureInfo.InvariantCulture, objectType));
}

JsonObjectContract contract = new JsonObjectContract(objectType);
InitializeContract(contract);

Expand Down Expand Up @@ -404,9 +397,21 @@ protected virtual JsonObjectContract CreateObjectContract(Type objectType)
SetExtensionDataDelegates(contract, extensionDataMember);
}

// serializing DirectoryInfo without ISerializable will stackoverflow
// https://github.com/JamesNK/Newtonsoft.Json/issues/1541
if (Array.IndexOf(BlacklistedTypeNames, objectType.FullName) != -1)
{
contract.OnSerializingCallbacks.Add(ThrowUnableToSerializeError);
}

return contract;
}

private static void ThrowUnableToSerializeError(object o, StreamingContext context)
{
throw new JsonSerializationException("Unable to serialize instance of '{0}'.".FormatWith(CultureInfo.InvariantCulture, o.GetType()));
}

private MemberInfo GetExtensionDataMemberForType(Type type)
{
IEnumerable<MemberInfo> members = GetClassHierarchyForType(type).SelectMany(baseType =>
Expand Down

0 comments on commit 8bb337d

Please sign in to comment.