DynamoModel.cs

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Configuration;
using System.Diagnostics;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using System.Xml;
using Dynamo.Configuration;
using Dynamo.Core;
using Dynamo.Engine;
using Dynamo.Events;
using Dynamo.Extensions;
using Dynamo.Graph;
using Dynamo.Graph.Annotations;
using Dynamo.Graph.Connectors;
using Dynamo.Graph.Nodes;
using Dynamo.Graph.Nodes.CustomNodes;
using Dynamo.Graph.Nodes.NodeLoaders;
using Dynamo.Graph.Nodes.ZeroTouch;
using Dynamo.Graph.Notes;
using Dynamo.Graph.Workspaces;
using Dynamo.Interfaces;
using Dynamo.Linting;
using Dynamo.Logging;
using Dynamo.Migration;
using Dynamo.Properties;
using Dynamo.Scheduler;
using Dynamo.Search;
using Dynamo.Search.SearchElements;
using Dynamo.Selection;
using Dynamo.Utilities;
using DynamoServices;
using DynamoUtilities;
using Greg;
using Lucene.Net.Documents;
using Lucene.Net.Index;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using ProtoCore;
using ProtoCore.Runtime;
using static Dynamo.Core.PathManager;
using Compiler = ProtoAssociative.Compiler;
// Dynamo package manager
using FunctionGroup = Dynamo.Engine.FunctionGroup;
using Symbol = Dynamo.Graph.Nodes.CustomNodes.Symbol;
using Utils = Dynamo.Graph.Nodes.Utilities;

namespace Dynamo.Models
{
    /// <summary>
    /// This class contains the extra Dynamo-specific preferences data
    /// </summary>
    public class DynamoPreferencesData
    {
        public double ScaleFactor { get; internal set; }
        public bool HasRunWithoutCrash { get; internal set; }
        public bool IsVisibleInDynamoLibrary { get; internal set; }
        public string Version { get; internal set; }
        public string RunType { get; internal set; }
        public string RunPeriod { get; internal set; }

        public DynamoPreferencesData(
          double scaleFactor,
          bool hasRunWithoutCrash,
          bool isVisibleInDynamoLibrary,
          string version,
          string runType,
          string runPeriod)
        {
            ScaleFactor = scaleFactor;
            HasRunWithoutCrash = hasRunWithoutCrash;
            IsVisibleInDynamoLibrary = isVisibleInDynamoLibrary;
            Version = version;
            RunType = runType;
            RunPeriod = runPeriod;
        }

        public static DynamoPreferencesData Default()
        {
            return new DynamoPreferencesData(
              1.0,
              true,
              true,
              AssemblyHelper.GetDynamoVersion().ToString(),
              Models.RunType.Automatic.ToString(),
              RunSettings.DefaultRunPeriod.ToString());
        }
    }

    /// <summary>
    /// Host analytics related info
    /// </summary>
    public struct HostAnalyticsInfo
    {
        // Dynamo variation identified by host, e.g. Dynamo Revit
        public string HostName;
        // Dynamo variation version specific to host
        public Version HostVersion;
        // Dynamo host application name, e.g. Revit
        public string HostProductName;
        // Dynamo host application version, e.g. 2025.2.0
        public Version HostProductVersion;
        // Dynamo host parent id for analytics purpose.
        public string ParentId;
        // Dynamo host session id for analytics purpose.
        public string SessionId;
    }

    /// <summary>
    /// This class creates an interface for Engine controller.
    /// </summary>
    public interface IEngineControllerManager
    {
        /// <summary>
        /// A controller to coordinate the interactions between some DesignScript
        /// sub components like library management, live runner and so on.
        /// </summary>
        EngineController EngineController { get; }
    }

    /// <summary>
    /// The core model of Dynamo.
    /// </summary>
    public partial class DynamoModel : IDynamoModel, IDisposable, IEngineControllerManager, ITraceReconciliationProcessor
    {
        #region private members

        private readonly string geometryFactoryPath;
        private readonly PathManager pathManager;
        private WorkspaceModel currentWorkspace;
        private Timer backupFilesTimer;
        private Dictionary<Guid, string> backupFilesDict = new Dictionary<Guid, string>();
        internal readonly Stopwatch stopwatch = Stopwatch.StartNew();

        /// <summary>
        /// Indicating if ASM is loaded correctly, defaulting to true because integrators most likely have code for ASM preloading
        /// During sandbox initializing, Dynamo checks specifically if ASM loading was correct
        /// </summary>
        internal bool IsASMLoaded = true;

        // Lucene search utility to perform indexing operations on nodes.
        internal LuceneSearchUtility LuceneUtility
        {
            get
            {
                return LuceneSearch.LuceneUtilityNodeSearch;
            }
        }

        /// <summary>
        /// Return a dictionary of GraphChecksumItems.
        /// Key will be the workspace guid and its value will be a list of saved checksums(sha256 hash) for that workspace.
        /// </summary>
        internal Dictionary<string, List<string>> GraphChecksumDictionary { get; set; }

        #endregion

        #region static properties

        /// <summary>
        /// Testing flag is used to defer calls to run in the idle thread
        /// with the assumption that the entire test will be wrapped in an
        /// idle thread call.
        /// </summary>
        public static bool IsTestMode { get; set; }

        /// <summary>
        /// Flag to indicate that there is no UI on this process, and things
        /// like the node index process, update manager and the analytics collection 
        /// should be disabled.
        /// </summary>
        public static bool IsHeadless { get; set; }

        /// <summary>
        ///     Specifies whether or not Dynamo is in a crash-state.
        /// </summary>
        public static bool IsCrashing { get; set; }

        /// <summary>
        /// Setting this flag enables creation of an XML in following format that records
        /// node mapping information - which old node has been converted to which to new node(s)
        /// </summary>
        public static bool EnableMigrationLogging { get; set; }

        #endregion

        #region public properties

        /// <summary>
        ///     DesignScript VM EngineController, used for this instance of Dynamo.
        /// </summary>
        public EngineController EngineController { get; set; }

        /// <summary>
        ///     Manages all loaded ZeroTouch libraries.
        /// </summary>
        public readonly LibraryServices LibraryServices;

        /// <summary>
        ///     Flag specifying whether a shutdown of Dynamo was requested.
        /// </summary>
        public bool ShutdownRequested { get; internal set; }

        /// <summary>
        ///     This version of Dynamo.
        /// </summary>
        public static string Version
        {
            get { return Core.PathManager.Instance.GetProductVersion().ToString(); }
        }

        /// <summary>
        /// Current Version of the Host (i.e. DynamoRevit/DynamoStudio)
        /// </summary>
        public string HostVersion { get; set; }

        /// <summary>
        /// Name of the Host (i.e. DynamoRevit/DynamoStudio)
        /// </summary>
        [Obsolete("This property will be removed in a future version of Dynamo - please use HostAnalyticsInfo")]
        internal string HostName { get; set; }

        /// <summary>
        /// Host analytics info
        /// </summary>
        public static HostAnalyticsInfo HostAnalyticsInfo { get; set; }

        /// <summary>
        /// Boolean indication of launching Dynamo in service mode, this mode is optimized for minimal launch time, mostly leveraged by CLI or WPF CLI.
        /// </summary>
        internal bool IsServiceMode { get; set; }

        /// <summary>
        /// True if Dynamo starts up in offline mode.
        /// </summary>
        internal bool NoNetworkMode { get; }

        /// <summary>
        /// Locale forced by cli arguments
        /// </summary>
        internal string CLILocale { get; set; }

        /// <summary>
        ///     The path manager that configures path information required for
        ///     Dynamo to function properly. See IPathManager interface for more
        ///     details.
        /// </summary>
        public IPathManager PathManager { get { return pathManager; } }

        /// <summary>
        ///     The context that Dynamo is running under.
        /// </summary>
        public readonly string Context;

        /// <summary>
        ///     Manages all extensions for Dynamo
        /// </summary>
        public IExtensionManager ExtensionManager { get { return extensionManager; } }

        /// <summary>
        ///     Manages the active linter
        /// </summary>
        public LinterManager LinterManager { get; }

        private readonly ExtensionManager extensionManager;

        /// <summary>
        ///     Manages all loaded NodeModel libraries.
        /// </summary>
        public readonly NodeModelAssemblyLoader Loader;

        /// <summary>
        ///     Custom Node Manager instance, manages all loaded custom nodes.
        /// </summary>
        public readonly CustomNodeManager CustomNodeManager;

        /// <summary>
        ///     The Dynamo Logger, receives and manages all log messages.
        /// </summary>
        public readonly DynamoLogger Logger;

        /// <summary>
        ///     The Dynamo Scheduler, handles scheduling of asynchronous tasks on different
        ///     threads.
        /// </summary>
        public DynamoScheduler Scheduler { get; private set; }

        /// <summary>
        ///     The Dynamo Node Library, complete with Search.
        /// </summary>
        public readonly NodeSearchModel SearchModel;

        /// <summary>
        ///     Debugging settings for this instance of Dynamo.
        /// </summary>
        public readonly DebugSettings DebugSettings;

        /// <summary>
        ///     Preference settings for this instance of Dynamo.
        /// </summary>
        public PreferenceSettings PreferenceSettings { get; private set; } 

        /// <summary>
        ///     Node Factory, used for creating and intantiating loaded Dynamo nodes.
        /// </summary>
        public readonly NodeFactory NodeFactory;

        /// <summary>
        ///     Migration Manager, upgrades old Dynamo file formats to the current version.
        /// </summary>
        public readonly MigrationManager MigrationManager;

        /// <summary>
        ///     The active workspace in Dynamo.
        /// </summary>
        public WorkspaceModel CurrentWorkspace
        {
            get { return currentWorkspace; }
            set
            {
                if (Equals(value, currentWorkspace)) return;
                var old = currentWorkspace;
                currentWorkspace = value;
                OnWorkspaceHidden(old);
                OnPropertyChanged(nameof(CurrentWorkspace));
            }
        }

        /// <summary>
        ///     The copy/paste clipboard.
        /// </summary>
        public ObservableCollection<ModelBase> ClipBoard { get; set; }

        /// <summary>
        ///     Specifies whether connectors are displayed in Dynamo.
        /// </summary>
        public bool IsShowingConnectors
        {
            get { return PreferenceSettings.ShowConnector; }
            set
            {
                PreferenceSettings.ShowConnector = value;
            }
        }
        /// <summary>
        /// Flag specifying the current state of whether or not to show 
        /// tooltips in the graph. In addition to this toggle, tooltip is only
        /// available when connectors are set to 'bezier' mode.
        /// </summary>
        public bool IsShowingConnectorTooltip
        {
            get
            {
                return PreferenceSettings.ShowConnectorToolTip;
            }
            set
            {
                PreferenceSettings.ShowConnectorToolTip = value;
            }
        }

        private ConnectorType connectorType = ConnectorType.BEZIER;
        /// <summary>
        ///     Specifies how connectors are displayed in Dynamo.
        /// </summary>
        public ConnectorType ConnectorType
        {
            get { return connectorType; }
            set
            {
                connectorType = value;
            }
        }

        /// <summary>
        ///     The private collection of visible workspaces in Dynamo
        /// </summary>
        private readonly List<WorkspaceModel> _workspaces = new List<WorkspaceModel>();

        /// <summary>
        ///     Returns collection of visible workspaces in Dynamo
        /// </summary>
        public IEnumerable<WorkspaceModel> Workspaces
        {
            get { return _workspaces; }
        }

        /// <summary>
        /// An object which implements the ITraceReconciliationProcessor interface,
        /// and is used for handlling the results of a trace reconciliation.
        /// </summary>
        public ITraceReconciliationProcessor TraceReconciliationProcessor { get; set; }

        /// <summary>
        /// Returns authentication manager object for oxygen authentication.
        /// </summary>
        public AuthenticationManager AuthenticationManager { get; set; }

        internal static string DefaultPythonEngine { get; private set; }

        internal static DynamoUtilities.DynamoFeatureFlagsManager FeatureFlags { get; private set; }

        #endregion

        #region constants

        private const int INSERT_VERTICAL_OFFSET_VALUE = 750;

        #endregion

        #region initialization and disposal

        /// <summary>
        /// External components call this method to shutdown DynamoModel. This
        /// method marks 'ShutdownRequested' property to 'true'. This method is
        /// used rather than a public virtual method to ensure that the value of
        /// ShutdownRequested is set to true.
        /// </summary>
        /// <param name="shutdownHost">Set this parameter to true to shutdown
        /// the host application.</param>
        public void ShutDown(bool shutdownHost)
        {
            if (ShutdownRequested)
            {
                const string message = "'DynamoModel.ShutDown' called twice";
                throw new InvalidOperationException(message);
            }

            ShutdownRequested = true;

            OnShutdownStarted(); // Notify possible event handlers.

            foreach (var ext in ExtensionManager.Extensions)
            {
                try
                {
                    ext.Shutdown();
                }
                catch (Exception exc)
                {
                    Logger.Log($"{ext.Name} :  {exc.Message} during shutdown");
                }
            }

            PreShutdownCore(shutdownHost);
            ShutDownCore(shutdownHost);
            PostShutdownCore(shutdownHost);

            AnalyticsService.ShutDown();

            LuceneSearch.LuceneUtilityNodeSearch = null;
            LuceneSearch.LuceneUtilityNodeAutocomplete = null;
            LuceneSearch.LuceneUtilityPackageManager = null;

            State = DynamoModelState.NotStarted;
            OnShutdownCompleted(); // Notify possible event handlers.
        }

        /// <summary>
        /// Based on the DynamoModelState a dependent component can take certain 
        /// decisions regarding its UI and functionality.
        /// In order to be able to run a specified graph , DynamoModel needs to be 
        /// at least in StartedUIless state. 
        /// </summary>
        public enum DynamoModelState { NotStarted, StartedUIless, StartedUI };

        /// <summary>
        /// The modelState tels us if the RevitDynamoModel was started and if has the
        /// the Dynamo UI attached to it or not 
        /// </summary>
        public DynamoModelState State { get; internal set; } = DynamoModelState.NotStarted;

        /// <summary>
        /// CLIMode indicates if we are running in DynamoCLI or DynamoWPFCLI mode.
        /// Note that in CLI mode Scheduler is synchronous.
        /// </summary>
        public bool CLIMode { get; internal set; }

        /// <summary>
        /// The Autodesk CrashReport tool location on disk (directory that contains the "cer.dll")
        /// </summary>
        public string CERLocation { get; internal set; }

        protected virtual void PreShutdownCore(bool shutdownHost)
        {
        }

        protected virtual void ShutDownCore(bool shutdownHost)
        {
            Dispose();
            PreferenceSettings.SaveInternal(pathManager.PreferenceFilePath);

            OnCleanup();

            DynamoSelection.DestroyInstance();

            if (Scheduler != null)
            {
                Scheduler.Shutdown();
                Scheduler.TaskStateChanged -= OnAsyncTaskStateChanged;
                Scheduler = null;
            }
        }

        protected virtual void PostShutdownCore(bool shutdownHost)
        {
        }

        // TODO_Dynamo3.0: Replace the IStartConfiguration with a class or struct instance in order to avoid future breaking changes for every new option added.
        public interface IStartConfiguration
        {
            string Context { get; set; }
            string DynamoCorePath { get; set; }
            string DynamoHostPath { get; set; }
            IPreferences Preferences { get; set; }
            IPathResolver PathResolver { get; set; }
            bool StartInTestMode { get; set; }
            ISchedulerThread SchedulerThread { get; set; }
            string GeometryFactoryPath { get; set; }
            IAuthProvider AuthProvider { get; set; }
            IEnumerable<IExtension> Extensions { get; set; }
            TaskProcessMode ProcessMode { get; set; }

            /// <summary>
            /// If true, the program does not have a UI.
            /// No update checks or analytics collection should be done.
            /// </summary>
            bool IsHeadless { get; set; }

            /// <summary>
            /// Configuration option to start Dynamo in offline mode.
            /// </summary>
            bool NoNetworkMode => false;

            /// <summary>
            /// Configuration object that contains host information like Host name, parent id and session id.
            /// </summary>
            HostAnalyticsInfo HostAnalyticsInfo { get; set; }
        }

        /// <summary>
        /// Options used to customize the CER (crash error reporting) experience.
        /// </summary>
        public struct CrashReporterStartupOptions
        {
            /// <summary>
            /// The Autodesk CrashReport tool location on disk (directory that contains the "senddmp.exe")
            /// </summary>
            public string CERLocation { get; set; }
        }

