Rework telemetry client (#253)

***NO_CI***

Author: josesimoes

azure-pipelines.yml

@@ -330,8 +330,8 @@ jobs:
   # Replace the intrument key
   - powershell: |
           . ./common.ps1
-          $fileToReplace = "$(System.DefaultWorkingDirectory)/nanoFirmwareFlasher.Library/appsettings.json"
-          $sourceString = "INTRUMENT_KEY"
+          $fileToReplace = "$(System.DefaultWorkingDirectory)/nanoFirmwareFlasher.Tool\appsettings.json"
+          $sourceString = "INSTRUMENT_KEY"
           $instrumentKey = "$(InstrumentKey)"
 
           Find-ReplaceInFile -filePath $fileToReplace -sourceString $sourceString -targetString $instrumentKey

nanoFirmwareFlasher.Library/FirmwarePackage.cs

@@ -3,22 +3,20 @@
 // See LICENSE file in the project root for full license information.
 //
 
+using Microsoft.ApplicationInsights;
+using Microsoft.ApplicationInsights.DataContracts;
+using Microsoft.Extensions.Configuration;
 using nanoFramework.Tools.Debugger;
-using nanoFramework.Tools.FirmwareFlasher;
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.IO;
 using System.IO.Compression;
 using System.Linq;
 using System.Net.Http;
+using System.Reflection;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
-using Microsoft.ApplicationInsights;
-using Microsoft.ApplicationInsights.DataContracts;
-using Microsoft.Extensions.Configuration;
-using Microsoft.Extensions.Configuration.Json;
-using System.Reflection;
 
 namespace nanoFramework.Tools.FirmwareFlasher
 {
@@ -36,11 +34,8 @@ public abstract class FirmwarePackage : IDisposable
 
         private readonly string _targetName;
         private readonly bool _preview;
-
         private const string _readmeContent = "This folder contains nanoFramework firmware files. Can safely be removed.";
 
-        private static IConfigurationRoot _configuration;
-
         /// <summary>
         /// Path with the base location for firmware packages.
         /// </summary>
@@ -113,16 +108,6 @@ static FirmwarePackage()
                 BaseAddress = new Uri("https://api.cloudsmith.io/v1/packages/net-nanoframework/")
             };
             _cloudsmithClient.DefaultRequestHeaders.Add("Accept", "*/*");
-
-            if (_configuration == null)
-            {
-
-                var builder = new ConfigurationBuilder()
-                    .SetBasePath(Directory.GetCurrentDirectory())
-                    .AddJsonFile("appsettings.json");
-
-                _configuration = builder.Build();
-            }
         }
 
         /// <summary>
@@ -361,19 +346,11 @@ internal async Task<ExitCodes> DownloadAndExtractAsync()
                             Console.ForegroundColor = ConsoleColor.White;
                         }
 
-                        //send app insight on successful download
-
-                        string insightConnectionString = _configuration["iConnectionString"];
-                        string optOut = Environment.GetEnvironmentVariable("NANOFRAMEWORK_TELEMETRY_OPTOUT");
-
                         stepSuccessful = true;
 
-                        if (!string.IsNullOrEmpty(insightConnectionString) && optOut != "1")
+                        // send telemetry data on successful download
+                        if (NanoTelemetryClient.TelemetryClient is not null)
                         {
-                            TelemetryClient telemetryClient = new TelemetryClient(new Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration()
-                            {
-                                ConnectionString = insightConnectionString
-                            });
                             AssemblyInformationalVersionAttribute nanoffVersion = null;
 
                             try
@@ -385,18 +362,17 @@ internal async Task<ExitCodes> DownloadAndExtractAsync()
                             }
                             catch
                             {
-
+                                // OK to fail here, just telemetry
                             }
+
                             var packageTelemetry = new EventTelemetry("PackageDownloaded");
                             packageTelemetry.Properties.Add("TargetName", _targetName);
                             packageTelemetry.Properties.Add("Version", Version);
                             packageTelemetry.Properties.Add("nanoffVersion", nanoffVersion == null ? "unknown" : nanoffVersion.InformationalVersion);
-                            telemetryClient.TrackEvent(packageTelemetry);
-                            telemetryClient.Flush();
 
+                            NanoTelemetryClient.TelemetryClient.TrackEvent(packageTelemetry);
+                            NanoTelemetryClient.TelemetryClient.Flush();
                         }
