Extension data to home workspace (#11553) 2.11 (#11557)

* Extension data to home workspace (#11553) * workspacemodel thumbnail api + test * add graphDocumentationURL + serialise and deserialise Author * Update WorkspaceModel.cs * handle empty URIs * Update 2080_JSONTESTCRASH undo_redo.dyn * move thumbnail and help link to HomeWorkspaceMode * move extension data to HomeWorkspaceModel * merge conflicts, remove new properties Co-authored-by: Sylvester Knudsen <[email protected]> Co-authored-by: michael kirschner <[email protected]>
DynamoDS · Mar 20, 2021 · ba81a8d · ba81a8d
1 parent 2379a3d
commit ba81a8d
Show file tree

Hide file tree

Showing 6 changed files with 85 additions and 68 deletions.
diff --git a/src/DynamoCore/Graph/Workspaces/HomeWorkspaceModel.cs b/src/DynamoCore/Graph/Workspaces/HomeWorkspaceModel.cs
@@ -7,6 +7,7 @@
 using System.Xml;
 using Dynamo.Core;
 using Dynamo.Engine;
+using Dynamo.Extensions;
 using Dynamo.Graph.Annotations;
 using Dynamo.Graph.Nodes;
 using Dynamo.Graph.Nodes.NodeLoaders;
@@ -90,6 +91,12 @@ public class HomeWorkspaceModel : WorkspaceModel
         public long EvaluationCount { get; private set; }
 
         /// <summary>
+        /// List of user defined data from extensions and view extensions stored in the graph
+        /// </summary>
+        internal ICollection<ExtensionData> ExtensionData
+        {
+            get; set;
+        }
         /// In near future, the file loading mechanism will be completely moved 
         /// into WorkspaceModel, that's the time we removed this property setter below.
         /// </summary>
@@ -278,6 +285,7 @@ public HomeWorkspaceModel(EngineController engine,
             this.verboseLogging = verboseLogging;
             IsTestMode = isTestMode;
             EngineController = engine;
+            this.ExtensionData = new List<ExtensionData>();
 
             // The first time the preloaded trace data is set, we cache
             // the data as historical. This will be used after the initial
@@ -769,6 +777,40 @@ internal IList<ISerializable> GetOrphanedSerializablesAndClearHistoricalTraceDat
             historicalTraceData = null;
 
             return orphans;
-        } 
+        }
+
+        internal bool TryGetMatchingWorkspaceData(string uniqueId, out Dictionary<string, string> data)
+        {
+            data = new Dictionary<string, string>();
+            if (!ExtensionData.Any())
+                return false;
+
+            var extensionData = ExtensionData.Where(x => x.ExtensionGuid == uniqueId)
+                .FirstOrDefault();
+
+            if (extensionData is null)
+                return false;
+
+            data = extensionData.Data;
+            return true;
+        }
+
+        internal void UpdateExtensionData(string uniqueId, Dictionary<string, string> data)
+        {
+            var extensionData = ExtensionData.Where(x => x.ExtensionGuid == uniqueId)
+                .FirstOrDefault();
+
+            if (extensionData is null)
+                return;
+
+            extensionData.Data = data;
+        }
+
+        internal void CreateNewExtensionData(string uniqueId, string name, string version, Dictionary<string, string> data)
+        {
+            // TODO: Figure out how to add extension version when creating new ExtensionData 
+            var extensionData = new ExtensionData(uniqueId, name, version, data);
+            ExtensionData.Add(extensionData);
+        }
     }
 }
diff --git a/src/DynamoCore/Graph/Workspaces/SerializationConverters.cs b/src/DynamoCore/Graph/Workspaces/SerializationConverters.cs
@@ -641,14 +641,17 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             }
             else
             {
-                ws = new HomeWorkspaceModel(guid, engine, scheduler, factory,
+                 var homeWorkspace = new HomeWorkspaceModel(guid, engine, scheduler, factory,
                     loadedTraceData, nodes, notes, annotations,
                     Enumerable.Empty<PresetModel>(), elementResolver,
                     info, verboseLogging, isTestMode);
-            }
 
+                // ExtensionData
+                homeWorkspace.ExtensionData = GetExtensionData(serializer, obj);
+                ws = homeWorkspace;
+            }
+
             ws.NodeLibraryDependencies = nodeLibraryDependencies.ToList();
-            ws.ExtensionData = GetExtensionData(serializer, obj);
 
             return ws;
         }
