DYN-6394: Add legacy trace warning when opening workspace

src/DynamoCore/Graph/Nodes/NodeCategories.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.Linq;
@@ -8,6 +8,7 @@
 using Dynamo.Configuration;
 using Dynamo.Engine;
 using Dynamo.Graph.Nodes.CustomNodes;
+using Dynamo.Graph.Workspaces;
 using Dynamo.Library;
 using ProtoCore;
 
@@ -282,7 +283,7 @@ internal static string GetDocumentXmlPath(XmlDocument document)
         /// <returns>Returns a dictionary of deserialized node-data-list pairs
         /// loaded from the given XmlDocument.</returns>
         internal static IEnumerable<KeyValuePair<Guid, List<CallSite.RawTraceData>>>
-            LoadTraceDataFromXmlDocument(XmlDocument document)
+            LoadTraceDataFromXmlDocument(XmlDocument document, out bool containsTraceData)
         {
             if (document == null)
                 throw new ArgumentNullException("document");
@@ -301,7 +302,10 @@ where childNode.Name.Equals(sessionXmlTagName)
 
             var loadedData = new Dictionary<Guid, List<CallSite.RawTraceData>>();
             if (!query.Any()) // There's no data, return empty dictionary.
+            {
+                containsTraceData = false;
                 return loadedData;
+            }
 
             XmlElement sessionElement = query.ElementAt(0);
             foreach (XmlElement nodeElement in sessionElement.ChildNodes)
@@ -313,14 +317,12 @@ where childNode.Name.Equals(sessionXmlTagName)
                     var callsiteId = string.Empty;
                     if (child.HasAttribute(Configurations.CallSiteID))
                     {
-                        callsiteId = child.GetAttribute(Configurations.CallSiteID);
+                        containsTraceData = true;
+                        return loadedData;
                     }
-                    var traceData = child.InnerText;
-                    callsiteTraceData.Add(new CallSite.RawTraceData(callsiteId, traceData));
                 }
-                loadedData.Add(guid, callsiteTraceData);
             }
-
+            containsTraceData = false;
             return loadedData;
         }
 

src/DynamoCore/Graph/Workspaces/SerializationConverters.cs

@@ -679,9 +679,12 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             #region Restore trace data
             // Trace Data
             Dictionary<Guid, List<CallSite.RawTraceData>> loadedTraceData = new Dictionary<Guid, List<CallSite.RawTraceData>>();
+            bool containsTraceData = false;
             // Restore trace data if bindings are present in json
             if (obj["Bindings"] != null && obj["Bindings"].Children().Count() > 0)
             {
+                containsTraceData = true;
+
                 JEnumerable<JToken> bindings = obj["Bindings"].Children();
 
                 // Iterate through bindings to extract nodeID's and bindingData (callsiteId & traceData)
@@ -725,7 +728,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
                 if (obj.TryGetValue(nameof(HomeWorkspaceModel.Thumbnail), StringComparison.OrdinalIgnoreCase, out JToken thumbnail))
                     homeWorkspace.Thumbnail = thumbnail.ToString();
 
-                // GraphDocumentaionLink
+                // GraphDocumentationLink
                 if (obj.TryGetValue(nameof(HomeWorkspaceModel.GraphDocumentationURL), StringComparison.OrdinalIgnoreCase, out JToken helpLink))
                 {
                     if (Uri.TryCreate(helpLink.ToString(), UriKind.Absolute, out Uri uri))
@@ -738,6 +741,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
                 // If there is a active linter serialized in the graph we set it to the active linter else set the default None.
                 SetActiveLinter(obj);
 
+
                 ws = homeWorkspace;
             }
 
@@ -746,7 +750,9 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             ws.ExternalFiles = externalFiles;
             if (obj.TryGetValue(nameof(WorkspaceModel.Author), StringComparison.OrdinalIgnoreCase, out JToken author))
                 ws.Author = author.ToString();
-
+
+            ws.ContainsTraceData = containsTraceData;
+
             return ws;
         }
 