        // Remove this interface in Dynamo3.0 and merge it back into IStartConfiguration.
        /// <summary>
        /// Use this interface to set the CER (crash error reporting) tool path. 
        /// </summary>
        public interface IStartConfigCrashReporter
        {
            /// <summary>
            /// CERLocation
            /// </summary>
            CrashReporterStartupOptions CRStartConfig { get; set; }
        }

        /// <summary>
        /// Initialization settings for DynamoModel.
        /// </summary>
        public struct DefaultStartConfiguration : IStartConfiguration
        {
            public string Context { get; set; }
            public string DynamoCorePath { get; set; }
            public string DynamoHostPath { get; set; }
            public IPreferences Preferences { get; set; }
            public IPathResolver PathResolver { get; set; }
            public bool StartInTestMode { get; set; }
            public ISchedulerThread SchedulerThread { get; set; }
            public string GeometryFactoryPath { get; set; }
            public IAuthProvider AuthProvider { get; set; }
            public IEnumerable<IExtension> Extensions { get; set; }
            public TaskProcessMode ProcessMode { get; set; }
            public bool IsHeadless { get; set; }
            public bool NoNetworkMode { get; set; }
            public bool IsServiceMode { get; set; }
            public string PythonTemplatePath { get; set; }
            /// <summary>
            /// Default Python script engine
            /// </summary>
            public string DefaultPythonEngine { get; set; }

            public HostAnalyticsInfo HostAnalyticsInfo { get; set; }

            /// <summary>
            /// CLIMode indicates if we are running in DynamoCLI or DynamoWPFCLI mode.
            /// </summary>
            public bool CLIMode { get; set; }
            public string CLILocale { get; set; }
        }

        /// <summary>
        ///     Start DynamoModel with all default configuration options
        /// </summary>
        /// <returns>The instance of <see cref="DynamoModel"/></returns>
        public static DynamoModel Start()
        {
            return Start(new DefaultStartConfiguration() { ProcessMode = TaskProcessMode.Asynchronous, Preferences = PreferenceSettings.Instance });
        }

        /// <summary>
        /// Start DynamoModel with custom configuration.  Defaults will be assigned not provided.
        /// </summary>
        /// <param name="configuration">Start configuration</param>
        /// <returns>The instance of <see cref="DynamoModel"/></returns>
        public static DynamoModel Start(IStartConfiguration configuration)
        {
            // where necessary, assign defaults
            if (string.IsNullOrEmpty(configuration.Context))
                configuration.Context = Configuration.Context.NONE;

            return new DynamoModel(configuration);
        }

        // Token representing the Built-InPackages directory
        internal static readonly string BuiltInPackagesToken = @"%BuiltInPackages%";
        [Obsolete("Only used for migration to the new for this directory - BuiltInPackages - do not use for other purposes")]
        // Token representing the standard library directory
        internal static readonly string StandardLibraryToken = @"%StandardLibrary%";        

        /// <summary>
        /// Default constructor for DynamoModel
        /// </summary>
        /// <param name="config">Start configuration</param>
        protected DynamoModel(IStartConfiguration config)
        {
            DynamoModel.IsCrashing = false;

            if (config is DefaultStartConfiguration defaultStartConfig)
            {
                // This is not exposed in IStartConfiguration to avoid a breaking change.
                // TODO: This fact should probably be revisited in 3.0.
                DefaultPythonEngine = defaultStartConfig.DefaultPythonEngine;
                CLIMode = defaultStartConfig.CLIMode;
                IsServiceMode = defaultStartConfig.IsServiceMode;
                CLILocale = defaultStartConfig.CLILocale;
            }

            if (config is IStartConfigCrashReporter cerConfig)
            {
                CERLocation = cerConfig.CRStartConfig.CERLocation;
            }

            ClipBoard = new ObservableCollection<ModelBase>();

            pathManager = CreatePathManager(config);

            // Ensure we have all directories in place.
            var exceptions = new List<Exception>();
            pathManager.EnsureDirectoryExistence(exceptions);

            Context = config.Context;
            IsTestMode = config.StartInTestMode;
            IsHeadless = config.IsHeadless;
            NoNetworkMode = config.NoNetworkMode;
            HostAnalyticsInfo = config.HostAnalyticsInfo;

            DebugSettings = new DebugSettings();
            Logger = new DynamoLogger(DebugSettings, pathManager.LogDirectory, IsTestMode, CLIMode, IsServiceMode);

            if (!IsServiceMode)
            {
                // Log all exceptions as part of directories check.
                foreach (var exception in exceptions)
                {
                    Logger.Log(exception);
                }
            }

            MigrationManager = new MigrationManager(DisplayFutureFileMessage, DisplayObsoleteFileMessage);
            MigrationManager.MessageLogged += LogMessage;
            MigrationManager.MigrationTargets.Add(typeof(WorkspaceMigrations));

            var thread = config.SchedulerThread ?? new DynamoSchedulerThread();
            Scheduler = new DynamoScheduler(thread, config.ProcessMode);
            Scheduler.TaskStateChanged += OnAsyncTaskStateChanged;

            geometryFactoryPath = config.GeometryFactoryPath;

            OnRequestUpdateLoadBarStatus(new SplashScreenLoadEventArgs(Resources.SplashScreenInitPreferencesSettings, 30));

            PreferenceSettings = (PreferenceSettings)CreateOrLoadPreferences(config.Preferences);
            PreferenceSettings.Instance = PreferenceSettings;

            if (PreferenceSettings != null)
            {
                SetUICulture(CLILocale ?? PreferenceSettings.Locale);
                PreferenceSettings.PropertyChanged += PreferenceSettings_PropertyChanged;
                PreferenceSettings.MessageLogged += LogMessage;
            }

            HostName = HostAnalyticsInfo.HostName;
            HostVersion = HostAnalyticsInfo.HostVersion?.ToString();

            bool areAnalyticsDisabledFromConfig = false;
            if (!IsServiceMode)
            {   // Skip getting the value for areAnalyticsDisabledFromConfig because analytics is disabled for service mode anyway
                try
                {
                    // Dynamo, behind a proxy server, has been known to have issues loading the Analytics binaries.
                    // Using the "DisableAnalytics" configuration setting, a user can skip loading analytics binaries altogether.
                    var assemblyConfig = ConfigurationManager.OpenExeConfiguration(GetType().Assembly.Location);
                    if (assemblyConfig != null)
                    {
                        var disableAnalyticsValue = assemblyConfig.AppSettings.Settings["DisableAnalytics"];
                        if (disableAnalyticsValue != null)
                            bool.TryParse(disableAnalyticsValue.Value, out areAnalyticsDisabledFromConfig);
                    }
                }
                catch (Exception)
                {
                    // Do nothing for now
                }
            }
            //If network traffic is disabled, analytics should also be disabled - this is already done in
            //our other entry points(CLI,Sandbox etc) - but
            //not all integrators will use those entry points, some may just create a DynamoModel directly.
            Analytics.DisableAnalytics = NoNetworkMode || Analytics.DisableAnalytics || IsServiceMode;

            // If user skipped analytics from assembly config, do not try to launch the analytics client
            // or the feature flags client for web traffic reason.
            if (!IsServiceMode && !areAnalyticsDisabledFromConfig && !Analytics.DisableAnalytics && !NoNetworkMode)
            {
                HandleAnalytics();

                //run process startup/reading on another thread so we don't block dynamo startup.
                //if we end up needing to control aspects of dynamo model or view startup that we can't make
                //event based/async then just run this on main thread - ie get rid of the Task.Run()
                var mainThreadSyncContext = SynchronizationContext.Current ?? new SynchronizationContext();
                Task.Run(() =>
                {
                    try
                    {
                        //this will kill the CLI process after cacheing the flags in Dynamo process.
                        using (FeatureFlags =
                                new DynamoFeatureFlagsManager(
                                AnalyticsService.GetUserIDForSession(),
                                mainThreadSyncContext,
                                IsTestMode))
                        {
                            FeatureFlags.MessageLogged += LogMessageWrapper;
                            //this will block task thread as it waits for data from feature flags process.
                            FeatureFlags.CacheAllFlags();
                        }
                    }
                    catch (Exception e) { Logger.LogError($"could not start feature flags manager {e}"); };
                });
                DynamoFeatureFlagsManager.FlagsRetrieved += HandleFeatureFlags;
            }

            // TBD: Do we need settings migrator for service mode? If we config the docker correctly, this could be skipped I think
            if (!IsServiceMode && !IsTestMode && PreferenceSettings.IsFirstRun)
            {
                DynamoMigratorBase migrator = null;

                try
                {
                    migrator = DynamoMigratorBase.MigrateBetweenDynamoVersions(pathManager);
                }
                catch (Exception e)
                {
                    Logger.Log(e.Message);
                }

                if (migrator != null)
                {
                    var isFirstRun = PreferenceSettings.IsFirstRun;
                    PreferenceSettings = migrator.PreferenceSettings;
                    PreferenceSettings.Instance = PreferenceSettings;

                    // Preserve the preference settings for IsFirstRun as this needs to be set
                    // only by UsageReportingManager
                    PreferenceSettings.IsFirstRun = isFirstRun;
                }
            }

            if (!IsServiceMode && PreferenceSettings.IsFirstRun && !IsTestMode)
            {
                PreferenceSettings.AddDefaultTrustedLocations();
            }

            InitializePreferences();

            // At this point, pathManager.PackageDirectories only has 1 element which is the directory
            // in AppData. If list of PackageFolders is empty, add the folder in AppData to the list since there
            // is no additional location specified. Otherwise, update pathManager.PackageDirectories to include
            // PackageFolders
            if (PreferenceSettings.CustomPackageFolders.Count == 0)
            {
                PreferenceSettings.CustomPackageFolders = new List<string> { BuiltInPackagesToken, pathManager.UserDataDirectory };
            }

            if (!PreferenceSettings.CustomPackageFolders.Contains(BuiltInPackagesToken))
            {
                PreferenceSettings.CustomPackageFolders.Insert(0, BuiltInPackagesToken);
            }

            // Make sure that the default package folder is added in the list if custom packages folder.
            var userDataFolder = pathManager.GetUserDataFolder(); // Get the default user data path
            AddPackagePath(userDataFolder);

            // Make sure that the global package folder is added in the list
            var userCommonPackageFolder = pathManager.CommonPackageDirectory;
            AddPackagePath(userCommonPackageFolder);

            // Load Python Template
            // The loading pattern is conducted in the following order
            // 1) Set from DynamoSettings.XML
            // 2) Set from API via the configuration file
            // 3) Set from PythonTemplate.py located in 'C:\Users\USERNAME\AppData\Roaming\Dynamo\Dynamo Core\2.X'
            // 4) Set from OOTB hard-coded default template

            // If a custom python template path doesn't already exists in the DynamoSettings.xml
            if (string.IsNullOrEmpty(PreferenceSettings.PythonTemplateFilePath) ||
                !File.Exists(PreferenceSettings.PythonTemplateFilePath) && !IsServiceMode)
            {
                // To supply a custom python template host integrators should supply a 'DefaultStartConfiguration' config file
                // or create a new struct that inherits from 'DefaultStartConfiguration' making sure to set the 'PythonTemplatePath'
                // while passing the config to the 'DynamoModel' constructor.
                if (config is DefaultStartConfiguration)
                {
                    var configurationSettings = (DefaultStartConfiguration)config;
                    var templatePath = configurationSettings.PythonTemplatePath;

                    // If a custom python template path was set in the config apply that template
                    if (!string.IsNullOrEmpty(templatePath) && File.Exists(templatePath))
                    {
                        PreferenceSettings.PythonTemplateFilePath = templatePath;
                        Logger.Log(Resources.PythonTemplateDefinedByHost + " : " +
                                   PreferenceSettings.PythonTemplateFilePath);
                    }

                    // Otherwise fallback to the default
                    else
                    {
                        SetDefaultPythonTemplate();
                    }
                }
                else
                {
                    // Fallback to the default
                    SetDefaultPythonTemplate();
                }
            }
            else
            {
                // A custom python template path already exists in the DynamoSettings.xml
                Logger.Log(Resources.PythonTemplateUserFile + " : " + PreferenceSettings.PythonTemplateFilePath);
            }

            pathManager.Preferences = PreferenceSettings;
            PreferenceSettings.RequestUserDataFolder += pathManager.GetUserDataFolder;

            if (!IsServiceMode)
            {
                SearchModel = new NodeSearchModel(Logger);
                SearchModel.ItemProduced += SearchModel_ItemProduced;
                    
            }

            NodeFactory = new NodeFactory();
            NodeFactory.MessageLogged += LogMessage;

            //Initialize the ExtensionManager with the CommonDataDirectory so that extensions found here are checked first for dll's with signed certificates
            extensionManager = new ExtensionManager(new[] { PathManager.CommonDataDirectory });
            extensionManager.MessageLogged += LogMessage;
            var extensions = config.Extensions ?? LoadExtensions();

            //don't load linter manager in service mode.
            if (!IsServiceMode)
            {
                LinterManager = new LinterManager(this.ExtensionManager);
            }

            // when dynamo is ready, alert the loaded extensions
            DynamoReady += (readyParams) =>
            {
                this.dynamoReady = true;
                DynamoReadyExtensionHandler(readyParams, ExtensionManager.Extensions);
            };

            // when an extension is added if dynamo is ready, alert that extension (this alerts late
            // loaded extensions)
            ExtensionManager.ExtensionAdded += (extension) =>
            {
                if (this.dynamoReady)
                {
                    DynamoReadyExtensionHandler(new ReadyParams(this),
                    new List<IExtension>() { extension });
                };
            };

            Loader = new NodeModelAssemblyLoader();
            Loader.MessageLogged += LogMessage;

            // Create a core which is used for parsing code and loading libraries
            var libraryCore = new ProtoCore.Core(new Options())
            {
                ParsingMode = ParseMode.AllowNonAssignment
            };
            libraryCore.Compilers.Add(Language.Associative, new Compiler(libraryCore));
            libraryCore.Compilers.Add(Language.Imperative, new ProtoImperative.Compiler(libraryCore));

            LibraryServices = new LibraryServices(libraryCore, pathManager, PreferenceSettings);
            LibraryServices.MessageLogged += LogMessage;
            LibraryServices.LibraryLoaded += LibraryLoaded;

            CustomNodeManager = new CustomNodeManager(NodeFactory, MigrationManager, LibraryServices);

            LuceneSearch.LuceneUtilityNodeSearch = new LuceneSearchUtility(this, LuceneSearchUtility.DefaultNodeIndexStartConfig);

            InitializeCustomNodeManager();

            ResetEngineInternal();

            EngineController.VMLibrariesReset += ReloadDummyNodes;

            AddHomeWorkspace();

            AuthenticationManager = new AuthenticationManager(config.AuthProvider);
  
            Logger.Log($"Dynamo -- Build {Assembly.GetExecutingAssembly().GetName().Version}");

            DynamoModel.OnRequestUpdateLoadBarStatus(new SplashScreenLoadEventArgs(Resources.SplashScreenLoadNodeLibrary, 50));
            InitializeNodeLibrary();

            if (extensions.Any())
            {
                Logger.Log("\nLoading Dynamo extensions:");
                var startupParams = new StartupParams(this);

                foreach (var ext in extensions)
                {
                    if (ext is ILogSource logSource)
                        logSource.MessageLogged += LogMessage;

                    try
                    {
                        if (ext is LinterExtensionBase linter)
                        {
                            linter.InitializeBase(this.LinterManager);
                        }

                        ext.Startup(startupParams);
                        // if we are starting extension (A) which is a source of other extensions (like packageManager)
                        // then we can start the extension(s) (B) that it requested be loaded.
                        if (ext is IExtensionSource)
                        {
                            foreach (var loadedExtension in (ext as IExtensionSource).RequestedExtensions)
                            {
                                if (loadedExtension is IExtension)
                                {
                                    if (loadedExtension is LinterExtensionBase loadedLinter)
                                    {
                                        loadedLinter.InitializeBase(this.LinterManager);
                                    }

                                    (loadedExtension as IExtension).Startup(startupParams);
                                }
                            }
                        }
                    }
                    catch (Exception ex)
                    {
                        Logger.Log(ex.Message);
                    }

                    ExtensionManager.Add(ext);

                }
            }

#if DEBUG
            CurrentWorkspace.NodeAdded += CrashOnDemand.CurrentWorkspace_NodeAdded;
#endif

            LogWarningMessageEvents.LogWarningMessage += LogWarningMessage;
            LogWarningMessageEvents.LogInfoMessage += LogInfoMessage;

#pragma warning disable AUTH_SERVICES
            AuthServices.RequestAuthProvider += AuthServicesEvents_AuthProviderRequested;
#pragma warning restore AUTH_SERVICES

            DynamoConsoleLogger.LogMessageToDynamoConsole += LogMessageWrapper;
            DynamoConsoleLogger.LogErrorToDynamoConsole += LogErrorMessageWrapper;
            if (!IsServiceMode)
            {
                StartBackupFilesTimer();
            }

            TraceReconciliationProcessor = this;

            State = DynamoModelState.StartedUIless;

            if(!IsServiceMode)
            {
                // Write index to disk only once
                LuceneUtility.CommitWriterChanges();
            }
            //Disposed writer if it is in file system mode so that the index files can be used by other processes (potentially a second Dynamo session)
            if (LuceneUtility.startConfig.StorageType == LuceneSearchUtility.LuceneStorage.FILE_SYSTEM)
            {
                LuceneUtility.DisposeWriter();
            }
            

            GraphChecksumDictionary = new Dictionary<string, List<string>>();
                 
            // This event should only be raised at the end of this method.
            DynamoReady(new ReadyParams(this));
        }

