Update analytics (#13822)

pinzart90 · pinzart · web-flow · commit f51b2d84e209 · 2023-03-15T11:01:49.000-04:00
* update analytics

* Update DynamoCore.csproj

* Update DynamoCoreTests.csproj

---------

Co-authored-by: pinzart &lt;tiberiu.pinzariu@autodesk.com&gt;
diff --git a/src/DynamoCore/Configuration/PreferenceSettings.cs b/src/DynamoCore/Configuration/PreferenceSettings.cs
@@ -57,8 +57,6 @@ public class PreferenceSettings : NotificationObject, IPreferences, IRenderPreci
         private bool isEnablePersistExtensionsEnabled;
         private bool isStaticSplashScreenEnabled;
         private bool isCreatedFromValidFile = true;
-        private bool isADPChecked = false;
-        private bool isADPOptedIn = false;
 
         #region Constants
         /// <summary>
@@ -114,22 +112,16 @@ public class PreferenceSettings : NotificationObject, IPreferences, IRenderPreci
 
         /// <summary>
         /// Indicates whether ADP analytics reporting is approved or not.
-        /// Note that this property is called often and the inner call to IsADPOptinIn can be slow sometimes
-        /// especially when there is an error involved. And therefore we will only check this once per instance.
+        /// Note that the getter will communicate to a analytics server which might be slow.
+        /// This API should only be used in UI scenarios (not in performance sensitive areas)
         /// </summary>
         [XmlIgnore]
-        [Obsolete("Setter is obsolete - ADP consent should not be set directly, it should be set using the consent dialog.")]
+        [Obsolete("API obsolete - This is an internal API and should not be used.")]
         public bool IsADPAnalyticsReportingApproved
         {
             get
             {
-                if (!isADPChecked)
-                {
-                    isADPChecked = true;
-                    isADPOptedIn = AnalyticsService.IsADPOptedIn;
-                }
-
-                return isADPOptedIn;
+                return AnalyticsService.IsADPOptedIn;
             }
             set { throw new Exception("do not use"); }
         }
diff --git a/src/DynamoCore/DynamoCore.csproj b/src/DynamoCore/DynamoCore.csproj
@@ -30,7 +30,7 @@
   </ItemGroup>
   <ItemGroup Label="Common dependencies">
     <PackageReference Include="Autodesk.IDSDK" Version="1.1.6" />
-    <PackageReference Include="DynamoVisualProgramming.Analytics" Version="3.0.0.2506" />
+    <PackageReference Include="DynamoVisualProgramming.Analytics" Version="3.0.1.740" />
     <PackageReference Include="DynamoVisualProgramming.LibG_229_0_0" Version="2.18.0.665" GeneratePathProperty="true"/>
     <PackageReference Include="DynamoVisualProgramming.LibG_228_0_0" Version="2.18.0.665" GeneratePathProperty="true"/>
     <PackageReference Include="Greg" Version="2.3.0.2505" />
diff --git a/src/DynamoCore/Logging/DynamoAnalyticsClient.cs b/src/DynamoCore/Logging/DynamoAnalyticsClient.cs
@@ -101,7 +101,8 @@ public bool ReportingAnalytics
         {
             get
             {
-                return Service.IsInitialized && (ReportingGoogleAnalytics || ReportingADPAnalytics);
+                return !Analytics.DisableAnalytics &&
+                    Service.IsInitialized;
             }
         }
 
@@ -119,20 +120,6 @@ private bool ReportingGoogleAnalytics
             }
         }
 
-        /// <summary>
-        /// Return if ADP Analytics Client is allowed to send analytics info
-        /// </summary>
-        private bool ReportingADPAnalytics
-        {
-            get
-            {
-                return preferences != null
-                    && Service.IsInitialized
-                    && !Analytics.DisableAnalytics
-                    && preferences.IsADPAnalyticsReportingApproved;
-            }
-        }
-
         /// <summary>
         /// Return if Analytics Client is allowed to send instrumentation info
         /// </summary>