@@ -766,11 +769,12 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
             // NodeLibraryDependencies
             writer.WritePropertyName(WorkspaceReadConverter.NodeLibraryDependenciesPropString);
             serializer.Serialize(writer, ws.NodeLibraryDependencies);
-
-            // ExtensionData
-            writer.WritePropertyName(WorkspaceReadConverter.EXTENSION_WORKSPACE_DATA);
-            serializer.Serialize(writer, ws.ExtensionData);
-
+            if (!isCustomNode && ws is HomeWorkspaceModel hws)
+            {
+                // ExtensionData
+                writer.WritePropertyName(WorkspaceReadConverter.EXTENSION_WORKSPACE_DATA);
+                serializer.Serialize(writer, hws.ExtensionData);
+            }
             if (engine != null)
             {
                 // Bindings

diff --git a/src/DynamoCore/Graph/Workspaces/WorkspaceModel.cs b/src/DynamoCore/Graph/Workspaces/WorkspaceModel.cs
@@ -724,14 +724,6 @@ public string Description
             }
         }
 
-        /// <summary>
-        /// List of user defined data from extensions and view extensions stored in the graph
-        /// </summary>
-        internal ICollection<ExtensionData> ExtensionData
-        {
-            get; set;
-        }
-
         /// <summary>
         ///     Are there unsaved changes in the workspace?
         /// </summary>
@@ -1045,7 +1037,6 @@ protected WorkspaceModel(
             this.annotations = new List<AnnotationModel>(annotations);
 
             this.NodeLibraryDependencies = new List<INodeLibraryDependencyInfo>();
-            this.ExtensionData = new List<ExtensionData>();
 
             // Set workspace info from WorkspaceInfo object
             Name = info.Name;
@@ -2158,40 +2149,6 @@ private Guid IdToGuidConverter(string id)
 
             return deterministicGuid;
         }
-
-        internal bool TryGetMatchingWorkspaceData(string uniqueId, out Dictionary<string, string> data)
-        {
-            data = new Dictionary<string, string>();
-            if (!ExtensionData.Any())
-                return false;
-
-            var extensionData = ExtensionData.Where(x => x.ExtensionGuid == uniqueId)
-                .FirstOrDefault();
-
-            if (extensionData is null)
-                return false;
-
-            data = extensionData.Data;
-            return true;
-        }
-
-        internal void UpdateExtensionData(string uniqueId, Dictionary<string, string> data)
-        {
-            var extensionData = ExtensionData.Where(x => x.ExtensionGuid == uniqueId)
-                .FirstOrDefault();
-
-            if (extensionData is null)
-                return;
-
-            extensionData.Data = data;
-        }
-
-        internal void CreateNewExtensionData(string uniqueId, string name, string version, Dictionary<string, string> data)
-        {
-            // TODO: Figure out how to add extension version when creating new ExtensionData 
-            var extensionData = new ExtensionData(uniqueId, name, version, data);
-            ExtensionData.Add(extensionData);
-        }
 
         /// <summary>
         ///     Returns a DelayedGraphExecution object.

diff --git a/src/DynamoCore/Models/DynamoModel.cs b/src/DynamoCore/Models/DynamoModel.cs
@@ -156,7 +156,8 @@ internal void OnWorkspaceSaving(WorkspaceModel workspace, SaveContext saveContex
             if (WorkspaceSaving != null)
             {
                 WorkspaceSaving(workspace, saveContext);
-                HandleStorageExtensionsOnWorkspaceSaving(workspace, saveContext);
+                if (workspace is HomeWorkspaceModel hws) 
+                    HandleStorageExtensionsOnWorkspaceSaving(hws, saveContext);
             }
         }
 
@@ -194,7 +195,8 @@ internal void OnWorkspaceOpened(WorkspaceModel workspace)
             if(WorkspaceOpened != null)
             {
                 WorkspaceOpened.Invoke(workspace);
-                HandleStorageExtensionsOnWorkspaceOpened(workspace);
+                if (workspace is HomeWorkspaceModel hws) 
+                    HandleStorageExtensionsOnWorkspaceOpened(hws);
             }
         }
 
@@ -972,23 +974,23 @@ private void RemoveExtension(IExtension ext)
         }
 
 
-        private void HandleStorageExtensionsOnWorkspaceOpened(WorkspaceModel workspace)
+        private void HandleStorageExtensionsOnWorkspaceOpened(HomeWorkspaceModel workspace)
         {
             foreach (var extension in extensionManager.StorageAccessExtensions)
             {
                 RaiseIExtensionStorageAccessWorkspaceOpened(workspace, extension, this.Logger);
             }
         }
 
