DYN-8498: Add splash-screen message to restart Dynamo when settings are imported (DynamoDS#16878)

Author: zeusongit

.gitignore

@@ -68,6 +68,9 @@ launchSettings.json
 ###############
 .idea
 .vscode/
+.claude
+.agent
+.cursor
 
 #documentation files
 doc/html/

src/DynamoCoreWpf/DynamoCoreWpf.csproj

@@ -23,7 +23,7 @@
 
   <Target Name="NpmRunBuild" BeforeTargets="BeforeBuild">
       <PropertyGroup>
-          <PackageVersion>1.0.30</PackageVersion>
+          <PackageVersion>1.0.31</PackageVersion>
           <PackageName>SplashScreen</PackageName>
       </PropertyGroup>
       <Exec Command="$(PowerShellCommand) -ExecutionPolicy Bypass -File &quot;$(SolutionDir)pkgexist.ps1&quot; &quot;$(PackageName)&quot; &quot;$(PackageVersion)&quot;" ConsoleToMSBuild="true">

src/DynamoCoreWpf/Properties/Resources.Designer.cs

@@ -3736,6 +3736,15 @@ In certain complex graphs or host program scenarios, Automatic mode may cause in
   <data name="SplashScreenImportSettingsFailDescription" xml:space="preserve">
     <value>Something went wrong when importing your custom setting file. Please try again or proceed with default settings.</value>
   </data>
+  <data name="SplashScreenSettingsImportedRestartMessage" xml:space="preserve">
+    <value>Settings imported. Please restart Dynamo.</value>
+  </data>
+  <data name="SplashScreenResetSettingsTooltip" xml:space="preserve">
+    <value>Reset imported settings</value>
+  </data>
+  <data name="SplashScreenSettingsResetSuccess" xml:space="preserve">
+    <value>Imported settings have been reset.</value>
+  </data>
   <data name="SplashScreenLaunchingDynamo" xml:space="preserve">
     <value>Launching Dynamo View...</value>
   </data>

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

@@ -3730,6 +3730,15 @@ In certain complex graphs or host program scenarios, Automatic mode may cause in
   <data name="SplashScreenImportSettingsFailDescription" xml:space="preserve">
     <value>Something went wrong when importing your custom setting file. Please try again or proceed with default settings.</value>
   </data>
+  <data name="SplashScreenSettingsImportedRestartMessage" xml:space="preserve">
+    <value>Settings imported. Please restart Dynamo.</value>
+  </data>
+  <data name="SplashScreenResetSettingsTooltip" xml:space="preserve">
+    <value>Reset imported settings</value>
+  </data>
+  <data name="SplashScreenSettingsResetSuccess" xml:space="preserve">
+    <value>Imported settings have been reset.</value>
+  </data>
   <data name="SplashScreenLaunchingDynamo" xml:space="preserve">
     <value>Launching Dynamo View...</value>
   </data>

src/DynamoCoreWpf/Properties/Resources.resx

@@ -1729,7 +1729,9 @@ Dynamo.UI.Views.ScriptHomeObject.StartGuidedTour(string path) -> void
 Dynamo.UI.Views.ScriptObject
 Dynamo.UI.Views.ScriptObject.ImportSettings(string file) -> void
 Dynamo.UI.Views.ScriptObject.LaunchDynamo(bool showScreenAgain) -> void
+Dynamo.UI.Views.ScriptObject.ResetSettings() -> void
 Dynamo.UI.Views.ScriptObject.ScriptObject(System.Action<bool> requestLaunchDynamo, System.Action<string> requestImportSettings, System.Func<bool> requestSignIn, System.Func<bool> requestSignOut) -> void
+Dynamo.UI.Views.ScriptObject.ScriptObject(System.Action<bool> requestLaunchDynamo, System.Action<string> requestImportSettings, System.Func<bool> requestSignIn, System.Func<bool> requestSignOut, System.Action requestResetSettings) -> void
 Dynamo.UI.Views.ScriptObject.SignIn() -> bool
 Dynamo.UI.Views.ScriptObject.SignOut() -> bool
 Dynamo.UI.Views.ScriptWizardObject
@@ -5728,6 +5730,9 @@ static Dynamo.Wpf.Properties.Resources.SplashScreenImportSettingsFailDescription
 static Dynamo.Wpf.Properties.Resources.SplashScreenLaunchingDynamo.get -> string
 static Dynamo.Wpf.Properties.Resources.SplashScreenLaunchTitle.get -> string
 static Dynamo.Wpf.Properties.Resources.SplashScreenLoadingTimeLabel.get -> string
+static Dynamo.Wpf.Properties.Resources.SplashScreenResetSettingsTooltip.get -> string
+static Dynamo.Wpf.Properties.Resources.SplashScreenSettingsImportedRestartMessage.get -> string
+static Dynamo.Wpf.Properties.Resources.SplashScreenSettingsResetSuccess.get -> string
 static Dynamo.Wpf.Properties.Resources.SplashScreenShowScreenAgainLabel.get -> string
 static Dynamo.Wpf.Properties.Resources.SplashScreenSignIn.get -> string
 static Dynamo.Wpf.Properties.Resources.SplashScreenSigningIn.get -> string

src/DynamoCoreWpf/PublicAPI.Unshipped.txt

@@ -63,6 +63,11 @@ internal enum CloseMode { ByStartingDynamo, ByCloseButton, ByOther };
         internal Func<bool> RequestSignIn;
         internal Func<bool> RequestSignOut;
 
+        // Fields for tracking imported settings and enabling reset functionality
+        private bool settingsWereImported = false;
+        private string originalSettingsContent = null;
+        private string importedSettingsFilePath = null;
+
         /// <summary>
         /// Dynamo auth manager reference
         /// </summary>
@@ -248,16 +253,46 @@ private void WebView_NavigationCompleted(object sender, CoreWebView2NavigationCo
         /// <param name="fileContent"></param>
         private void ImportSettings(string fileContent)
         {
-            bool isImported = viewModel.PreferencesViewModel.importSettingsContent(fileContent);
-            if (isImported)
+            try
             {
-                SetImportStatus(ImportStatus.success);
+                // Get the settings file path
+                var pathManager = viewModel?.Model?.PathManager ?? PathManager.Instance;
+                importedSettingsFilePath = pathManager.PreferenceFilePath;
+
+                // Backup original settings before importing (only if not already backed up)
+                if (!settingsWereImported && System.IO.File.Exists(importedSettingsFilePath))
+                {
+                    originalSettingsContent = System.IO.File.ReadAllText(importedSettingsFilePath);
+                }
+
+                // Validate the imported settings
+                bool isImported = viewModel.PreferencesViewModel.importSettingsContent(fileContent);
+
+                if (isImported)
+                {
+                    // Mark that settings were imported
+                    settingsWereImported = true;
+
+                    // Show success status on splash screen
+                    SetImportStatus(ImportStatus.success);
+
+                    // Show the restart message and reset button
+                    ShowRestartMessage();
+
+                    Analytics.TrackEvent(Actions.Import, Categories.SplashScreenOperations, "true");
+                }
+                else
+                {
+                    SetImportStatus(ImportStatus.error);
+                    Analytics.TrackEvent(Actions.Import, Categories.SplashScreenOperations, "false");
+                }
             }
-            else
+            catch (Exception ex)
             {
+                viewModel?.Model?.Logger?.Log($"Error importing settings: {ex.Message}");
                 SetImportStatus(ImportStatus.error);
+                Analytics.TrackEvent(Actions.Import, Categories.SplashScreenOperations, "false");
             }
-            Analytics.TrackEvent(Actions.Import, Categories.SplashScreenOperations, isImported.ToString());
         }
 
         /// <summary>
@@ -396,7 +431,7 @@ protected override async void OnContentRendered(EventArgs e)
 
                 webView.NavigateToString(htmlString);
                 webView.CoreWebView2.AddHostObjectToScript("scriptObject",
-                   new ScriptObject(RequestLaunchDynamo, RequestImportSettings, RequestSignIn, RequestSignOut));
+                   new ScriptObject(RequestLaunchDynamo, RequestImportSettings, RequestSignIn, RequestSignOut, ResetImportedSettings));
             }
             catch (ObjectDisposedException ex)
             {
@@ -465,6 +500,81 @@ await webView.CoreWebView2.ExecuteScriptAsync("window.setImportStatus({" +
             }
         }
 