@@ -199,7 +186,7 @@ private void RegisterADPTracker(Service service)
             if (service.GetTrackerFactory(ADPTrackerFactory.Name) == null)
             {
                 service.Register(new ADPTrackerFactory());
-                service.AddTrackerFactoryFilter(ADPTrackerFactory.Name, () => ReportingADPAnalytics);
+                service.AddTrackerFactoryFilter(ADPTrackerFactory.Name, () => ReportingAnalytics);
             }
         }
 
@@ -209,8 +196,10 @@ private void RegisterADPTracker(Service service)
         /// </summary>
         public void Start()
         {
-            if (preferences != null &&
-                (preferences.IsAnalyticsReportingApproved || preferences.IsADPAnalyticsReportingApproved))
+            // Start Analytics service regardless of optin status.
+            // Each track event will be enabled/disabled based on the corresponding optin status.
+            // Ex. ADP will manage optin status internally
+            if (preferences != null && !Analytics.DisableAnalytics)
             {
                 //Register trackers
                 var service = Service.Instance;
@@ -222,14 +211,13 @@ public void Start()
                 if (preferences.IsAnalyticsReportingApproved)
                     RegisterGATracker(service);
 
-                // Register ADP Tracker only if the user is opted in.
-                if (preferences.IsADPAnalyticsReportingApproved)
-                    RegisterADPTracker(service);
+                // Always register ADP Tracker.
+                // ADP manages opt in status internally.
+                RegisterADPTracker(service);
 
                 //If not ReportingAnalytics, then set the idle time as infinite so idle state is not recorded.
                 Service.StartUp(product, new UserInfo(Session.UserId), hostInfo, TimeSpan.FromMinutes(30));
                 TrackPreferenceInternal("ReportingAnalytics", "", ReportingAnalytics ? 1 : 0);
-                TrackPreferenceInternal("ReportingADPAnalytics", "", ReportingADPAnalytics ? 1 : 0);
             }
         }
 
diff --git a/src/DynamoCoreWpf/UI/GuidedTour/GuidesManager.cs b/src/DynamoCoreWpf/UI/GuidedTour/GuidesManager.cs
@@ -8,6 +8,7 @@
 using System.Windows.Controls;
 using System.Windows.Controls.Primitives;
 using Dynamo.Controls;
+using Dynamo.Logging;
 using Dynamo.ViewModels;
 using Dynamo.Wpf.Properties;
 using Dynamo.Wpf.ViewModels.GuidedTour;
