Dock and Undock view extension with Dynamic extension ID as edge case (#11394)

QilongTang · web-flow · commit 4a1250a3d868 · 2021-01-13T15:36:57.000-05:00
* Initial Commit with settings null check

* Add unit test

* Add view extension loading warning

* Update message
diff --git a/src/DynamoCoreWpf/Extensions/ViewExtensionManager.cs b/src/DynamoCoreWpf/Extensions/ViewExtensionManager.cs
@@ -94,6 +94,12 @@ public void Add(IViewExtension extension)
             {
                 viewExtensions.Add(extension);
                 Log(fullName + " view extension is added");
+                // Inform view extension author and consumer that the view extension does not come 
+                // with a consistent UniqueId. This may result in unexpected Dynamo behavior.
+                if (extension.UniqueId != extension.UniqueId)
+                {
+                    Log("Inconsistent UniqueId for " + extension.Name + " view extension. This may result in unexpected Dynamo behavior.");
+                }
 
                 if (ExtensionAdded != null)
                 {
diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs
@@ -296,6 +296,7 @@ private ExtensionWindow AddExtensionWindow(IViewExtension viewExtension, UIEleme
                 }
             }
             
+            // Setting the content of the undocked window
             // Icon is passed from DynamoView (respecting Host integrator icon)
             SetApplicationIcon();
             window.Icon = this.Icon;
@@ -328,15 +329,18 @@ private void SaveExtensionWindowSettings(ExtensionWindow window)
         {
             var extension = window.Tag as IViewExtension;
             var settings = this.dynamoViewModel.Model.PreferenceSettings.ViewExtensionSettings.Find(ext => ext.UniqueId == extension.UniqueId);
-            if (settings.WindowSettings == null)
+            if (settings != null)
             {
-                settings.WindowSettings = new WindowSettings();
+                if (settings.WindowSettings == null)
+                {
+                    settings.WindowSettings = new WindowSettings();
+                }
+                settings.WindowSettings.Status = window.WindowState == WindowState.Maximized ? WindowStatus.Maximized : WindowStatus.Normal;
+                settings.WindowSettings.Left = (int)window.SavedWindowRect.Left;
+                settings.WindowSettings.Top = (int)window.SavedWindowRect.Top;
+                settings.WindowSettings.Width = (int)window.SavedWindowRect.Width;
+                settings.WindowSettings.Height = (int)window.SavedWindowRect.Height;
             }
-            settings.WindowSettings.Status = window.WindowState == WindowState.Maximized ? WindowStatus.Maximized : WindowStatus.Normal;
-            settings.WindowSettings.Left = (int)window.SavedWindowRect.Left;
-            settings.WindowSettings.Top = (int)window.SavedWindowRect.Top;
-            settings.WindowSettings.Width = (int)window.SavedWindowRect.Width;
-            settings.WindowSettings.Height = (int)window.SavedWindowRect.Height;
         }
 
         private TabItem AddExtensionTab(IViewExtension viewExtension, UIElement content)
@@ -472,8 +476,11 @@ internal void UndockExtension(string name)
             CloseExtensionTab(tabItem);
             var extension = tabItem.Tag as IViewExtension;
             var settings = this.dynamoViewModel.PreferenceSettings.ViewExtensionSettings.Find(s => s.UniqueId == extension.UniqueId);
-            AddExtensionWindow(extension, content, settings.WindowSettings);
-            settings.DisplayMode = ViewExtensionDisplayMode.FloatingWindow;
+            AddExtensionWindow(extension, content, settings?.WindowSettings);
+            if (settings != null)
+            {
+                settings.DisplayMode = ViewExtensionDisplayMode.FloatingWindow;
+            }
         }
 
         /// <summary>
@@ -516,8 +523,10 @@ private void ExtensionWindow_Closed(object sender, EventArgs e)
                 AddExtensionTab(extension, content);
 
                 var settings = this.dynamoViewModel.PreferenceSettings.ViewExtensionSettings.Find(s => s.UniqueId == extension.UniqueId);
-                settings.DisplayMode = ViewExtensionDisplayMode.DockRight;
-
+                if (settings != null)
+                {
+                    settings.DisplayMode = ViewExtensionDisplayMode.DockRight;
+                }
                 Analytics.TrackEvent(Actions.Dock, Categories.ViewExtensionOperations, extName);
             }
             else
diff --git a/test/DynamoCoreWpfTests/ViewExtensions/ViewExtensionTests.cs b/test/DynamoCoreWpfTests/ViewExtensions/ViewExtensionTests.cs
@@ -226,6 +226,23 @@ public void ExtensionUndockClose()
             Assert.AreEqual(0, View.ExtensionWindows.Count);
         }
 
+        [Test]
+        public void ExtensionDockAndUndockWithRandomGUID()
+        {
+            RaiseLoadedEvent(this.View);
+
+            // Add extension, default state is docked immediately
+            View.viewExtensionManager.Add(extensionsSideBarViewExtension);
+
+            // Extension bar is shown
+            Assert.AreEqual(1, View.ExtensionTabItems.Count);
+            Assert.IsFalse(View.ExtensionsCollapsed);
+
+            // Undock extension which return a new UniqueId, this should not crash Dynamo
+            extensionsSideBarViewExtension.UniqueId = "NewRandomGuid1";
+            Assert.DoesNotThrow(() => View.UndockExtension(extensionsSideBarViewExtension.Name));
+        }
+
         [Test]
         public void ExtensionCannotBeAddedAsBothWindowAndTab()
         {

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,12 @@ public void Add(IViewExtension extension)`
`94`	`94`	`{`
`95`	`95`	`viewExtensions.Add(extension);`
`96`	`96`	`Log(fullName + " view extension is added");`
	`97`	`+ // Inform view extension author and consumer that the view extension does not come`
	`98`	`+ // with a consistent UniqueId. This may result in unexpected Dynamo behavior.`
	`99`	`+ if (extension.UniqueId != extension.UniqueId)`
	`100`	`+ {`
	`101`	`+ Log("Inconsistent UniqueId for " + extension.Name + " view extension. This may result in unexpected Dynamo behavior.");`
	`102`	`+ }`
`97`	`103`
`98`	`104`	`if (ExtensionAdded != null)`
`99`	`105`	`{`