Add ways to pass Analytics Host Entitlement info for out of process integrators (#11841) (#11857)

QilongTang · web-flow · commit 4bb0de14a445 · 2021-07-15T05:57:28.000-07:00
* Initial Commit

* Add ParentId to update manager

* Updates

* Add CLI support

* Add unit tests

* Update tests

* Update HostContextInfo type usage

* Comments to use struct

* Move properties out of update manager

* Update

* Comments

* Comments

* update test
diff --git a/extern/Analytics.NET/Analytics.NET.Core.dll b/extern/Analytics.NET/Analytics.NET.Core.dll
diff --git a/extern/Analytics.NET/Analytics.Net.ADP.dll b/extern/Analytics.NET/Analytics.Net.ADP.dll
diff --git a/src/DynamoApplications/StartupUtils.cs b/src/DynamoApplications/StartupUtils.cs
@@ -1,6 +1,5 @@
 ﻿using System;
 using System.Collections.Generic;
-using System.ComponentModel;
 using System.Diagnostics;
 using System.Globalization;
 using System.IO;
@@ -96,7 +95,7 @@ public static CommandLineArguments Parse(string[] args)
                 var geometryFilePath = string.Empty;
 
                 // dll paths we'll import before running a graph 
-                var importPaths = new List<string>() ;
+                var importPaths = new List<string>();
 
                 // Local ASM binaries path
                 var asmPath = string.Empty;
@@ -109,6 +108,10 @@ public static CommandLineArguments Parse(string[] args)
                 // Allow Dynamo launcher to identify Dynamo variation for log purpose like analytics, e.g. Dynamo Revit
                 var hostname = string.Empty;
 
+                // Allow Dynamo out of process launcher to identify host analytics info
+                var parentId = string.Empty;
+                var sessionId = string.Empty;
+
                 var optionsSet = new OptionSet().Add("o=|O=", "OpenFilePath, Instruct Dynamo to open headless and run a dyn file at this path", o => openfilepath = o)
                 .Add("c=|C=", "CommandFilePath, Instruct Dynamo to open a commandfile and run the commands it contains at this path," +
                 "this option is only supported when run from DynamoSandbox", c => commandFilePath = c)
@@ -123,6 +126,8 @@ public static CommandLineArguments Parse(string[] args)
                 .Add("gp=|GP=|geometrypath=|GeometryPath=", "relative or absolute path to a directory containing ASM. When supplied, instead of searching the hard disk for ASM, it will be loaded directly from this path.", gp => asmPath = gp)
                 .Add("k|K|keepalive", "Keepalive mode, leave the Dynamo process running until a loaded extension shuts it down.", k => keepAlive = k != null)
                 .Add("hn=|HN=|hostname", "Identify Dynamo variation associated with host", hn => hostname = hn)
+                .Add("si=|SI=|sessionId", "Identify Dynamo host analytics session id", si => sessionId = si)
+                .Add("pi=|PI=|parentId", "Identify Dynamo host analytics parent id", pi => parentId = pi)
                 ;
                 optionsSet.Parse(args);
 
@@ -147,7 +152,7 @@ public static CommandLineArguments Parse(string[] args)
                     ImportedPaths = importPaths,
                     ASMPath = asmPath,
                     KeepAlive = keepAlive,
-                    HostName = hostname,
+                    AnalyticsInfo = new HostAnalyticsInfo() { HostName = hostname,  ParentId = parentId, SessionId = sessionId }
                 };
             }
 
@@ -166,7 +171,9 @@ private static void ShowHelp(OptionSet opSet)
             public IEnumerable<String> ImportedPaths { get; set; }
             public string ASMPath { get; set; }
             public bool KeepAlive { get; set; }
+            [Obsolete("This property will be removed in Dynamo 3.0 - please use AnalyticsInfo")]
             public string HostName { get; set; }
+            public HostAnalyticsInfo AnalyticsInfo { get; set; } 
         }
 
         /// <summary>
@@ -192,19 +199,14 @@ public static void PreloadShapeManager(ref string geometryFactoryPath, ref strin
         }
 
         /// <summary>