@@ -474,7 +475,7 @@ private Step CreateStep(Step jsonStepInfo, HostControlInfo hostControlInfo, int
                         Sequence = jsonStepInfo.Sequence,
                         RatingTextTitle = formattedText.ToString(),
                         StepType = Step.StepTypes.SURVEY,
-                        IsRatingVisible = dynamoViewModel.Model.PreferenceSettings.IsADPAnalyticsReportingApproved,
+                        IsRatingVisible = !Analytics.DisableAnalytics && Analytics.IsEnabled,
                         StepContent = new Content()
                         {
                             FormattedText = formattedText,
diff --git a/src/DynamoCoreWpf/Utilities/CrashReportTool.cs b/src/DynamoCoreWpf/Utilities/CrashReportTool.cs
@@ -254,7 +254,7 @@ internal static bool ShowCrashErrorReportWindow(DynamoViewModel viewModel, Crash
                     var miniDumpFilePath = CreateMiniDumpFile(cerDir.FullName);
                     var upiConfigFilePath = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "upiconfig.xml");
 
-                    var cerArgs = $"/UPITOKEN {upiConfigFilePath} /DMP {miniDumpFilePath} /APPXML \"{appConfig}\" {dynConfig} {extras}";
+                    var cerArgs = $"/UPITOKEN {upiConfigFilePath} /DMP {miniDumpFilePath} /APPXML \"{appConfig}\" {dynConfig} {extras} /USEEXCEPTIONTRACE";
                     
                     Process.Start(new ProcessStartInfo(cerToolPath, cerArgs)).WaitForExit();
                     return true;
diff --git a/test/DynamoCoreTests/DynamoCoreTests.csproj b/test/DynamoCoreTests/DynamoCoreTests.csproj
@@ -36,7 +36,7 @@
         <PackageReference Include="JunitXml.TestLogger" Version="3.0.124" />
     </ItemGroup>
     <ItemGroup>
-    <PackageReference Include="DynamoVisualProgramming.Analytics" Version="3.0.0.2506">
+    <PackageReference Include="DynamoVisualProgramming.Analytics" Version="3.0.1.740">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>compile; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,8 @@ public bool ReportingAnalytics`
`101`	`101`	`{`
`102`	`102`	`get`
`103`	`103`	`{`
`104`		`- return Service.IsInitialized && (ReportingGoogleAnalytics \|\| ReportingADPAnalytics);`
	`104`	`+ return !Analytics.DisableAnalytics &&`
	`105`	`+ Service.IsInitialized;`
`105`	`106`	`}`
`106`	`107`	`}`
`107`	`108`
`@@ -119,20 +120,6 @@ private bool ReportingGoogleAnalytics`
`119`	`120`	`}`
`120`	`121`	`}`
`121`	`122`
`122`		`- /// <summary>`
`123`		`- /// Return if ADP Analytics Client is allowed to send analytics info`
`124`		`- /// </summary>`
`125`		`- private bool ReportingADPAnalytics`
`126`		`- {`
`127`		`- get`
`128`		`- {`
`129`		`- return preferences != null`
`130`		`- && Service.IsInitialized`
`131`		`- && !Analytics.DisableAnalytics`
`132`		`- && preferences.IsADPAnalyticsReportingApproved;`
`133`		`- }`
`134`		`- }`
`135`		`-`
`136`	`123`	`/// <summary>`
`137`	`124`	`/// Return if Analytics Client is allowed to send instrumentation info`
`138`	`125`	`/// </summary>`
`@@ -199,7 +186,7 @@ private void RegisterADPTracker(Service service)`
`199`	`186`	`if (service.GetTrackerFactory(ADPTrackerFactory.Name) == null)`
`200`	`187`	`{`
`201`	`188`	`service.Register(new ADPTrackerFactory());`
`202`		`- service.AddTrackerFactoryFilter(ADPTrackerFactory.Name, () => ReportingADPAnalytics);`
	`189`	`+ service.AddTrackerFactoryFilter(ADPTrackerFactory.Name, () => ReportingAnalytics);`
`203`	`190`	`}`
`204`	`191`	`}`
`205`	`192`
`@@ -209,8 +196,10 @@ private void RegisterADPTracker(Service service)`
`209`	`196`	`/// </summary>`
`210`	`197`	`public void Start()`
`211`	`198`	`{`
`212`		`- if (preferences != null &&`
`213`		`- (preferences.IsAnalyticsReportingApproved \|\| preferences.IsADPAnalyticsReportingApproved))`
	`199`	`+ // Start Analytics service regardless of optin status.`
	`200`	`+ // Each track event will be enabled/disabled based on the corresponding optin status.`
	`201`	`+ // Ex. ADP will manage optin status internally`
	`202`	`+ if (preferences != null && !Analytics.DisableAnalytics)`
`214`	`203`	`{`
`215`	`204`	`//Register trackers`
`216`	`205`	`var service = Service.Instance;`
`@@ -222,14 +211,13 @@ public void Start()`
`222`	`211`	`if (preferences.IsAnalyticsReportingApproved)`
`223`	`212`	`RegisterGATracker(service);`
`224`	`213`
`225`		`- // Register ADP Tracker only if the user is opted in.`
`226`		`- if (preferences.IsADPAnalyticsReportingApproved)`
`227`		`- RegisterADPTracker(service);`
	`214`	`+ // Always register ADP Tracker.`
	`215`	`+ // ADP manages opt in status internally.`
	`216`	`+ RegisterADPTracker(service);`
`228`	`217`
`229`	`218`	`//If not ReportingAnalytics, then set the idle time as infinite so idle state is not recorded.`
`230`	`219`	`Service.StartUp(product, new UserInfo(Session.UserId), hostInfo, TimeSpan.FromMinutes(30));`
`231`	`220`	`TrackPreferenceInternal("ReportingAnalytics", "", ReportingAnalytics ? 1 : 0);`
`232`		`- TrackPreferenceInternal("ReportingADPAnalytics", "", ReportingADPAnalytics ? 1 : 0);`
`233`	`221`	`}`
`234`	`222`	`}`
`235`	`223`