        private void AuthServicesEvents_AuthProviderRequested(RequestAuthProviderEventArgs args)
        {
            args.AuthProvider = AuthenticationManager.AuthProvider;
        }

        /// <summary>
        /// When feature flags received, handle them and make changes 
        /// </summary>
        private void HandleFeatureFlags()
        {
            PreferenceSettings.UpdateNamespacesToExcludeFromLibrary();
            return;
        }

        private void HandleAnalytics()
        {
            if (IsTestMode)
            {
                if (Analytics.DisableAnalytics)
                {
                    Logger.Log("Incompatible configuration: [IsTestMode] and [Analytics disabled] ");
                }
                return;
            }

            if (IsHeadless)
            {
                return;
            }

            // Start the Analytics service only when a session is not present.
            // In an integrator host, as splash screen can be closed without shutting down the ViewModel, the analytics service is not stopped.
            // So we don't want to start it when splash screen or dynamo window is launched again.
            if (Analytics.client == null)
            {
                AnalyticsService.Start();
            }
            else if (Analytics.client is DynamoAnalyticsClient dac)
            {
                if (dac.Session == null)
                {
                    AnalyticsService.Start();
                }
            }
        }

        private void SearchModel_ItemProduced(NodeModel node)
        {
            ExecuteCommand(new CreateNodeCommand(node, 0, 0, true, true));
        }

        /// <summary>
        /// It returns a PathManager instance based on the mode in order to reuse it's Singleton instance or create a new one
        /// </summary>
        /// <param name="config"></param>
        /// <returns></returns>
        internal PathManager CreatePathManager(IStartConfiguration config)
        {
            if (!config.StartInTestMode)
            {
                if (!Core.PathManager.Instance.HasPathResolver)
                {
                    Core.PathManager.Instance.AssignHostPathAndIPathResolver(config.DynamoHostPath, config.PathResolver);
                }
                return Core.PathManager.Instance;
            }
            else
            {
                return new PathManager(new PathManagerParams
                {
                    CorePath = config.DynamoCorePath,
                    HostPath = config.DynamoHostPath,
                    PathResolver = config.PathResolver
                });
            }
        }

        /// <summary>
        /// Create or load a preference checking the usage mode and if it already exists
        /// </summary>
        /// <param name="preferences"></param>
        /// <returns></returns>
        private IPreferences CreateOrLoadPreferences(IPreferences preferences)
        {
            if (preferences != null) // If there is preference settings provided...
                return preferences;

            //Skip file handling and trust location in service mode.
            if (IsServiceMode)
            {
                var setting = new PreferenceSettings();
                setting.SetTrustWarningsDisabled(true);
                return setting;
            }

            // Is order for test cases not to interfere with the regular preference
            // settings xml file, a test case usually specify a temporary xml file
            // path from where preference settings are to be loaded. If that value
            // is not set, then fall back to the file path specified in PathManager.
            //
            var xmlFilePath = PreferenceSettings.DynamoTestPath;
            if (string.IsNullOrEmpty(xmlFilePath))
                xmlFilePath = pathManager.PreferenceFilePath;

            if (File.Exists(xmlFilePath))
            {
                // If the specified xml file path exists, load it.
                return PreferenceSettings.Load(xmlFilePath);
            }

            // Otherwise make a default preference settings object.
            return new PreferenceSettings();
        }

        private void SetDefaultPythonTemplate()
        {
            // First check if the default python template is overridden by a PythonTemplate.py file in AppData
            // This file is always named accordingly and located in 'C:\Users\USERNAME\AppData\Roaming\Dynamo\Dynamo Core\2.X'
            if (!string.IsNullOrEmpty(pathManager.PythonTemplateFilePath) && File.Exists(pathManager.PythonTemplateFilePath))
            {
                PreferenceSettings.PythonTemplateFilePath = pathManager.PythonTemplateFilePath;
                Logger.Log(Resources.PythonTemplateAppData + " : " + PreferenceSettings.PythonTemplateFilePath);
            }

            // Otherwise the OOTB hard-coded template is applied
            else
            {
                Logger.Log(Resources.PythonTemplateDefaultFile);
            }
        }

        private void DynamoReadyExtensionHandler(ReadyParams readyParams, IEnumerable<IExtension> extensions)
        {

            foreach (var ext in extensions)
            {
                try
                {
                    ext.Ready(readyParams);
                }
                catch (Exception ex)
                {
                    Logger.Log(String.Format(Properties.Resources.FailedToHandleReadyEvent, ext.Name, " ", ex.Message));
                }
            }
        }

        /// <summary>
        /// Adds a new path to the list of custom package folders, but only if the path
        /// does not already exist in the list.
        /// </summary>
        /// <param name="path"> The path to add.</param>
        /// <param name="file"> The file to add when importing a library.</param>
        public bool AddPackagePath(string path, string file = "")
        {
            if (!Directory.Exists(path))
                return false;

            string fullFilename = path;
            if (file != "")
            {
                fullFilename = Path.Combine(path, file);
                if (!File.Exists(fullFilename))
                    return false;
            }

            if (PreferenceSettings.CustomPackageFolders.Contains(fullFilename))
                return false;

            PreferenceSettings.CustomPackageFolders.Add(fullFilename);

            return true;
        }

        private IEnumerable<IExtension> LoadExtensions()
        {
            var extensions = new List<IExtension>();
            foreach (var dir in pathManager.ExtensionsDirectories)
            {
                extensions.AddRange(ExtensionManager.ExtensionLoader.LoadDirectory(dir));
            }
            return extensions;
        }

        private void RemoveExtension(IExtension ext)
        {
            ExtensionManager.Remove(ext);

            var logSource = ext as ILogSource;
            if (logSource != null)
                logSource.MessageLogged -= LogMessage;
        }


        private void HandleStorageExtensionsOnWorkspaceOpened(HomeWorkspaceModel workspace)
        {
            foreach (var extension in extensionManager.StorageAccessExtensions)
            {
                RaiseIExtensionStorageAccessWorkspaceOpened(workspace, extension, this.Logger);
            }
        }

        private void HandleStorageExtensionsOnWorkspaceSaving(HomeWorkspaceModel workspace, SaveContext saveContext)
        {
            foreach (var extension in extensionManager.StorageAccessExtensions)
            {
                RaiseIExtensionStorageAccessWorkspaceSaving(workspace, extension, saveContext, this.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);

            try
            {
                extension.OnWorkspaceOpen(extensionDataCopy);
            }
            catch (Exception ex)
            {
                logger.Log(ex.Message + " : " + ex.StackTrace);
                return;
            }
        }

        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}";

            var hasMatchingExtensionData = workspace.TryGetMatchingWorkspaceData(extension.UniqueId, out Dictionary<string, string> data);

            try
            {
                extension.OnWorkspaceSaving(data, saveContext);
            }
            catch (Exception ex)
            {
                logger.Log(ex.Message + " : " + ex.StackTrace);
                return;
            }


            if (hasMatchingExtensionData)
            {
                workspace.UpdateExtensionData(extension.UniqueId, data);
                return;
            }

            workspace.CreateNewExtensionData(extension.UniqueId, extension.Name, version, data);
        }

        private void EngineController_TraceReconcliationComplete(TraceReconciliationEventArgs obj)
        {
            Debug.WriteLine("TRACE RECONCILIATION: {0} total serializables were orphaned.", obj.CallsiteToOrphanMap.SelectMany(kvp => kvp.Value).Count());

            // The orphans will come back here as a dictionary of lists of strings keyed by their callsite id.
            // This dictionary gets redistributed into a dictionary keyed by the workspace id.

            var workspaceOrphanMap = new Dictionary<Guid, List<string>>();
            var nodeToWorkspaceMap = new Dictionary<Guid, WorkspaceModel>();

            foreach (var maybeWs in Workspaces)
            {
                foreach (var node in maybeWs.Nodes)
                {
                    nodeToWorkspaceMap[node.GUID] = maybeWs;
                }

                if (maybeWs is not HomeWorkspaceModel ws)
                {
                    continue;
                }

                // Get the orphaned serializables to this workspace
                var wsOrphans = ws.GetOrphanedSerializablesAndClearHistoricalTraceData();

                if (!wsOrphans.Any())
                {
                    continue;
                }

                if (workspaceOrphanMap.TryGetValue(ws.Guid, out var workspaceOrphans))
                {
                    workspaceOrphans.AddRange(wsOrphans);
                }
                else
                {
                    workspaceOrphanMap.Add(ws.Guid, wsOrphans);
                }
            }

            foreach (var kvp in obj.CallsiteToOrphanMap)
            {
                if (!kvp.Value.Any()) continue;

                var nodeGuid = EngineController.LiveRunnerRuntimeCore.RuntimeData.CallSiteToNodeMap[kvp.Key];

                // TODO: MAGN-7314
                // Find the owning workspace for a node.
                if (!nodeToWorkspaceMap.TryGetValue(nodeGuid, out var nodeSpace))
                {
                    continue;
                }

                // Add the node's orphaned serializables to the workspace
                // orphan map.
                if (workspaceOrphanMap.TryGetValue(nodeSpace.Guid, out var workspaceOrphans))
                {
                    workspaceOrphans.AddRange(kvp.Value);
                }
                else
                {
                    workspaceOrphanMap.Add(nodeSpace.Guid, kvp.Value.ToList());
                }
            }

            TraceReconciliationProcessor.PostTraceReconciliation(workspaceOrphanMap);
        }

        /// <summary>
        /// Deals with orphaned serializables.
        /// </summary>
        /// <param name="orphanedSerializables">Collection of orphaned serializables.</param>
        public virtual void PostTraceReconciliation(Dictionary<Guid, List<string>> orphanedSerializables)
        {
            // Override in derived classes to deal with orphaned serializables.
        }

        /// <summary>
        /// LibraryLoaded event handler.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void LibraryLoaded(object sender, LibraryServices.LibraryLoadedEventArgs e)
        {
            foreach (var newLibrary in e.LibraryPaths)
            {
                // Load all functions defined in that library.
                AddZeroTouchNodesToSearch(LibraryServices.GetFunctionGroups(newLibrary));
            }
        }

        /// <summary>
        /// This event handler is invoked when DynamoScheduler changes the state
        /// of an AsyncTask object. See TaskStateChangedEventArgs.State for more
        /// details of these state changes.
        /// </summary>
        /// <param name="sender">The scheduler which raised the event.</param>
        /// <param name="e">Task state changed event argument.</param>
        ///
        private void OnAsyncTaskStateChanged(DynamoScheduler sender, TaskStateChangedEventArgs e)
        {
            var updateTask = e.Task as UpdateGraphAsyncTask;
            switch (e.CurrentState)
            {
                case TaskStateChangedEventArgs.State.ExecutionStarting:
                    if (updateTask != null)
                        ExecutionEvents.OnGraphPreExecution(new ExecutionSession(updateTask, this, geometryFactoryPath));
                    break;

                case TaskStateChangedEventArgs.State.ExecutionCompleted:
                    if (updateTask != null)
                    {
                        // Record execution time for update graph task.
                        long start = e.Task.ExecutionStartTime.TickCount;
                        long end = e.Task.ExecutionEndTime.TickCount;
                        var executionTimeSpan = new TimeSpan(end - start);

                        //don't attempt to send these events unless GA is active or ADP will actually record these events.
                        if (Logging.Analytics.ReportingAnalytics)
                        {
                            if (updateTask.ModifiedNodes != null && updateTask.ModifiedNodes.Any())
                            {
                                // Send analytics for each of modified nodes so they are counted individually
                                foreach (var node in updateTask.ModifiedNodes)
                                {
                                    // Tracking node execution as generic event
                                    // it is distinguished with the legacy aggregated performance event
                                    Dynamo.Logging.Analytics.TrackEvent(
                                        Actions.Run,
                                        Categories.NodeOperations,
                                        node.GetOriginalName());
                                }
                            }
                        }

                        Debug.WriteLine(String.Format(Resources.EvaluationCompleted, executionTimeSpan));

                        ExecutionEvents.OnGraphPostExecution(new ExecutionSession(updateTask, this, geometryFactoryPath));
                    }
                    break;
            }
        }

        /// <summary>
        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
        /// </summary>
        /// <filterpriority>2</filterpriority>
        public void Dispose()
        {
            EngineController.TraceReconcliationComplete -= EngineController_TraceReconcliationComplete;
            EngineController.RequestCustomNodeRegistration -= EngineController_RequestCustomNodeRegistration;

            ExtensionManager.Dispose();
            extensionManager.MessageLogged -= LogMessage;

            LinterManager.Dispose();

            LibraryServices.Dispose();
            LibraryServices.LibraryManagementCore.Cleanup();
            LibraryServices.MessageLogged -= LogMessage;
            LibraryServices.LibraryLoaded -= LibraryLoaded;

            EngineController.VMLibrariesReset -= ReloadDummyNodes;
            DynamoFeatureFlagsManager.FlagsRetrieved -= HandleFeatureFlags;

            Logger.Dispose();

            EngineController.Dispose();
            EngineController = null;

            if (backupFilesTimer != null)
            {
                backupFilesTimer.Dispose();
                backupFilesTimer = null;
                Logger.Log("Backup files timer is disposed");
            }

            if (PreferenceSettings != null)
            {
                PreferenceSettings.PropertyChanged -= PreferenceSettings_PropertyChanged;
                PreferenceSettings.RequestUserDataFolder -= pathManager.GetUserDataFolder;
                PreferenceSettings.MessageLogged -= LogMessage;
            }

            // Lucene disposals (just if LuceneNET was initialized)
            LuceneUtility?.DisposeAll();

#if DEBUG
            CurrentWorkspace.NodeAdded -= CrashOnDemand.CurrentWorkspace_NodeAdded;
#endif

            LogWarningMessageEvents.LogWarningMessage -= LogWarningMessage;
            LogWarningMessageEvents.LogInfoMessage -= LogInfoMessage;

#pragma warning disable AUTH_SERVICES
            AuthServices.RequestAuthProvider -= AuthServicesEvents_AuthProviderRequested;
#pragma warning restore AUTH_SERVICES

            DynamoConsoleLogger.LogMessageToDynamoConsole -= LogMessageWrapper;
            DynamoConsoleLogger.LogErrorToDynamoConsole -= LogErrorMessageWrapper;
            foreach (var ws in _workspaces)
            {
                ws.Dispose();
            }
            NodeFactory.MessageLogged -= LogMessage;
            CustomNodeManager.MessageLogged -= LogMessage;
            CustomNodeManager.Dispose();
            MigrationManager.MessageLogged -= LogMessage;
            if (FeatureFlags != null)
            {
                FeatureFlags.MessageLogged -= LogMessageWrapper;
            }
            if (!IsServiceMode)
            {
                SearchModel.ItemProduced -= SearchModel_ItemProduced;
            }
            //handle the disposal of IDSDK manager instance for sandbox
            if (AuthenticationManager?.AuthProvider is IDSDKManager idsdkProvider)
            {
                idsdkProvider?.Dispose();
            }
        }