-        /// if we are building a model for CLI mode, then we don't want to start an updateManager
-        /// for now, building an updatemanager instance requires finding Dynamo install location
-        /// which if we are running on mac os or *nix will use different logic then SandboxLookup
+        ///if we are building a model for CLI mode, then we don't want to start an updateManager
+        ///for now, building an updatemanager instance requires finding Dynamo install location
+        ///which if we are running on mac os or *nix will use different logic then SandboxLookup 
         /// </summary>
-        /// <param name="hostName">Dynamo variation identified by host.</param>
-        /// <returns></returns>
-        private static IUpdateManager InitializeUpdateManager(string hostName = "")
+        private static IUpdateManager InitializeUpdateManager()
         {
             var cfg = UpdateManagerConfiguration.GetSettings(new SandboxLookUp());
-            var um = new Dynamo.Updates.UpdateManager(cfg)
-            {
-                HostName = hostName
-            };
+            var um = new Dynamo.Updates.UpdateManager(cfg);
             Debug.Assert(cfg.DynamoLookUp != null);
             return um;
         }
@@ -219,8 +221,20 @@ private static IUpdateManager InitializeUpdateManager(string hostName = "")
         public static DynamoModel MakeModel(bool CLImode, string asmPath = "", string hostName ="")
         {
             PreloadASM(asmPath, out string geometryFactoryPath, out string preloaderLocation);
-            return StartDynamoWithDefaultConfig(CLImode, geometryFactoryPath, preloaderLocation, hostName);
+            return StartDynamoWithDefaultConfig(CLImode, geometryFactoryPath, preloaderLocation, new HostAnalyticsInfo() { HostName = hostName });
+        }
 
+        /// <summary>
+        /// Use this overload to construct a DynamoModel when the location of ASM to use is known and host analytics info is known.
+        /// </summary>
+        /// <param name="CLImode">CLI mode starts the model in test mode and uses a separate path resolver.</param>
+        /// <param name="asmPath">Path to directory containing geometry library binaries</param>
+        /// <param name="info">Host analytics info</param>
+        /// <returns></returns>
+        public static DynamoModel MakeModel(bool CLImode, string asmPath = "", HostAnalyticsInfo info = new HostAnalyticsInfo())
+        {
+            PreloadASM(asmPath, out string geometryFactoryPath, out string preloaderLocation);
+            return StartDynamoWithDefaultConfig(CLImode, geometryFactoryPath, preloaderLocation, info);
         }
 
         /// <summary>
@@ -290,15 +304,16 @@ private static void PreloadASM(string asmPath, out string geometryFactoryPath, o
             }
         }
 
-        private static DynamoModel StartDynamoWithDefaultConfig(bool CLImode, string geometryFactoryPath, string preloaderLocation, string hostName = "")
+        private static DynamoModel StartDynamoWithDefaultConfig(bool CLImode, string geometryFactoryPath, string preloaderLocation, HostAnalyticsInfo info = new HostAnalyticsInfo())
         {
             var config = new DynamoModel.DefaultStartConfiguration()
             {
                 GeometryFactoryPath = geometryFactoryPath,
-                ProcessMode = TaskProcessMode.Asynchronous
+                ProcessMode = TaskProcessMode.Asynchronous,
+                HostAnalyticsInfo = info
             };
 
-            config.UpdateManager = CLImode ? null : InitializeUpdateManager(hostName);
+            config.UpdateManager = CLImode ? null : InitializeUpdateManager();
             config.StartInTestMode = CLImode ? true : false;
             config.PathResolver = CLImode ? new CLIPathResolver(preloaderLocation) as IPathResolver : new SandboxPathResolver(preloaderLocation) as IPathResolver;
 
@@ -343,7 +358,7 @@ public static string SetLocale(CommandLineArguments cmdLineArgs)
         /// <summary>
         /// The white list of dependencies to be ignored.
         /// </summary>
-        private static String[] assemblyNamesToIgnore = { "Newtonsoft.Json", "RevitAPI.dll", "RevitAPIUI.dll" };
+        private static readonly String[] assemblyNamesToIgnore = { "Newtonsoft.Json", "RevitAPI.dll", "RevitAPIUI.dll" };
 
         /// <summary>
         /// Checks that an assembly does not have any dependencies that have already been loaded into the 
@@ -410,8 +425,5 @@ private static List<Exception> GetVersionMismatchedReferencesInAppDomain(Assembl
             }
             return output;
         }
-
-
-
     }
 }
