Azure · JoshLove-msft · May 3, 2023 · Apr 21, 2023 · Apr 25, 2023 · Apr 25, 2023
@@ -344,7 +344,7 @@ private async Task ExtendResourceGroupExpirationAsync()
             // unexpected response => throw an exception
             if (response.Status != 200)
             {
-                throw await _clientDiagnostics.CreateRequestFailedExceptionAsync(response);
+                throw new RequestFailedException(response);
             }
 
             // parse the response
@@ -392,7 +392,7 @@ private async Task ExtendResourceGroupExpirationAsync()
                     response = await pipeline.SendRequestAsync(request, CancellationToken.None);
                     if (response.Status != 200)
                     {
-                        throw await _clientDiagnostics.CreateRequestFailedExceptionAsync(response);
+                        throw new RequestFailedException(response);
                     }
                 }
             }

@@ -4,6 +4,9 @@
 
 ### Features Added
 
+- Added the `GetRawResponse` method to `RequestFailedException`.
+- Added overloads of `Operation<T>.WaitForCompletion` and `Operation.WaitForCompletionResponse` that take a `DelayStrategy`.
+
 ### Breaking Changes
 
 ### Bugs Fixed

@@ -229,6 +229,7 @@ public RequestFailedException(string message, System.Exception? innerException)
         public string? ErrorCode { get { throw null; } }
         public int Status { get { throw null; } }
         public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
+        public Azure.Response? GetRawResponse() { throw null; }
     }
     public abstract partial class Response : System.IDisposable
     {

@@ -229,6 +229,7 @@ public RequestFailedException(string message, System.Exception? innerException)
         public string? ErrorCode { get { throw null; } }
         public int Status { get { throw null; } }
         public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
+        public Azure.Response? GetRawResponse() { throw null; }
     }
     public abstract partial class Response : System.IDisposable
     {

@@ -229,6 +229,7 @@ public RequestFailedException(string message, System.Exception? innerException)
         public string? ErrorCode { get { throw null; } }
         public int Status { get { throw null; } }
         public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
+        public Azure.Response? GetRawResponse() { throw null; }
     }
     public abstract partial class Response : System.IDisposable
     {

@@ -229,6 +229,7 @@ public RequestFailedException(string message, System.Exception? innerException)
         public string? ErrorCode { get { throw null; } }
         public int Status { get { throw null; } }
         public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
+        public Azure.Response? GetRawResponse() { throw null; }
     }
     public abstract partial class Response : System.IDisposable
     {

@@ -229,6 +229,7 @@ public RequestFailedException(string message, System.Exception? innerException)
         public string? ErrorCode { get { throw null; } }
         public int Status { get { throw null; } }
         public override void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) { }
