Add cloud error code and new type of error (#243)

Co-authored-by: Erich(Renyong) Wang <[email protected]>

Author: dingmeng-xue

src/Authentication.Abstractions/AzurePSErrorDataKeys.cs

@@ -41,6 +41,11 @@ public static class AzurePSErrorDataKeys
         /// </summary>
         public static readonly string HttpStatusCode = KeyPrefix + "HttpStatusCode";
 
+        /// <summary>
+        /// Key for cloud error code in http response body
+        /// </summary>
+        public static readonly string CloudErrorCodeKey = KeyPrefix + "CloudErrorCode";
+
         /// <summary>
         /// Key for authentication error code which normally comes from MSAL.NET
         /// </summary>
@@ -100,6 +105,7 @@ public static bool IsKeyPredefined(string key)
             ErrorLineNumberKey,
             ErrorFileNameKey,
             ErrorHResultKey,
+            CloudErrorCodeKey,
         });
     }
 }

src/Authentication.Abstractions/Interfaces/IContainsAzPSErrorData.cs

@@ -74,5 +74,12 @@ public override string ToString()
         /// Error that belongs to neither UserError nor ServiceError
         /// </summary>
         public static ErrorKind InternalError = new ErrorKind("Internal");
+
+        /// <summary>
+        /// Error reported by cmdlet execution but it is considered as false positive error. 
+        /// This error kind is used in the case that we don't want to introduce breaking change 
+        /// but result should be considered as succeeded.
+        /// </summary>
+        public static ErrorKind FalseError = new ErrorKind("FalseError");
     }
 }

src/Common/MetricHelper.cs

@@ -303,27 +303,25 @@ private void PopulatePropertiesFromQos(AzurePSQoSEvent qos, IDictionary<string,
                 eventProperties.Add("interval", ((TimeSpan)(qos.StartTime - qos.PreviousEndTime)).ToString("c"));
             }
 
-            if (!qos.IsSuccess && qos.Exception?.Data?.Contains(AzurePSErrorDataKeys.ErrorKindKey) == true)
-            {
-                eventProperties.Add("pebcak", (qos.Exception.Data[AzurePSErrorDataKeys.ErrorKindKey] == ErrorKind.UserError).ToString());
-            }
-
             if (qos.Exception != null && populateException)
             {
                 eventProperties["exception-type"] = qos.Exception.GetType().ToString();
+                string cloudErrorCode = null;
                 if (qos.Exception is CloudException cloudException)
                 {
                     eventProperties["exception-httpcode"] = cloudException.Response?.StatusCode.ToString();
+                    cloudErrorCode = cloudException.Body?.Code;
                 }
                 Exception innerException = qos.Exception.InnerException;
                 List<Exception> innerExceptions = new List<Exception>();
                 string innerExceptionStr = string.Empty;
                 while (innerException != null)
                 {
                     innerExceptions.Add(innerException);
-                    if (innerException is CloudException)
+                    if (innerException is CloudException innerCloudException)
                     {
-                        eventProperties["exception-httpcode"] = ((CloudException)qos.Exception).Response?.StatusCode.ToString();
+                        eventProperties["exception-httpcode"] = innerCloudException.Response?.StatusCode.ToString();
+                        cloudErrorCode = innerCloudException.Body?.Code;
                     }
                     innerException = innerException.InnerException;
                 }
@@ -339,12 +337,33 @@ private void PopulatePropertiesFromQos(AzurePSQoSEvent qos, IDictionary<string,
                     eventProperties["exception-stack"] = stack;
                 }
 
+                if (cloudErrorCode != null && !(qos.Exception.Data?.Contains(AzurePSErrorDataKeys.CloudErrorCodeKey) == true))
+                {
+                    qos.Exception.Data[AzurePSErrorDataKeys.CloudErrorCodeKey] = cloudErrorCode;
+                }
+
                 if (qos.Exception.Data != null)
                 {
                     if (qos.Exception.Data.Contains(AzurePSErrorDataKeys.HttpStatusCode))
                     {
                         eventProperties["exception-httpcode"] = qos.Exception.Data[AzurePSErrorDataKeys.HttpStatusCode].ToString();
                     }
+
+                    if (qos.Exception.Data.Contains(AzurePSErrorDataKeys.CloudErrorCodeKey) == true)
+                    {
+                        string existingErrorKind = qos.Exception.Data.Contains(AzurePSErrorDataKeys.ErrorKindKey)
+                                                    ? qos.Exception.Data[AzurePSErrorDataKeys.ErrorKindKey].ToString()
+                                                    : null;
+                        cloudErrorCode = (string)qos.Exception.Data[AzurePSErrorDataKeys.CloudErrorCodeKey];
+                        // For the time being, we consider ResourceNotFound and ResourceGroupNotFound as user's input error. 
+                        // We are considering if ResourceNotFound should be false positive error.
+                        if (("ResourceNotFound".Equals(cloudErrorCode) || "ResourceGroupNotFound".Equals(cloudErrorCode))
+                            && existingErrorKind != ErrorKind.FalseError)
+                        {
+                            qos.Exception.Data[AzurePSErrorDataKeys.ErrorKindKey] = ErrorKind.UserError;
+                        }
+                    }
+
                     StringBuilder sb = new StringBuilder();
                     foreach (var key in qos.Exception.Data?.Keys)
                     {
@@ -363,6 +382,20 @@ private void PopulatePropertiesFromQos(AzurePSQoSEvent qos, IDictionary<string,
                         eventProperties["exception-data"] = sb.ToString();
                     }
                 }
+                //We record the case which exception has no message
+                if (string.IsNullOrEmpty(qos.Exception.Message))
+                {
+                    eventProperties["exception-emptymessage"] = true.ToString();
+                }
+
+                if (!qos.IsSuccess && qos.Exception?.Data?.Contains(AzurePSErrorDataKeys.ErrorKindKey) == true)
+                {
+                    eventProperties["pebcak"] = (qos.Exception.Data[AzurePSErrorDataKeys.ErrorKindKey] == ErrorKind.UserError).ToString();
+                    if (qos.Exception.Data[AzurePSErrorDataKeys.ErrorKindKey] == ErrorKind.FalseError)
+                    {
+                        eventProperties["IsSuccess"] = true.ToString();
+                    }
+                }
             }
 
             if (qos.InputFromPipeline != null)