diff --git a/src/DynamoCLI/CommandLineRunner.cs b/src/DynamoCLI/CommandLineRunner.cs
@@ -44,11 +44,7 @@ private static XmlDocument RunCommandLineArgs(DynamoModel model, StartupUtils.Co
             {
                 Console.WriteLine("geometryFilePath option is only available when running DynamoWPFCLI, not DynamoCLI");
             }
-
-            if (!(string.IsNullOrEmpty(cmdLineArgs.HostName)))
-            {
-                model.HostName = cmdLineArgs.HostName;
-            }
+            model.HostAnalyticsInfo = cmdLineArgs.AnalyticsInfo;
 
             cmdLineArgs.ImportedPaths.ToList().ForEach(path =>
             {
diff --git a/src/DynamoCore/Logging/DynamoAnalyticsClient.cs b/src/DynamoCore/Logging/DynamoAnalyticsClient.cs
@@ -103,11 +103,13 @@ public void Dispose() { }
         private const string ANALYTICS_PROPERTY = "UA-52186525-1";
 #endif
 
-        private IPreferences preferences = null;
+        private readonly IPreferences preferences = null;
 
         public static IDisposable Disposable { get { return new Dummy(); } }
 
-        private ProductInfo product;
+        private readonly ProductInfo product;
+
+        private readonly HostContextInfo hostInfo;
 
         public virtual IAnalyticsSession Session { get; private set; }
 
@@ -178,9 +180,10 @@ public DynamoAnalyticsClient(DynamoModel dynamoModel)
             
             var hostName = string.IsNullOrEmpty(dynamoModel.HostName) ? "Dynamo" : dynamoModel.HostName;
 
-            string buildId = "", releaseId = "";
-            Version version;
-            if (Version.TryParse(dynamoModel.Version, out version))
+            hostInfo = new HostContextInfo() { ParentId = dynamoModel.HostAnalyticsInfo.ParentId, SessionId = dynamoModel.HostAnalyticsInfo.SessionId };
+
+            string buildId = String.Empty, releaseId = String.Empty;
+            if (Version.TryParse(dynamoModel.Version, out Version version))
             {
                 buildId = $"{version.Major}.{version.Minor}.{version.Build}"; // BuildId has the following format major.minor.build, ex: 2.5.1
                 releaseId = $"{version.Major}.{version.Minor}.0"; // ReleaseId has the following format: major.minor.0; ex: 2.5.0
@@ -232,7 +235,7 @@ public void Start()
                     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), TimeSpan.FromMinutes(30));
+                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/DynamoCore/Models/DynamoModel.cs b/src/DynamoCore/Models/DynamoModel.cs
@@ -91,6 +91,19 @@ public static DynamoPreferencesData Default()
         }
     }
 
+    /// <summary>
+    /// Host analytics related info
+    /// </summary>
+    public struct HostAnalyticsInfo
+    {
+        /// Dynamo variation identified by host.
+        public string HostName;
+        /// 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>
@@ -181,8 +194,14 @@ public string Version
         /// <summary>
         /// Name of the Host (i.e. DynamoRevit/DynamoStudio)
         /// </summary>
+        [Obsolete("This property will be removed in Dynamo 3.0 - please use HostAnalyticsInfo")]
         public string HostName { get; set; }
 
+        /// <summary>
+        /// Host analytics info
+        /// </summary>
+        public HostAnalyticsInfo HostAnalyticsInfo { get; set; }
+
         /// <summary>
         /// UpdateManager to handle automatic upgrade to higher version.
         /// </summary>
@@ -460,6 +479,12 @@ public struct DefaultStartConfiguration : IStartConfiguration
             /// Disables ADP for the entire process for the lifetime of the process.
             /// </summary>
             public bool DisableADP { get; set; }
+
+            /// <summary>
+            /// Host analytics info
+            /// TODO: Move this to IStartConfiguration in Dynamo 3.0
+            /// </summary>
+            public HostAnalyticsInfo HostAnalyticsInfo { get; set; }
         }
 
         /// <summary>
@@ -542,21 +567,26 @@ protected DynamoModel(IStartConfiguration config)
             geometryFactoryPath = config.GeometryFactoryPath;
 
             IPreferences preferences = CreateOrLoadPreferences(config.Preferences);