        private void InitializeCustomNodeManager()
        {
            CustomNodeManager.MessageLogged += LogMessage;

            var customNodeSearchRegistry = new HashSet<Guid>();
            CustomNodeManager.InfoUpdated += info =>
            {
                //just bail in service mode.
                if (IsServiceMode)
                {
                    return;
                }

                if (customNodeSearchRegistry.Contains(info.FunctionId)
                        || !info.IsVisibleInDynamoLibrary)
                    return;

               
                var elements = SearchModel?.Entries.OfType<CustomNodeSearchElement>().
                                Where(x =>
                                {
                                    // Search for common paths and get rid of empty paths.
                                    // It can be empty just in case it's just created node.
                                    return String.Compare(x.Path, info.Path, StringComparison.OrdinalIgnoreCase) == 0 &&
                                        !String.IsNullOrEmpty(x.Path);
                                }).ToList();

                if (elements.Any())
                {
                    foreach (var element in elements)
                    {
                        element.SyncWithCustomNodeInfo(info);
                        SearchModel.Update(element);
                    }
                    return;
                }
                

                customNodeSearchRegistry.Add(info.FunctionId);
                var searchElement = new CustomNodeSearchElement(CustomNodeManager, info);
                SearchModel.Add(searchElement);

                //Indexing node packages installed using PackageManagerSearch
                var iDoc = LuceneUtility.InitializeIndexDocumentForNodes();
                if (searchElement != null)
                {
                    LuceneUtility.AddNodeTypeToSearchIndex(searchElement, iDoc);
                }

                Action<CustomNodeInfo> infoUpdatedHandler = null;
                infoUpdatedHandler = newInfo =>
                {
                    if (info.FunctionId == newInfo.FunctionId)
                    {
                        bool isCategoryChanged = searchElement.FullCategoryName != newInfo.Category;
                        searchElement.SyncWithCustomNodeInfo(newInfo);
                        SearchModel.Update(searchElement, isCategoryChanged);
                    }
                };
                CustomNodeManager.InfoUpdated += infoUpdatedHandler;
                CustomNodeManager.CustomNodeRemoved += id =>
                {
                    CustomNodeManager.InfoUpdated -= infoUpdatedHandler;
                    if (info.FunctionId == id)
                    {
                        customNodeSearchRegistry.Remove(info.FunctionId);
                        SearchModel.Remove(searchElement);
                        var workspacesToRemove = _workspaces.FindAll(w => w is CustomNodeWorkspaceModel
                            && (w as CustomNodeWorkspaceModel).CustomNodeId == id);
                        workspacesToRemove.ForEach(w => RemoveWorkspace(w));
                    }
                };
            };

            CustomNodeManager.DefinitionUpdated += UpdateCustomNodeDefinition;
        }

        private void InitializeIncludedNodes()
        {
            var iDoc = LuceneUtility.InitializeIndexDocumentForNodes();

            var customNodeData = new TypeLoadData(typeof(Function));
            NodeFactory.AddLoader(new CustomNodeLoader(CustomNodeManager, IsTestMode));
            NodeFactory.AddAlsoKnownAs(customNodeData.Type, customNodeData.AlsoKnownAs);

            var dsFuncData = new TypeLoadData(typeof(DSFunction));
            var dsVarArgFuncData = new TypeLoadData(typeof(DSVarArgFunction));
            var cbnData = new TypeLoadData(typeof(CodeBlockNodeModel));
            var dummyData = new TypeLoadData(typeof(DummyNode));
            var symbolData = new TypeLoadData(typeof(Symbol));
            var outputData = new TypeLoadData(typeof(Output));

            var ztLoader = new ZeroTouchNodeLoader(LibraryServices);
            NodeFactory.AddLoader(dsFuncData.Type, ztLoader);
            NodeFactory.AddAlsoKnownAs(dsFuncData.Type, dsFuncData.AlsoKnownAs);
            NodeFactory.AddLoader(dsVarArgFuncData.Type, ztLoader);
            NodeFactory.AddAlsoKnownAs(dsVarArgFuncData.Type, dsVarArgFuncData.AlsoKnownAs);

            var cbnLoader = new CodeBlockNodeLoader(LibraryServices);
            NodeFactory.AddLoader(cbnData.Type, cbnLoader);
            NodeFactory.AddFactory(cbnData.Type, cbnLoader);
            NodeFactory.AddAlsoKnownAs(cbnData.Type, cbnData.AlsoKnownAs);

            NodeFactory.AddTypeFactoryAndLoader(dummyData.Type);
            NodeFactory.AddAlsoKnownAs(dummyData.Type, dummyData.AlsoKnownAs);

            var inputLoader = new InputNodeLoader();
            NodeFactory.AddLoader(symbolData.Type, inputLoader);
            NodeFactory.AddFactory(symbolData.Type, inputLoader);
            NodeFactory.AddAlsoKnownAs(symbolData.Type, symbolData.AlsoKnownAs);

            NodeFactory.AddTypeFactoryAndLoader(outputData.Type);
            NodeFactory.AddAlsoKnownAs(outputData.Type, outputData.AlsoKnownAs);

            var cnbNode = new CodeBlockNodeSearchElement(cbnData, LibraryServices);
            SearchModel?.Add(cnbNode);

            var symbolSearchElement = new NodeModelSearchElement(symbolData)
            {
                IsVisibleInSearch = CurrentWorkspace is CustomNodeWorkspaceModel
            };
            var outputSearchElement = new NodeModelSearchElement(outputData)
            {
                IsVisibleInSearch = CurrentWorkspace is CustomNodeWorkspaceModel
            };

            WorkspaceHidden += _ =>
            {
                var isVisible = CurrentWorkspace is CustomNodeWorkspaceModel;
                symbolSearchElement.IsVisibleInSearch = isVisible;
                outputSearchElement.IsVisibleInSearch = isVisible;
            };

            SearchModel?.Add(symbolSearchElement);
            SearchModel?.Add(outputSearchElement);
            LuceneUtility.AddNodeTypeToSearchIndex([cnbNode, symbolSearchElement, outputSearchElement], iDoc);

        }

        internal static bool IsDisabledPath(string packagesDirectory, IPreferences preferences)
        {
            if (!(preferences is IDisablePackageLoadingPreferences disablePrefs)) return false;

            var isACustomPackageDirectory = preferences.CustomPackageFolders.Where(x => packagesDirectory.StartsWith(x)).Any();

            return
            //if this directory is the builtin packages location
            //and loading from there is disabled, don't scan the directory.
            (disablePrefs.DisableBuiltinPackages && packagesDirectory == Core.PathManager.BuiltinPackagesDirectory)
            //or if custom package directories are disabled, and this is a custom package directory, don't scan.
            || (disablePrefs.DisableCustomPackageLocations && isACustomPackageDirectory);
        }

        private void InitializeNodeLibrary()
        {
            // Initialize all nodes inside of this assembly.
            InitializeIncludedNodes();

            Loader.LoadNodeModelsAndMigrations(pathManager.NodeDirectories,
                Context, out var modelTypes, out var migrationTypes);

            LoadNodeModels(modelTypes, false);

            // Load migrations
            foreach (var type in migrationTypes)
                MigrationManager.AddMigrationType(type);

            // Import Zero Touch libs
            var functionGroups = LibraryServices.GetAllFunctionGroups();
            if (!IsTestMode)
                AddZeroTouchNodesToSearch(functionGroups);
#if DEBUG_LIBRARY
            DumpLibrarySnapshot(functionGroups);
#endif


            // Load local custom nodes and locally imported libraries
            foreach (var path in pathManager.DefinitionDirectories)
            {
                DirectoryInfo parentPath;
                try
                {
                    parentPath = Directory.GetParent(path);
                }
                catch (ArgumentException)
                {
                    parentPath = null;
                }
                var pathName = parentPath != null ? parentPath.FullName : path;
                if (IsDisabledPath(pathName, PreferenceSettings))
                {
                    continue;
                }

                // NOTE: extension will only be null if path is null
                string extension = null;
                try
                {
                    extension = Path.GetExtension(path);
                }
                catch (ArgumentException e)
                {
                    Logger.Log(e.Message);
                }
                if (extension == null)
                    continue;

                // If the path has a .dll or .ds extension it is an explicitly imported library
                if (extension == ".dll" || extension == ".ds")
                {
                    // If a library was explicitly loaded by using the "File | ImportLibrary..." command
                    // and for some reason the import fails we do not want to throw an exception
                    LibraryServices.ImportLibrary(path, true);
                    continue;
                }

                // Otherwise it is a custom node
                CustomNodeManager.AddUninitializedCustomNodesInPath(path, IsTestMode);
            }

            CustomNodeManager.AddUninitializedCustomNodesInPath(pathManager.CommonDefinitions, IsTestMode);
        }

        /// <summary>
        /// Imports a node library (zero touch or nodeModel) into the VM.
        /// Does not necessarily add those imported functions to search.
        /// </summary>
        /// <param name="assem">The assembly to load which contains the types to import.</param>
        /// <param name="suppressZeroTouchLibraryLoad">If True, zero touch types will not be added to search.
        /// This is used by packageManager extension to defer adding ZT libraries to search until all libraries are loaded.
        /// </param>
        internal void LoadNodeLibrary(Assembly assem, bool suppressZeroTouchLibraryLoad = true)
        {
            // don't import assembly if its marked node lib and contains any nodemodels and any nodecustomizations
            // as a consequence we won't import any ZT nodes from assemblies that contain customziations and are marked node libraries.
            // We'll only apply the customizations and import NodeModels which are present.
            // I think this is consistent with the current behavior - IE today - if a nodeModel exists in an assembly, the rest of the assembly 
            // is not imported as ZT - the same will be true if the assembly contains a NodeViewCustomization.

            bool hasNodeModelOrNodeViewTypes;
            try
            {
                hasNodeModelOrNodeViewTypes = NodeModelAssemblyLoader.ContainsNodeModelSubType(assem)
                || (NodeModelAssemblyLoader.ContainsNodeViewCustomizationType(assem));
            }
            catch (Exception ex)
            {
                throw new Exceptions.LibraryLoadFailedException(assem.Location, ex.Message);
            }

            // TODO(mjk) draw up matrix of current behaviors which nodeLib flag can control.
            if (!hasNodeModelOrNodeViewTypes)
            {
                if (suppressZeroTouchLibraryLoad)
                {
                    LibraryServices.LoadNodeLibrary(assem.Location, isExplicitlyImportedLib: false);
                }
                else
                {
                    LibraryServices.ImportLibrary(assem.Location, isExplicitlyImportedLib: false);
                }

                return;
            }

            var nodes = new List<TypeLoadData>();
            Loader.LoadNodesFromAssembly(assem, Context, nodes, new List<TypeLoadData>());

            LoadNodeModels(nodes, true);
        }

        private void LoadNodeModels(List<TypeLoadData> nodes, bool isPackageMember)
        {
            var iDoc = LuceneUtility.InitializeIndexDocumentForNodes();
            List<NodeSearchElement> nodeSearchElements = [];
            foreach (var type in nodes)
            {
                // Protect ourselves from exceptions thrown by malformed third party nodes.
                try
                {
                    NodeFactory.AddTypeFactoryAndLoader(type.Type);
                    NodeFactory.AddAlsoKnownAs(type.Type, type.AlsoKnownAs);
                    type.IsPackageMember = isPackageMember;
                    // Legacy index process to search dictionary
                    var ele = AddNodeTypeToSearch(type);
                    // New index process from Lucene
                    // TODO: get search element some other way
                    if (ele != null)
                    {
                        nodeSearchElements.Add(ele);
                    }
                }
                catch (Exception e)
                {
                    Logger.Log(e);
                }
            }
            LuceneUtility.AddNodeTypeToSearchIndex(nodeSearchElements, iDoc);
        }

        private void InitializePreferences()
        {
            if (PreferenceSettings != null)
            {
                ProtoCore.Mirror.MirrorData.PrecisionFormat = DynamoUnits.Display.PrecisionFormat = PreferenceSettings.NumberFormat;
                PreferenceSettings.InitializeNamespacesToExcludeFromLibrary();
                InitializePreferenceLocations();
            }
        }

        private void InitializePreferenceLocations()
        {
            if (string.IsNullOrEmpty(PreferenceSettings.BackupLocation))
            {
                PreferenceSettings.BackupLocation = pathManager.DefaultBackupDirectory;
            }
            if (string.IsNullOrEmpty(PreferenceSettings.TemplateFilePath))
            {
                PreferenceSettings.TemplateFilePath = pathManager.DefaultTemplatesDirectory;
            }
            var supportedLocales = Configurations.SupportedLocaleDic.Values.ToList<string>();

            //Get the last part of the template path e.f. if the path is C:\ProgramData\Dynamo\Dynamo Core\templates\en-US then currentPathLocale = en-US
            var pathParts = PreferenceSettings.TemplateFilePath.Split("\\");
            var currentPathLocale = pathParts.Last();

            //Check if the locale is found inside the supported locales 
            if (supportedLocales.Contains(currentPathLocale))
            {
                //If the CurrentUICulture is different than the locale in the TemplateFilePath then needs to be updated         
                if (CultureInfo.CurrentUICulture.Name != currentPathLocale)
                {
                    PreferenceSettings.TemplateFilePath= PreferenceSettings.TemplateFilePath.Replace(currentPathLocale, CultureInfo.CurrentUICulture.Name);
                }
            }


            UpdatePreferenceItemLocation(PreferenceItem.Backup, PreferenceSettings.BackupLocation);
            UpdatePreferenceItemLocation(PreferenceItem.Templates, PreferenceSettings.TemplateFilePath);
        }
        internal bool UpdatePreferenceItemLocation(PreferenceItem item, string newLocation)
        {
            if (string.IsNullOrEmpty(newLocation)) return false;
            switch (item)
            {
                case PreferenceItem.Backup:
                    PreferenceSettings.BackupLocation = newLocation;
                    break;
                case PreferenceItem.Templates:
                    PreferenceSettings.TemplateFilePath = newLocation;
                    break;
                default:
                    break;
            }
            return pathManager.UpdatePreferenceItemPath(item, newLocation);
        }
        internal bool IsDefaultPreferenceItemLocation(PreferenceItem item)
        {
            switch (item)
            {
                case PreferenceItem.Backup:
                    return PreferenceSettings.BackupLocation.Equals(pathManager.DefaultBackupDirectory);
                case PreferenceItem.Templates:
                    return PreferenceSettings.TemplateFilePath.Equals(pathManager.DefaultTemplatesDirectory);
                default:
                    return false;
            }
        }

        internal string DefaultPreferenceItemLocation(PreferenceItem item)
        {
            switch (item)
            {
                case PreferenceItem.Backup:
                    return pathManager.DefaultBackupDirectory;
                case PreferenceItem.Templates:
                    return pathManager.DefaultTemplatesDirectory;
                default:
                    return string.Empty;
            }
        }
        internal string ResetPreferenceItemLocation(PreferenceItem item)
        {
            var loc = DefaultPreferenceItemLocation(item);
            UpdatePreferenceItemLocation(item, loc);

            return loc;
        }

        /// <summary>
        /// Responds to property update notifications on the preferences,
        /// and synchronizes with the Units Manager.
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        //TODO(Steve): See if we can't just do this in PreferenceSettings by making the properties directly access BaseUnit
        private void PreferenceSettings_PropertyChanged(object sender, PropertyChangedEventArgs e)
        {
            switch (e.PropertyName)
            {
                case nameof(PreferenceSettings.NumberFormat):
                    ProtoCore.Mirror.MirrorData.PrecisionFormat = DynamoUnits.Display.PrecisionFormat = PreferenceSettings.NumberFormat;
                    break;
            }
        }

        /// <summary>
        /// This warning message is displayed on the node associated with the FFI dll
        /// </summary>
        /// <param name="args"></param>
        private void LogWarningMessage(LogWarningMessageEventArgs args)
        {
            Validity.Assert(EngineController.LiveRunnerRuntimeCore != null);
            EngineController.LiveRunnerRuntimeCore.RuntimeStatus.LogWarning(WarningID.Default, args.message);
        }

        /// <summary>
        /// This info message is displayed on the node associated with the FFI dll
        /// </summary>
        /// <param name="args"></param>
        private void LogInfoMessage(LogWarningMessageEventArgs args)
        {
            Validity.Assert(EngineController.LiveRunnerRuntimeCore != null);
            EngineController.LiveRunnerRuntimeCore.RuntimeStatus.LogInfo(InfoID.Default, args.message);
        }

        #endregion

        #region engine management

        /// <summary>
        ///     Register custom node defintion and execute all custom node
        ///     instances.
        /// </summary>
        /// <param name="definition"></param>
        private void UpdateCustomNodeDefinition(CustomNodeDefinition definition)
        {
            RegisterCustomNodeDefinitionWithEngine(definition);
            MarkAllDependenciesAsModified(definition);
        }

        /// <summary>
        ///     Registers (or re-registers) a Custom Node definition with the DesignScript VM,
        ///     so that instances of the custom node can be evaluated.
        /// </summary>
        /// <param name="definition"></param>
        private void RegisterCustomNodeDefinitionWithEngine(CustomNodeDefinition definition)
        {
            EngineController.GenerateGraphSyncDataForCustomNode(
                Workspaces.OfType<HomeWorkspaceModel>().SelectMany(ws => ws.Nodes),
                definition,
                DebugSettings.VerboseLogging);
        }

