Skip to content

Implement serialization context for recursive references #37

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
IvanMurzak merged 5 commits into from
Dec 10, 2025
Merged

Implement serialization context for recursive references #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5254114
Implement serialization context to handle recursive references and cy…
IvanMurzak Dec 10, 2025
5ce71d5
Add tests for serialization of recursive objects and update reference…
IvanMurzak Dec 10, 2025
58c0460
Refactor recursion tests to correct child reference assertions and im…
IvanMurzak Dec 10, 2025
93df4ab
Refactor SerializationContext to optimize path storage and improve me…
IvanMurzak Dec 10, 2025
89df827
Add deserialization context to manage recursive references and cycles
IvanMurzak Dec 10, 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
368 changes: 368 additions & 0 deletions ReflectorNet.Tests/src/RecursionTests.cs
View file
Open in desktop

Large diffs are not rendered by default.

53 changes: 45 additions & 8 deletions ReflectorNet/src/Convertor/IReflectionConvertor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,57 @@ public interface IReflectionConvertor

int SerializationPriority(Type type, ILogger? logger = null);

object? Deserialize(
Reflector reflector,
SerializedMember data,
Type? fallbackType = null,
string? fallbackName = null,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null,
DeserializationContext? context = null);

object? Deserialize(Reflector reflector, SerializedMember data, Type? fallbackType = null, string? fallbackName = null, int depth = 0, StringBuilder? stringBuilder = null, ILogger? logger = null);

SerializedMember Serialize(Reflector reflector, object? obj, Type? fallbackType = null, string? name = null, bool recursive = true,
SerializedMember Serialize(
Reflector reflector,
object? obj,
Type? fallbackType = null,
string? name = null,
bool recursive = true,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
int depth = 0, StringBuilder? stringBuilder = null,
ILogger? logger = null);
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null,
SerializationContext? context = null);