+        public Azure.Response? GetRawResponse() { throw null; }
     }
     public abstract partial class Response : System.IDisposable
     {

@@ -31,6 +31,11 @@ public class RequestFailedException : Exception, ISerializable
         /// </summary>
         public string? ErrorCode { get; }
 
+        /// <summary>
+        /// Gets the response, if any, that led to the exception.
+        /// </summary>
+        private readonly Response? _response;
+
         /// <summary>Initializes a new instance of the <see cref="RequestFailedException"></see> class with a specified error message.</summary>
         /// <param name="message">The message that describes the error.</param>
         public RequestFailedException(string message) : this(0, message)
@@ -105,6 +110,7 @@ public RequestFailedException(Response response)
         public RequestFailedException(Response response, Exception? innerException)
             : this(response.Status, GetRequestFailedExceptionContent(response), innerException)
         {
+            _response = response;
         }
 
         /// <inheritdoc />
@@ -126,8 +132,15 @@ public override void GetObjectData(SerializationInfo info, StreamingContext cont
             base.GetObjectData(info, context);
         }
 
+        /// <summary>
+        /// Gets the response, if any, that led to the exception.
+        /// </summary>
+        public Response? GetRawResponse() => _response;
+
         internal static (string FormattedError, string? ErrorCode, IDictionary<string, string>? Data) GetRequestFailedExceptionContent(Response response)
         {
+            BufferResponseIfNeeded(response);
+
             bool parseSuccess = response.RequestFailedDetailsParser == null ? TryExtractErrorContent(response, out ResponseError? error, out IDictionary<string, string>? data) : response.RequestFailedDetailsParser.TryParse(response, out error, out data);
             StringBuilder messageBuilder = new();
 
@@ -191,25 +204,23 @@ internal static (string FormattedError, string? ErrorCode, IDictionary<string, s
             return (formatMessage, error?.Code, data);
         }
 
-        /// <summary>
-        /// This is intentionally sync-only as it will only be called by the ctor.
-        /// </summary>
-        /// <param name="response"></param>
-        /// <returns></returns>
-        internal static string? ReadContent(Response response)
+        private static void BufferResponseIfNeeded(Response response)
         {
-            string? content = null;
-
-            if (response.ContentStream != null &&
-                ContentTypeUtilities.TryGetTextEncoding(response.Headers.ContentType, out var encoding))
+            // Buffer into a memory stream if not already buffered
+            if (response.ContentStream is null or MemoryStream)
             {
-                using (var streamReader = new StreamReader(response.ContentStream, encoding))
-                {
-                    content = streamReader.ReadToEnd();
-                }
+                return;
             }
 
-            return content;
+            var bufferedStream = new MemoryStream();
+            response.ContentStream.CopyTo(bufferedStream);
+
+            // Dispose the unbuffered stream
+            response.ContentStream.Dispose();
+
+            // Reset the position of the buffered stream and set it on the response
+            bufferedStream.Position = 0;
+            response.ContentStream = bufferedStream;
         }
 
         internal static bool TryExtractErrorContent(Response response, out ResponseError? error, out IDictionary<string, string>? data)
@@ -218,18 +229,9 @@ internal static bool TryExtractErrorContent(Response response, out ResponseError
             data = null;
             try
             {
-                string? content = null;
-                if (response.ContentStream != null && response.ContentStream.CanSeek)
-                {
-                    content = response.Content.ToString();
-                }
-                else
-                {
-                    // this path should only happen in exceptional cases such as when
-                    // the RFE ctor was called directly by client or customer code with an un-buffered response.
-                    // Generated code would never do this.
-                    content = ReadContent(response);
-                }
+                // The response content is buffered at this point.
+                string? content = response.Content.ToString();
+
                 // Optimistic check for JSON object we expect
                 if (content == null || !content.StartsWith("{", StringComparison.OrdinalIgnoreCase))
                 {

@@ -18,10 +18,6 @@ namespace Azure.Core.Pipeline
 {
     internal class ClientDiagnostics : DiagnosticScopeFactory
     {
-        private const string DefaultMessage = "Service request failed.";
-
-        private readonly HttpMessageSanitizer _sanitizer;
-
         /// <summary>
         /// Initializes a new instance of the <see cref="ClientDiagnostics"/> class.
         /// </summary>
@@ -55,7 +51,6 @@ public ClientDiagnostics(ClientOptions options, bool? suppressNestedClientActivi
         public ClientDiagnostics(string optionsNamespace, string? providerNamespace, DiagnosticsOptions diagnosticsOptions, bool? suppressNestedClientActivities = null)
             : base(optionsNamespace, providerNamespace, diagnosticsOptions.IsDistributedTracingEnabled, suppressNestedClientActivities.GetValueOrDefault(false))
         {
-            _sanitizer = CreateMessageSanitizer(diagnosticsOptions);
         }
 
         internal static HttpMessageSanitizer CreateMessageSanitizer(DiagnosticsOptions diagnostics)
@@ -65,154 +60,6 @@ internal static HttpMessageSanitizer CreateMessageSanitizer(DiagnosticsOptions d
                 diagnostics.LoggedHeaderNames.ToArray());
         }
 
-        internal static ResponseError? ExtractAzureErrorContent(string? content)
-        {
-            try
-            {
-                // Optimistic check for JSON object we expect
-                if (content == null ||
-                    !content.StartsWith("{", StringComparison.OrdinalIgnoreCase)) return null;
-
-                return JsonSerializer.Deserialize<ErrorResponse>(content)?.Error;
-            }
-            catch (Exception)
-            {
-                // Ignore any failures - unexpected content will be
-                // included verbatim in the detailed error message
-            }
-
-            return null;
-        }
-
-        public async ValueTask<RequestFailedException> CreateRequestFailedExceptionAsync(Response response, ResponseError? error = null, IDictionary<string, string>? additionalInfo = null, Exception? innerException = null)
-        {
-            if (GetType() == typeof(ClientDiagnostics) && error is null && additionalInfo is null)
-            {
-                return new RequestFailedException(response, innerException);
-            }
-
-            var content = await ReadContentAsync(response, true).ConfigureAwait(false);
-            return CreateRequestFailedExceptionWithContent(response, error, content, additionalInfo, innerException);
-        }
-
-        public RequestFailedException CreateRequestFailedException(Response response, ResponseError? error = null, IDictionary<string, string>? additionalInfo = null, Exception? innerException = null)
-        {
-            if (GetType() == typeof(ClientDiagnostics) && error is null && additionalInfo is null)
-            {
-                return new RequestFailedException(response, innerException);
-            }
-
-            string? content = ReadContentAsync(response, false).EnsureCompleted();
-            return CreateRequestFailedExceptionWithContent(response, error, content, additionalInfo, innerException);
-        }
-
-        private RequestFailedException CreateRequestFailedExceptionWithContent(
-            Response response,
-            ResponseError? error = null,
-            string? content = null,
-            IDictionary<string, string>? additionalInfo = null,
-            Exception? innerException = null)
-        {
-            error ??= ExtractAzureErrorContent(content);
-            var formatMessage = CreateRequestFailedMessageWithContent(response, error, content, additionalInfo, _sanitizer);
-            var exception = new RequestFailedException(response.Status, formatMessage, error?.Code, innerException);
-
-            if (additionalInfo != null)
-            {
-                foreach (KeyValuePair<string, string> keyValuePair in additionalInfo)
-                {
-                    exception.Data.Add(keyValuePair.Key, keyValuePair.Value);
-                }
-            }
-
-            return exception;
-        }
-
-        public async ValueTask<string> CreateRequestFailedMessageAsync(Response response, ResponseError? error, IDictionary<string, string>? additionalInfo, bool async)
-        {
-            var content = await ReadContentAsync(response, async).ConfigureAwait(false);
-            return CreateRequestFailedMessageWithContent(response, error, content, additionalInfo, _sanitizer);
-        }
-
-        internal static string CreateRequestFailedMessageWithContent(Response response, ResponseError? error, string? content, IDictionary<string, string>? additionalInfo, HttpMessageSanitizer sanitizer)
-        {
-            StringBuilder messageBuilder = new StringBuilder();
-
-            messageBuilder
-                .AppendLine(error?.Message ?? DefaultMessage)
-                .Append("Status: ")
-                .Append(response.Status.ToString(CultureInfo.InvariantCulture));
-
-            if (!string.IsNullOrEmpty(response.ReasonPhrase))
-            {
-                messageBuilder.Append(" (")
-                    .Append(response.ReasonPhrase)
-                    .AppendLine(")");
-            }
-            else
-            {
-                messageBuilder.AppendLine();
-            }
-
-            if (!string.IsNullOrWhiteSpace(error?.Code))
-            {
-                messageBuilder.Append("ErrorCode: ")
-                    .Append(error?.Code)
-                    .AppendLine();
-            }
-
-            if (additionalInfo != null && additionalInfo.Count > 0)
-            {
-                messageBuilder
-                    .AppendLine()
-                    .AppendLine("Additional Information:");
-                foreach (KeyValuePair<string, string> info in additionalInfo)
-                {
-                    messageBuilder
-                        .Append(info.Key)
-                        .Append(": ")
-                        .AppendLine(info.Value);
-                }
-            }
-
-            if (content != null)
-            {
-                messageBuilder
-                    .AppendLine()
-                    .AppendLine("Content:")
-                    .AppendLine(content);
-            }
-
-            messageBuilder
-                .AppendLine()
-                .AppendLine("Headers:");
-
-            foreach (HttpHeader responseHeader in response.Headers)
-            {
-                string headerValue = sanitizer.SanitizeHeader(responseHeader.Name, responseHeader.Value);
-                string header = $"{responseHeader.Name}: {headerValue}";
-                messageBuilder.AppendLine(header);
-            }
-
-            return messageBuilder.ToString();
-        }
-
-        internal static async ValueTask<string?> ReadContentAsync(Response response, bool async)
-        {
-            string? content = null;
-
-            if (response.ContentStream != null &&
-                ContentTypeUtilities.TryGetTextEncoding(response.Headers.ContentType, out var encoding))
-            {
-                using (var streamReader = new StreamReader(response.ContentStream, encoding))
-                {
-                    content = async ? await streamReader.ReadToEndAsync().ConfigureAwait(false) : streamReader.ReadToEnd();
-                }
-            }
-
-            return content;
-        }
-
         internal static string? GetResourceProviderNamespace(Assembly assembly)
         {
             foreach (var customAttribute in assembly.GetCustomAttributes(true))
@@ -227,11 +74,5 @@ internal static string CreateRequestFailedMessageWithContent(Response response,
 
             return null;
         }
-
-        private class ErrorResponse
-        {
-            [JsonPropertyName("error")]
-            public ResponseError? Error { get; set; }
-        }
     }
 }
@@ -230,9 +230,5 @@ protected DiagnosticScope CreateScope(string scopeName)
             scope.Start();
             return scope;
         }
-
-        protected async ValueTask<RequestFailedException> CreateException(bool async, Response response) => async
-            ? await _diagnostics.CreateRequestFailedExceptionAsync(response).ConfigureAwait(false)
-            : _diagnostics.CreateRequestFailedException(response);
     }
 }
@@ -261,7 +261,7 @@ protected override async ValueTask<Response> UpdateStatusAsync(bool async, Cance
 
                 if (!state.HasSucceeded && state.OperationFailedException == null)
                 {
-                    state = OperationState<T>.Failure(state.RawResponse, await CreateException(async, state.RawResponse).ConfigureAwait(false));
+                    state = OperationState<T>.Failure(state.RawResponse, new RequestFailedException(state.RawResponse));
                 }
 
                 asyncLock.SetValue(state);