        /// <summary>
        /// Returns all function instances directly or indirectly depends on the
        /// specified function definition and mark them as modified so that
        /// their values will be re-queried.
        /// </summary>
        /// <param name="def"></param>
        /// <returns></returns>
        private void MarkAllDependenciesAsModified(CustomNodeDefinition def)
        {
            var homeWorkspace = Workspaces.OfType<HomeWorkspaceModel>().FirstOrDefault();
            if (homeWorkspace == null)
                return;

            var dependencies = CustomNodeManager.GetAllDependenciesGuids(def);
            var funcNodes = homeWorkspace.Nodes.OfType<Function>();
            var dirtyNodes = funcNodes.Where(n => dependencies.Contains(n.Definition.FunctionId));
            homeWorkspace.MarkNodesAsModifiedAndRequestRun(dirtyNodes);
        }

        /// <summary>
        /// Call this method to reset the virtual machine, avoiding a race
        /// condition by using a thread join inside the vm executive.
        /// </summary>
        /// <param name="markNodesAsDirty">Set this parameter to true to force
        /// reset of the execution substrate. Note that setting this parameter
        /// to true will have a negative performance impact.</param>
        public virtual void ResetEngine(bool markNodesAsDirty = false)
        {
            // TODO(Luke): Push this into a resync call with the engine controller
            //
            // Tracked in MAGN-5167.
            // As some async tasks use engine controller, for example
            // CompileCustomNodeAsyncTask and UpdateGraphAsyncTask, it is possible
            // that engine controller is reset *before* tasks get executed. For
            // example, opening custom node will schedule a CompileCustomNodeAsyncTask
            // firstly and then reset engine controller.
            //
            // We should make sure engine controller is reset after all tasks that
            // depend on it get executed, or those tasks are thrown away if safe to
            // do that.

            ResetEngineInternal();
            foreach (var workspaceModel in Workspaces.OfType<HomeWorkspaceModel>())
            {
                workspaceModel.ResetEngine(EngineController, markNodesAsDirty);
            }
        }

        protected void ResetEngineInternal()
        {
            if (EngineController != null)
            {
                EngineController.RequestCustomNodeRegistration -= EngineController_RequestCustomNodeRegistration;
                EngineController.TraceReconcliationComplete -= EngineController_TraceReconcliationComplete;
                EngineController.MessageLogged -= LogMessage;
                EngineController.Dispose();
                EngineController = null;
            }

            EngineController = new EngineController(
                LibraryServices,
                geometryFactoryPath,
                DebugSettings.VerboseLogging);

            EngineController.MessageLogged += LogMessage;
            EngineController.TraceReconcliationComplete += EngineController_TraceReconcliationComplete;
            EngineController.RequestCustomNodeRegistration += EngineController_RequestCustomNodeRegistration;

            foreach (var def in CustomNodeManager.LoadedDefinitions)
                RegisterCustomNodeDefinitionWithEngine(def);
        }

        private void EngineController_RequestCustomNodeRegistration(object sender, EventArgs e)
        {
            foreach (var def in CustomNodeManager.LoadedDefinitions)
                RegisterCustomNodeDefinitionWithEngine(def);
        }

        /// <summary>
        ///     Forces an evaluation of the current workspace by resetting the DesignScript VM.
        /// </summary>
        public void ForceRun()
        {
            Logger.Log("Beginning engine reset");

            ResetEngine(true);

            Logger.Log("Reset complete");

            ((HomeWorkspaceModel)CurrentWorkspace).Run();
        }

        #endregion

        #region save/load

        /// <summary>
        /// Opens a Dynamo workspace from a Json string.
        /// </summary>
        /// <param name="fileContents">Json file content</param>
        /// <param name="forceManualExecutionMode">Set this to true to discard
        /// execution mode specified in the file and set manual mode</param>
        public void OpenFileFromJson(string fileContents, bool forceManualExecutionMode = false)
        {
            OpenJsonFileFromPath(fileContents, "", forceManualExecutionMode);
            return;
        }

        /// <summary>
        /// Opens a Dynamo workspace from a path to a file on disk.
        /// </summary>
        /// <param name="filePath">Path to file</param>
        /// <param name="forceManualExecutionMode">Set this to true to discard
        /// execution mode specified in the file and set manual mode</param>
        public void OpenFileFromPath(string filePath, bool forceManualExecutionMode = false)
        {
            
            Exception ex;            
            string fileContents;
            if (DynamoUtilities.PathHelper.isValidJson(filePath, out fileContents, out ex))
            {
                OpenJsonFileFromPath(fileContents, filePath, forceManualExecutionMode);
                return;
            }
            else
            {
                // These kind of exceptions indicate that file is not accessible 
                if (ex is IOException || ex is UnauthorizedAccessException)
                {
                    throw ex;
                }

                XmlDocument xmlDoc;

                // When Json opening failed, either this file is corrupted or file might be XML
                if (ex is JsonReaderException && DynamoUtilities.PathHelper.isValidXML(filePath, out xmlDoc, out ex))
                {
                    OpenXmlFileFromPath(xmlDoc, filePath, forceManualExecutionMode);
                    return;
                }
                else
                {
                    throw ex;
                }                
            }            
        }

        /// <summary>
        /// Opens a Dynamo workspace from a path to a template on disk.
        /// </summary>
        /// <param name="filePath">Path to file</param>
        /// <param name="forceManualExecutionMode">Set this to true to discard
        /// execution mode specified in the file and set manual mode</param>
        public void OpenTemplateFromPath(string filePath, bool forceManualExecutionMode = false)
        {

            if (DynamoUtilities.PathHelper.isValidJson(filePath, out string fileContents, out Exception ex))
            {
                OpenJsonFileFromPath(fileContents, filePath, forceManualExecutionMode, true);
            }
            else
            {
                // These kind of exceptions indicate that file is not accessible 
                if (ex is IOException || ex is UnauthorizedAccessException || ex is JsonReaderException)
                {
                    throw ex;
                }
            }
        }

        /// <summary>
        /// Inserts a Dynamo graph or Custom Node inside the current workspace from a file path
        /// </summary>
        /// <param name="filePath"></param>
        /// <param name="forceManualExecutionMode"></param>
        public void InsertFileFromPath(string filePath, bool forceManualExecutionMode = false)
        {
            Exception ex;
            string fileContents;

            if (DynamoUtilities.PathHelper.isValidJson(filePath, out fileContents, out ex))
            {
                InsertJsonFileFromPath(fileContents, filePath, forceManualExecutionMode);
                return;
            }
            else
            {
                // These kind of exceptions indicate that file is not accessible 
                if (ex is IOException || ex is UnauthorizedAccessException)
                {
                    throw ex;
                }

                if (ex is JsonReaderException)
                {
                    XmlDocument xmlDoc;
                    if (DynamoUtilities.PathHelper.isValidXML(filePath, out xmlDoc, out ex))
                    {
                        InsertXmlFileFromPath(xmlDoc, filePath, forceManualExecutionMode);
                        return;
                    }
                }
                else
                {
                    throw ex;
                }
            }
        }

        static private DynamoPreferencesData DynamoPreferencesDataFromJson(string json)
        {
            JsonReader reader = new JsonTextReader(new StringReader(json));
            var obj = JObject.Load(reader);
            var viewBlock = obj["View"];
            var dynamoBlock = viewBlock == null ? null : viewBlock[Configurations.DynamoAsString];
            if (dynamoBlock == null)
                return DynamoPreferencesData.Default();

            var settings = new JsonSerializerSettings
            {
                Error = (sender, args) =>
                {
                    args.ErrorContext.Handled = true;
                    Console.WriteLine(args.ErrorContext.Error);
                },
                ReferenceLoopHandling = ReferenceLoopHandling.Ignore,
                TypeNameHandling = TypeNameHandling.None,
                Formatting = Newtonsoft.Json.Formatting.Indented,
                Culture = CultureInfo.InvariantCulture
            };

            return JsonConvert.DeserializeObject<DynamoPreferencesData>(dynamoBlock.ToString(), settings);
        }

        /// <summary>
        /// Opens a Dynamo workspace from a path to an JSON file on disk.
        /// </summary>
        /// <param name="fileContents">Json file contents</param>
        /// <param name="filePath">Path to file</param>
        /// <param name="forceManualExecutionMode">Set this to true to discard
        /// execution mode specified in the file and set manual mode</param>
        /// <param name="isTemplate">Set this to true to indicate that the file is a template</param>
        /// <returns>True if workspace was opened successfully</returns>
        private bool OpenJsonFileFromPath(string fileContents, string filePath, bool forceManualExecutionMode, bool isTemplate = false)
        {
            try
            {
                DynamoPreferencesData dynamoPreferences = DynamoPreferencesDataFromJson(fileContents);
                if (dynamoPreferences != null)
                {
                    // TODO, QNTM-1101: Figure out JSON migration strategy
                    if (true) //MigrationManager.ProcessWorkspace(dynamoPreferences.Version, xmlDoc, IsTestMode, NodeFactory))
                    {
                        WorkspaceModel ws;
                        if (OpenJsonFile(filePath, fileContents, dynamoPreferences, forceManualExecutionMode, isTemplate, out ws))
                        {
                            OpenWorkspace(ws);
                            //Raise an event to deserialize the view parameters before
                            //setting the graph to run
                            OnComputeModelDeserialized();

                            SetPeriodicEvaluation(ws);
                        }
                    }
                }
                return true;
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
#pragma warning disable CA2200 // Rethrow to preserve stack details
                throw e;
#pragma warning restore CA2200 // Rethrow to preserve stack details
            }
        }

        private bool InsertJsonFileFromPath(string fileContents, string filePath, bool forceManualExecutionMode)
        {
            try
            {
                // Update (assign new) Guids for each node, connection, note and group
                // The update of Guids is necessary to assure the insertion of dynamo graphs does not interfere with the current workspace
                // This allows multiple inserts of the same or 'similar' graph to take place
                fileContents = GuidUtility.UpdateWorkspaceGUIDs(fileContents);

                DynamoPreferencesData dynamoPreferences = DynamoPreferencesDataFromJson(fileContents);
                if (dynamoPreferences != null)
                {
                    if (true) //MigrationManager.ProcessWorkspace(dynamoPreferences.Version, xmlDoc, IsTestMode, NodeFactory))
                    {
                        if (OpenJsonFile(filePath, fileContents, dynamoPreferences, forceManualExecutionMode, false, out WorkspaceModel ws))
                        {
                            ExtraWorkspaceViewInfo viewInfo = ExtraWorkspaceViewInfo.ExtraWorkspaceViewInfoFromJson(fileContents);

                            InsertWorkspace(ws, viewInfo);
                        }
                    }
                }
                return true;
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
#pragma warning disable CA2200 // Rethrow to preserve stack details
                throw e;
#pragma warning restore CA2200 // Rethrow to preserve stack details
            }
        }

        /// <summary>
        /// Opens a Dynamo workspace from a path to an Xml file on disk.
        /// </summary>
        /// <param name="xmlDoc">xml file content</param>
        /// <param name="filePath">Path to file</param>
        /// <param name="forceManualExecutionMode">Set this to true to discard
        /// execution mode specified in the file and set manual mode</param>
        /// <returns>True if workspace was opened successfully</returns>
        private bool OpenXmlFileFromPath(XmlDocument xmlDoc, string filePath, bool forceManualExecutionMode)
        {
            try
            {
                //save the file before it is migrated to JSON.
                //if in test mode, don't save the file in backup
                if (!IsTestMode)
                {
                    if (!pathManager.BackupXMLFile(xmlDoc, filePath))
                    {
                        Logger.Log("File is not saved in the backup folder {0}: ", pathManager.BackupDirectory);
                    }
                }

                WorkspaceInfo workspaceInfo;
                if (WorkspaceInfo.FromXmlDocument(xmlDoc, filePath, IsTestMode, forceManualExecutionMode, Logger, out workspaceInfo))
                {
                    if (MigrationManager.ProcessWorkspace(workspaceInfo, xmlDoc, IsTestMode, NodeFactory))
                    {
                        WorkspaceModel ws;
                        if (OpenXmlFile(workspaceInfo, xmlDoc, out ws))
                        {
                            OpenWorkspace(ws);

                            // Set up workspace cameras here
                            OnWorkspaceOpening(xmlDoc);
                            SetPeriodicEvaluation(ws);
                        }
                    }
                }
                return true;
            }
            catch (Exception)
            {
                return false;
            }
        }

        private bool InsertXmlFileFromPath(XmlDocument xmlDoc, string filePath, bool forceManualExecutionMode)
        {
            try
            {
                //save the file before it is migrated to JSON.
                //if in test mode, don't save the file in backup
                if (!IsTestMode)
                {
                    if (!pathManager.BackupXMLFile(xmlDoc, filePath))
                    {
                        Logger.Log("File is not saved in the backup folder {0}: ", pathManager.BackupDirectory);
                    }
                }

                WorkspaceInfo workspaceInfo;
                if (WorkspaceInfo.FromXmlDocument(xmlDoc, filePath, IsTestMode, forceManualExecutionMode, Logger, out workspaceInfo))
                {
                    if (MigrationManager.ProcessWorkspace(workspaceInfo, xmlDoc, IsTestMode, NodeFactory))
                    {
                        WorkspaceModel ws;
                        if (OpenXmlFile(workspaceInfo, xmlDoc, out ws))
                        {
                            InsertWorkspace(ws);
                        }
                    }
                }
                return true;
            }
            catch (Exception)
            {
                return false;
            }
        }

        private void OpenWorkspace(WorkspaceModel ws)
        {
            // TODO: #4258
            // The logic to remove all other home workspaces from the model
            // was moved from the ViewModel. When #4258 is implemented, we will need to
            // remove this step.
            var currentHomeSpaces = Workspaces.OfType<HomeWorkspaceModel>().ToList();
            if (currentHomeSpaces.Any())
            {
                // If the workspace we're opening is a home workspace,
                // then remove all the other home workspaces. Otherwise,
                // Remove all but the first home workspace.
                var end = ws is HomeWorkspaceModel ? 0 : 1;

                for (var i = currentHomeSpaces.Count - 1; i >= end; i--)
                {
                    RemoveWorkspace(currentHomeSpaces[i]);
                }
            }

            AddWorkspace(ws);
            CurrentWorkspace = ws;
            OnWorkspaceOpened(ws);
        }

        private void InsertWorkspace(WorkspaceModel ws, ExtraWorkspaceViewInfo viewInfo = null)
        {
            var nodes = ws.Nodes;
            var connectors = ws.Connectors;
            var notes = viewInfo?.Annotations;

            DynamoSelection.Instance.ClearSelection();

            if ((nodes == null && notes == null) || (!nodes.Any() && !notes.Any()) || (NodesAlreadyLoaded(nodes) || NotesAlreadyLoaded(notes)))
            {
                OnRequestNotification(Resources.FailedInsertFileNodeExistNotification);

                return;
            }

            double offsetX = 0.0;
            double offsetY = 0.0;
            double nodeX = 0.0;
            double nodeY = 0.0;

            if (viewInfo != null)
            {
                // Get the offsets before we insert the nodes
                GetInsertNodesOffset(currentWorkspace.Nodes, viewInfo.NodeViews, out offsetX, out offsetY, out nodeX, out nodeY);
            }

            InsertNodes(nodes, nodeX, nodeY);
            InsertConnectors(connectors);

            CurrentWorkspace.UpdateWithExtraWorkspaceViewInfo(viewInfo, offsetX, offsetY);

            if (viewInfo != null)
            {
                List<NoteModel> insertedNotes = GetInsertedNotes(viewInfo.Annotations);
                DynamoSelection.Instance.Selection.AddRange(insertedNotes);
            }

            DynamoSelection.Instance.Selection.AddRange(nodes);

            currentWorkspace.HasUnsavedChanges = true;
        }

        private void SetPeriodicEvaluation(WorkspaceModel ws)
        {
            // TODO: #4258
            // The following logic to start periodic evaluation will need to be moved
            // inside of the HomeWorkspaceModel's constructor.  It cannot be there today
            // as it causes an immediate crash due to the above ResetEngine call.
            var hws = ws as HomeWorkspaceModel;
            if (hws != null)
            {
                // TODO: #4258
                // Remove this ResetEngine call when multiple home workspaces is supported.
                // This call formerly lived in DynamoViewModel
                ResetEngine(false);

                if (hws.RunSettings.RunType == RunType.Periodic)
                {
                    hws.StartPeriodicEvaluation();
                }
            }
        }