bool TryPopulate(Reflector reflector, ref object? obj, SerializedMember data, Type? fallbackType = null, int depth = 0, StringBuilder? stringBuilder = null,
bool TryPopulate(
Reflector reflector,
ref object? obj,
SerializedMember data,
Type? fallbackType = null,
int depth = 0,
StringBuilder? stringBuilder = null,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
ILogger? logger = null);

bool SetField(Reflector reflector, ref object? obj, Type type, FieldInfo fieldInfo, SerializedMember? value, int depth = 0, StringBuilder? stringBuilder = null,
bool SetField(
Reflector reflector,
ref object? obj,
Type type,
FieldInfo fieldInfo,
SerializedMember? value,
int depth = 0,
StringBuilder? stringBuilder = null,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
ILogger? logger = null);
bool SetProperty(Reflector reflector, ref object? obj, Type type, PropertyInfo propertyInfo, SerializedMember? value, int depth = 0, StringBuilder? stringBuilder = null,

bool SetProperty(
Reflector reflector,
ref object? obj,
Type type,
PropertyInfo propertyInfo,
SerializedMember? value,
int depth = 0,
StringBuilder? stringBuilder = null,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
ILogger? logger = null);

Expand All @@ -44,6 +79,7 @@ bool SetProperty(Reflector reflector, ref object? obj, Type type, PropertyInfo p
Type objType,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
ILogger? logger = null);

IEnumerable<PropertyInfo>? GetSerializableProperties(
Reflector reflector,
Type objType,
Expand All @@ -55,6 +91,7 @@ IEnumerable<string> GetAdditionalSerializableFields(
Type objType,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
ILogger? logger = null);

IEnumerable<string> GetAdditionalSerializableProperties(
Reflector reflector,
Type objType,
Expand Down
29 changes: 24 additions & 5 deletions ReflectorNet/src/Convertor/Reflection/ArrayReflectionConvertor.Deserialize.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ public partial class ArrayReflectionConvertor : BaseReflectionConvertor<Array>
string? fallbackName = null,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
DeserializationContext? context = null)
{
var padding = StringUtils.GetPadding(depth);

Expand Down Expand Up @@ -102,17 +103,22 @@ public partial class ArrayReflectionConvertor : BaseReflectionConvertor<Array>
return null;
}

// Register the array early (before deserializing elements) so child references can resolve
context?.Register(array);

int i = 0;
foreach (var element in jsonArray.EnumerateArray())
{
var member = ParseElementToMember(element);
member.name = $"[{i}]"; // Set array index as name for path tracking

var deserializedElement = reflector.Deserialize(
data: member,
fallbackType: elementType,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger);
logger: logger,
context: context);

if (deserializedElement != null)
{
Expand Down Expand Up @@ -152,18 +158,25 @@ public partial class ArrayReflectionConvertor : BaseReflectionConvertor<Array>
return null;
}

// Register the list early (before deserializing elements) so child references can resolve
context?.Register(list);

int i = 0;
foreach (var element in jsonArray.EnumerateArray())
{
var member = ParseElementToMember(element);
member.name = $"[{i}]"; // Set array index as name for path tracking

var deserializedElement = reflector.Deserialize(
member,
fallbackType: elementType,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger);
logger: logger,
context: context);

addMethod.Invoke(list, new[] { deserializedElement });
i++;
}

logger?.LogInformation("{padding}Successfully created list of type='{typeName}'", padding, list.GetType().GetTypeName(pretty: true));
Expand Down Expand Up @@ -269,7 +282,8 @@ protected virtual bool TryDeserializeValueListInternal(
string? name = null,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
DeserializationContext? context = null)
{
var padding = StringUtils.GetPadding(depth);
var paddingNext = StringUtils.GetPadding(depth + 1);
Expand Down Expand Up @@ -333,16 +347,21 @@ protected virtual bool TryDeserializeValueListInternal(
return false;
}

// Register the list early (before deserializing elements) so child references can resolve
context?.Register(list);

int i = 0;
foreach (var element in jsonArray.EnumerateArray())
{
var member = ParseElementToMember(element);
member.name = $"[{i}]"; // Set array index as name for path tracking
var parsedValue = reflector.Deserialize(
data: member,
fallbackType: itemType,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger
logger: logger,
context: context
);

if (logger?.IsEnabled(LogLevel.Trace) == true)
Expand Down
6 changes: 4 additions & 2 deletions ReflectorNet/src/Convertor/Reflection/ArrayReflectionConvertor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ protected override SerializedMember InternalSerialize(
BindingFlags flags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
SerializationContext? context = null)
{
if (obj == null)
return SerializedMember.FromJson(type, json: null, name: name);
Expand All @@ -84,7 +85,8 @@ protected override SerializedMember InternalSerialize(
flags: flags,
depth: depth,
stringBuilder: stringBuilder,
logger: logger));
logger: logger,
context: context));
}

return SerializedMember.FromValue(
Expand Down
17 changes: 14 additions & 3 deletions ReflectorNet/src/Convertor/Reflection/Base/BaseReflectionConvertor.Deserialize.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ public abstract partial class BaseReflectionConvertor<T> : IReflectionConvertor
string? fallbackName = null,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
DeserializationContext? context = null)
{
if (!TryDeserializeValue(reflector,
serializedMember: data,
Expand All @@ -73,6 +74,10 @@ public abstract partial class BaseReflectionConvertor<T> : IReflectionConvertor

var padding = StringUtils.GetPadding(depth);

// Register the object early (before deserializing children) so child references can resolve
if (result != null && context != null)
context.Register(result);

if (data.fields != null)
{
if (data.fields.Count > 0)
Expand All @@ -94,7 +99,12 @@ public abstract partial class BaseReflectionConvertor<T> : IReflectionConvertor
continue;
}

var fieldValue = reflector.Deserialize(field, depth: depth + 1, stringBuilder: stringBuilder, logger: logger);
var fieldValue = reflector.Deserialize(
data: field,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger,
context: context);

var fieldInfo = type!.GetField(field.name, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
if (fieldInfo == null)
Expand Down Expand Up @@ -135,7 +145,8 @@ public abstract partial class BaseReflectionConvertor<T> : IReflectionConvertor
property,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger);
logger: logger,
context: context);

var propertyInfo = type!.GetProperty(property.name, BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance);
if (propertyInfo == null)
Expand Down
17 changes: 10 additions & 7 deletions ReflectorNet/src/Convertor/Reflection/Base/BaseReflectionConvertor.Serialize.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public abstract partial class BaseReflectionConvertor<T> : IReflectionConvertor
public virtual SerializedMember Serialize(Reflector reflector, object? obj, Type? type = null, string? name = null, bool recursive = true,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
int depth = 0, StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null, SerializationContext? context = null)
{
return InternalSerialize(reflector, obj,
type: type ?? obj?.GetType() ?? typeof(T),
Expand All @@ -32,11 +32,12 @@ public virtual SerializedMember Serialize(Reflector reflector, object? obj, Type
flags: flags,
depth: depth,
stringBuilder: stringBuilder,
logger: logger);
logger: logger,
context: context);
}

protected virtual SerializedMemberList? SerializeFields(Reflector reflector, object obj, BindingFlags flags,
int depth = 0, StringBuilder? stringBuilder = null, ILogger? logger = null)
int depth = 0, StringBuilder? stringBuilder = null, ILogger? logger = null, SerializationContext? context = null)
{
var serializedFields = default(SerializedMemberList);
var objType = obj.GetType();
Expand All @@ -60,14 +61,15 @@ public virtual SerializedMember Serialize(Reflector reflector, object? obj, Type
flags: flags,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger)
logger: logger,
context: context)
);
}
return serializedFields;
}