src/DynamoCore/Graph/Workspaces/WorkspaceModel.cs

@@ -233,6 +233,8 @@ internal int CurrentPasteOffset
             }
         }
 
+        internal bool ContainsTraceData { get; set; }
+
         internal bool ScaleFactorChanged = false;
 
         /// <summary>

src/DynamoCore/Models/DynamoModel.cs

@@ -2320,15 +2320,17 @@ private bool OpenJsonFile(
             workspace.FromJsonGraphId = string.IsNullOrEmpty(filePath) ? WorkspaceModel.ComputeGraphIdFromJson(fileContents) : "";
             workspace.ScaleFactor = dynamoPreferences.ScaleFactor;
 
-            // NOTE: This is to handle the case of opening a JSON file that does not have a version string
-            //       This logic may not be correct, need to decide the importance of versioning early JSON files
-            string versionString = dynamoPreferences.Version;
-            if (versionString == null)
-                versionString = AssemblyHelper.GetDynamoVersion().ToString();
-            workspace.WorkspaceVersion = new System.Version(versionString);
 
-            HomeWorkspaceModel homeWorkspace = workspace as HomeWorkspaceModel;
-            if (homeWorkspace != null)
+            // This is to handle the case of opening a JSON file that does not have a version string
+            workspace.WorkspaceVersion = dynamoPreferences.Version ==
+                                         null ? AssemblyHelper.GetDynamoVersion() : new Version(dynamoPreferences.Version);
+
+            if (workspace.ContainsTraceData && workspace.WorkspaceVersion < new Version(3, 0, 0))
+            {
+                OnRequestNotification(Resources.LegacyTraceDataWarning, true);
+            }
+
+            if (workspace is HomeWorkspaceModel homeWorkspace)
             {
                 homeWorkspace.EnableLegacyPolyCurveBehavior ??= PreferenceSettings.Instance.DefaultEnableLegacyPolyCurveBehavior;
 
@@ -2451,12 +2453,16 @@ private bool OpenXmlHomeWorkspace(
         {
             var nodeGraph = NodeGraph.LoadGraphFromXml(xmlDoc, NodeFactory);
             Guid deterministicId = GuidUtility.Create(GuidUtility.UrlNamespace, workspaceInfo.Name);
+
+            var loadedTraceData = Utils.LoadTraceDataFromXmlDocument(xmlDoc, out var containsTraceData);
+            if(containsTraceData) OnRequestNotification(Resources.LegacyTraceDataWarning, true);
+
             var newWorkspace = new HomeWorkspaceModel(
                 deterministicId,
                 EngineController,
                 Scheduler,
                 NodeFactory,
-                Utils.LoadTraceDataFromXmlDocument(xmlDoc),
+                loadedTraceData,
                 nodeGraph.Nodes,
                 nodeGraph.Notes,
                 nodeGraph.Annotations,

src/DynamoCore/Models/DynamoModelEvents.cs

@@ -541,12 +541,12 @@ internal void OnRequestPythonReset(string pythonEngine)
         /// <summary>
         /// This event is used to raise a toast notification from the DynamoViewModel 
         /// </summary>
-        internal event Action<string> RequestNotification;
-        internal void OnRequestNotification(string notification)
+        internal event Action<string, bool> RequestNotification;
+        internal void OnRequestNotification(string notification, bool stayOpen = false)
         {
             if (RequestNotification != null)
             {
-                RequestNotification(notification);
+                RequestNotification(notification, stayOpen);
             }
         }
 

src/DynamoCore/Properties/Resources.en-US.resx

@@ -908,4 +908,7 @@ This package likely contains an assembly that is blocked. You will need to load
   <data name="FormulaMigrated" xml:space="preserve">
     <value>Formula node has been deprecated. It has been automatically migrated to a CodeBlock node. Note that results may vary after the migration depending on lacing options selected on the original Formula node. Appropriate replication guides might need to be applied to the CodeBlock node script.</value>
   </data>
+  <data name="LegacyTraceDataWarning" xml:space="preserve">
+    <value>This workspace contains element binding data in a legacy format that is no longer supported in Dynamo 3.0 and higher versions. Element binding will work however, if any new trace data generated during graph execution is saved with the workspace.</value>
+  </data>
 </root>

src/DynamoCore/Properties/Resources.resx

@@ -911,4 +911,7 @@ This package likely contains an assembly that is blocked. You will need to load
   <data name="FormulaMigrated" xml:space="preserve">
     <value>Formula node has been deprecated. It has been automatically migrated to a CodeBlock node. Note that results may vary after the migration depending on lacing options selected on the original Formula node. Appropriate replication guides might need to be applied to the CodeBlock node script.</value>
   </data>
+  <data name="LegacyTraceDataWarning" xml:space="preserve">
+    <value>This workspace contains element binding data in a legacy format that is no longer supported in Dynamo 3.0 and higher versions. Element binding will work however, if any new trace data generated during graph execution is saved with the workspace.</value>
+  </data>
 </root>

src/DynamoCoreWpf/ViewModels/Core/DynamoViewModel.cs

@@ -1907,9 +1907,9 @@ private void model_ComputeModelDeserialized()
         /// Create a toast notification with a notification sent by the DynamoModel
         /// </summary>
         /// <param name="notification"></param>
-        private void model_RequestNotification(string notification)
+        private void model_RequestNotification(string notification, bool stayOpen = false)
         {
-            this.MainGuideManager.CreateRealTimeInfoWindow(notification);
+            this.MainGuideManager.CreateRealTimeInfoWindow(notification, stayOpen);
         }
 
         /// <summary>

test/DynamoCoreTests/CallsiteTests.cs

@@ -334,5 +334,18 @@ public void CanDetectLegacyTraceFormat()
                 "PFNPQVAtRU5WOkVudmVsb3BlIHhtbG5zOnhzaT0iaHR0cDovL3d3dyY2hlbWFzLm1pY3Jvc29mdC5jb20vc29hcC9lbmNvZGluZy";
             Assert.True(CheckIfTraceDataIsLegacySOAPFormat(legacyTraceData));
         }
+
+        [Test]
+        public void CanWarnAboutLegacyTraceData()
+        {
+            var counter = 99;
+            CurrentDynamoModel.RequestNotification += (_, _) => { counter++; };
+
+            // Dyn file contains SOAP formatted trace data.
+            var ws = Open<HomeWorkspaceModel>(TestDirectory, callsiteDir,
+                "element_binding_customNodes_modified_multiple_pre3.0.dyn");
+
+            Assert.AreEqual(100, counter);
+        }
     }
 }

test/DynamoCoreTests/UtilityTests.cs

@@ -300,14 +300,14 @@ public void LoadTraceDataFromXmlDocument00()
             Assert.Throws<ArgumentNullException>(() =>
             {
                 // Test method call without a valid XmlDocument.
-                Graph.Nodes.Utilities.LoadTraceDataFromXmlDocument(null);
+                Graph.Nodes.Utilities.LoadTraceDataFromXmlDocument(null, out _);
             });
 
             Assert.Throws<ArgumentException>(() =>
             {
                 // Test XmlDocument without a document element.
                 XmlDocument document = new XmlDocument();
-                Graph.Nodes.Utilities.LoadTraceDataFromXmlDocument(document);
+                Graph.Nodes.Utilities.LoadTraceDataFromXmlDocument(document, out _);
             });
         }
 
@@ -321,7 +321,7 @@ public void LoadTraceDataFromXmlDocument01()
             {
                 XmlDocument document = new XmlDocument();
                 document.AppendChild(document.CreateElement("RootElement"));
-                outputs = Graph.Nodes.Utilities.LoadTraceDataFromXmlDocument(document);
+                outputs = Graph.Nodes.Utilities.LoadTraceDataFromXmlDocument(document, out _);
             });
 
             Assert.IsNotNull(outputs);