        private bool OpenJsonFile(
          string filePath,
          string fileContents,
          DynamoPreferencesData dynamoPreferences,
          bool forceManualExecutionMode,
          bool isTemplate,
          out WorkspaceModel workspace)
        {
            if (!string.IsNullOrEmpty(filePath))
            {
                CustomNodeManager.AddUninitializedCustomNodesInPath(Path.GetDirectoryName(filePath), IsTestMode);
            }

            var currentHomeSpace = Workspaces.OfType<HomeWorkspaceModel>().FirstOrDefault();
            currentHomeSpace.UndefineCBNFunctionDefinitions();

            // This is to handle the case of opening a JSON file that does not have a version string
            EngineController.CurrentWorkspaceVersion = dynamoPreferences.Version ==
                                         null ? AssemblyHelper.GetDynamoVersion() : new Version(dynamoPreferences.Version);

            // TODO, QNTM-1108: WorkspaceModel.FromJson does not check a schema and so will not fail as long
            // as the fileContents are valid JSON, regardless of if all required data is present or not
            workspace = WorkspaceModel.FromJson(
                fileContents,
                LibraryServices,
                EngineController,
                Scheduler,
                NodeFactory,
                IsTestMode,
                false,
                CustomNodeManager,
                this.LinterManager);

            workspace.FileName = string.IsNullOrEmpty(filePath) || isTemplate? string.Empty : filePath;
            workspace.FromJsonGraphId = string.IsNullOrEmpty(filePath) ? WorkspaceModel.ComputeGraphIdFromJson(fileContents) : string.Empty;
            workspace.ScaleFactor = dynamoPreferences.ScaleFactor;
            workspace.IsTemplate = isTemplate;
            
            if (!IsTestMode && !IsHeadless)
            {
                if (workspace.ContainsLegacyTraceData)
                {
                    OnRequestNotification(Resources.LegacyTraceDataWarning, true);
                }
            }

            if (workspace is HomeWorkspaceModel homeWorkspace)
            {
                homeWorkspace.EnableLegacyPolyCurveBehavior ??= PreferenceSettings.DefaultEnableLegacyPolyCurveBehavior;

                homeWorkspace.HasRunWithoutCrash = dynamoPreferences.HasRunWithoutCrash;

                homeWorkspace.ReCompileCodeBlockNodesForFunctionDefinitions();

                if (string.IsNullOrEmpty(workspace.FileName))
                {
                    workspace.HasUnsavedChanges = true;
                }

                RunType runType;
                if (!homeWorkspace.HasRunWithoutCrash || !Enum.TryParse(dynamoPreferences.RunType, false, out runType) || forceManualExecutionMode)
                    runType = RunType.Manual;
                int runPeriod;
                if (!Int32.TryParse(dynamoPreferences.RunPeriod, out runPeriod))
                    runPeriod = RunSettings.DefaultRunPeriod;
                homeWorkspace.RunSettings = new RunSettings(runType, runPeriod);

                RegisterHomeWorkspace(homeWorkspace);
            }

            CustomNodeWorkspaceModel customNodeWorkspace = workspace as CustomNodeWorkspaceModel;
            if (customNodeWorkspace != null)
                customNodeWorkspace.IsVisibleInDynamoLibrary = dynamoPreferences.IsVisibleInDynamoLibrary;

            return true;
        }

        // Attempts to reload all the dummy nodes in the current workspace and replaces them with resolved version. 
        private void ReloadDummyNodes()
        {
            JObject dummyNodeJSON = null;
            Boolean resolvedDummyNode = false;

            WorkspaceModel currentWorkspace = this.CurrentWorkspace;

            if (currentWorkspace == null || string.IsNullOrEmpty(currentWorkspace.FileName))
            {
                return;
            }

            // Get the dummy nodes in the current workspace. 
            var dummyNodes = currentWorkspace.Nodes.OfType<DummyNode>();

            foreach (DummyNode dn in dummyNodes)
            {
                dummyNodeJSON = dn.OriginalNodeContent as JObject;

                if (dummyNodeJSON != null)
                {
                    // Deserializing the dummy node and verifying if it is resolved by the downloaded or imported package
                    NodeModel resolvedNode = dn.GetNodeModelForDummyNode(
                                                               dummyNodeJSON.ToString(),
                                                               LibraryServices,
                                                               NodeFactory,
                                                               IsTestMode,
                                                               CustomNodeManager);

                    // If the resolved node is also a dummy node, then skip it else replace the dummy node with the resolved version of the node. 
                    if (!(resolvedNode is DummyNode))
                    {
                        currentWorkspace.RemoveAndDisposeNode(dn);
                        currentWorkspace.AddAndRegisterNode(resolvedNode, false);

                        // Adding back the connectors for the resolved node. 
                        List<ConnectorModel> connectors = dn.AllConnectors.ToList();
                        foreach (var connectorModel in connectors)
                        {
                            var startNode = connectorModel.Start.Owner;
                            var endNode = connectorModel.End.Owner;

                            if (startNode is DummyNode && startNode.GUID == resolvedNode.GUID)
                            {
                                startNode = resolvedNode;
                            }
                            if (endNode is DummyNode && endNode.GUID == resolvedNode.GUID)
                            {
                                endNode = resolvedNode;
                            }

                            connectorModel.Delete();
                            ConnectorModel.Make(startNode, endNode, connectorModel.Start.Index, connectorModel.End.Index, connectorModel.GUID);
                        }
                        resolvedDummyNode = true;
                    }
                }
            }

            if (resolvedDummyNode)
            {
                currentWorkspace.HasUnsavedChanges = false;
                // Once all the dummy nodes are reloaded, the DummyNodesReloaded event is invoked and
                // the Dependency table is regenerated in the WorkspaceDependencyView extension. 
                currentWorkspace.OnDummyNodesReloaded();
            }
        }

        private bool OpenXmlFile(WorkspaceInfo workspaceInfo, XmlDocument xmlDoc, out WorkspaceModel workspace)
        {
            CustomNodeManager.AddUninitializedCustomNodesInPath(
                Path.GetDirectoryName(workspaceInfo.FileName),
                IsTestMode);

            var result = workspaceInfo.IsCustomNodeWorkspace
                ? CustomNodeManager.OpenCustomNodeWorkspace(xmlDoc, workspaceInfo, IsTestMode, out workspace)
                : OpenXmlHomeWorkspace(xmlDoc, workspaceInfo, out workspace);

            workspace.OnCurrentOffsetChanged(
                this,
                new PointEventArgs(new Point2D(workspaceInfo.X, workspaceInfo.Y)));

            workspace.ScaleFactor = workspaceInfo.ScaleFactor;
            return result;
        }

        private bool OpenXmlHomeWorkspace(
            XmlDocument xmlDoc, WorkspaceInfo workspaceInfo, out WorkspaceModel workspace)
        {
            var nodeGraph = NodeGraph.LoadGraphFromXml(xmlDoc, NodeFactory);
            Guid deterministicId = GuidUtility.Create(GuidUtility.UrlNamespace, workspaceInfo.Name);

            var loadedTraceData = Utils.LoadTraceDataFromXmlDocument(xmlDoc, out var containsLegacyTraceData);
            if (!IsTestMode && !IsHeadless)
            {
                if (containsLegacyTraceData) OnRequestNotification(Resources.LegacyTraceDataWarning, true);
            }

            var newWorkspace = new HomeWorkspaceModel(
                deterministicId,
                EngineController,
                Scheduler,
                NodeFactory,
                loadedTraceData,
                nodeGraph.Nodes,
                nodeGraph.Notes,
                nodeGraph.Annotations,
                nodeGraph.Presets,
                nodeGraph.ElementResolver,
                workspaceInfo,
                DebugSettings.VerboseLogging,
                IsTestMode,
                LinterManager
               );

            RegisterHomeWorkspace(newWorkspace);

            workspace = newWorkspace;
            return true;
        }

        private void RegisterHomeWorkspace(HomeWorkspaceModel newWorkspace)
        {
            newWorkspace.EvaluationCompleted += OnEvaluationCompleted;
            newWorkspace.RefreshCompleted += OnRefreshCompleted;

            newWorkspace.Disposed += () =>
            {
                newWorkspace.EvaluationCompleted -= OnEvaluationCompleted;
                newWorkspace.RefreshCompleted -= OnRefreshCompleted;
            };
        }

        #endregion

        #region backup/timer

        /// <summary>
        /// Backup all the files
        /// </summary>
        protected void SaveBackupFiles(object state)
        {
            //No backup files in ServiceMode due to Lambda restrictions
            if (IsServiceMode)
            {
                return;
            }

            OnRequestDispatcherBeginInvoke(() =>
            {
                // tempDict stores the list of backup files and their corresponding workspaces IDs
                // when the last auto-save operation happens. Now the IDs will be used to know
                // whether some workspaces have already been backed up. If so, those workspaces won't be
                // backed up again.
                var tempDict = new Dictionary<Guid, string>(backupFilesDict);
                backupFilesDict.Clear();
                PreferenceSettings.BackupFiles.Clear();
                foreach (var workspace in Workspaces)
                {
                    if (!workspace.HasUnsavedChanges)
                    {
                        if (workspace.Nodes.Any() &&
                            !workspace.Notes.Any())
                            continue;

                        if (tempDict.ContainsKey(workspace.Guid))
                        {
                            backupFilesDict.Add(workspace.Guid, tempDict[workspace.Guid]);
                            continue;
                        }
                    }

                    var savePath = pathManager.GetBackupFilePath(workspace);
                    OnRequestWorkspaceBackUpSave(savePath, true);
                    backupFilesDict[workspace.Guid] = savePath;
                    Logger.Log(Resources.BackupSavedMsg + ": " + savePath);
                }
                PreferenceSettings.BackupFiles.AddRange(backupFilesDict.Values);
            });
        }

        /// <summary>
        /// Start the timer to backup files periodically
        /// </summary>
        private void StartBackupFilesTimer()
        {
            // When running test cases, the dispatcher may be null which will cause the timer to
            // introduce a lot of threads. So the timer will not be started if test cases are running.
            if (IsTestMode)
                return;

            if (backupFilesTimer != null)
            {
                throw new Exception("The timer to backup files has already been started!");
            }

            backupFilesTimer = new Timer(SaveBackupFiles);
            backupFilesTimer.Change(PreferenceSettings.BackupInterval, PreferenceSettings.BackupInterval);
            Logger.Log(String.Format("Backup files timer is started with an interval of {0} milliseconds", PreferenceSettings.BackupInterval));
        }

        #endregion

        #region internal methods

        internal void PostUIActivation(object parameter)
        {
            Logger.Log(Environment.NewLine + Resources.WelcomeMessage);
        }

        internal void DeleteModelInternal(List<ModelBase> modelsToDelete)
        {
            if (null == CurrentWorkspace)
                return;

            //Check for empty group
            var annotations = Workspaces
                .SelectMany(ws => ws.Annotations)
                .OrderBy(x => x.HasNestedGroups);

            foreach (var annotation in annotations)
            {
                //record the annotation before the models in it are deleted.
                foreach (var model in modelsToDelete)
                {
                    //If there is only one model, then deleting that model should delete the group. In that case, do not record
                    //the group for modification. Until we have one model in a group, group should be recorded for modification
                    //otherwise, undo operation cannot get the group back.
                    if (annotation.Nodes.Count() > 1 &&
                        annotation.Nodes.Where(x => x.GUID == model.GUID).Any())
                    {
                        CurrentWorkspace.RecordGroupModelBeforeUngroup(annotation);
                    }
                }

                if (annotation.Nodes.Any() && !annotation.Nodes.Except(modelsToDelete).Any(n => n is not ConnectorPinModel))
                {
                    //Annotation Model has to be serialized first - before the nodes.
                    //so, store the Annotation model as first object. This will serialize the
                    //annotation before the nodes are deleted. So, when Undo is pressed,
                    //annotation model is deserialized correctly.
                    modelsToDelete.Insert(0, annotation);
                }
            }

            var cancelEventArgs = new CancelEventArgs();
            OnDeletionStarted(modelsToDelete, cancelEventArgs);
            if (cancelEventArgs.Cancel)
            {
                return;
            }

            CurrentWorkspace.RecordAndDeleteModels(modelsToDelete);

            var selection = DynamoSelection.Instance.Selection;
            foreach (ModelBase model in modelsToDelete)
            {
                selection.Remove(model); // Remove from selection set.
                model.Dispose();
            }

            OnDeletionComplete(this, EventArgs.Empty);
        }

        internal void UngroupModel(List<ModelBase> modelsToUngroup)
        {
            var emptyGroup = new List<ModelBase>();
            var annotations = Workspaces.SelectMany(ws => ws.Annotations);
            foreach (var model in modelsToUngroup)
            {
                foreach (var annotation in annotations)
                {
                    if (annotation.Nodes.Any(x => x.GUID == model.GUID))
                    {
                        var list = annotation.Nodes.ToList();

                        if (list.Count > 1)
                        {
                            CurrentWorkspace.RecordGroupModelBeforeUngroup(annotation);
                            if (list.Remove(model))
                            {
                                if (!list.Any(n => n is not ConnectorPinModel))
                                {
                                    emptyGroup.Add(annotation);
                                }
                                else
                                {
                                    if (model is ConnectorPinModel pinModel)
                                    {
                                        annotation.MarkPinAsRemoved(pinModel);
                                    }
                                    annotation.Nodes = list;
                                    annotation.UpdateBoundaryFromSelection();
                                }
                            }
                        }
                        else
                        {
                            emptyGroup.Add(annotation);
                        }
                    }
                }
            }

            if (emptyGroup.Any())
            {
                DeleteModelInternal(emptyGroup);
            }
        }

        internal void AddToGroup(List<ModelBase> modelsToAdd)
        {
            var workspaceAnnotations = Workspaces.SelectMany(ws => ws.Annotations);
            var selectedGroups = workspaceAnnotations
                .Where(x => x.IsSelected && x.IsExpanded);

            // If multiple groups are selected, chances are that we
            // have a group that contains a nested group.
            // If this is the case we want to make sure that we add the
            // node to the parent folder.
            var selectedGroup = selectedGroups.FirstOrDefault(x => x.HasNestedGroups) ??
                selectedGroups.FirstOrDefault();

            if (selectedGroup != null)
            {
                foreach (var model in modelsToAdd)
                {
                    CurrentWorkspace.RecordGroupModelBeforeUngroup(selectedGroup);
                    selectedGroup.AddToTargetAnnotationModel(model);
                }
            }

        }

        /// <summary>
        /// Add a list of annotations to the host group on model level.
        /// </summary>
        /// <param name="modelsToAdd">List of annotation models.</param>
        /// <param name="hostGroupGuid">Host annotation guid.</param>
        internal void AddGroupsToGroup(List<ModelBase> modelsToAdd, Guid hostGroupGuid)
        {
            var workspaceAnnotations = Workspaces.SelectMany(ws => ws.Annotations);
            var selectedGroup = workspaceAnnotations.FirstOrDefault(x => x.GUID == hostGroupGuid);
            if (selectedGroup is null) return;

            var modelsToModify = new List<ModelBase>();
            modelsToModify.AddRange(modelsToAdd);
            modelsToModify.Add(selectedGroup);

            // Mark the parent group and groups to add all for undo recorder
            WorkspaceModel.RecordModelsForModification(modelsToModify, CurrentWorkspace.UndoRecorder);
            foreach (var model in modelsToAdd)
            {
                selectedGroup.AddToTargetAnnotationModel(model);
            }
        }

        internal void DumpLibraryToXml(object parameter)
        {
            string fileName = String.Format("LibrarySnapshot_{0}.xml", DateTime.Now.ToString("yyyyMMddHmmss"));
            string fullFileName = Path.Combine(pathManager.LogDirectory, fileName);

            SearchModel?.DumpLibraryToXml(fullFileName, PathManager.DynamoCoreDirectory);

            Logger.Log(string.Format(Resources.LibraryIsDumped, fullFileName));
        }

        internal bool CanDumpLibraryToXml(object obj)
        {
            return true;
        }

        #endregion

        #region public methods

        /// <summary>
        /// Set UI culture based on preferences
        /// </summary>
        public static void SetUICulture(string locale)
        {
            if (string.IsNullOrWhiteSpace(locale)) return;

            //Validate that the provided locale against the supported locales
            locale = Configurations.SupportedLocaleDic.FirstOrDefault(x => x.Value == locale).Value ?? Configurations.SupportedLocaleDic.FirstOrDefault().Value;

            // Setting the locale for Dynamo from loaded Preferences, with Default handled differently
            // between a non-in-process integration case (when HostAnalyticsInfo.HostName is unspecified)
            // and in-process integration case. In later case, Default setting means following host locale.
            if (string.IsNullOrEmpty(HostAnalyticsInfo.HostName))
            {
                // Sandbox default to en-US
                Thread.CurrentThread.CurrentUICulture = new CultureInfo(locale == "Default" ? "en-US" : locale);
                Thread.CurrentThread.CurrentCulture = new CultureInfo(locale == "Default" ? "en-US" : locale);
            }
            else
            {
                var defaultCulture = CultureInfo.DefaultThreadCurrentCulture ?? new CultureInfo("en-US");
                // Integration default to DefaultThreadCurrentCulture set by integrator
                Thread.CurrentThread.CurrentUICulture = locale == "Default" ? defaultCulture : new CultureInfo(locale);
                Thread.CurrentThread.CurrentCulture = locale == "Default" ? defaultCulture : new CultureInfo(locale);
            }
        }