protected virtual SerializedMemberList? SerializeProperties(Reflector reflector, object obj, BindingFlags flags,
int depth = 0, StringBuilder? stringBuilder = null, ILogger? logger = null)
int depth = 0, StringBuilder? stringBuilder = null, ILogger? logger = null, SerializationContext? context = null)
{
var serializedProperties = default(SerializedMemberList);
var objType = obj.GetType();
Expand All @@ -92,7 +94,8 @@ public virtual SerializedMember Serialize(Reflector reflector, object? obj, Type
flags: flags,
depth: depth + 1,
stringBuilder: stringBuilder,
logger: logger)
logger: logger,
context: context)
);
}
catch { /* skip inaccessible properties */ }
Expand All @@ -103,6 +106,6 @@ public virtual SerializedMember Serialize(Reflector reflector, object? obj, Type
protected abstract SerializedMember InternalSerialize(Reflector reflector, object? obj, Type type, string? name = null, bool recursive = true,
BindingFlags flags = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance,
int depth = 0, StringBuilder? stringBuilder = null,
ILogger? logger = null);
ILogger? logger = null, SerializationContext? context = null);
}
}
7 changes: 4 additions & 3 deletions ReflectorNet/src/Convertor/Reflection/GenericReflectionConvertor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ protected override SerializedMember InternalSerialize(
BindingFlags flags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
SerializationContext? context = null)
{
if (obj == null)
return SerializedMember.FromJson(type, json: null, name: name);
Expand All @@ -42,8 +43,8 @@ protected override SerializedMember InternalSerialize(
{
name = name,
typeName = type.GetTypeName(pretty: false) ?? string.Empty,
fields = base.SerializeFields(reflector, obj, flags, depth: depth, stringBuilder: stringBuilder, logger: logger),
props = base.SerializeProperties(reflector, obj, flags, depth: depth, stringBuilder: stringBuilder, logger: logger),
fields = base.SerializeFields(reflector, obj, flags, depth: depth, stringBuilder: stringBuilder, logger: logger, context: context),
props = base.SerializeProperties(reflector, obj, flags, depth: depth, stringBuilder: stringBuilder, logger: logger, context: context),
valueJsonElement = new JsonObject().ToJsonElement()
}
: SerializedMember.FromJson(type, obj.ToJson(reflector), name: name);
Expand Down
2 changes: 1 addition & 1 deletion ReflectorNet/src/Convertor/Reflection/PrimitiveReflectionConvertor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public override int SerializationPriority(Type type, ILogger? logger = null)
protected override SerializedMember InternalSerialize(Reflector reflector, object? obj, Type type, string? name = null, bool recursive = true,
BindingFlags flags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,
int depth = 0, StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null, SerializationContext? context = null)
{
if (obj == null)
return SerializedMember.FromJson(type, json: null, name: name);
Expand Down
5 changes: 3 additions & 2 deletions ReflectorNet/src/Convertor/Reflection/Specialized/AssemblyReflectionConvertor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ protected override SerializedMember InternalSerialize(
BindingFlags flags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
SerializationContext? context = null)
{
if (obj is Assembly assemblyObj)
{
var assemblyName = assemblyObj.FullName ?? assemblyObj.GetName().Name ?? string.Empty;
return SerializedMember.FromValue(reflector, type, assemblyName, name: name);
}

return base.InternalSerialize(reflector, obj, type, name, recursive, flags, depth, stringBuilder, logger);
return base.InternalSerialize(reflector, obj, type, name, recursive, flags, depth, stringBuilder, logger, context);
}

public override object? CreateInstance(Reflector reflector, Type type)
Expand Down
5 changes: 3 additions & 2 deletions ReflectorNet/src/Convertor/Reflection/Specialized/TypeReflectionConvertor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,16 @@ protected override SerializedMember InternalSerialize(
BindingFlags flags = BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic,
int depth = 0,
StringBuilder? stringBuilder = null,
ILogger? logger = null)
ILogger? logger = null,
SerializationContext? context = null)
{
if (obj is Type typeObj)
{
var typeName = typeObj.GetTypeName(pretty: false);
return SerializedMember.FromValue(reflector, type, typeName, name: name);
}

return base.InternalSerialize(reflector, obj, type, name, recursive, flags, depth, stringBuilder, logger);
return base.InternalSerialize(reflector, obj, type, name, recursive, flags, depth, stringBuilder, logger, context);
}

public override object? CreateInstance(Reflector reflector, Type type)
Expand Down
Loading