Merge pull request #39 from sillsdev/sp-2359-prevent-crash-from-config-file-problems

SP-2359: Do not crash in constructor if config file cannot be upgrade… (#39)

Author: tombogle

.github/workflows/PR.yml

@@ -1,6 +1,7 @@
 on:
   pull_request:
     branches: [ master ]
+
 jobs:
   build:
     strategy:
@@ -14,14 +15,14 @@ jobs:
       with:
         fetch-depth: 0
 
-    - name: Install .NET Core
-      uses: actions/setup-dotnet@77a48bbb85cd3809790223e895ba4b6cbc110fe8
+    - name: Install .NET SDK
+      uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: 5.0.x
+        dotnet-version: '8.0.x'
 
     - name: Build
       run: dotnet build
 
     - name: Test
+      if: runner.os == 'Windows'
       run: dotnet test
-

src/DesktopAnalytics/Analytics.cs

@@ -10,6 +10,7 @@
 using System.Net;
 using System.Reflection;
 using System.Runtime.InteropServices;
+using System.Threading;
 using System.Xml.Linq;
 using System.Xml.XPath;
 using JetBrains.Annotations;
@@ -172,9 +173,23 @@ public Analytics(string apiSecret, UserInfo userInfo, Dictionary<string,
 			if (AnalyticsSettings.Default.NeedUpgrade)
 			{
 				//see http://stackoverflow.com/questions/3498561/net-applicationsettingsbase-should-i-call-upgrade-every-time-i-load
-				AnalyticsSettings.Default.Upgrade();
-				AnalyticsSettings.Default.NeedUpgrade = false;
-				AnalyticsSettings.Default.Save();
+				try
+				{
+					AnalyticsSettings.Default.Upgrade();
+					AnalyticsSettings.Default.NeedUpgrade = false;
+					TrySaveSettings();
+				}
+				catch (ConfigurationErrorsException e)
+				{
+					try
+					{
+						Console.WriteLine(e);
+					}
+					catch
+					{
+						Debug.WriteLine(e);
+					}
+				}
 			}
 
 			if (IsNullOrEmpty(AnalyticsSettings.Default.IdForAnalytics))
@@ -195,9 +210,8 @@ public Analytics(string apiSecret, UserInfo userInfo, Dictionary<string,
 
 			if (IsNullOrEmpty(AnalyticsSettings.Default.IdForAnalytics))
 			{
-
 				AnalyticsSettings.Default.IdForAnalytics = Guid.NewGuid().ToString();
-				AnalyticsSettings.Default.Save();
+				TrySaveSettings();
 			}
 
 			s_locationInfo = new JsonObject();
@@ -236,7 +250,31 @@ public Analytics(string apiSecret, UserInfo userInfo, Dictionary<string,
 			// See http://issues.bloomlibrary.org/youtrack/issue/BL-4011.
 
 			AnalyticsSettings.Default.LastVersionLaunched = versionNumberWithBuild;
-			AnalyticsSettings.Default.Save();
+			TrySaveSettings();
+		}
+
+		private static void TrySaveSettings()
+		{
+			int retryCount = 0;
+			do
+			{
+				try
+				{
+					AnalyticsSettings.Default.Save();
+					return;
+				}
+				catch (Exception e)
+				{
+					try
+					{
+						Console.WriteLine(e);
+					}
+					catch
+					{
+					}
+					Thread.Sleep(300);
+				}
+			} while (++retryCount < 3);
 		}
 
 		private void AttemptToGetUserIdSettingsFromDifferentChannel()
@@ -309,7 +347,7 @@ private void AttemptToGetUserIdSettingsFromDifferentChannel()
 						AnalyticsSettings.Default.LastName = ExtractSetting(AnalyticsSettings.Default.LastName, doc, "LastName");
 						AnalyticsSettings.Default.LastVersionLaunched = ExtractSetting(AnalyticsSettings.Default.LastVersionLaunched, doc, "LastVersionLaunched");
 						AnalyticsSettings.Default.Email = ExtractSetting(AnalyticsSettings.Default.Email, doc, "Email");
-						AnalyticsSettings.Default.Save();
+						TrySaveSettings();
 						return;
 					}
 					catch (Exception)

src/DesktopAnalyticsTests/UserInfoTests.cs

@@ -11,7 +11,7 @@ public class UserInfoTests
 		[Test]
 		public void CreateSanitized_AllFieldsNull_NoChange()
 		{
-			var orig = new UserInfo() { Email = null, FirstName = null, LastName = null, OtherProperties = null };
+			var orig = new UserInfo { Email = null, FirstName = null, LastName = null, OtherProperties = null };
 			var sanitized = orig.CreateSanitized();
 			Assert.IsNull(sanitized.Email);
 			Assert.IsNull(sanitized.FirstName);
@@ -22,7 +22,7 @@ public void CreateSanitized_AllFieldsNull_NoChange()
 		[Test]
 		public void CreateSanitized_AllFieldsWhitespace_NoChange()
 		{
-			var orig = new UserInfo() { Email = "  ", FirstName = "", LastName = "    ", OtherProperties = new AttributeDictionary() };
+			var orig = new UserInfo { Email = "  ", FirstName = "", LastName = "    ", OtherProperties = new AttributeDictionary() };
 			orig.OtherProperties.Add("   ", " \r\n ");
 			var sanitized = orig.CreateSanitized();
 			Assert.AreEqual("  ", sanitized.Email);
@@ -34,7 +34,7 @@ public void CreateSanitized_AllFieldsWhitespace_NoChange()
 		[Test]
 		public void CreateSanitized_AllFieldsSingleLetter_FirstNameAndLastNameHashed_NoChagneToOtherFields()
 		{
-			var orig = new UserInfo() { Email = "e", FirstName = "f", LastName = "L", OtherProperties = new AttributeDictionary() };
+			var orig = new UserInfo { Email = "e", FirstName = "f", LastName = "L", OtherProperties = new AttributeDictionary() };
 			orig.OtherProperties.Add("a", "b");
 			var sanitized = orig.CreateSanitized();
 			Assert.AreEqual("e", sanitized.Email);
@@ -48,7 +48,7 @@ public void CreateSanitized_AllFieldsSingleLetter_FirstNameAndLastNameHashed_NoC
 		[Test]
 		public void CreateSanitized_NormalData_FirstNameAndLastNameHashed_EmailDomainPreserved()
 		{
-			var orig = new UserInfo() { Email = "Wanda_Finkelstein@gumbyland.org", FirstName = "Wanda", LastName = "Finkelstein", OtherProperties = new AttributeDictionary() };
+			var orig = new UserInfo { Email = "Wanda_Finkelstein@gumbyland.org", FirstName = "Wanda", LastName = "Finkelstein", OtherProperties = new AttributeDictionary() };
 			orig.OtherProperties.Add("Important", "stuff");
 			var sanitized = orig.CreateSanitized();
 			Assert.AreEqual("@gumbyland.org", sanitized.Email);
@@ -64,7 +64,7 @@ public void CreateSanitized_NormalData_FirstNameAndLastNameHashed_EmailDomainPre
 		[Test]
 		public void CreateSanitized_InvalidEmailAddressMissingDomain_EmailIsAtSign()
 		{
-			var orig = new UserInfo() { Email = "Buck@", FirstName = "Buck", LastName = "", OtherProperties = new AttributeDictionary() };
+			var orig = new UserInfo { Email = "Buck@", FirstName = "Buck", LastName = "", OtherProperties = new AttributeDictionary() };
 			var sanitized = orig.CreateSanitized();
 			Assert.AreEqual("@", sanitized.Email);
 			Assert.IsTrue(sanitized.FirstName.StartsWith("B"));
@@ -77,7 +77,7 @@ public void CreateSanitized_InvalidEmailAddressMissingDomain_EmailIsAtSign()
 		[Test]
 		public void CreateSanitized_InvalidEmailAddressMultipleAtSigns_EmailIsEverythingAfterFirstAtSign()
 		{
-			var orig = new UserInfo() { Email = "What@is@this@nonesense@.c.o.m", FirstName = "", LastName = "" };
+			var orig = new UserInfo { Email = "What@is@this@nonesense@.c.o.m", FirstName = "", LastName = "" };
 			var sanitized = orig.CreateSanitized();
 			Assert.AreEqual("@is@this@nonesense@.c.o.m", sanitized.Email);
 			Assert.AreEqual("", sanitized.FirstName);