        /// <summary>
        ///     Add a new HomeWorkspace and set as current
        /// </summary>
        /// <api_stability>1</api_stability>
        public void AddHomeWorkspace()
        {
            var defaultWorkspace = new HomeWorkspaceModel(
                EngineController,
                Scheduler,
                NodeFactory,
                DebugSettings.VerboseLogging,
                IsTestMode, LinterManager, string.Empty);

            defaultWorkspace.RunSettings.RunType = PreferenceSettings.DefaultRunType;

            RegisterHomeWorkspace(defaultWorkspace);
            AddWorkspace(defaultWorkspace);
            CurrentWorkspace = defaultWorkspace;
        }

        /// <summary>
        ///     Add a new, visible Custom Node workspace to Dynamo
        /// </summary>
        /// <param name="workspace"><see cref="CustomNodeWorkspaceModel"/> to add</param>
        public void AddCustomNodeWorkspace(CustomNodeWorkspaceModel workspace)
        {
            AddWorkspace(workspace);
        }

        private void CheckForInvalidInputSymbols(WorkspaceModel workspace)
        {
            if (workspace.containsInvalidInputSymbols() && !IsTestMode)
            {
                DisplayInvalidInputSymbolWarning();
            }
        }

        private void DisplayInvalidInputSymbolWarning()
        {
            string summary = Resources.InvalidInputSymbolWarningShortMessage;
            var description = Resources.InvalidInputSymbolWarningMessage;
            const string imageUri = "/DynamoCoreWpf;component/UI/Images/task_dialog_future_file.png";
            var args = new TaskDialogEventArgs(
               new Uri(imageUri, UriKind.Relative),
               Resources.InvalidInputSymbolWarningTitle, summary, description);

            args.AddRightAlignedButton((int)ButtonId.Proceed, Resources.OKButton);
            OnRequestTaskDialog(null, args);
        }

        internal event VoidHandler Preview3DOutage;
        private void OnPreview3DOutage()
        {
            if (Preview3DOutage != null)
            {
                Preview3DOutage();
            }
        }

        internal void Report3DPreviewOutage(string summary, string description)
        {
            OnPreview3DOutage();

            const string imageUri = "/DynamoCoreWpf;component/UI/Images/task_dialog_future_file.png";
            var args = new TaskDialogEventArgs(
               new Uri(imageUri, UriKind.Relative),
               Resources.Preview3DOutageTitle, summary, description);

            OnRequestTaskDialog(null, args);
        }

        /// <summary>
        ///     Remove a workspace from the dynamo model.
        /// </summary>
        /// <param name="workspace">Workspace to remove</param>
        public void RemoveWorkspace(WorkspaceModel workspace)
        {
            OnWorkspaceRemoveStarted(workspace);
            if (_workspaces.Remove(workspace))
            {   
                if (workspace is HomeWorkspaceModel)
                {
                    workspace.Dispose();
                }
                OnWorkspaceRemoved(workspace);
            }
        }

        /// <summary>
        ///     Opens an existing custom node workspace.
        /// </summary>
        /// <param name="guid">Identifier of the workspace to open</param>
        /// <returns>True if workspace was found and open</returns>
        public bool OpenCustomNodeWorkspace(Guid guid)
        {
            CustomNodeWorkspaceModel customNodeWorkspace;
            if (CustomNodeManager.TryGetFunctionWorkspace(guid, IsTestMode, out customNodeWorkspace))
            {
                if (!Workspaces.OfType<CustomNodeWorkspaceModel>().Contains(customNodeWorkspace))
                {
                    AddWorkspace(customNodeWorkspace);
                }

                CurrentWorkspace = customNodeWorkspace;
                return true;
            }

            return false;
        }
        /// <summary>
        ///     Opens an existing custom node workspace.
        /// </summary>
        /// <param name="guid">Identifier of the workspace to open</param>
        /// <returns>True if workspace was found and open</returns>
        internal bool OpenCustomNodeWorkspaceSilent(Guid guid)
        {
            CustomNodeWorkspaceModel customNodeWorkspace;
            if (CustomNodeManager.TryGetFunctionWorkspace(guid, IsTestMode, out customNodeWorkspace))
            {
                if (!Workspaces.OfType<CustomNodeWorkspaceModel>().Contains(customNodeWorkspace))
                {
                    AddWorkspace(customNodeWorkspace);
                }

                return true;
            }

            return false;
        }

        /// <summary>
        ///     Adds a node to the current workspace.
        /// </summary>
        /// <param name="node">Node to add</param>
        /// <param name="centered">Indicates if the node should be placed
        /// at the center of workspace.</param>
        /// <param name="addToSelection">Indicates if the newly added node
        /// should be selected</param>
        internal void AddNodeToCurrentWorkspace(NodeModel node, bool centered, bool addToSelection = true)
        {
            CurrentWorkspace.AddAndRegisterNode(node, centered);

            //TODO(Steve): This should be moved to WorkspaceModel.AddNode when all workspaces have their own selection -- MAGN-5707
            if (addToSelection)
            {
                DynamoSelection.Instance.ClearSelection();
                DynamoSelection.Instance.Selection.Add(node);
            }

            //TODO(Steve): Make sure we're not missing something with TransformCoordinates. -- MAGN-5708
        }

        /// <summary>
        /// Copy selected ISelectable objects to the clipboard.
        /// </summary>
        public void Copy()
        {
            ClipBoard.Clear();

            foreach (
                var el in
                    DynamoSelection.Instance.Selection.OfType<ModelBase>()
                        .Where(el => !ClipBoard.Contains(el)))
            {
                ClipBoard.Add(el);

                if (!(el is NodeModel))
                    continue;

                var node = el as NodeModel;
                var connectors =
                    node.InPorts.Concat(node.OutPorts).SelectMany(port => port.Connectors)
                        .Where(
                            connector =>
                                connector.End != null && connector.End.Owner.IsSelected
                                    && !ClipBoard.Contains(connector));

                ClipBoard.AddRange(connectors);
            }
        }

        /// <summary>
        ///     Paste ISelectable objects from the clipboard to the workspace
        /// so that the nodes appear in their original location with a slight offset
        /// </summary>
        public void Paste()
        {
            var locatableModels = ClipBoard.Where(model => model is NoteModel || model is NodeModel);
            var x = locatableModels.Min(m => m.X);
            var y = locatableModels.Min(m => m.Y);
            var targetPoint = new Point2D(x, y);

            Paste(targetPoint);
        }

        /// <summary>
        ///     Paste ISelectable objects from the clipboard to the workspace at specified point.
        /// </summary>
        /// <param name="targetPoint">Location where data will be pasted</param>
        /// <param name="useOffset">Indicates whether we will use current workspace offset or paste nodes
        /// directly in this point. </param>
        public void Paste(Point2D targetPoint, bool useOffset = true)
        {
            //When called from somewhere other than StateMachine and only ConnectorPins are selected.
            if (ClipBoard.All(m => m is ConnectorPinModel))
            {
                return;
            }
            if (useOffset)
            {
                // Provide a small offset when pasting so duplicate pastes aren't directly on top of each other
                CurrentWorkspace.IncrementPasteOffset();
            }

            //clear the selection so we can put the
            //paste contents in
            DynamoSelection.Instance.ClearSelection();

            //make a lookup table to store the guids of the
            //old models and the guids of their pasted versions
            var modelLookup = new Dictionary<Guid, ModelBase>();

            //make a list of all newly created models so that their
            //creations can be recorded in the undo recorder.
            var createdModels = new List<ModelBase>();

            var nodes = ClipBoard.OfType<NodeModel>();
            var connectors = ClipBoard.OfType<ConnectorModel>();
            var notes = ClipBoard.OfType<NoteModel>();
            // we only want to get groups that either has nested groups
            // or does not belong to a group here.
            // We handle creation of nested groups when creating the
            // parent group.
            var annotations = ClipBoard.OfType<AnnotationModel>();

            var xmlDoc = new XmlDocument();

            // Create the new NodeModel's
            var newNodeModels = new List<NodeModel>();
            using (CurrentWorkspace.BeginDelayedGraphExecution())
            {
                foreach (var node in nodes)
                {
                    NodeModel newNode;

                    if (CurrentWorkspace is HomeWorkspaceModel && (node is Symbol || node is Output))
                    {
                        var symbol = (node is Symbol
                            ? (node as Symbol).InputSymbol
                            : (node as Output).Symbol);
                        var code = (string.IsNullOrEmpty(symbol) ? "x" : symbol) + ";";
                        newNode = new CodeBlockNodeModel(code, node.X, node.Y, LibraryServices, CurrentWorkspace.ElementResolver);
                    }
                    else
                    {
                        var dynEl = node.Serialize(xmlDoc, SaveContext.Copy);
                        newNode = NodeFactory.CreateNodeFromXml(dynEl, SaveContext.Copy, CurrentWorkspace.ElementResolver);
                    }

                    var lacing = node.ArgumentLacing.ToString();
                    newNode.UpdateValue(new UpdateValueParams("ArgumentLacing", lacing));
                    if (!string.IsNullOrEmpty(node.Name) && !(node is Symbol) && !(node is Output))
                        newNode.Name = node.Name;

                    newNode.Width = node.Width;
                    newNode.Height = node.Height;

                    modelLookup.Add(node.GUID, newNode);

                    newNodeModels.Add(newNode);
                }

                // Create the new NoteModel's
                var newNoteModels = new List<NoteModel>();
                foreach (var note in notes)
                {
                    var noteModel = new NoteModel(note.X, note.Y, note.Text, Guid.NewGuid());
                    if (note.PinnedNode != null)
                    {
                        ModelBase pinned;
                        var pinnedNode =
                            modelLookup.TryGetValue(note.PinnedNode.GUID, out pinned)
                            ? pinned as NodeModel
                            : CurrentWorkspace.Nodes.FirstOrDefault(x => x.GUID == note.PinnedNode.GUID);
                        noteModel = new NoteModel(note.X, note.Y, note.Text, Guid.NewGuid(), pinnedNode);
                    }
                    //Store the old note as Key and newnote as value.
                    modelLookup.Add(note.GUID, noteModel);
                    newNoteModels.Add(noteModel);
                }

                var newItems = newNodeModels.Concat<ModelBase>(newNoteModels);

                var shiftX = targetPoint.X - newItems.Min(item => item.X);
                var shiftY = targetPoint.Y - newItems.Min(item => item.Y);
                var offset = useOffset ? CurrentWorkspace.CurrentPasteOffset : 0;

                foreach (var model in newItems)
                {
                    model.X = model.X + shiftX + offset;
                    model.Y = model.Y + shiftY + offset;
                }

                // Add the new NodeModel's to the Workspace
                foreach (var newNode in newNodeModels)
                {
                    CurrentWorkspace.AddAndRegisterNode(newNode, false);
                    createdModels.Add(newNode);
                }

                // TODO: is this required?
                OnRequestLayoutUpdate(this, EventArgs.Empty);

                // Add the new NoteModel's to the Workspace
                foreach (var newNote in newNoteModels)
                {
                    CurrentWorkspace.AddNote(newNote, false);
                    createdModels.Add(newNote);
                }

                ModelBase start;
                ModelBase end;
                var newConnectors =
                    from c in connectors

                        // If the guid is in nodeLookup, then we connect to the new pasted node. Otherwise we
                        // re-connect to the original.
                    let startNode =
                            modelLookup.TryGetValue(c.Start.Owner.GUID, out start)
                                ? start as NodeModel
                                : CurrentWorkspace.Nodes.FirstOrDefault(x => x.GUID == c.Start.Owner.GUID)
                    let endNode =
                        modelLookup.TryGetValue(c.End.Owner.GUID, out end)
                            ? end as NodeModel
                            : CurrentWorkspace.Nodes.FirstOrDefault(x => x.GUID == c.End.Owner.GUID)

                    // Don't make a connector if either end is null.
                    where startNode != null && endNode != null
                    select
                        ConnectorModel.Make(startNode, endNode, c.Start.Index, c.End.Index);

                createdModels.AddRange(newConnectors);

                //Grouping depends on the selected node models.
                //so adding the group after nodes / notes are added to workspace.
                //select only those nodes that are part of a group.
                var newAnnotations = new List<AnnotationModel>();
                foreach (var annotation in annotations.OrderByDescending(a => a.HasNestedGroups))
                {
                    if (modelLookup.ContainsKey(annotation.GUID))
                    {
                        continue;
                    }

                    // If this group has nested group we need to create them first
                    if (annotation.HasNestedGroups)
                    {
                        foreach (var group in annotation.Nodes.OfType<AnnotationModel>())
                        {
                            var nestedGroup = CreateAnnotationModel(
                                group,
                                modelLookup
                                    .Where(x => group.Nodes.Select(y => y.GUID).Contains(x.Key))
                                    .ToDictionary(x => x.Key, x => x.Value)
                                );

                            newAnnotations.Add(nestedGroup);
                            modelLookup.Add(group.GUID, nestedGroup);
                        }
                    }

                    var annotationModel = CreateAnnotationModel(annotation, modelLookup);

                    newAnnotations.Add(annotationModel);
                }

                DynamoSelection.Instance.ClearSelectionDisabled = true;

                // Add the new Annotation's to the Workspace
                foreach (var newAnnotation in newAnnotations)
                {
                    CurrentWorkspace.AddAnnotation(newAnnotation);
                    createdModels.Add(newAnnotation);
                    AddToSelection(newAnnotation);
                }

                // adding an annotation overrides selection, so add nodes and notes after
                foreach (var item in newItems)
                {
                    AddToSelection(item);
                }

                DynamoSelection.Instance.ClearSelectionDisabled = false;

                // Record models that are created as part of the command.
                CurrentWorkspace.RecordCreatedModels(createdModels);
            }
        }

        private AnnotationModel CreateAnnotationModel(
            AnnotationModel model, Dictionary<Guid, ModelBase> modelLookup)
        {
            var annotationNodeModel = new List<NodeModel>();
            var annotationNoteModel = new List<NoteModel>();
            var annotationAnnotationModels = new List<AnnotationModel>();
            // some models can be deleted after copying them,
            // so they need to be in pasted annotation as well
            var modelsToRestore = model.DeletedModelBases.Intersect(ClipBoard);
            var modelsToAdd = model.Nodes.Concat(modelsToRestore);

            // checked condition here that supports pasting of multiple groups
            foreach (var models in modelsToAdd)
            {
                ModelBase mbase;
                modelLookup.TryGetValue(models.GUID, out mbase);
                if (mbase is NodeModel nodeBase)
                {
                    annotationNodeModel.Add(nodeBase);
                }
                else if (mbase is NoteModel noteBase)
                {
                    annotationNoteModel.Add(noteBase);
                }
                else if (mbase is AnnotationModel annotationM)
                {
                    annotationAnnotationModels.Add(annotationM);
                }
            }

            var annotationModel = new AnnotationModel(annotationNodeModel, annotationNoteModel, annotationAnnotationModels)
            {
                GUID = Guid.NewGuid(),
                AnnotationText = model.AnnotationText,
                AnnotationDescriptionText = model.AnnotationDescriptionText,
                HeightAdjustment = model.HeightAdjustment,
                WidthAdjustment = model.WidthAdjustment,
                Background = model.Background,
                FontSize = model.FontSize,
                GroupStyleId = model.GroupStyleId,
            };

            modelLookup.Add(model.GUID, annotationModel);
            return annotationModel;
        }

        /// <summary>
        ///     Add an ISelectable object to the selection.
        /// </summary>
        /// <param name="parameters">The object to add to the selection.</param>
        public void AddToSelection(object parameters)
        {
            var selectable = parameters as ISelectable;
            if (selectable != null)
            {
                DynamoSelection.Instance.Selection.AddUnique(selectable);
            }
        }

