Skip GA Client Tear Down Process if NOT Necessary (#10340)

* Skip Analytics Client Tear down if it is not needed * Add unit test covering analytics tear down * Touch test naming
DynamoDS · Feb 10, 2020 · 5bc2f39 · 5bc2f39
1 parent 9cec99e
commit 5bc2f39
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 7 deletions.
diff --git a/src/DynamoCore/Logging/DynamoAnalyticsClient.cs b/src/DynamoCore/Logging/DynamoAnalyticsClient.cs
@@ -51,10 +51,15 @@ public void Dispose()
             else
                 StabilityCookie.WriteCleanShutdown();
 
-            Service.ShutDown();
-            //Unregister the GATrackerFactory only after shutdown is recorded.
-            //Unregister is required, so that the host app can re-start Analytics service.
-            Service.Instance.Unregister(GATrackerFactory.Name);
+            // If the Analytics Client was initialized, shut it down.
+            // Otherwise skip this step because it would cause an exception.
+            if (Service.IsInitialized)
+            {
+                Service.ShutDown();
+                // Unregister the GATrackerFactory only after shutdown is recorded.
+                // Unregister is required, so that the host app can re-start Analytics service.
+                Service.Instance.Unregister(GATrackerFactory.Name);
+            }
 
             if (null != heartbeat)
                 Heartbeat.DestroyInstance();

diff --git a/test/DynamoCoreWpfTests/CoreUITests.cs b/test/DynamoCoreWpfTests/CoreUITests.cs
@@ -471,20 +471,27 @@ public void PreferenceSetting_BackgroundPreview_1_0API()
 
         [Test]
         [Category("DynamoUI")]
-        public void PreferenceSetting_Analytics()
+        public void PreferenceSetting_AgreeAnalyticSharing()
         {
             // Test deserialization of analytics setting 
             // Test loading old settings file without agreement 
             var filePath = Path.Combine(GetTestDirectory(ExecutingDirectory), @"settings\DynamoSettings-firstrun.xml");
             var resultSetting = PreferenceSettings.Load(filePath);
             Assert.AreEqual(false, resultSetting.IsAnalyticsReportingApproved);
             Assert.AreEqual(false, resultSetting.IsUsageReportingApproved);
+            Assert.DoesNotThrow(() => Dynamo.Logging.AnalyticsService.ShutDown());
+        }
 
+        [Test]
+        [Category("DynamoUI")]
+        public void PreferenceSetting_NotAgreeAnalyticsSharing()
+        {
             // Test loading old settings file without render precision attribute
-            filePath = Path.Combine(GetTestDirectory(ExecutingDirectory), @"settings\DynamoSettings-AnalyticsTurnedOn.xml");
-            resultSetting = PreferenceSettings.Load(filePath);
+            var filePath = Path.Combine(GetTestDirectory(ExecutingDirectory), @"settings\DynamoSettings-AnalyticsTurnedOn.xml");
+            var resultSetting = PreferenceSettings.Load(filePath);
             Assert.AreEqual(true, resultSetting.IsAnalyticsReportingApproved);
             Assert.AreEqual(true, resultSetting.IsUsageReportingApproved);
+            Assert.DoesNotThrow(() => Dynamo.Logging.AnalyticsService.ShutDown());
         }
 
         #region PreferenceSettings