Collect environment information in telemetry (Azure#22074)

* Record InstallationId

* Fixed one unit test after the buffer for the telememetry is changed.

* Collect the host env

* Fix getting mac address on Linux.

- On Linux, the first up network interface is the loopback device which
  has the same physicial address on all machines. That is not a good
  indicator about telling apart different environment. In the fix, we
  only check the physcial address of the first up network interface
  which is an ethernet or a wifi device.

* Update unit test and fix potential data corruption in telemetry

- Update the unit tests after all the previous changes.
- We now always check if we have enough buffer to add info about displayed suggestions and accepted suggestion.
  This may fix potential data corruption in the telemetry event. The issue is that the telemetry property value is still
  truncated. With this change, we always check to make sure there is enough buffer before adding new info. So we should
  not see the truncation anymore.

* clen up code

* Improve the way to collect Az version

- We check both Az and AzPreview for the Az version.

Author: kceiw

tools/Az.Tools.Predictor/Az.Tools.Predictor.Test/AzPredictorTelemetryTests.cs

@@ -16,11 +16,9 @@
 using Microsoft.Azure.PowerShell.Tools.AzPredictor.Test.Mocks;
 using System;
 using System.Collections.Generic;
-using System.Globalization;
 using System.Linq;
 using System.Management.Automation.Subsystem.Prediction;
 using System.Text.Json;
-using System.Text.Json.Serialization;
 using System.Threading;
 using System.Threading.Tasks;
 using Xunit;
@@ -922,7 +920,7 @@ public void VerifyAggregationDataSplitAtGetSuggestion()
 
             for (int i = 0; i < expectedTelemetryCount; ++i)
             {
-                // Call the methods a few times to make sure the telemetry data is less than 8092 but the next such call will
+                // Call the methods a few times to make sure the telemetry data is less than AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer but the next such call will
                 // make it larger than it.
                 var predictionContext = PredictionContext.Create($"Clear-Content -Path '*' -Filter '{i}.log'");
                 var _ = azPredictor.GetSuggestion(MockObjects.PredictionClient, predictionContext, CancellationToken.None);
@@ -961,7 +959,7 @@ public void VerifyAggregationDataSplitAtGetSuggestion()
         /// Verifies that the Suggestion field is divided into events when SuggestionDisplayedTelemetryData is added.
         /// </summary>
         [Fact]
-        public void VerifyAggregationDataSplitAtAcceptSuggestion()
+        public void VerifyAggregationDataSplitAtDisplaySuggestion()
         {
             var expectedTelemetryCount = 64;
             var expectedSuggestionSessionInFirstBatch = expectedTelemetryCount;
@@ -971,15 +969,14 @@ public void VerifyAggregationDataSplitAtAcceptSuggestion()
 
             for (int i = 0; i < expectedTelemetryCount - 1; ++i)
             {
-                // Call the methods a few times to make sure the telemetry data is less than 8092 but the next such call will
-                // make it larger than it.
+                // Call the methods a few times to make sure the telemetry data is less than AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
                 predictionContext = PredictionContext.Create($"Clear-Variable -Name my* -Scop");
                 var _ = azPredictor.GetSuggestion(MockObjects.PredictionClient, predictionContext, CancellationToken.None);
             }
 
-            // It's easier to pad the cached telemetry event with the command without parameters. With parameters, it's more likely to exceed the
-            // buffer size.
+            // This call just to make sure that the size is close enough to AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
             predictionContext = PredictionContext.Create("Get-ChildIte");
+
             suggestionPackage = azPredictor.GetSuggestion(MockObjects.PredictionClient, predictionContext, CancellationToken.None);
 
             VerifyTelemetryDispatchCount(expectedTelemetryCount, telemetryClient);
@@ -991,9 +988,8 @@ public void VerifyAggregationDataSplitAtAcceptSuggestion()
             telemetryClient.ExceptedTelemetryDispatchCount = expectedTelemetryCount;
 
             // OnSuggestionDisplayed makes the property value size larger than AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
-            // But the additional data from SuggestionDisplayedTelemetryData is small so we are still less than the maximum application insight property value size.
             azPredictor.OnSuggestionDisplayed(MockObjects.PredictionClient, suggestionPackage.Session.Value, 1);
-            // We'll send the first batch contains the found suggestions and displayed info when we process SuggestionAcceptedTelemetryData.
+            // We'll send the first batch that contains the found suggestions when we process SuggestionDisplayedTelemetryData.
             azPredictor.OnSuggestionAccepted(MockObjects.PredictionClient, suggestionPackage.Session.Value, "Get-ChildItem");
 
             VerifyTelemetryDispatchCount(expectedTelemetryCount, telemetryClient);
@@ -1004,10 +1000,8 @@ public void VerifyAggregationDataSplitAtAcceptSuggestion()
             Assert.Equal(expectedSuggestionSessionInFirstBatch, suggestionSessions.Count());
             Assert.True(suggestionSessions.All((s) => s.ContainsKey(GetSuggestionTelemetryData.PropertyNameFound) && s.ContainsKey(GetSuggestionTelemetryData.PropertyNameUserInput)));
             Assert.True(suggestionSessions.All((s) => !s.ContainsKey(SuggestionAcceptedTelemetryData.PropertyNameAccepted)));
-            Assert.True(suggestionSessions.SkipLast(1).All((s) => !s.ContainsKey(SuggestionDisplayedTelemetryData.PropertyNameDisplayed) && !s.ContainsKey(GetSuggestionTelemetryData.PropertyNameSuggestionSessionId)));
+            Assert.True(suggestionSessions.All((s) => !s.ContainsKey(SuggestionDisplayedTelemetryData.PropertyNameDisplayed)));
             Assert.Equal(suggestionPackage.Session.Value, ((JsonElement)suggestionSessions.Last()[GetSuggestionTelemetryData.PropertyNameSuggestionSessionId]).GetUInt32());
-            Assert.Equal(1, ((JsonElement)suggestionSessions.Last()[SuggestionDisplayedTelemetryData.PropertyNameDisplayed])[0].GetInt32());
-            Assert.Equal(1, ((JsonElement)suggestionSessions.Last()[SuggestionDisplayedTelemetryData.PropertyNameDisplayed])[1].GetInt32());
 
             recordedTelemetry = telemetryClient.RecordedTelemetry[1];
             suggestionSessions = JsonSerializer.Deserialize<IList<IDictionary<string, object>>>(recordedTelemetry.Properties[GetSuggestionTelemetryData.PropertyNamePrediction]);
@@ -1016,57 +1010,55 @@ public void VerifyAggregationDataSplitAtAcceptSuggestion()
             Assert.False(suggestionSessions[0].ContainsKey(GetSuggestionTelemetryData.PropertyNameUserInput));
             Assert.False(suggestionSessions[0].ContainsKey(GetSuggestionTelemetryData.PropertyNameIsCancelled));
             Assert.Equal(suggestionPackage.Session.Value, ((JsonElement)suggestionSessions[0][GetSuggestionTelemetryData.PropertyNameSuggestionSessionId]).GetUInt32());
+            Assert.Equal(1, ((JsonElement)suggestionSessions[0][SuggestionDisplayedTelemetryData.PropertyNameDisplayed])[0].GetInt32());
+            Assert.Equal(1, ((JsonElement)suggestionSessions[0][SuggestionDisplayedTelemetryData.PropertyNameDisplayed])[1].GetInt32());
             Assert.Equal("Get-ChildItem", ((JsonElement)suggestionSessions[0][SuggestionAcceptedTelemetryData.PropertyNameAccepted]).GetString());
         }
 
         /// <summary>
-        /// Verifies that the Suggestion field is divided into events when history is added.
+        /// Verifies that the Suggestion field is divided into events when SuggestionAcceptedTelemetryData is added.
         /// </summary>
         [Fact]
-        public void VerifyAggregationDataSplitAtCommandHistory()
+        public void VerifyAggregationDataSplitAtAcceptSuggestion()
         {
             var expectedTelemetryCount = 64;
-            var expectedSuggestionSessionInFirstBatch = expectedTelemetryCount;
+            var expectedSuggestionSessionInFirstBatch = expectedTelemetryCount - 1; // The display info is in the same suggstion session as the GetSuggestionTelemetryData
             var (azPredictor, telemetryClient) = CreateTestObjects(throwException: false, expectedTelemetryCount, flushTelemetry: false);
             PredictionContext predictionContext = default;
             SuggestionPackage suggestionPackage = default;
 
             for (int i = 0; i < expectedTelemetryCount - 1; ++i)
             {
-                // Call the methods a few times to make sure the telemetry data is less than 8092 but the CommandAccepted and CommandExecuted events
-                // make it larger than it.
-                predictionContext = PredictionContext.Create($"Clear-Variable -Name my* -Scop");
-                var _ = suggestionPackage = azPredictor.GetSuggestion(MockObjects.PredictionClient, predictionContext, CancellationToken.None);
+                // Call the methods a few times to make sure the telemetry data is less than AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
+                predictionContext = PredictionContext.Create($"Clear-Variable -Name my* -Scope");
+                suggestionPackage = azPredictor.GetSuggestion(MockObjects.PredictionClient, predictionContext, CancellationToken.None);
             }
 
-            // It's easier to pad the cached telemetry event with the command without parameters. With parameters, it's more likely to exceed the
-            // buffer size.
-            predictionContext = PredictionContext.Create("Get-ChildIte");
-            suggestionPackage = azPredictor.GetSuggestion(MockObjects.PredictionClient, predictionContext, CancellationToken.None);
+            // With this call, the size is still less than AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
+            azPredictor.OnSuggestionDisplayed(MockObjects.PredictionClient, suggestionPackage.Session.Value, 1);
 
             VerifyTelemetryDispatchCount(expectedTelemetryCount, telemetryClient);
             Assert.True(telemetryClient.RecordedAggregatedData.EstimateSuggestionSessionSize < AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer);
 
-            expectedTelemetryCount = 3;
+            expectedTelemetryCount = 1;
             var expectedSuggestionSessionInSecondBatch = 1;
             telemetryClient.ResetWaitingTasks();
             telemetryClient.ExceptedTelemetryDispatchCount = expectedTelemetryCount;
 
-            // OnSuggestionDisplayed makes the property value size larger than AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
-            // But the additional data from SuggestionDisplayedTelemetryData is small so we are still less than the maximum application insight property value size.
-            azPredictor.OnSuggestionDisplayed(MockObjects.PredictionClient, suggestionPackage.Session.Value, 1);
+            // With this call, the size will exceed AzPredictorTelemetryClient.MaxPropertyValueSizeWithBuffer.
             // We'll send the first batch contains the found suggestions and displayed info when we process SuggestionAcceptedTelemetryData.
-            azPredictor.OnCommandLineAccepted(MockObjects.PredictionClient, new string[] { "Get-ChildItem" });
-            azPredictor.OnCommandLineExecuted(MockObjects.PredictionClient, "Get-ChildItem", success: true);
+            var acceptedSuggestion = "Clear-Variable -Name my* -Scope Global";
+            azPredictor.OnSuggestionAccepted(MockObjects.PredictionClient, suggestionPackage.Session.Value, acceptedSuggestion);
 
             VerifyTelemetryDispatchCount(expectedTelemetryCount, telemetryClient);
+            telemetryClient.FlushTelemetry();
 
             var recordedTelemetry = telemetryClient.RecordedTelemetry[0];
             var suggestionSessions = JsonSerializer.Deserialize<IList<IDictionary<string, object>>>(recordedTelemetry.Properties[GetSuggestionTelemetryData.PropertyNamePrediction]);
             Assert.Equal(expectedSuggestionSessionInFirstBatch, suggestionSessions.Count());
             Assert.True(suggestionSessions.All((s) => s.ContainsKey(GetSuggestionTelemetryData.PropertyNameFound) && s.ContainsKey(GetSuggestionTelemetryData.PropertyNameUserInput)));
             Assert.True(suggestionSessions.All((s) => !s.ContainsKey(SuggestionAcceptedTelemetryData.PropertyNameAccepted)));
-            Assert.True(suggestionSessions.SkipLast(1).All((s) => !s.ContainsKey(SuggestionDisplayedTelemetryData.PropertyNameDisplayed)));
+            Assert.True(suggestionSessions.SkipLast(1).All((s) => !s.ContainsKey(SuggestionDisplayedTelemetryData.PropertyNameDisplayed) && !s.ContainsKey(GetSuggestionTelemetryData.PropertyNameSuggestionSessionId)));
             Assert.Equal(suggestionPackage.Session.Value, ((JsonElement)suggestionSessions.Last()[GetSuggestionTelemetryData.PropertyNameSuggestionSessionId]).GetUInt32());
             Assert.Equal(1, ((JsonElement)suggestionSessions.Last()[SuggestionDisplayedTelemetryData.PropertyNameDisplayed])[0].GetInt32());
             Assert.Equal(1, ((JsonElement)suggestionSessions.Last()[SuggestionDisplayedTelemetryData.PropertyNameDisplayed])[1].GetInt32());
@@ -1078,7 +1070,7 @@ public void VerifyAggregationDataSplitAtCommandHistory()
             Assert.False(suggestionSessions[0].ContainsKey(GetSuggestionTelemetryData.PropertyNameUserInput));
             Assert.False(suggestionSessions[0].ContainsKey(GetSuggestionTelemetryData.PropertyNameIsCancelled));
             Assert.Equal(suggestionPackage.Session.Value, ((JsonElement)suggestionSessions[0][GetSuggestionTelemetryData.PropertyNameSuggestionSessionId]).GetUInt32());
-            Assert.Equal("Get-ChildItem", recordedTelemetry.Properties[HistoryTelemetryData.PropertyNameCommand]);
+            Assert.Equal(acceptedSuggestion, ((JsonElement)suggestionSessions[0][SuggestionAcceptedTelemetryData.PropertyNameAccepted]).GetString());
         }
 
         private (AzPredictor, MockAzPredictorTelemetryClient) CreateTestObjects(bool throwException, int expectedTelemetryEvent, bool flushTelemetry = true)

tools/Az.Tools.Predictor/Az.Tools.Predictor.Test/Mocks/MockAzContext.cs

@@ -19,22 +19,26 @@ namespace Microsoft.Azure.PowerShell.Tools.AzPredictor.Test.Mocks
 {
     sealed class MockAzContext : IAzContext
     {
+        public string InstallationId => Guid.Empty.ToString();
+
         public string HashUserId => "TestUserId";
 
         public string MacAddress => "TestMacAddress";
 
         public string OSVersion => "TestOSVersion";
 
-        public Version PowerShellVersion => Version.Parse("0.0.0.0");
+        public Version PowerShellVersion => new();
 
-        public Version ModuleVersion => Version.Parse("0.0.0.0");
+        public Version ModuleVersion => new();
 
-        public Version AzVersion => Version.Parse("0.0.0.0");
+        public Version AzVersion => new();
 
         public int Cohort { get; set; } = -1;
 
         public bool IsInternal => true;
 
+        public string HostEnvironment => "TestEnvironment";
+
         public Runspace DefaultRunspace => default;
 
         public void UpdateContext()

tools/Az.Tools.Predictor/Az.Tools.Predictor/AzCLIProfileInfo.cs

@@ -0,0 +1,33 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using Newtonsoft.Json;
+using System;
+using System.IO;
+
+// This is copied from src/Accounts/Authentication/Modules/AzCliProfileInfo.cs
+
+namespace Microsoft.Azure.PowerShell.Tools.AzPredictor
+{
+    /// <summary>
+    /// this class defines installation id field in Azure CLI context. This information is shared between Azure CLI and Azure PowerShell
+    /// </summary>
+    internal class AzCLIProfileInfo
+    {
+        [JsonProperty(PropertyName = "installationId")]
+        internal string installationId { get; set; }
+
+        public static readonly string AzCLIProfileFile = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), ".Azure", "AzureProfile.json");
+    }
+}