        /// <summary>
        ///     Clear the workspace. Removes all nodes, notes, and connectors from the current workspace.
        /// </summary>
        public void ClearCurrentWorkspace()
        {
            OnWorkspaceClearingStarted(CurrentWorkspace);
            OnWorkspaceClearing();

            CurrentWorkspace.Clear();
            if (CurrentWorkspace is HomeWorkspaceModel)
            {
                //Sets the home workspace run type based on the preferences settings value
                ((HomeWorkspaceModel)CurrentWorkspace).RunSettings.RunType = PreferenceSettings.DefaultRunType;
            }

            //don't save the file path
            CurrentWorkspace.FileName = "";
            CurrentWorkspace.HasUnsavedChanges = false;
            EngineController.CurrentWorkspaceVersion = AssemblyHelper.GetDynamoVersion();

            this.LinterManager?.SetDefaultLinter();

            OnWorkspaceCleared(CurrentWorkspace);
        }

        #endregion

        #region private methods

        private void LogMessage(ILogMessage obj)
        {
            Logger.Log(obj);
        }

        private void LogMessageWrapper(string m)
        {
            LogMessage(Dynamo.Logging.LogMessage.Info(m));
        }

        private void LogErrorMessageWrapper(string m)
        {
            LogMessage(Dynamo.Logging.LogMessage.Error(m));
        }

#if DEBUG_LIBRARY
        private void DumpLibrarySnapshot(IEnumerable<Engine.FunctionGroup> functionGroups)
        {
            if (null == functionGroups)
                return;

            var descriptions =
                functionGroups.Select(functionGroup => functionGroup.Functions.ToList())
                    .Where(functions => functions.Any())
                    .SelectMany(
                        functions =>
                            (from function in functions
                             where function.IsVisibleInLibrary
                             let displayString = function.UserFriendlyName
                             where !displayString.Contains("GetType")
                             select string.IsNullOrEmpty(function.Namespace)
                                ? ""
                                : function.Namespace + "." + function.Signature + "\n"));

            var sb = string.Join("\n", descriptions);

            Logger.Log(sb, LogLevel.File);
        }
#endif

        private NodeModelSearchElement AddNodeTypeToSearch(TypeLoadData typeLoadData)
        {
            if (!typeLoadData.IsDSCompatible || typeLoadData.IsDeprecated || typeLoadData.IsHidden
                || typeLoadData.IsMetaNode)
            {
                return null;
            }
            var namespaces = PreferenceSettings.NamespacesToExcludeFromLibrary;
            if (namespaces.Any(ns =>
                {
                    var namespc = ns.Split(":").LastOrDefault();

                    return namespc != null && namespc.Contains(typeLoadData.Category);
                }))
            {
                return null;
            }
                if(PreferenceSettings.InitialExperimentalLib_Namespaces.
                Select(x => x.Split(":").LastOrDefault()).Any(x => x.Contains(typeLoadData.Category))){
                //TODO safer way to set this?
                typeLoadData.IsExperimental = true;
            }

            var node = new NodeModelSearchElement(typeLoadData);
            SearchModel?.Add(node);
            return node;
        }

        /// <summary>
        /// Remove node information from Lucene indexing.
        /// </summary>
        /// <param name="node">node info that needs to be removed.</param>
        internal void RemoveNodeTypeFromSearchIndex(NodeSearchElement node)
        {
            var term = new Term(nameof(LuceneConfig.NodeFieldsEnum.Name), node.Name);

            LuceneUtility.writer?.DeleteDocuments(term);
            LuceneUtility.CommitWriterChanges();
        }

        /// <summary>
        /// This method updates the node search library to either hide or unhide nodes that belong
        /// to a specified assembly name and namespace. These nodes will be hidden from the node
        /// library sidebar and from the node search.
        /// </summary>
        /// <param name="hide">Set to true to hide, set to false to unhide.</param>
        /// <param name="library">The assembly name of the library.</param>
        /// <param name="namespc">The namespace of the nodes to be hidden.</param>
        internal void HideUnhideNamespace(bool hide, string library, string namespc)
        {
            var str = library + ':' + namespc;
            var namespaces = PreferenceSettings.NamespacesToExcludeFromLibrary;

            if (hide)
            {
                if (!namespaces.Contains(str))
                {
                    namespaces.Add(str);
                }
            }
            else // unhide
            {
                namespaces.Remove(str);
            }
        }

        internal void AddZeroTouchNodesToSearch(IEnumerable<FunctionGroup> functionGroups)
        {
            var iDoc = LuceneUtility.InitializeIndexDocumentForNodes();
            List<NodeSearchElement> nodes = new();

            foreach (var funcGroup in functionGroups)
            {
                foreach (var functionDescriptor in funcGroup.Functions)
                {
                    if (functionDescriptor.IsVisibleInLibrary)
                    {
                        var ele = new ZeroTouchSearchElement(functionDescriptor);
                        SearchModel?.Add(ele);
                        nodes.Add(ele);
                    }
                }
            }
            LuceneUtility.AddNodeTypeToSearchIndex(nodes, iDoc);
        }

        /// <summary>
        ///     Adds a workspace to the dynamo model.
        /// </summary>
        /// <param name="workspace"></param>
        public void AddWorkspace(WorkspaceModel workspace)
        {
            if (workspace == null) return;

            Action savedHandler = () => OnWorkspaceSaved(workspace);
            workspace.Saved += savedHandler;
            Action<SaveContext> savingHandler = (c) => OnWorkspaceSaving(workspace, c);
            workspace.WorkspaceSaving += savingHandler;
            workspace.MessageLogged += LogMessage;
            workspace.PropertyChanged += OnWorkspacePropertyChanged;
            workspace.Disposed += () =>
            {
                workspace.Saved -= savedHandler;
                workspace.WorkspaceSaving -= savingHandler;
                workspace.MessageLogged -= LogMessage;
                workspace.PropertyChanged -= OnWorkspacePropertyChanged;
            };

            _workspaces.Add(workspace);
            CheckForXMLDummyNodes(workspace);
            CheckForInvalidInputSymbols(workspace);
            OnWorkspaceAdded(workspace);
        }

        private void CheckForXMLDummyNodes(WorkspaceModel workspace)
        {
            //if the graph that is opened contains xml dummynodes log a notification 
            if (workspace.containsXmlDummyNodes())
            {
                this.Logger.LogNotification("DynamoViewModel",
                  Resources.UnresolvedNodesWarningTitle,
                  Resources.UnresolvedNodesWarningShortMessage,
                  Resources.UnresolvedNodesWarningMessage);
                if (!IsTestMode)
                {
                    DisplayXmlDummyNodeWarning();
                }
                //raise a window as well so the user is clearly alerted to this state.
            }
        }
        private void DisplayXmlDummyNodeWarning()
        {
            var xmlDummyNodeCount = this.CurrentWorkspace.Nodes.OfType<DummyNode>().
                 Where(node => node.OriginalNodeContent is XmlElement).Count();

            string summary = Resources.UnresolvedNodesWarningShortMessage;
            var description = Resources.UnresolvedNodesWarningMessage;
            const string imageUri = "/DynamoCoreWpf;component/UI/Images/task_dialog_future_file.png";
            var args = new TaskDialogEventArgs(
               new Uri(imageUri, UriKind.Relative),
               Resources.UnresolvedNodesWarningTitle, summary, description);

            args.AddRightAlignedButton((int)ButtonId.Proceed, Resources.OKButton);
            OnRequestTaskDialog(null, args);
        }

        internal enum ButtonId
        {
            Ok = 43420,
            Cancel,
            DownloadLatest,
            Proceed,
            Submit
        }

        /// <summary>
        /// Call this method to display a message box when a file of an older
        /// version cannot be opened by the current version of Dynamo.
        /// </summary>
        /// <param name="fullFilePath"></param>
        /// <param name="fileVersion">Version of the input file.</param>
        /// <param name="currVersion">Current version of the Dynamo.</param>
        private void DisplayObsoleteFileMessage(string fullFilePath, Version fileVersion, Version currVersion)
        {
            var fileVer = ((fileVersion != null) ? fileVersion.ToString() : "Unknown");
            var currVer = ((currVersion != null) ? currVersion.ToString() : "Unknown");

            string summary = Resources.FileCannotBeOpened;
            var description =
                string.Format(
                    Resources.ObsoleteFileDescription,
                    fullFilePath,
                    fileVersion,
                    currVersion);

            const string imageUri = "/DynamoCoreWpf;component/UI/Images/task_dialog_obsolete_file.png";
            var args = new TaskDialogEventArgs(
                new Uri(imageUri, UriKind.Relative),
                Resources.ObsoleteFileTitle,
                summary,
                description);

            args.AddRightAlignedButton((int)ButtonId.Ok, Resources.OKButton);

            OnRequestTaskDialog(null, args);
        }

        /// <summary>
        /// Call this method to display an error message in an event when live
        /// runner throws an exception that is not handled anywhere else. This
        /// message instructs user to save their work and restart Dynamo.
        /// </summary>
        /// <param name="exception">The exception to display.</param>
        private TaskDialogEventArgs DisplayEngineFailureMessage(Exception exception)
        {
            Dynamo.Logging.Analytics.TrackEvent(Actions.EngineFailure, Categories.Stability);

            if (exception != null)
            {
                Dynamo.Logging.Analytics.TrackException(exception, false);
            }

            string summary = Resources.UnhandledExceptionSummary;

            string description = Resources.DisplayEngineFailureMessageDescription;

            const string imageUri = "/DynamoCoreWpf;component/UI/Images/task_dialog_crash.png";
            var args = new TaskDialogEventArgs(
                new Uri(imageUri, UriKind.Relative),
                Resources.UnhandledExceptionTitle,
                summary,
                description);

            args.AddRightAlignedButton((int)ButtonId.Submit, Resources.SubmitBugButton);
            args.AddRightAlignedButton((int)ButtonId.Ok, Resources.ArggOKButton);
            args.Exception = exception;

            OnRequestTaskDialog(null, args);
            if (args.ClickedButtonId == (int)ButtonId.Submit)
                OnRequestBugReport();

            return args;
        }

        /// <summary>
        /// Displays file open error dialog if the file is of a future version than the currently installed version.
        /// </summary>
        /// <param name="fullFilePath"></param>
        /// <param name="fileVersion"></param>
        /// <param name="currVersion"></param>
        /// <returns> true if the file must be opened and false otherwise. </returns>
        private bool DisplayFutureFileMessage(string fullFilePath, Version fileVersion, Version currVersion)
        {
            string summary = Resources.FutureFileSummary;
            var description = string.Format(Resources.FutureFileDescription, fullFilePath, fileVersion, currVersion);

            const string imageUri = "/DynamoCoreWpf;component/UI/Images/task_dialog_future_file.png";
            var args = new TaskDialogEventArgs(
                new Uri(imageUri, UriKind.Relative),
                Resources.FutureFileTitle, summary, description)
            { ClickedButtonId = (int)ButtonId.Cancel };

            args.AddRightAlignedButton((int)ButtonId.Cancel, Resources.CancelButton);
            args.AddRightAlignedButton((int)ButtonId.DownloadLatest, Resources.DownloadLatestButton);
            args.AddRightAlignedButton((int)ButtonId.Proceed, Resources.ProceedButton);

            OnRequestTaskDialog(null, args);
            if (args.ClickedButtonId == (int)ButtonId.DownloadLatest)
            {
                // this should be an event on DynamoModel
                OnRequestDownloadDynamo();
                return false;
            }

            return args.ClickedButtonId == (int)ButtonId.Proceed;
        }

        private void OnWorkspacePropertyChanged(object sender, PropertyChangedEventArgs args)
        {
            if (args.PropertyName == "RunEnabled")
                OnPropertyChanged("RunEnabled");

            if (args.PropertyName == "EnablePresetOptions")
                OnPropertyChanged("EnablePresetOptions");
        }

        #region insert private methods

        private void InsertNodes(IEnumerable<NodeModel> nodes, double offsetX, double offsetY)
        {
            foreach (var node in nodes)
            {
                if (currentWorkspace.Nodes.Any(n => n.GUID == node.GUID))
                {
                    continue;  // prevent loading the same node twice
                }

                currentWorkspace.AddAndRegisterNode(node, false);
            }
            RecordUndoModels(currentWorkspace, nodes.Cast<ModelBase>().ToList());
        }


        private void InsertConnectors(IEnumerable<ConnectorModel> connectors)
        {
            List<ConnectorModel> newConnectors = new List<ConnectorModel>();

            foreach (var connectorModel in connectors)
            {
                var startNode = connectorModel.Start.Owner;
                var endNode = connectorModel.End.Owner;

                var usedConnectors = currentWorkspace.Connectors.Where(n => n.GUID == connectorModel.GUID);

                foreach (var connector in usedConnectors)
                {
                    connector.Delete();
                }

                var newConnector = ConnectorModel.Make(startNode, endNode, connectorModel.Start.Index, connectorModel.End.Index, connectorModel.GUID);
                newConnectors.Add(newConnector);
            }

            RecordUndoModels(currentWorkspace, newConnectors.Cast<ModelBase>().ToList());
        }

        private List<NoteModel> GetInsertedNotes(IEnumerable<ExtraAnnotationViewInfo> viewInfoAnnotations)
        {
            List<NoteModel> result = new List<NoteModel>();

            foreach (var annotation in viewInfoAnnotations)
            {
                if (annotation.Nodes.Any()) continue;

                var guidValue = WorkspaceModel.IdToGuidConverter(annotation.Id);
                var matchingNote = CurrentWorkspace.Notes.FirstOrDefault(x => x.GUID == guidValue);

                if (matchingNote != null)
                {
                    result.Add(matchingNote);
                }
            }
            RecordUndoModels(currentWorkspace, result.Cast<ModelBase>().ToList());

            return result;
        }

        internal static void RecordUndoModels(WorkspaceModel workspace, List<ModelBase> undoItems)
        {
            var userActionDictionary = new Dictionary<ModelBase, UndoRedoRecorder.UserAction>();
            //Add models that were newly created
            foreach (var undoItem in undoItems)
            {
                userActionDictionary.Add(undoItem, UndoRedoRecorder.UserAction.Creation);
            }

            WorkspaceModel.RecordModelsForUndo(userActionDictionary, workspace.UndoRecorder);
        }

        private void GetInsertNodesOffset(IEnumerable<NodeModel> currentWorkspaceNodes
            , IEnumerable<ExtraNodeViewInfo> insertedNodes
            , out double offsetX
            , out double offsetY
            , out double nodeOffsetX
            , out double nodeOffsetY)
        {
            if (!currentWorkspaceNodes.Any())
            {
                offsetX = offsetY = nodeOffsetX = nodeOffsetY = 0;
                return;
            }

            double currentX, currentY, nodeX, nodeY;
            GetRelativeInsertPoints(currentWorkspaceNodes, out currentX, out currentY);
            GetRelativeInsertPoints(insertedNodes, out nodeX, out nodeY);
            nodeOffsetX = currentX;
            nodeOffsetY = currentY + INSERT_VERTICAL_OFFSET_VALUE;

            offsetX = currentX - nodeX;
            offsetY = currentY - nodeY + INSERT_VERTICAL_OFFSET_VALUE;
        }

        private void GetRelativeInsertPoints(IEnumerable<NodeModel> nodes, out double x, out double y)
        {
            NodeModel nodeX = null;
            foreach (var n in nodes)
            {
                if (nodeX == null)
                {
                    nodeX = n;
                    continue;
                }
                if (n.CenterX < nodeX.CenterX)
                {
                    nodeX = n;
                }
            }

            var minX = nodeX.CenterX;
            var minXWidth = nodeX.Width;
            x = minX - minXWidth * 0.5;
            y = nodes.Max(n => n.CenterY);
        }

        private void GetRelativeInsertPoints(IEnumerable<ExtraNodeViewInfo> nodes, out double x, out double y)
        {
            ExtraNodeViewInfo nodeX = null;
            foreach (var n in nodes)
            {
                if (nodeX == null)
                {
                    nodeX = n;
                    continue;
                }
                if (n.X < nodeX.X)
                {
                    nodeX = n;
                }
            }

            x = nodeX.X;
            y = nodes.Min(n => n.Y);
        }

        private bool NodesAlreadyLoaded(IEnumerable<NodeModel> nodes)
        {
            foreach (var node in nodes)
            {
                if (currentWorkspace.Nodes.Any(n => n.GUID == node.GUID))
                {
                    // if at least one node is inside the workspace, return true
                    return true;
                }
            }
            // If no nodes exist with the same GUID, then we are good to go
            return false;
        }

        private bool NotesAlreadyLoaded(IEnumerable<ExtraAnnotationViewInfo> notes)
        {
            if (notes == null) return false;

            foreach (var note in notes)
            {
                if (currentWorkspace.Notes.Any(n => n.GUID.ToString() == note.Id))
                {
                    // if at least one node is inside the workspace, return true
                    return true;
                }
            }
            // If no notes exist with the same GUID, then we are good to go
            return false;
        }
        #endregion

        #endregion
    }
}