DYN-2375 - Event to handle the close operation of the workspace references extension (#10280)

reddyashish · web-flow · commit 201748a885b4 · 2020-01-11T02:33:01.000+05:30
* First commit

* new changes

* Renaming the event

* Adding test
diff --git a/src/DynamoCore/Graph/Workspaces/HomeWorkspaceModel.cs b/src/DynamoCore/Graph/Workspaces/HomeWorkspaceModel.cs
@@ -32,6 +32,9 @@ public class HomeWorkspaceModel : WorkspaceModel
         private readonly bool verboseLogging;
         private bool graphExecuted;
 
+        // Event to handle closing of the workspace references extension when the workspace is closed. 
+        internal static event Action WorkspaceClosed;
+
         // To check whether task is completed or not. 
         private bool executingTask;
 
@@ -419,6 +422,7 @@ private void NodeOnRequestSilenceNodeModifiedEvents(NodeModel node, bool value)
         /// </summary>
         public override void Clear()
         {
+            WorkspaceClosed?.Invoke();
             base.Clear();
             PreloadedTraceData = null;
             RunSettings.Reset();
diff --git a/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs b/src/DynamoCoreWpf/Views/Core/DynamoView.xaml.cs
@@ -208,18 +208,6 @@ public DynamoView(DynamoViewModel dynamoViewModel)
             FocusableGrid.InputBindings.Clear();
         }
 
-        /// <summary>
-        /// This method will close a tab item in the right side bar based on passed extension
-        /// </summary>
-        /// <param name="viewExtension">Extension to be closed</param>
-        /// <returns></returns>
-        internal void CloseExtensionTabItem(IViewExtension viewExtension)
-        {
-            string tabName = viewExtension.Name;
-            TabItem tabitem = ExtensionTabItems.OfType<TabItem>().SingleOrDefault(n => n.Header.ToString() == tabName);
-            CloseExtensionTab(tabitem);
-        }
-
         // This method adds a tab item to the right side bar and 
         // sets the extension window as the tab content.
         internal TabItem AddExtensionTabItem(IViewExtension viewExtension, ContentControl contentControl)
@@ -259,6 +247,19 @@ internal TabItem AddExtensionTabItem(IViewExtension viewExtension, ContentContro
             return null;
         }
 
+        /// <summary>
+        /// This method will close a tab item in the right side bar based on passed extension
+        /// </summary>
+        /// <param name="viewExtension">Extension to be closed</param>
+        /// <returns></returns>
+        internal void CloseExtensionTabItem(IViewExtension viewExtension)
+        {
+            string tabName = viewExtension.Name;
+            TabItem tabitem = ExtensionTabItems.OfType<TabItem>().SingleOrDefault(n => n.Header.ToString() == tabName);
+            CloseExtension?.Invoke(tabName);
+            CloseExtensionTab(tabitem);
+        }
+ 
         /// <summary>
         /// Event handler for the CloseButton.
         /// This method triggers the close operation on the selected tab.
diff --git a/src/WorkspaceDependencyViewExtension/WorkspaceDependencyView.xaml.cs b/src/WorkspaceDependencyViewExtension/WorkspaceDependencyView.xaml.cs
@@ -153,7 +153,7 @@ internal void DependencyRegen(WorkspaceModel ws)
         internal void TriggerDependencyRegen()
         {
             DependencyRegen(currentWorkspace);
-        } 
+        }
 
         /// <summary>
         /// Constructor
@@ -173,6 +173,15 @@ public WorkspaceDependencyView(WorkspaceDependencyViewExtension viewExtension, V
             dependencyViewExtension = viewExtension;
             DependencyRegen(currentWorkspace);
             DynamoView.CloseExtension += this.OnExtensionTabClosedHandler;
+            HomeWorkspaceModel.WorkspaceClosed += this.CloseExtensionTab;
+        }
+
+        /// <summary>
+        /// This method will call the close API on the workspace references extension. 
+        /// </summary>
+        internal void CloseExtensionTab()
+        {
+            loadedParams.CloseExtensioninInSideBar(dependencyViewExtension);
         }
 
         /// <summary>
@@ -268,6 +277,7 @@ public void Dispose()
             loadedParams.CurrentWorkspaceCleared -= OnWorkspaceCleared;
             WorkspaceModel.DummyNodesReloaded -= TriggerDependencyRegen;
             DynamoView.CloseExtension -= this.OnExtensionTabClosedHandler;
+            HomeWorkspaceModel.WorkspaceClosed -= this.CloseExtensionTab;
         }
 
         private void Refresh_MouseLeftButtonDown(object sender, System.Windows.Input.MouseButtonEventArgs e)
diff --git a/test/DynamoCoreWpfTests/ViewExtensions/WorkspaceDependencyViewExtensionTests.cs b/test/DynamoCoreWpfTests/ViewExtensions/WorkspaceDependencyViewExtensionTests.cs
@@ -128,6 +128,23 @@ public void APItoCloseViewExtensionTabTest()
             Assert.AreEqual(0, View.ExtensionTabItems.Count);
         }
 
+        /// <summary>
+        /// This test will make sure that the extension tab is closed upon closing the home workspace.
+        /// </summary>
+        [Test]
+        public void CloseViewExtensionTabOnClosingWorkspace()
+        {
+            RaiseLoadedEvent(this.View);
+            var extensionManager = View.viewExtensionManager;
+            extensionManager.Add(viewExtension);
+            // Open a graph which should bring up the Workspace References view extension window with one tab
+            Open(@"pkgs\Dynamo Samples\extra\CustomRenderExample.dyn");
+            Assert.AreEqual(1, View.ExtensionTabItems.Count);
+            var homeSpace = Model.Workspaces.First(ws => ws is HomeWorkspaceModel) as HomeWorkspaceModel;
+            homeSpace.Clear();
+            Assert.AreEqual(0, View.ExtensionTabItems.Count);
+        }
+
         /// <summary>
         /// This test is created to guard a crash happened that while dep viewer is loaded,
         /// opening a dyf directly and closing it to switch to an empty homeworkspace causing a crash