-
-
                     }
                     catch
                     {

nanoFirmwareFlasher.Library/NanoTelemetryClient.cs

@@ -0,0 +1,61 @@
+//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using Microsoft.ApplicationInsights;
+using System;
+
+namespace nanoFramework.Tools.FirmwareFlasher
+{
+    /// <summary>
+    /// Telemetry client for sending telemetry data to Application Insights.
+    /// </summary>
+    public class NanoTelemetryClient
+    {
+        private static TelemetryClient _myTelemetryClient;
+
+        // flag to signal that the telemetry client field initialized has been processed
+        private static bool notProcessed = true;
+
+        /// <summary>
+        /// Connection string for <see cref="TelemetryClient"/>.
+        /// </summary>
+        public static string ConnectionString;
+
+        /// <summary>
+        /// Gets the <see cref="TelemetryClient"/> to use for sending telemetry data.
+        /// </summary>
+        public static TelemetryClient TelemetryClient => GetTelemetryClient();
+
+        private static TelemetryClient GetTelemetryClient()
+        {
+            if (notProcessed && _myTelemetryClient is null)
+            {
+                string optOutTelemetry = Environment.GetEnvironmentVariable("NANOFRAMEWORK_TELEMETRY_OPTOUT");
+
+                if (!string.IsNullOrEmpty(ConnectionString)
+                    && (optOutTelemetry is null || optOutTelemetry != "1"))
+                {
+                    // parsing the connection string could fail
+                    try
+                    {
+                        _myTelemetryClient = new TelemetryClient(new Microsoft.ApplicationInsights.Extensibility.TelemetryConfiguration()
+                        {
+                            ConnectionString = ConnectionString
+                        });
+                    }
+                    catch
+                    {
+                        // don't care, telemetry is not mandatory
+                    };
+                }
+
+                // set flag to false to signal that the telemetry client field has been processed
+                notProcessed = false;
+            }
+
+            return _myTelemetryClient;
+        }
+    }
+}

nanoFirmwareFlasher.Library/appsettings.json

@@ -127,10 +127,5 @@
         <None Include="..\lib\uniflash\**" Link="uniflash\%(RecursiveDir)%(Filename)%(Extension)">
         </None>
     </ItemGroup>
-    <ItemGroup>
-      <None Update="appsettings.json">
-        <CopyToOutputDirectory>Always</CopyToOutputDirectory>
-      </None>
-    </ItemGroup>
 
 </Project>

nanoFirmwareFlasher.Library/nanoFirmwareFlasher.Library.csproj

@@ -5,7 +5,7 @@
 
 using CommandLine;
 using CommandLine.Text;
-using nanoFramework.Tools.Debugger;
+using Microsoft.Extensions.Configuration;
 using nanoFramework.Tools.FirmwareFlasher.Extensions;
 using Newtonsoft.Json;
 using System;
@@ -17,7 +17,6 @@
 using System.Net.Http;
 using System.Net.Http.Headers;
 using System.Reflection;
-using System.Threading;
 using System.Threading.Tasks;
 
 namespace nanoFramework.Tools.FirmwareFlasher
@@ -51,6 +50,14 @@ public static async Task<int> Main(string[] args)
             var fullPath = Path.GetFullPath(codeBase);
             ExecutingPath = Path.GetDirectoryName(fullPath);
 
+            // grab AppInsights connection string to setup telemetry client
+            IConfigurationRoot appConfigurationRoot = new ConfigurationBuilder()
+                .SetBasePath(ExecutingPath)
+                .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
+                .Build();
+
+            NanoTelemetryClient.ConnectionString = appConfigurationRoot?["iConnectionString"];
+
             // check for empty argument collection
             if (!args.Any())
             {

nanoFirmwareFlasher.Tool/Program.cs

@@ -0,0 +1,3 @@
+{
+  "iConnectionString": "INSTRUMENT_KEY"
+}

nanoFirmwareFlasher.Tool/appsettings.json

@@ -69,6 +69,12 @@
 	  <ProjectReference Include="..\nanoFirmwareFlasher.Library\nanoFirmwareFlasher.Library.csproj" />
 	</ItemGroup>
 
+	<ItemGroup>
+	  <None Update="appsettings.json">
+	    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+	  </None>
+	</ItemGroup>
+
 	<Target Name="CopyToolsContent" AfterTargets="Build">
 	    <ItemGroup>
             <LibSourceFiles Include="$(MSBuildThisFileDirectory)\..\lib\**\*.*" />