+        /// <summary>
+        /// Show the restart required message and reset button after settings import
+        /// </summary>
+        internal async void ShowRestartMessage()
+        {
+            try
+            {
+                if (webView?.CoreWebView2 != null)
+                {
+                    await webView.CoreWebView2.ExecuteScriptAsync("window.showRestartMessage()");
+                }
+            }
+            catch (Exception ex)
+            {
+                viewModel?.Model?.Logger?.Log($"Error showing restart message: {ex.Message}");
+            }
+        }
+
+        /// <summary>
+        /// Hide the restart required message and reset button
+        /// </summary>
+        internal async void HideRestartMessage()
+        {
+            try
+            {
+                if (webView?.CoreWebView2 != null)
+                {
+                    await webView.CoreWebView2.ExecuteScriptAsync("window.hideRestartMessage()");
+                }
+            }
+            catch (Exception ex)
+            {
+                viewModel?.Model?.Logger?.Log($"Error hiding restart message: {ex.Message}");
+            }
+        }
+
+        /// <summary>
+        /// Resets the imported settings to the original settings that were backed up
+        /// </summary>
+        private void ResetImportedSettings()
+        {
+            try
+            {
+                if (!string.IsNullOrEmpty(originalSettingsContent) &&
+                    !string.IsNullOrEmpty(importedSettingsFilePath))
+                {
+                    // Restore original settings to disk
+                    System.IO.File.WriteAllText(importedSettingsFilePath, originalSettingsContent);
+
+                    // Reload the original settings into the current session
+                    var restoredPreferences = PreferenceSettings.LoadContent(originalSettingsContent);
+                    if (restoredPreferences.IsCreatedFromValidFile)
+                    {
+                        viewModel.PreferencesViewModel.importSettingsContent(originalSettingsContent);
+                    }
+
+                    // Clear the imported flag and backup
+                    settingsWereImported = false;
+                    originalSettingsContent = null;
+
+                    // Hide the restart message
+                    HideRestartMessage();
+
+                    // Show reset success message briefly
+                    SetImportStatus(ImportStatus.none);
+
+                    viewModel?.Model?.Logger?.Log(Wpf.Properties.Resources.SplashScreenSettingsResetSuccess);
+                }
+            }
+            catch (Exception ex)
+            {
+                viewModel?.Model?.Logger?.Log($"Error resetting settings: {ex.Message}");
+            }
+        }
+
         /// <summary>
         /// Set the login status on splash screen.
         /// </summary>