-            var settings = preferences as PreferenceSettings;
-            if (settings != null)
+            if (preferences is PreferenceSettings settings)
             {
                 PreferenceSettings = settings;
                 PreferenceSettings.PropertyChanged += PreferenceSettings_PropertyChanged;
             }
 
+            if (config is DefaultStartConfiguration defaultStartConfiguration)
+            {
+                HostAnalyticsInfo = defaultStartConfiguration.HostAnalyticsInfo;
+            }
+
             UpdateManager = config.UpdateManager ?? new DefaultUpdateManager(null);
 
             var hostUpdateManager = config.UpdateManager;
 
             if (hostUpdateManager != null)
             {
-                HostName = hostUpdateManager.HostName;
-                HostVersion = hostUpdateManager.HostVersion == null ? null : hostUpdateManager.HostVersion.ToString();
+                // For API compatibility now in Dynamo 2.0, integrators can set HostName in both ways
+                HostName = string.IsNullOrEmpty(hostUpdateManager.HostName)? HostAnalyticsInfo.HostName : hostUpdateManager.HostName;
+                HostVersion = hostUpdateManager.HostVersion?.ToString();
             }
             else
             {
diff --git a/src/DynamoCore/Updates/UpdateManager.cs b/src/DynamoCore/Updates/UpdateManager.cs
@@ -9,6 +9,7 @@
 using System.Reflection;
 using System.Xml.Linq;
 using System.Xml.Serialization;
+using Autodesk.Analytics.Core;
 using Dynamo.Core;
 using Dynamo.Logging;
 
diff --git a/src/DynamoSandbox/DynamoCoreSetup.cs b/src/DynamoSandbox/DynamoCoreSetup.cs
@@ -21,9 +21,9 @@ class DynamoCoreSetup
         private SettingsMigrationWindow migrationWindow;
         private DynamoViewModel viewModel = null;
         private readonly string commandFilePath;
-        private Stopwatch startupTimer = Stopwatch.StartNew();
+        private readonly Stopwatch startupTimer = Stopwatch.StartNew();
         private readonly string ASMPath;
-        private readonly string hostName;
+        private readonly HostAnalyticsInfo analyticsInfo;
         private const string sandboxWikiPage = @"https://github.com/DynamoDS/Dynamo/wiki/How-to-Utilize-Dynamo-Builds";
 
         [DllImport("msvcrt.dll")]
@@ -36,7 +36,7 @@ public DynamoCoreSetup(string[] args)
             _putenv(locale);
             commandFilePath = cmdLineArgs.CommandFilePath;
             ASMPath = cmdLineArgs.ASMPath;
-            hostName = cmdLineArgs.HostName;
+            analyticsInfo = cmdLineArgs.AnalyticsInfo;
         }
 
         public void RunApplication(Application app)
@@ -46,7 +46,7 @@ public void RunApplication(Application app)
                 DynamoModel.RequestMigrationStatusDialog += MigrationStatusDialogRequested;
                 DynamoModel model;
                 Dynamo.Applications.StartupUtils.ASMPreloadFailure += ASMPreloadFailureHandler;
