Swallow all the exceptions from the callback (#18301)

Author: kceiw

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

@@ -29,6 +29,7 @@ public record TelemetryRecord(string EventName, IDictionary<string, string> Prop
         public SuggestionDisplayedTelemetryData SuggestionDisplayedData { get; internal set; }
         public SuggestionAcceptedTelemetryData SuggestionAcceptedData { get; internal set; }
         public ParameterMapTelemetryData ParameterMapData { get; internal set; }
+        public GeneralExceptionTelemetryData ExceptionData { get; internal set; }
         public IList<TelemetryRecord> RecordedTelemetry { get; internal set; } = new List<TelemetryRecord>();
         public IList<ITelemetryData> DispatchedTelemetry { get; internal set; } = new List<ITelemetryData>();
         public AggregatedTelemetryData RecordedAggregatedData { get; private set; }
@@ -101,6 +102,13 @@ public override void OnLoadParameterMap(ParameterMapTelemetryData telemetryData)
             ParameterMapData = telemetryData;
         }
 
+        /// <inheritdoc/>
+        public override void OnGeneralException(GeneralExceptionTelemetryData telemetryData)
+        {
+            base.OnGeneralException(telemetryData);
+            ExceptionData = telemetryData;
+        }
+
         public void FlushTelemetry() => SendAggregatedTelemetryData();
 
         public void ResetWaitingTasks()

tools/Az.Tools.Predictor/Az.Tools.Predictor/AzPredictor.cs

@@ -314,12 +314,13 @@ public virtual CommandLineSuggestion GetSuggestion(PredictionContext context, in
         }
 
         /// <inheritdoc/>
-        public virtual void RecordHistory(CommandAst history)
-        {
-            Validation.CheckArgument(history, $"{nameof(history)} cannot be null.");
+        public virtual void RecordHistory(CommandAst history) =>
+            ExceptionUtilities.RecordExceptionWrapper(_telemetryClient, () =>
+            {
+                Validation.CheckArgument(history, $"{nameof(history)} cannot be null.");
 
-            _parameterValuePredictor.ProcessHistoryCommand(history);
-        }
+                _parameterValuePredictor.ProcessHistoryCommand(history);
+            });
 
         /// <inheritdoc/>
         public bool IsSupportedCommand(string cmd) => IsRecognizedCommand(cmd)

tools/Az.Tools.Predictor/Az.Tools.Predictor/AzPredictorService.cs

@@ -139,6 +139,7 @@ public virtual void OnGetSuggestion(GetSuggestionTelemetryData telemetryData)
             System.Diagnostics.Trace.WriteLine("Recording GetSuggestion");
 #endif
         }
+
         /// <inheritdoc/>
         public virtual void OnSuggestionDisplayed(SuggestionDisplayedTelemetryData telemetryData)
         {
@@ -179,6 +180,16 @@ public void OnParseCommandLineFailure(CommandLineParsingTelemetryData telemetryD
 #endif
         }
 
+        /// <inheritdoc/>
+        public virtual void OnGeneralException(GeneralExceptionTelemetryData telemetryData)
+        {
+            PostTelemetryData(telemetryData);
+
+#if TELEMETRY_TRACE && DEBUG
+            System.Diagnostics.Trace.WriteLine("Recording GeneralException");
+#endif
+        }
+
         /// <summary>
         /// Gets the client that can send telemetry via Application Insight.
         /// </summary>
@@ -216,6 +227,9 @@ protected virtual void DispatchTelemetryData(ITelemetryData telemetryData)
                 case CommandLineParsingTelemetryData commandLineParsing:
                     ProcessTelemetryData(commandLineParsing);
                     break;
+                case GeneralExceptionTelemetryData exception:
+                    ProcessTelemetryData(exception);
+                    break;
             }
         }
 
@@ -553,6 +567,17 @@ private void ProcessTelemetryData(CommandLineParsingTelemetryData telemetryData)
             }
         }
 
+        /// <summary>
+        /// Processes the telemetry with the exception.
+        /// </summary>
+        private void ProcessTelemetryData(GeneralExceptionTelemetryData telemetryData)
+        {
+            if (telemetryData.Exception != null)
+            {
+                SendException("An error occurred that wasn't caught in any scenarios.", telemetryData, telemetryData.Exception);
+            }
+        }
+
         /// <summary>
         /// Add the common properties to the telemetry event.
         /// </summary>

tools/Az.Tools.Predictor/Az.Tools.Predictor/Telemetry/AzPredictorTelemetryClient.cs

@@ -0,0 +1,48 @@
+// ----------------------------------------------------------------------------------
+//
+// 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 System;
+using System.Management.Automation.Subsystem.Prediction;
+
+namespace Microsoft.Azure.PowerShell.Tools.AzPredictor.Telemetry
+{
+    /// <summary>
+    /// The data to collect in <see cref="ITelemetryClient.OnGeneralException(GeneralExceptionTelemetryData)"/>.
+    /// </summary>
+    public sealed class GeneralExceptionTelemetryData : ITelemetryData
+    {
+        /// <inheritdoc/>
+        public PredictionClient Client { get; }
+
+        /// <inheritdoc/>
+        string ITelemetryData.CommandId { get; set; }
+
+        /// <inheritdoc/>
+        string ITelemetryData.RequestId { get; set; }
+
+        /// <summary>
+        /// Gets the exception.
+        /// </summary>
+        public Exception Exception { get; }
+
+        /// <summary>
+        /// Creates a new instance of <see cref="GeneralExceptionTelemetryData"/>.
+        /// </summary>
+        /// <param name="exception">The exception that is thrown.</param>
+        public GeneralExceptionTelemetryData(Exception exception)
+        {
+            Exception = exception;
+        }
+    }
+}

tools/Az.Tools.Predictor/Az.Tools.Predictor/Telemetry/GeneralExceptionTelemetryData.cs

@@ -12,6 +12,8 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
+using System;
+
 namespace Microsoft.Azure.PowerShell.Tools.AzPredictor.Telemetry
 {
     /// <summary>
@@ -70,5 +72,14 @@ public interface ITelemetryClient
         /// </summary>
         /// <param name="telemetryData">The data to collect.</param>
         public void OnParseCommandLineFailure(CommandLineParsingTelemetryData telemetryData);
+
+        /// <summary>
+        /// Collects when there is a non-specific failure in the code.
+        /// </summary>
+        /// <remarks>
+        /// Use the other methods to record the exceptions in those events.
+        /// This is only used when it's not in any specific telemetry event.
+        /// </remarks>
+        public void OnGeneralException(GeneralExceptionTelemetryData e);
     }
 }

tools/Az.Tools.Predictor/Az.Tools.Predictor/Telemetry/ITelemetryClient.cs

@@ -0,0 +1,40 @@
+// ----------------------------------------------------------------------------------
+//
+// 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 System;
+using Microsoft.Azure.PowerShell.Tools.AzPredictor.Telemetry;
+
+namespace Microsoft.Azure.PowerShell.Tools.AzPredictor.Utilities
+{
+    /// <summary>
+    /// A utilities class to provide functions around exceptions.
+    /// </summary>
+    internal static class ExceptionUtilities
+    {
+        /// <summary>
+        /// Handles all exceptions and record it in the telemetry.
+        /// </summary>
+        public static void RecordExceptionWrapper(ITelemetryClient telemetryClient, Action action)
+        {
+            try
+            {
+                action();
+            }
+            catch (Exception e)
+            {
+                telemetryClient.OnGeneralException(new GeneralExceptionTelemetryData(e));
+            }
+        }
+    }
+}