@@ -516,7 +626,9 @@ await webView.CoreWebView2.ExecuteScriptAsync("window.setLabels({" +
                    $"signOutTitle: \"{Wpf.Properties.Resources.SplashScreenSignOut}\"," +
                    $"signOutTooltip: \"{Wpf.Properties.Resources.SignOutConfirmationDialogText}\"," +
                    $"signingInTitle: \"{Wpf.Properties.Resources.SplashScreenSigningIn}\"," +
-                   $"importSettingsTooltipDescription: \"{Wpf.Properties.Resources.ImportPreferencesInfo}\"" + "})");
+                   $"importSettingsTooltipDescription: \"{Wpf.Properties.Resources.ImportPreferencesInfo}\"," +
+                   $"restartMessage: \"{Wpf.Properties.Resources.SplashScreenSettingsImportedRestartMessage}\"," +
+                   $"resetTooltip: \"{Wpf.Properties.Resources.SplashScreenResetSettingsTooltip}\"" + "})");
             }
         }
 
@@ -663,38 +775,58 @@ public class ScriptObject
         readonly Action<string> RequestImportSettings;
         readonly Func<bool> RequestSignIn;
         readonly Func<bool> RequestSignOut;
+        readonly Action RequestResetSettings;
+
+        [Obsolete("This constructor is obsolete. Use the constructor with the additional parameters instead.")]
+        public ScriptObject(Action<bool> requestLaunchDynamo, Action<string> requestImportSettings, Func<bool> requestSignIn, Func<bool> requestSignOut)
+        {
+            RequestLaunchDynamo = requestLaunchDynamo;
+            RequestImportSettings = requestImportSettings;
+            RequestSignIn = requestSignIn;
+            RequestSignOut = requestSignOut;
+        }
 
         /// <summary>
-        /// [Obsolete] Constructor for ScriptObject
+        /// Constructor for ScriptObject
         /// </summary>
-        [Obsolete]
-        public ScriptObject(Action<bool> requestLaunchDynamo, Action<string> requestImportSettings, Func< bool> requestSignIn, Func<bool> requestSignOut)
+        public ScriptObject(Action<bool> requestLaunchDynamo, Action<string> requestImportSettings, Func< bool> requestSignIn, Func<bool> requestSignOut, Action requestResetSettings)
         {
             RequestLaunchDynamo = requestLaunchDynamo;
             RequestImportSettings = requestImportSettings;
             RequestSignIn = requestSignIn;
             RequestSignOut = requestSignOut;
+            RequestResetSettings = requestResetSettings;
         }
+
         [DynamoJSInvokable]
         public void LaunchDynamo(bool showScreenAgain)
         {
             RequestLaunchDynamo(showScreenAgain);
             Analytics.TrackEvent(Actions.Start, Categories.SplashScreenOperations);
         }
+
         [DynamoJSInvokable]
         public void ImportSettings(string file)
         {
             RequestImportSettings(file);
         }
+
         [DynamoJSInvokable]
         public bool SignIn()
         {
             return RequestSignIn();
         }
+
         [DynamoJSInvokable]
         public bool SignOut()
         {
             return RequestSignOut();
         }
+
+        [DynamoJSInvokable]
+        public void ResetSettings()
+        {
+            RequestResetSettings();
+        }
     }
 }