-        private void HandleStorageExtensionsOnWorkspaceSaving(WorkspaceModel workspace, SaveContext saveContext)
+        private void HandleStorageExtensionsOnWorkspaceSaving(HomeWorkspaceModel workspace, SaveContext saveContext)
         {
             foreach (var extension in extensionManager.StorageAccessExtensions)
             {
                 RaiseIExtensionStorageAccessWorkspaceSaving(workspace, extension, saveContext, this.Logger);
             }
         }
 
-        internal static void RaiseIExtensionStorageAccessWorkspaceOpened(WorkspaceModel workspace, IExtensionStorageAccess extension, ILogger logger)
+        internal static void RaiseIExtensionStorageAccessWorkspaceOpened(HomeWorkspaceModel workspace, IExtensionStorageAccess extension, ILogger logger)
         {
             workspace.TryGetMatchingWorkspaceData(extension.UniqueId, out Dictionary<string, string> data);
             var extensionDataCopy = new Dictionary<string, string>(data);
@@ -1004,7 +1006,7 @@ internal static void RaiseIExtensionStorageAccessWorkspaceOpened(WorkspaceModel
             }
         }
 
-        internal static void RaiseIExtensionStorageAccessWorkspaceSaving(WorkspaceModel workspace, IExtensionStorageAccess extension, SaveContext saveContext, ILogger logger)
+        internal static void RaiseIExtensionStorageAccessWorkspaceSaving(HomeWorkspaceModel workspace, IExtensionStorageAccess extension, SaveContext saveContext, ILogger logger)
         {
             var assemblyName = Assembly.GetAssembly(extension.GetType()).GetName();
             var version = $"{assemblyName.Version.Major}.{assemblyName.Version.Minor}";

diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs
@@ -215,17 +215,23 @@ public DynamoView(DynamoViewModel dynamoViewModel)
 
         private void OnWorkspaceOpened(WorkspaceModel workspace)
         {
+            if (!(workspace is HomeWorkspaceModel hws))
+                return;
+
             foreach (var extension in viewExtensionManager.StorageAccessViewExtensions)
             {
-                DynamoModel.RaiseIExtensionStorageAccessWorkspaceOpened(workspace, extension, dynamoViewModel.Model.Logger);
+                DynamoModel.RaiseIExtensionStorageAccessWorkspaceOpened(hws, extension, dynamoViewModel.Model.Logger);
             }
         }
 
         private void OnWorkspaceSaving(WorkspaceModel workspace, Graph.SaveContext saveContext)
         {
+            if (!(workspace is HomeWorkspaceModel hws))
+                return;
+
             foreach (var extension in viewExtensionManager.StorageAccessViewExtensions)
             {
-                DynamoModel.RaiseIExtensionStorageAccessWorkspaceSaving(workspace, extension, saveContext, dynamoViewModel.Model.Logger);
+                DynamoModel.RaiseIExtensionStorageAccessWorkspaceSaving(hws, extension, saveContext, dynamoViewModel.Model.Logger);
             }
         }
 

diff --git a/test/DynamoCoreTests/StorageExtensionTests.cs b/test/DynamoCoreTests/StorageExtensionTests.cs
@@ -4,13 +4,15 @@
 using System.Text;
 using System.Threading.Tasks;
 using Dynamo.Extensions;
+using Dynamo.Graph.Workspaces;
 using Dynamo.Models;
 using Dynamo.Scheduler;
 using Moq;
 using NUnit.Framework;
 
 namespace Dynamo.Tests
 {
+    [TestFixture]
     public class StorageExtensionTests
     {
         private const string MOCK_EXTENSION_GUID = "7de691ac-b1ea-4353-9b9b-1f57b2967895";
@@ -124,7 +126,8 @@ public void OnWorkspaceOpenIsCalledWhenWorkspaceIsOpened()
         public void OnWorkspaceOpenDoesNotAddToWorkspaceExtensionData()
         {
             // Arrange
-            var extensionDataBeforeWorkspaceOpen = model.CurrentWorkspace.ExtensionData.Count;
+            var homeworkspace = model.CurrentWorkspace as HomeWorkspaceModel;
+            var extensionDataBeforeWorkspaceOpen = homeworkspace.ExtensionData.Count;
 
             var dataDictionary = new Dictionary<string, string>
             {
@@ -135,7 +138,7 @@ public void OnWorkspaceOpenDoesNotAddToWorkspaceExtensionData()
 
             // Act
             model.OnWorkspaceOpened(model.CurrentWorkspace);
-            var extensionDataAfterWorkspaceOpen = model.CurrentWorkspace.ExtensionData.Count;
+            var extensionDataAfterWorkspaceOpen = homeworkspace.ExtensionData.Count;
 
             // Assert
             Assert.AreEqual(extensionDataBeforeWorkspaceOpen, extensionDataAfterWorkspaceOpen);
@@ -145,6 +148,7 @@ public void OnWorkspaceOpenDoesNotAddToWorkspaceExtensionData()
         public void OnWorkspaceOpenDoesNotModifyExistingExtensionDataDictionary()
         {
             // Arrange
+            var homeworkspace = model.CurrentWorkspace as HomeWorkspaceModel;
             var initialDict = new Dictionary<string, string>
             {
                 {"A","a"},
@@ -161,11 +165,11 @@ public void OnWorkspaceOpenDoesNotModifyExistingExtensionDataDictionary()
 
             // Act
             model.OnWorkspaceSaving(model.CurrentWorkspace, Graph.SaveContext.Save);
-            var extensionDataDictionaryBeforeOpen = model.CurrentWorkspace.ExtensionData
+            var extensionDataDictionaryBeforeOpen = homeworkspace.ExtensionData
                 .Where(x=>x.ExtensionGuid == MOCK_EXTENSION_GUID).FirstOrDefault();
 
             model.OnWorkspaceOpened(model.CurrentWorkspace);
-            var extensionDataDictionaryAfterOpen = model.CurrentWorkspace.ExtensionData
+            var extensionDataDictionaryAfterOpen = homeworkspace.ExtensionData
                 .Where(x => x.ExtensionGuid == MOCK_EXTENSION_GUID).FirstOrDefault();
 
             // Assert
@@ -178,7 +182,8 @@ public void OnWorkspaceOpenDoesNotModifyExistingExtensionDataDictionary()
         public void OnWorkspaceSavingAddsToStoredExtensionData()
         {
             // Arrange
-            var initialDataDictionary = model.CurrentWorkspace.ExtensionData
+            var homeworkspace = model.CurrentWorkspace as HomeWorkspaceModel;
+            var initialDataDictionary = homeworkspace.ExtensionData
                 .Where(x => x.ExtensionGuid == MOCK_EXTENSION_GUID)
                 .FirstOrDefault();
 
@@ -193,7 +198,7 @@ public void OnWorkspaceSavingAddsToStoredExtensionData()
 
             // Act
             model.OnWorkspaceSaving(model.CurrentWorkspace, Graph.SaveContext.Save);
-            var extensionDataDictionaryAfterSave = model.CurrentWorkspace.ExtensionData
+            var extensionDataDictionaryAfterSave = homeworkspace.ExtensionData
                 .Where(x => x.ExtensionGuid == MOCK_EXTENSION_GUID).FirstOrDefault();
 
             // Assert
@@ -207,13 +212,14 @@ public void OnWorkspaceSavingAddsToStoredExtensionData()
         public void OnWorkspaceSavingModifiesExistingExtensionDataDictionary()
         {
             // Arrange
+            var homeworkspace = model.CurrentWorkspace as HomeWorkspaceModel;
             var initialDataDictionary = new Dictionary<string, string>
             {
                 {"A","a" },
                 {"B","b" }
             };
             var extensionData = new ExtensionData(MOCK_EXTENSION_GUID, MOCK_EXTENSION_NAME, "0.0", initialDataDictionary);
-            model.CurrentWorkspace.ExtensionData.Add(extensionData);
+            homeworkspace.ExtensionData.Add(extensionData);
 
             var dictionaryToAddOnSaving = new Dictionary<string, string>
             {
@@ -230,7 +236,7 @@ public void OnWorkspaceSavingModifiesExistingExtensionDataDictionary()
 
             // Act
             model.OnWorkspaceSaving(model.CurrentWorkspace, Graph.SaveContext.Save);
-            var extensionDataAfterSave = model.CurrentWorkspace.ExtensionData
+            var extensionDataAfterSave = homeworkspace.ExtensionData
                 .Where(x => x.ExtensionGuid == MOCK_EXTENSION_GUID).FirstOrDefault();
 
             // Assert