-                model = Dynamo.Applications.StartupUtils.MakeModel(false, ASMPath ?? string.Empty, hostName);
+                model = Dynamo.Applications.StartupUtils.MakeModel(false, ASMPath ?? string.Empty, analyticsInfo);
 
                 viewModel = DynamoViewModel.Start(
                     new DynamoViewModel.StartConfiguration()
diff --git a/src/DynamoWPFCLI/CommandLineRunnerWPF.cs b/src/DynamoWPFCLI/CommandLineRunnerWPF.cs
@@ -40,10 +40,7 @@ private static XmlDocument RunCommandLineArgs(DynamoViewModel viewModel, Startup
                 Console.WriteLine("commandFilePath option is only available when running DynamoSandbox, not DynamoWPFCLI");
             }
 
-            if (!(string.IsNullOrEmpty(cmdLineArgs.HostName)))
-            {
-                viewModel.Model.HostName = cmdLineArgs.HostName;
-            }
+            viewModel.Model.HostAnalyticsInfo= cmdLineArgs.AnalyticsInfo;
 
             cmdLineArgs.ImportedPaths.ToList().ForEach(path =>
             {
diff --git a/test/DynamoCoreTests/Updates/UpdatesTests.cs b/test/DynamoCoreTests/Updates/UpdatesTests.cs
@@ -144,12 +144,12 @@ public void UpdateManagerPropertiesTest()
 
             Assert.AreEqual(true, updateManager.ForceUpdate);
 
-            //HostName
+            // HostName
             updateManager.HostName = "Host Name";
             Assert.AreEqual("Host Name", updateManager.HostName);
 
             //UpdateFileLocation
-            var um = new UpdateManager(new UpdateManagerConfiguration());
+            _ = new UpdateManager(new UpdateManagerConfiguration());
             //  For a new UpdateManager, the UpdateFileLocation property is not initialized.
             Assert.IsNullOrEmpty(updateManager.UpdateFileLocation);
         }
diff --git a/test/Libraries/CommandLineTests/CommandLineTests.cs b/test/Libraries/CommandLineTests/CommandLineTests.cs
@@ -94,7 +94,31 @@ public void CanSetHostNameWithCommandLineRunner()
             string commandstring = $"/o {openpath} /hn {hostName}";
 
             runner.Run(CommandstringToArgs(commandstring));
-            Assert.AreEqual(this.CurrentDynamoModel.HostName, "DynamoFormIt");
+            Assert.AreEqual(this.CurrentDynamoModel.HostAnalyticsInfo.HostName, "DynamoFormIt");
+        }
+
+        [Test]
+        public void CanSetParentIdWithCommandLineRunner()
+        {
+            var openpath = Path.Combine(TestDirectory, @"core\math\Add.dyn");
+            var parentId = "RVT&2022&MUI64&22.0.2.392";
+            var runner = new DynamoCLI.CommandLineRunner(this.CurrentDynamoModel);
+            string commandstring = $"/o {openpath} /pi {parentId}";
+
+            runner.Run(CommandstringToArgs(commandstring));
+            Assert.AreEqual(this.CurrentDynamoModel.HostAnalyticsInfo.ParentId, "RVT&2022&MUI64&22.0.2.392");
+        }
+
+        [Test]
+        public void CanSetSessionIdWithCommandLineRunner()
+        {
+            var openpath = Path.Combine(TestDirectory, @"core\math\Add.dyn");
+            var sessionId = "ABCDEFG";
+            var runner = new DynamoCLI.CommandLineRunner(this.CurrentDynamoModel);
+            string commandstring = $"/o {openpath} /si {sessionId}";
+
+            runner.Run(CommandstringToArgs(commandstring));
+            Assert.AreEqual(this.CurrentDynamoModel.HostAnalyticsInfo.SessionId, "ABCDEFG");
         }
 
         [Test]

Original file line number	Diff line number	Diff line change
`@@ -44,11 +44,7 @@ private static XmlDocument RunCommandLineArgs(DynamoModel model, StartupUtils.Co`
`44`	`44`	`{`
`45`	`45`	`Console.WriteLine("geometryFilePath option is only available when running DynamoWPFCLI, not DynamoCLI");`
`46`	`46`	`}`
`47`		`-`
`48`		`- if (!(string.IsNullOrEmpty(cmdLineArgs.HostName)))`
`49`		`- {`
`50`		`- model.HostName = cmdLineArgs.HostName;`
`51`		`- }`
	`47`	`+ model.HostAnalyticsInfo = cmdLineArgs.AnalyticsInfo;`
`52`	`48`
`53`	`49`	`cmdLineArgs.ImportedPaths.ToList().ForEach(path =>`
`54`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,10 +40,7 @@ private static XmlDocument RunCommandLineArgs(DynamoViewModel viewModel, Startup`
`40`	`40`	`Console.WriteLine("commandFilePath option is only available when running DynamoSandbox, not DynamoWPFCLI");`
`41`	`41`	`}`
`42`	`42`
`43`		`- if (!(string.IsNullOrEmpty(cmdLineArgs.HostName)))`
`44`		`- {`
`45`		`- viewModel.Model.HostName = cmdLineArgs.HostName;`
`46`		`- }`
	`43`	`+ viewModel.Model.HostAnalyticsInfo= cmdLineArgs.AnalyticsInfo;`
`47`	`44`
`48`	`45`	`cmdLineArgs.ImportedPaths.ToList().ForEach(path =>`
`49`	`46`	`{`