DYN-6470 Improve Dynamo PreferenceSettings.Instance singleton behavior. (#14658)

saintentropy · web-flow · commit d8db34eae83e · 2023-12-04T14:18:15.000-05:00
* Add passthrough to DynamoModel.PreferenceSettings when available

* remove reference

* Don't need to reset the reference

* Simplify and invert

* update test

---------

Co-authored-by: Craig Long &lt;craig.long@autodesk.com&gt;
diff --git a/src/DynamoCore/Configuration/PreferenceSettings.cs b/src/DynamoCore/Configuration/PreferenceSettings.cs
@@ -53,7 +53,7 @@ internal readonly static Lazy<PreferenceSettings>
             (() => PreferenceSettings.Load(PathManager.Instance.PreferenceFilePath));
 
         [XmlIgnore]
-        public static PreferenceSettings Instance { get { return lazy.Value; } }
+        public static PreferenceSettings Instance { get; internal set; } = lazy.Value;
 
         private string numberFormat;
         private string lastUpdateDownloadPath;
diff --git a/src/DynamoCore/Models/DynamoModel.cs b/src/DynamoCore/Models/DynamoModel.cs
@@ -287,7 +287,8 @@ public static string Version
         /// <summary>
         ///     Preference settings for this instance of Dynamo.
         /// </summary>
-        public readonly PreferenceSettings PreferenceSettings;
+        [Obsolete("this will be removed in 4.0")]
+        public PreferenceSettings PreferenceSettings => PreferenceSettings.Instance;
 
         /// <summary>
         ///     Node Factory, used for creating and intantiating loaded Dynamo nodes.
@@ -672,7 +673,8 @@ protected DynamoModel(IStartConfiguration config)
 
             OnRequestUpdateLoadBarStatus(new SplashScreenLoadEventArgs(Resources.SplashScreenInitPreferencesSettings, 30));
 
-            PreferenceSettings = (PreferenceSettings)CreateOrLoadPreferences(config.Preferences);
+            PreferenceSettings.Instance = (PreferenceSettings)CreateOrLoadPreferences(config.Preferences);
+
             if (PreferenceSettings != null)
             {
                 SetUICulture(PreferenceSettings.Locale);
@@ -751,7 +753,7 @@ protected DynamoModel(IStartConfiguration config)
                 if (migrator != null)
                 {
                     var isFirstRun = PreferenceSettings.IsFirstRun;
-                    PreferenceSettings = migrator.PreferenceSettings;
+                    PreferenceSettings.Instance = migrator.PreferenceSettings;
 
                     // Preserve the preference settings for IsFirstRun as this needs to be set
                     // only by UsageReportingManager
diff --git a/test/Libraries/DynamoPythonTests/PythonTestsWithLogging.cs b/test/Libraries/DynamoPythonTests/PythonTestsWithLogging.cs
@@ -33,16 +33,15 @@ protected override DynamoModel.IStartConfiguration CreateStartConfiguration(IPre
         [Test]
         public void DynamoPrintLogsToConsole()
         {
-            var expectedOutput = ".*Greeting CPython node: Hello from Python3!!!" + Environment.NewLine
-                + ".*Greeting CPython String node: Hello from Python3!!!" + Environment.NewLine
-                + ".*Greeting CPython String node: Hello from Python3!!!" + Environment.NewLine
-                + ".*Multiple print parameter node: Hello Dynamo Print !!!" + Environment.NewLine
-                + ".*Print separator parameter node: Hello_Dynamo_Print_!!!" + Environment.NewLine
-                + ".*`!\"£\\$%\\^&\\*\\(\\)_\\+-\\[\\{\\]\\}#~'@;:\\|\\\\,<\\.>/\\? Special character node: Lot's of special characters!!!" + Environment.NewLine
-                + ".*";
+            var expectedOutput = "Greeting CPython node: Hello from Python3!!!" + Environment.NewLine
+                  + "Greeting CPython String node: Hello from Python3!!!" + Environment.NewLine
+                  + "Greeting CPython String node: Hello from Python3!!!" + Environment.NewLine
+                  + "Multiple print parameter node: Hello Dynamo Print !!!" + Environment.NewLine
+                  + "Print separator parameter node: Hello_Dynamo_Print_!!!" + Environment.NewLine
+                  + @"`!£$%^&*()_+-[{]}#~'@;:|\,<.>/? Special character node: Lot's of special characters!!!";
 
             CurrentDynamoModel.OpenFileFromPath(Path.Combine(TestDirectory, "core", "python", "DynamoPrint.dyn"));
-            StringAssert.IsMatch(expectedOutput, CurrentDynamoModel.Logger.LogText);
+            StringAssert.Contains(expectedOutput, CurrentDynamoModel.Logger.LogText);
         }
 
         [Test]
diff --git a/test/core/python/DynamoPrint.dyn b/test/core/python/DynamoPrint.dyn
@@ -387,8 +387,8 @@
       },
       {
         "ShowGeometry": true,
-        "Name": "`!\"£$%^&*()_+-[{]}#~'@;:|\\,<.>/? Special character node",
         "Id": "da61a0ad7b024ec3bc05c63503a70358",
+        "Name": "`!£$%^&*()_+-[{]}#~'@;:|\\,<.>/? Special character node",
         "IsSetAsInput": false,
         "IsSetAsOutput": false,
         "Excluded": false,
