Fixing NodewView serializationn properties (#13663)

jesusalvino · web-flow · commit 90987ac237bd · 2023-01-18T23:11:57.000+08:00
* Fixing NodewView serializationn properties

* Serialization order for the NodeModel

* Using simple order tag

* Upadte unit test

* naming and message
diff --git a/src/DynamoCore/Graph/Nodes/CodeBlockNode.cs b/src/DynamoCore/Graph/Nodes/CodeBlockNode.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Collections.Specialized;
@@ -234,6 +234,7 @@ public override string AstIdentifierBase
         /// <summary>
         ///     Returns string content of CodeBlock node.
         /// </summary>
+        [JsonProperty(Order = 10)]
         public string Code
         {
             get { return code; }
diff --git a/src/DynamoCore/Graph/Nodes/NodeModel.cs b/src/DynamoCore/Graph/Nodes/NodeModel.cs
@@ -133,6 +133,7 @@ public virtual string CreationName
         /// server type for the node. This property should only be
         /// used for serialization.
         /// </summary>
+        [JsonProperty(Order = 2)]
         public virtual string NodeType
         {
             get
@@ -229,7 +230,7 @@ internal void OnNodeExecutionEnd()
         /// <summary>
         /// Id for this node, must be unique within the graph.
         /// </summary>
-        [JsonProperty("Id")]
+        [JsonProperty("Id",Order = 1)]
         [JsonConverter(typeof(IdToGuidConverter))]
         public override Guid GUID
         {
@@ -472,7 +473,7 @@ public string Name
         /// <summary>
         ///     Collection of PortModels representing all Input ports.
         /// </summary>
-        [JsonProperty("Inputs")]
+        [JsonProperty("Inputs", Order = 3)]
         public ObservableCollection<PortModel> InPorts
         {
             get { return inPorts; }
@@ -487,7 +488,7 @@ public ObservableCollection<PortModel> InPorts
         /// <summary>
         ///     Collection of PortModels representing all Output ports.
         /// </summary>
-        [JsonProperty("Outputs")]
+        [JsonProperty("Outputs", Order = 4)]
         public ObservableCollection<PortModel> OutPorts
         {
             get { return outPorts; }
@@ -514,7 +515,7 @@ public IDictionary<int, HashSet<Tuple<int, NodeModel>>> OutputNodes
         /// <summary>
         ///     Control how arguments lists of various sizes are laced.
         /// </summary>
-        [JsonProperty("Replication"), JsonConverter(typeof(StringEnumConverter))]
+        [JsonProperty("Replication", Order = 6), JsonConverter(typeof(StringEnumConverter))]
         public LacingStrategy ArgumentLacing
         {
             get
@@ -802,6 +803,7 @@ public List<string> Tags
         /// <summary>
         ///     Description of this Node.
         /// </summary>
+        [JsonProperty(Order = 7)]
         public string Description
         {
             get
diff --git a/src/DynamoCore/Graph/Nodes/ZeroTouch/DSFunction.cs b/src/DynamoCore/Graph/Nodes/ZeroTouch/DSFunction.cs
@@ -1,5 +1,6 @@
 using Autodesk.DesignScript.Runtime;
 using Dynamo.Engine;
+using Newtonsoft.Json;
 
 namespace Dynamo.Graph.Nodes.ZeroTouch
 {
@@ -25,6 +26,7 @@ public override string NodeType
             }
         }
 
+        [JsonProperty(Order = 5)]
         public string FunctionSignature
         {
             get
diff --git a/src/DynamoCore/Graph/Workspaces/SerializationExtensions.cs b/src/DynamoCore/Graph/Workspaces/SerializationExtensions.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 using System.Text.RegularExpressions;
@@ -94,6 +94,6 @@ internal static string SerializeIntegerSliderAs32BitType(string json)
             var rgx2 = new Regex(@"\bCoreNodeModels.Input.IntegerSlider64Bit\b");
 
             return rgx2.Replace(result, "CoreNodeModels.Input.IntegerSlider");
-        }
+        }        
     }
 }
diff --git a/src/DynamoCoreWpf/ViewModels/Core/NodeViewModel.cs b/src/DynamoCoreWpf/ViewModels/Core/NodeViewModel.cs
@@ -69,6 +69,7 @@ public partial class NodeViewModel : ViewModelBase
         /// Returns NodeModel ID
         /// </summary>
         [JsonConverter(typeof(IdToGuidConverter))]
+        [JsonProperty(Order = 1)]
         public Guid Id
         {
             get { return NodeModel.GUID; }
@@ -164,6 +165,7 @@ public bool IsInput
             }
         }
 
+        [JsonProperty(Order = 3)]
         public bool IsSetAsInput
         {
             get
@@ -192,6 +194,7 @@ public bool IsOutput
             }
         }
 
+        [JsonProperty(Order = 4)]
         public bool IsSetAsOutput
         {
             get
@@ -211,11 +214,12 @@ public bool IsSetAsOutput
             }
         }
 
-        
+
         /// <summary>
         /// The Name of the nodemodel this view points to
         /// this is the name of the node as it is displayed in the UI.
         /// </summary>
+        [JsonProperty(Order = 2)]
         public string Name
         {
             get
@@ -347,7 +351,7 @@ public bool IsInteractionEnabled
             get { return true; }
         }
 
-        [JsonProperty("ShowGeometry")]
+        [JsonProperty("ShowGeometry",Order = 6)]
         public bool IsVisible
         {
             get
@@ -594,7 +598,7 @@ public bool IsFrozen
         /// <value>
         ///  Returns true if the node has been frozen explicitly by the user, otherwise false.
         /// </value>  
-        [JsonProperty("Excluded")]
+        [JsonProperty("Excluded", Order = 5)]
         public bool IsFrozenExplicitly
         {
             get
@@ -629,6 +633,7 @@ public bool CanToggleFrozen
         /// <summary>
         ///     Returns or set the X position of the Node.
         /// </summary>
+        [JsonProperty(Order = 7)]
         public double X
         {
             get { return NodeModel.X; }
@@ -641,6 +646,7 @@ public double X
         /// <summary>
         ///     Returns or set the Y position of the Node.
         /// </summary>
+        [JsonProperty(Order = 8)]
         public double Y
         {
             get { return NodeModel.Y; }
diff --git a/src/Libraries/CoreNodeModels/Input/BaseTypes.cs b/src/Libraries/CoreNodeModels/Input/BaseTypes.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.ComponentModel;
 using System.Globalization;
@@ -203,7 +203,7 @@ void Preferences_PropertyChanged(object sender, PropertyChangedEventArgs e)
         /// or unassigned identifier syntax.i.e *start..end*
         /// This property is only validated for new user input.
         /// </summary>
-        [JsonProperty("InputValue"),JsonConverter(typeof(DoubleInputValueSerializationConverter))]
+        [JsonProperty("InputValue",Order = 10),JsonConverter(typeof(DoubleInputValueSerializationConverter))]
         public string Value
         {
             get { return _value; }
diff --git a/src/Libraries/CoreNodeModels/Input/BasicInteractive.cs b/src/Libraries/CoreNodeModels/Input/BasicInteractive.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Xml;
@@ -12,7 +12,7 @@ public abstract class BasicInteractive<T> : NodeModel
     {
         private T value;
 
-        [JsonProperty("InputValue")]
+        [JsonProperty("InputValue", Order = 9)]
         public virtual T Value
         {
             get
diff --git a/src/Libraries/CoreNodeModels/Input/FileSystem.cs b/src/Libraries/CoreNodeModels/Input/FileSystem.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.ComponentModel;
@@ -20,6 +20,8 @@ namespace CoreNodeModels.Input
     public abstract class FileSystemBrowser : String
     {
         private static readonly string HintPathString = "HintPath";
+
+        [JsonProperty(Order = 8)]
         public string HintPath { get; set; }
 
         protected FileSystemBrowser(IEnumerable<PortModel> inPorts, IEnumerable<PortModel> outPorts) : base(inPorts, outPorts)
diff --git a/test/DynamoCoreWpfTests/SerializationTests.cs b/test/DynamoCoreWpfTests/SerializationTests.cs
@@ -1,4 +1,4 @@
-﻿using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -434,6 +434,77 @@ public void TestDummyNodeSerialization()
             Assert.AreEqual(element.Name, "Dynamo.Nodes.DSFunction");
         }
 
+        [Test]
+        public void NodeViewSerializationPropertiesTest()
+        {
+            var serializationNodeViewModelFile = Path.Combine(TestDirectory, @"core\serialization\serializationNodeViewModel.dyn");
+            OpenModel(serializationNodeViewModelFile);
+
+            var workSpaceJobject = JObject.Parse(ViewModel.CurrentSpaceViewModel.ToJson());
+            JObject nodeViewModelJobject = JObject.Parse(workSpaceJobject["NodeViews"][0].ToString());
+
+            Assert.AreEqual(8, nodeViewModelJobject.Properties().Count(), "The number of Serialized properties is not the expected");
+
+            bool explicitOrder =
+                nodeViewModelJobject.Properties().ElementAt(0).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.Id)) &&
+                nodeViewModelJobject.Properties().ElementAt(1).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.Name)) &&
+                nodeViewModelJobject.Properties().ElementAt(2).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.IsSetAsInput)) &&
+                nodeViewModelJobject.Properties().ElementAt(3).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.IsSetAsOutput)) &&
+                nodeViewModelJobject.Properties().ElementAt(4).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.IsFrozenExplicitly)) &&
+                nodeViewModelJobject.Properties().ElementAt(5).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.IsVisible)) &&
+                nodeViewModelJobject.Properties().ElementAt(6).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.X)) &&
+                nodeViewModelJobject.Properties().ElementAt(7).Name == GetJsonPropertydName<NodeViewModel>(nameof(NodeViewModel.Y));
+
+            Assert.IsTrue(explicitOrder, "The order of the properties is not the expected");
+        }
+
+        [Test]
+        public void NodeModelSerializationPropertiesTest()
+        {
+            var openPath = Path.Combine(TestDirectory, @"core\serialization\serializationNodeModel.dyn");
+
+            var jsonText = File.ReadAllText(openPath);
+            var jobject1 = JObject.Parse(jsonText);
+           
+            JObject firstNodeModelObject = JObject.Parse(jobject1["Nodes"][0].ToString());
+
+            bool firstNodeExplicitOrder =
+                firstNodeModelObject.Properties().ElementAt(0).Name == "ConcreteType" &&
+                firstNodeModelObject.Properties().ElementAt(1).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.GUID)) &&
+                firstNodeModelObject.Properties().ElementAt(2).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.NodeType)) &&
+                firstNodeModelObject.Properties().ElementAt(3).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.InPorts)) &&
+                firstNodeModelObject.Properties().ElementAt(4).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.OutPorts)) &&                
+                firstNodeModelObject.Properties().ElementAt(5).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.ArgumentLacing)) &&
+                firstNodeModelObject.Properties().ElementAt(6).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.Description)) &&
+                firstNodeModelObject.Properties().ElementAt(7).Name == GetJsonPropertydName<CodeBlockNodeModel>(nameof(CodeBlockNodeModel.Code));
+
+            Assert.IsTrue(firstNodeExplicitOrder, "The first serialized Node doesn't have the expected order");
+
+            JObject secondNodeModelObject = JObject.Parse(jobject1["Nodes"][1].ToString());
+
+            bool secondNodeExplicitOrder =
+                secondNodeModelObject.Properties().ElementAt(0).Name == "ConcreteType" &&
+                secondNodeModelObject.Properties().ElementAt(1).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.GUID)) &&
+                secondNodeModelObject.Properties().ElementAt(2).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.NodeType)) &&
+                secondNodeModelObject.Properties().ElementAt(3).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.InPorts)) &&
+                secondNodeModelObject.Properties().ElementAt(4).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.OutPorts)) &&
+                secondNodeModelObject.Properties().ElementAt(5).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.ArgumentLacing)) &&
+                secondNodeModelObject.Properties().ElementAt(6).Name == GetJsonPropertydName<NodeModel>(nameof(NodeModel.Description)) &&
+                secondNodeModelObject.Properties().ElementAt(7).Name == GetJsonPropertydName<FileSystemBrowser>(nameof(FileSystemBrowser.HintPath)) &&
+                secondNodeModelObject.Properties().ElementAt(8).Name == GetJsonPropertydName<BasicInteractive<object>>(nameof(BasicInteractive<object>.Value));
+            
+
+            Assert.IsTrue(secondNodeExplicitOrder, "The second serialized Node doesn't have the expected order");
+        }
+
+        public string GetJsonPropertydName<T>(string propertyName)
+        {
+            System.Reflection.PropertyInfo t = typeof(T).GetProperty(propertyName);
+            var attr = t.GetCustomAttributes(typeof(Newtonsoft.Json.JsonPropertyAttribute), true).FirstOrDefault() as Newtonsoft.Json.JsonPropertyAttribute;
+
+            return attr.PropertyName ?? propertyName;
+        }
+
         [Test]
         public void JSONisSameBeforeAndAfterSaveWithDummyNodes()
         {
diff --git a/test/core/serialization/serializationNodeModel.dyn b/test/core/serialization/serializationNodeModel.dyn
diff --git a/test/core/serialization/serializationNodeViewModel.dyn b/test/core/serialization/serializationNodeViewModel.dyn

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using Autodesk.DesignScript.Runtime;`
`2`	`2`	`using Dynamo.Engine;`
	`3`	`+using Newtonsoft.Json;`
`3`	`4`
`4`	`5`	`namespace Dynamo.Graph.Nodes.ZeroTouch`
`5`	`6`	`{`
`@@ -25,6 +26,7 @@ public override string NodeType`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`
	`29`	`+ [JsonProperty(Order = 5)]`
`28`	`30`	`public string FunctionSignature`
`29`	`31`	`{`
`30`	`32`	`get`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-using System;`
	`1`	`+using System;`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.Globalization;`
`4`	`4`	`using System.Text.RegularExpressions;`
`@@ -94,6 +94,6 @@ internal static string SerializeIntegerSliderAs32BitType(string json)`
`94`	`94`	`var rgx2 = new Regex(@"\bCoreNodeModels.Input.IntegerSlider64Bit\b");`
`95`	`95`
`96`	`96`	`return rgx2.Replace(result, "CoreNodeModels.Input.IntegerSlider");`
`97`		`- }`
	`97`	`+ }`
`98`	`98`	`}`
`99`	`99`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ public partial class NodeViewModel : ViewModelBase`
`69`	`69`	`/// Returns NodeModel ID`
`70`	`70`	`/// </summary>`
`71`	`71`	`[JsonConverter(typeof(IdToGuidConverter))]`
	`72`	`+ [JsonProperty(Order = 1)]`
`72`	`73`	`public Guid Id`
`73`	`74`	`{`
`74`	`75`	`get { return NodeModel.GUID; }`
`@@ -164,6 +165,7 @@ public bool IsInput`
`164`	`165`	`}`
`165`	`166`	`}`
`166`	`167`
	`168`	`+ [JsonProperty(Order = 3)]`
`167`	`169`	`public bool IsSetAsInput`
`168`	`170`	`{`
`169`	`171`	`get`
`@@ -192,6 +194,7 @@ public bool IsOutput`
`192`	`194`	`}`
`193`	`195`	`}`
`194`	`196`
	`197`	`+ [JsonProperty(Order = 4)]`
`195`	`198`	`public bool IsSetAsOutput`
`196`	`199`	`{`
`197`	`200`	`get`
`@@ -211,11 +214,12 @@ public bool IsSetAsOutput`
`211`	`214`	`}`
`212`	`215`	`}`
`213`	`216`
`214`		`-`
	`217`	`+`
`215`	`218`	`/// <summary>`
`216`	`219`	`/// The Name of the nodemodel this view points to`
`217`	`220`	`/// this is the name of the node as it is displayed in the UI.`
`218`	`221`	`/// </summary>`
	`222`	`+ [JsonProperty(Order = 2)]`
`219`	`223`	`public string Name`
`220`	`224`	`{`
`221`	`225`	`get`
`@@ -347,7 +351,7 @@ public bool IsInteractionEnabled`
`347`	`351`	`get { return true; }`
`348`	`352`	`}`
`349`	`353`
`350`		`- [JsonProperty("ShowGeometry")]`
	`354`	`+ [JsonProperty("ShowGeometry",Order = 6)]`
`351`	`355`	`public bool IsVisible`
`352`	`356`	`{`
`353`	`357`	`get`
`@@ -594,7 +598,7 @@ public bool IsFrozen`
`594`	`598`	`/// <value>`
`595`	`599`	`/// Returns true if the node has been frozen explicitly by the user, otherwise false.`
`596`	`600`	`/// </value>`
`597`		`- [JsonProperty("Excluded")]`
	`601`	`+ [JsonProperty("Excluded", Order = 5)]`
`598`	`602`	`public bool IsFrozenExplicitly`
`599`	`603`	`{`
`600`	`604`	`get`
`@@ -629,6 +633,7 @@ public bool CanToggleFrozen`
`629`	`633`	`/// <summary>`
`630`	`634`	`/// Returns or set the X position of the Node.`
`631`	`635`	`/// </summary>`
	`636`	`+ [JsonProperty(Order = 7)]`
`632`	`637`	`public double X`
`633`	`638`	`{`
`634`	`639`	`get { return NodeModel.X; }`
`@@ -641,6 +646,7 @@ public double X`
`641`	`646`	`/// <summary>`
`642`	`647`	`/// Returns or set the Y position of the Node.`
`643`	`648`	`/// </summary>`
	`649`	`+ [JsonProperty(Order = 8)]`
`644`	`650`	`public double Y`
`645`	`651`	`{`
`646`	`652`	`get { return NodeModel.Y; }`