fix: For issue #431 - decorated properties of PathsResultBoltRelationship and PathsResultBoltNode with JsonProperty to ensure correct serialization/deserialization when using CamelCasePropertyNamesContractResolver (#433)

Author: andrew-ubco

Neo4jClient.Tests/BoltGraphClientTests/Cypher/ExecuteGetCypherResultsTests.cs

@@ -8,6 +8,7 @@
 using Neo4j.Driver;
 using Neo4jClient.ApiModels.Cypher;
 using Neo4jClient.Cypher;
+using Newtonsoft.Json.Serialization;
 using Xunit;
 
 namespace Neo4jClient.Tests.BoltGraphClientTests.Cypher
@@ -89,7 +90,7 @@ public bool Equals(INode other)
 
         #region Implementation of INode
 
-        public IReadOnlyList<string> Labels { get; }
+        public IReadOnlyList<string> Labels { get; set; }
 
         #endregion
     }
@@ -718,5 +719,59 @@ public async Task ShouldDeserializePathsResultAsSetBased()
                 results.First().Start.Id.Should().Be(2);
             }
         }
+ 
+        [Fact]
+        public async Task ShouldDeserializePathsResultWhenUsingCamelCaseResolver()
+        {
+            // Arrange
+            const string queryText = @"MATCH (start:Node {Id:$p0}),(end:Node {Id: $p1}), p = shortestPath((start)-[*..5]->(end)) RETURN p";
+
+            var parameters = new Dictionary<string, object>
+            {
+                {"p0", 215},
+                {"p1", 219}
+            };
+
+            var cypherQuery = new CypherQuery(queryText, parameters, CypherResultMode.Set, CypherResultFormat.Rest, "neo4j");
+            
+            using (var testHarness = new BoltTestHarness())
+            {
+                var recordMock = new Mock<IRecord>();
+                recordMock
+                    .Setup(r => r["p"])
+                    .Returns(new TestPath
+                    {
+                        End = new TestNode{Id = 1, Labels = new []{"Node"}}, 
+                        Start = new TestNode{Id=2, Labels = new []{"Node"}}, 
+                        Relationships = new List<IRelationship> {new TestRelationship{Id=3, StartNodeId = 2, EndNodeId = 1, Type = "Foo"}}, 
+                        Nodes = new List<INode> {new TestNode(), new TestNode() }
+                    });
+                recordMock
+                    .Setup(r => r.Keys)
+                    .Returns(new[] {"p"});
+                
+                var testStatementResult = new TestStatementResult(new[] {"p"}, recordMock.Object);
+                testHarness.SetupCypherRequestResponse(cypherQuery.QueryText, cypherQuery.QueryParameters, testStatementResult);
+
+                var graphClient = await testHarness.CreateAndConnectBoltGraphClient();
+                graphClient.JsonContractResolver = new CamelCasePropertyNamesContractResolver();
+                var results = (await graphClient.ExecuteGetCypherResultsAsync<PathsResultBolt>(cypherQuery)).ToArray();
+
+                //Assert
+                Assert.IsAssignableFrom<IEnumerable<PathsResultBolt>>(results);
+                var resultPath = results.First();
+                Assert.Equal(1, resultPath.Length);
+                resultPath.Nodes.Count.Should().Be(2);
+                resultPath.End.Id.Should().Be(1);
+                resultPath.End.Labels.Should().BeEquivalentTo("Node");
+                resultPath.Start.Id.Should().Be(2);
+                resultPath.Start.Labels.Should().BeEquivalentTo("Node");
+                resultPath.Relationships.Count.Should().Be(1);
+                resultPath.Relationships[0].Id.Should().Be(3);
+                resultPath.Relationships[0].StartNodeId.Should().Be(2);
+                resultPath.Relationships[0].EndNodeId.Should().Be(1);
+                resultPath.Relationships[0].Type.Should().Be("Foo");
+            }
+        }
     }
 }

Neo4jClient/ApiModels/Cypher/PathsResultBolt.cs

@@ -39,13 +39,18 @@ internal PathsResultBolt(IPath path)
 
         public class PathsResultBoltRelationship
         {
+            [JsonProperty("Id")]
             public long Id { get; set; }
+            [JsonProperty("Type")]
             public string Type { get; set; }
+            [JsonProperty("StartNodeId")]
             public long StartNodeId { get; set; }
+            [JsonProperty("EndNodeId")]
             public long EndNodeId { get; set; }
 
             public object this[string key] => Properties[key];
 
+            [JsonProperty("Properties")]
             public Dictionary<string, object> Properties { get; set; }
 
             public PathsResultBoltRelationship() { Properties = new Dictionary<string, object>(); }
@@ -90,9 +95,12 @@ public override int GetHashCode()
 
         public class PathsResultBoltNode 
         {
+            [JsonProperty("Id")]
             public long Id { get; set; }
+            [JsonProperty("Labels")]
             public List<string> Labels { get; set; }
             public object this[string key] => Properties[key];
+            [JsonProperty("Properties")]
             public Dictionary<string, object> Properties { get; set; }
 
             public PathsResultBoltNode() { Properties = new Dictionary<string, object>(); }