DYN-8298: Fix python node script editor displays wrong script when closed as unsaved (#15875)

zeusongit · web-flow · commit 91bca1d43ae5 · 2025-03-03T13:45:22.000-05:00
diff --git a/src/Libraries/PythonNodeModelsWpf/PythonNode.cs b/src/Libraries/PythonNodeModelsWpf/PythonNode.cs
@@ -1,18 +1,14 @@
 using System;
-using System.Collections;
 using System.Collections.Generic;
 using System.Collections.Specialized;
 using System.Linq;
 using System.Windows;
 using System.Windows.Controls;
-using System.Windows.Data;
 using System.Windows.Input;
-using System.Windows.Threading;
 using Dynamo.Configuration;
 using Dynamo.Controls;
 using Dynamo.Graph.Nodes;
 using Dynamo.Graph.Workspaces;
-using Dynamo.Models;
 using Dynamo.PythonServices;
 using Dynamo.ViewModels;
 using Dynamo.Wpf;
@@ -65,7 +61,15 @@ public class PythonNodeViewCustomization : VariableInputNodeViewCustomization, I
         private readonly MenuItem editWindowItem = new MenuItem { Header = PythonNodeModels.Properties.Resources.EditHeader, IsCheckable = false };
         private MenuItem pythonEngineVersionMenu;
         private readonly MenuItem learnMoreItem = new MenuItem { Header = PythonNodeModels.Properties.Resources.PythonNodeContextMenuLearnMoreButton };
+        private class ScriptEditEventArgs : EventArgs
+        {
+            internal string ScriptContent { get; }
 
+            internal ScriptEditEventArgs(string scriptContent)
+            {
+                ScriptContent = scriptContent;
+            }
+        }
         public void CustomizeView(PythonNode nodeModel, NodeView nodeView)
         {
             base.CustomizeView(nodeModel, nodeView);
@@ -208,6 +212,14 @@ public void editWindow_Closed(object sender, EventArgs e)
             editWindow = null;
         }
 
+        /// <summary>
+        /// The method to open the script editor window.
+        /// In default state, the editor will be opened as a floating window, or docked if previously recorded.
+        /// The editor displays the saved script by default, the method can be triggered with unsaved text/script
+        /// to be displayed when provided using <see cref="ScriptEditEventArgs">ScriptEditEventArgs</see>.
+        /// </summary>
+        /// <param name="sender"></param>
+        /// <param name="e"></param>
         private void EditScriptContent(object sender, EventArgs e)
         {
             try
@@ -223,15 +235,19 @@ private void EditScriptContent(object sender, EventArgs e)
                     {
                         editWindow = new ScriptEditorWindow(dynamoViewModel, pythonNodeModel, pythonNodeView, ref editorWindowRect);
 
-                        if (pythonNodeModel.ScriptContentSaved || sender == null)
+                        if (pythonNodeModel.ScriptContentSaved)
                         {
                             editWindow.Initialize(workspaceModel.Guid, pythonNodeModel.GUID, "ScriptContent", pythonNodeModel.Script);
                         }
-                        else
+                        else if (e is ScriptEditEventArgs se && se != null)
                         {
-                            editWindow.Initialize(workspaceModel.Guid, pythonNodeModel.GUID, "ScriptContent", sender.ToString());
+                            editWindow.Initialize(workspaceModel.Guid, pythonNodeModel.GUID, "ScriptContent", se.ScriptContent);
                             editWindow.IsSaved = false;
                         }
+                        else
+                        {
+                            throw new InvalidOperationException("Failed to initialize the script editor window.");
+                        }
 
                         editWindow.Closed += editWindow_Closed;
                         dynamoView = editWindow.Owner as DynamoView;
@@ -273,7 +289,8 @@ private bool IsEditorCurrentlyDocked()
 
         private void EditScriptContent(string text)
         {
-            EditScriptContent(text, null);
+            var args = new ScriptEditEventArgs(text);
+            EditScriptContent(null, args);
         }
 
         private void NodeModel_PropertyChanged(object sender, System.ComponentModel.PropertyChangedEventArgs e)
diff --git a/src/Libraries/PythonNodeModelsWpf/ScriptEditorWindow.xaml b/src/Libraries/PythonNodeModelsWpf/ScriptEditorWindow.xaml
@@ -416,9 +416,9 @@
                         <TextBlock Margin="15 5" FontSize="14" Foreground="Black" FontFamily="{StaticResource ArtifaktElementRegular}" TextWrapping="WrapWithOverflow" Text="{x:Static p:Resources.PythonScriptUnsavedChangesPromptText}"/>
                     </StackPanel>
                     <StackPanel Orientation="Vertical" VerticalAlignment="Center" Grid.Column="2">
-                        <Button 
+                        <Button Name="ResumeButton"
                             Style="{StaticResource UnSaveButtonStyle}" Content="Keep editing" Click="ResumeButton_OnClick"></Button>
-                        <Button 
+                        <Button Name="CloseWarningBarButton"
                             Style="{StaticResource UnSaveButtonStyle}" Content="Close" Click="CloseWarningBarButton_OnClick"></Button>
                     </StackPanel>
                 </Grid>
diff --git a/src/Libraries/PythonNodeModelsWpf/ScriptEditorWindow.xaml.cs b/src/Libraries/PythonNodeModelsWpf/ScriptEditorWindow.xaml.cs
@@ -640,6 +640,9 @@ private void CloseWarningBarButton_OnClick(object sender, RoutedEventArgs e)
             {
                 var senderContext = (sender as Button)?.DataContext;
 
+                //At this point the user choses to close the window without saving the script, so mark the script as saved.
+                IsSaved = true;
+
                 if (this.Equals(senderContext))
                 {
                     Close();
diff --git a/test/DynamoCoreWpf3Tests/PythonNodeCustomizationTests.cs b/test/DynamoCoreWpf3Tests/PythonNodeCustomizationTests.cs
@@ -262,6 +262,75 @@ public void OnSaveRunRevertEventsTest()
             Assert.That(watchOUT.CachedValue, Is.EqualTo("Autodesk,1982"));
         }
 
+        /// <summary>
+        /// The test to validate that the editor window will not retain changes
+        /// and revert to the last saved state when the editor is closed without saving.
+        /// The test will execute the events:
+        /// CloseWarningBarButton_OnClick(object sender, RoutedEventArgs e)
+        /// CloseButton_OnClick(object sender, RoutedEventArgs e)
+        /// EditScriptContent(object sender, EventArgs e)
+        /// </summary>
+        [Test]
+        public void OnCloseWithoutSaveShouldRevertEventsTest()
+        {
+            Open(@"core\python\python_check_output.dyn");
+            ViewModel.HomeSpace.Run();
+
+            var nodeView = NodeViewWithGuid("3bcad14e-d086-4278-9e08-ed2759ef92f3");
+            var nodeModel = nodeView.ViewModel.NodeModel as PythonNodeBase;
+            Assert.NotNull(nodeModel);
+
+            //Get the Watch node so we can check the content later
+            var watchOUT = Model.CurrentWorkspace.NodeFromWorkspace<Watch>("714838b43a114f5f93cfe2f1d26092cf");
+
+            var scriptWindow = EditPythonCode(nodeView, View);
+            var codeEditor = FindCodeEditor(scriptWindow);
+
+            //Replace dictionary values so we can use the Revert and Run buttons
+            codeEditor.Text = codeEditor.Text.Replace("Autodesk", "Softdesk").Replace("1982", "1997");
+            codeEditor.Focus();
+
+            //This will get the buttons from the WPF xaml code
+            var closeButton = scriptWindow.FindName("CloseButton") as Button;
+            var resumeButton = scriptWindow.FindName("ResumeButton") as Button;
+
+            //Press the close button without saving
+            closeButton.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
+            DispatcherUtil.DoEvents();
+
+            var unsavedChangesStatusBar = scriptWindow.FindName("UnsavedChangesStatusBar") as Grid;
+
+            //Check that the warning bar is visible
+            Assert.That(unsavedChangesStatusBar.Visibility, Is.EqualTo(Visibility.Visible));
+
+            //Pressing the Resume button
+            resumeButton.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
+            DispatcherUtil.DoEvents();
+
+            //Check that the warning bar is not visible
+            Assert.That(unsavedChangesStatusBar.Visibility, Is.EqualTo(Visibility.Collapsed));
+
+            //Press the close button without saving
+            closeButton.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
+            DispatcherUtil.DoEvents();
+
+            //Check that the warning bar is visible again
+            Assert.That(unsavedChangesStatusBar.Visibility, Is.EqualTo(Visibility.Visible));
+
+            var closeWarningBarButton = scriptWindow.FindName("CloseWarningBarButton") as Button;
+
+            //Pressing the close button on the warning bar
+            closeWarningBarButton.RaiseEvent(new RoutedEventArgs(ButtonBase.ClickEvent));
+            DispatcherUtil.DoEvents();
+
+            //Open python editor window again
+            scriptWindow = EditPythonCode(nodeView, View);
+            codeEditor = FindCodeEditor(scriptWindow);
+
+            //Validate that the changes were reverted
+            Assert.That(codeEditor.Text.Contains("Autodesk"), Is.True);
+        }
+
         /// <summary>
         /// This test method will validate that the OnMoreInfoEvent was executed correctly
         /// </summary>

Original file line number	Diff line number	Diff line change
`@@ -640,6 +640,9 @@ private void CloseWarningBarButton_OnClick(object sender, RoutedEventArgs e)`
`640`	`640`	`{`
`641`	`641`	`var senderContext = (sender as Button)?.DataContext;`
`642`	`642`
	`643`	`+ //At this point the user choses to close the window without saving the script, so mark the script as saved.`
	`644`	`+ IsSaved = true;`
	`645`	`+`
`643`	`646`	`if (this.Equals(senderContext))`
`644`	`647`	`{`
`645`	`648`	`Close();`