Ditching System.Serialization.ObjectIdGenerator

Author: MoaidHathot

README.md

@@ -210,7 +210,6 @@ DumpConfig.Default.MaxDepth = 3;
 * Add custom rendering for more types:
     - Exceptions, AggregateExceptions, etc...
 * Rethink Generators caching keys
-* Ditch `ObjectIdGenerator` and create a custom, modern implementation
 * Consider using Max Depth for Descriptors
 * Refactor Renderers and make it better extendable
 * Add more renderers

src/Dumpify.Playground/Program.cs

@@ -12,12 +12,31 @@
 // DumpConfig.Default.TableConfig.ShowMemberTypes = true;
 // new DirectoryInfo("C:\\Program Files").Dump();
 // (1, 2, 3, 4, ("1", "b"), 5, 6, 7, 8, 9, 10, 11, 12, 13, "14", "15", 16, 17, 18).Dump("ValueTuple", tableConfig: new TableConfig {  MaxCollectionCount = 4 });
-(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, "14", "15", 16, 17, 18).Dump("ValueTuple 1");
-(1, 2, 3, 4, ("1", "b"), 5, 6, 7, 8, 9, 10, 11, 12, 13, "14", "15", 16, 17, 18).Dump("ValueTuple");
-Tuple.Create(1, 2, 3, 4, 5, 6, 7, Tuple.Create(8, 9, 10, 11)).Dump("System.Tuple");
+// (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, "14", "15", 16, 17, 18).Dump("ValueTuple 1");
+// (1, 2, 3, 4, ("1", "b"), 5, 6, 7, 8, 9, 10, 11, 12, 13, "14", "15", 16, 17, 18).Dump("ValueTuple");
+// Tuple.Create(1, 2, 3, 4, 5, 6, 7, Tuple.Create(8, 9, 10, 11)).Dump("System.Tuple");
 // new[] { 1, 2, 3,  4, 5, 6, 7, 8, 9, 10 }.Dump(tableConfig: new TableConfig { MaxCollectionCount = 3 });
 Console.WriteLine("---------------------");
+    var moaid1 = new Person
+    {
+        FirstName = "Moaid",
+        LastName = "Hathot",
+        Profession = Profession.Software
+    };
+
+    var haneeni1 = new Person
+    {
+        FirstName = "Haneeni",
+        LastName = "Shibli",
+        Profession = Profession.Health
+    };
 
+moaid1.Spouse = haneeni1;
+haneeni1.Spouse = moaid1;
+
+new [] { moaid1, haneeni1 }.Dump();
+
+moaid1.Dump();
 // TestSpecific();
 // TestSingle();
 // ShowEverything();
@@ -35,7 +54,6 @@
 //var foo = new { Name = "Moaid", LastName = "Hathot", Age = 35, Content = Enumerable.Range(0, 10).Select(i => (char)(i + 'a')).ToArray() };
 //foo.Dump("Test");
 
-
 void TestSpecific()
 {
     {

src/Dumpify/Renderers/IObjectIdTracker.cs

@@ -0,0 +1,6 @@
+namespace Dumpify;
+
+public interface IObjectIdTracker
+{
+	public (bool firstTime, long id) Track(object obj);
+}

src/Dumpify/Renderers/ObjectIdReferenceTracker.cs

@@ -0,0 +1,18 @@
+namespace Dumpify;
+
+public class ObjectIdReferenceTracker : IObjectIdTracker
+{
+	private readonly Dictionary<object, long> _objects = new(ReferenceEqualityComparer.Instance);
+
+    public (bool firstTime, long id) Track(object obj)
+	{
+		if(_objects.TryAdd(obj, _objects.Count + 1))
+		{
+			return (true, _objects.Count);
+		}
+		else
+		{
+			return (false, _objects[obj]);
+		}
+	}
+}

src/Dumpify/Renderers/RenderContext.cs

@@ -3,5 +3,5 @@
 namespace Dumpify;
 
 //Todo: RootObjectTransform is a temp workaround and should be removed once we merge the ObjectTableBuilder logic
-public record class RenderContext(in RendererConfig Config, ObjectIDGenerator ObjectTracker, int CurrentDepth, object? RootObject, object? RootObjectTransform);
-public record class RenderContext<TState>(in RendererConfig Config, ObjectIDGenerator ObjectTracker, int CurrentDepth, object? RootObject, object? RootObjectTransform, TState State) : RenderContext(Config, ObjectTracker, CurrentDepth, RootObject, RootObjectTransform);
+public record class RenderContext(in RendererConfig Config, IObjectIdTracker ObjectTracker, int CurrentDepth, object? RootObject, object? RootObjectTransform);
+public record class RenderContext<TState>(in RendererConfig Config, IObjectIdTracker ObjectTracker, int CurrentDepth, object? RootObject, object? RootObjectTransform, TState State) : RenderContext(Config, ObjectTracker, CurrentDepth, RootObject, RootObjectTransform);

src/Dumpify/Renderers/RendererBase.cs

@@ -1,7 +1,6 @@
 using Dumpify.Descriptors;
 using Dumpify.Descriptors.ValueProviders;
 using System.Collections.Concurrent;
-using System.Runtime.Serialization;
 
 namespace Dumpify;
 
@@ -26,7 +25,7 @@ protected void AddCustomTypeDescriptor(ICustomTypeRenderer<TRenderable> handler)
     public IRenderedObject Render(object? obj, IDescriptor? descriptor, RendererConfig config)
     {
         var state = CreateState(obj, descriptor, config);
-        var idGenerator = new ObjectIDGenerator();
+        var idGenerator = new ObjectIdReferenceTracker();
         var context = new RenderContext<TState>(config, idGenerator, 0, obj, null, state);
 
         var renderable = obj switch
@@ -135,9 +134,10 @@ private TRenderable RenderCustomDescriptor(object obj, CustomDescriptor customDe
         return RenderDescriptor(customValue, customValueDescriptor, context);
     }
 
-    private bool ObjectAlreadyRendered(object @object, ObjectIDGenerator tracker)
+    private bool ObjectAlreadyRendered(object @object, IObjectIdTracker tracker)
     {
-        tracker.GetId(@object, out var firstTime);
+        // tracker.GetId(@object, out var firstTime);
+        var (firstTime, id) = tracker.Track(@object);
 
         return firstTime is false;
     }