Throw exception in CDNClient if http request is not successful (#672)

Provides a WebAPIRequestException subclass for source compatibility. Fixes #650

SteamKit2/SteamKit2/Steam/CDNClient.cs

@@ -258,6 +258,8 @@ public CDNClient( SteamClient steamClient, byte[] appTicket = null )
         /// No Steam CS servers available, or the suggested CellID is unavailable.
         /// Check that the <see cref="SteamClient"/> associated with this <see cref="CDNClient"/> instance is logged onto Steam.
         /// </exception>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task<IList<Server>> FetchServerListAsync( IPEndPoint csServer = null, uint? cellId = null, int maxServers = 20 )
         {
             DebugLog.Assert( steamClient.IsConnected, "CDNClient", "CMClient is not connected!" );
@@ -356,6 +358,8 @@ public async Task<IList<Server>> FetchServerListAsync( IPEndPoint csServer = nul
         /// </summary>
         /// <param name="csServer">The content server to connect to.</param>
         /// <exception cref="System.ArgumentNullException">csServer was null.</exception>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task ConnectAsync( Server csServer )
         {
             DebugLog.Assert( steamClient.IsConnected, "CDNClient", "CMClient is not connected!" );
@@ -411,6 +415,8 @@ public async Task ConnectAsync( Server csServer )
         /// This is used for decrypting filenames (if needed) in depot manifests, and processing depot chunks.
         /// </param>
         /// <param name="cdnAuthToken">CDN auth token for CDN content server endpoints.</param>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task AuthenticateDepotAsync( uint depotid, byte[] depotKey = null, string cdnAuthToken = null )
         {
             if ( depotIds.ContainsKey( depotid ) )
@@ -446,6 +452,8 @@ public async Task AuthenticateDepotAsync( uint depotid, byte[] depotKey = null,
         /// <param name="depotId">The id of the depot being accessed.</param>
         /// <param name="manifestId">The unique identifier of the manifest to be downloaded.</param>
         /// <returns>A <see cref="DepotManifest"/> instance that contains information about the files present within a depot.</returns>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task<DepotManifest> DownloadManifestAsync( uint depotId, ulong manifestId )
         {
             depotCdnAuthKeys.TryGetValue( depotId, out var cdnToken );
@@ -466,6 +474,8 @@ public async Task<DepotManifest> DownloadManifestAsync( uint depotId, ulong mani
         /// This is used for decrypting filenames (if needed) in depot manifests, and processing depot chunks.
         /// </param>
         /// <returns>A <see cref="DepotManifest"/> instance that contains information about the files present within a depot.</returns>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task<DepotManifest> DownloadManifestAsync( uint depotId, ulong manifestId, string host, string cdnAuthToken, byte[] depotKey = null )
         {
             var server = new Server
@@ -501,6 +511,8 @@ public async Task<DepotManifest> DownloadManifestAsync( uint depotId, ulong mani
         /// <returns>A <see cref="DepotChunk"/> instance that contains the data for the given chunk.</returns>
         /// <exception cref="System.ArgumentNullException">chunk's <see cref="DepotManifest.ChunkData.ChunkID"/> was null.</exception>
         /// <exception cref="System.IO.InvalidDataException">Thrown if the downloaded data does not match the expected length.</exception>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task<DepotChunk> DownloadDepotChunkAsync( uint depotId, DepotManifest.ChunkData chunk )
 #pragma warning restore 0419
 #pragma warning restore 1574
@@ -549,6 +561,8 @@ public async Task<DepotChunk> DownloadDepotChunkAsync( uint depotId, DepotManife
         /// </param>
         /// <exception cref="System.ArgumentNullException">chunk's <see cref="DepotManifest.ChunkData.ChunkID"/> was null.</exception>
         /// <exception cref="System.IO.InvalidDataException">Thrown if the downloaded data does not match the expected length.</exception>
+        /// <exception cref="HttpRequestException">An network error occurred when performing the request.</exception>
+        /// <exception cref="SteamKitWebRequestException">A network error occurred when performing the request.</exception>
         public async Task<DepotChunk> DownloadDepotChunkAsync( uint depotId, DepotManifest.ChunkData chunk, string host, string cdnAuthToken, byte[] depotKey = null)
 #pragma warning restore 1574
 #pragma warning restore 0419
@@ -632,6 +646,11 @@ async Task<byte[]> DoRawCommandAsync( Server server, HttpMethod method, string c
                 {
                     var response = await httpClient.SendAsync( request, cts.Token ).ConfigureAwait( false );
 
+                    if ( !response.IsSuccessStatusCode )
+                    {
+                        throw new SteamKitWebRequestException( $"Response status code does not indicate success: {response.StatusCode} ({response.ReasonPhrase}).", response );
+                    }
+
                     var responseData = await response.Content.ReadAsByteArrayAsync().ConfigureAwait( false );
                     return responseData;
                 }

SteamKit2/SteamKit2/Steam/WebAPI/WebAPI.cs

@@ -521,32 +521,4 @@ static HttpClient CreateDefaultHttpClient( Uri baseAddress )
             return client;
         }
     }
-
-    /// <summary>
-    /// Thrown when WebAPI request fails.
-    /// </summary>
-    public sealed class WebAPIRequestException : HttpRequestException
-    {
-        /// <summary>
-        /// Represents the status code of the HTTP response.
-        /// </summary>
-        public HttpStatusCode StatusCode { get; private set; }
-
-        /// <summary>
-        /// Represents the collection of HTTP response headers.
-        /// </summary>
-        public HttpResponseHeaders Headers { get; private set; }
-
-        /// <summary>
-        /// Initializes a new instance of the <see cref="WebAPIRequestException"/> class.
-        /// </summary>
-        /// <param name="message">The message that describes the error.</param>
-        /// <param name="response">HTTP response message including the status code and data.</param>
-        public WebAPIRequestException(string message, HttpResponseMessage response)
-            : base(message)
-        {
-            this.StatusCode = response.StatusCode;
-            this.Headers = response.Headers;
-        }
-    }
 }

SteamKit2/SteamKit2/Steam/WebAPI/WebAPIRequestException.cs

@@ -0,0 +1,20 @@
+using System.Net.Http;
+
+namespace SteamKit2
+{
+    /// <summary>
+    /// Thrown when WebAPI request fails.
+    /// </summary>
+    public sealed class WebAPIRequestException : SteamKitWebRequestException
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="WebAPIRequestException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        /// <param name="response">HTTP response message including the status code and data.</param>
+        public WebAPIRequestException(string message, HttpResponseMessage response)
+            : base(message, response)
+        {
+        }
+    }
+}

SteamKit2/SteamKit2/Util/SteamKitWebRequestException.cs

@@ -0,0 +1,34 @@
+using System.Net;
+using System.Net.Http;
+using System.Net.Http.Headers;
+
+namespace SteamKit2
+{
+    /// <summary>
+    /// Thrown when a HTTP request fails.
+    /// </summary>
+    public class SteamKitWebRequestException : HttpRequestException
+    {
+        /// <summary>
+        /// Represents the status code of the HTTP response.
+        /// </summary>
+        public HttpStatusCode StatusCode { get; private set; }
+
+        /// <summary>
+        /// Represents the collection of HTTP response headers.
+        /// </summary>
+        public HttpResponseHeaders Headers { get; private set; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SteamKitWebRequestException"/> class.
+        /// </summary>
+        /// <param name="message">The message that describes the error.</param>
+        /// <param name="response">HTTP response message including the status code and data.</param>
+        public SteamKitWebRequestException(string message, HttpResponseMessage response)
+            : base(message)
+        {
+            this.StatusCode = response.StatusCode;
+            this.Headers = response.Headers;
+        }
+    }
+}

SteamKit2/Tests/CDNClientFacts.cs

@@ -0,0 +1,37 @@
+using System;
+using System.Net;
+using System.Net.Http;
+using System.Threading;
+using System.Threading.Tasks;
+using SteamKit2;
+using Xunit;
+
+namespace Tests
+{
+    public class CDNClientFacts
+    {
+        [Fact]
+        public async Task ThrowsSteamKitWebExceptionOnUnsuccessfulWebResponse()
+        {
+            var configuration = SteamConfiguration.Create(x => x.WithHttpClientFactory(() => new HttpClient(new TeapotHttpMessageHandler())));
+            var steam = new SteamClient(configuration);
+            var client = new CDNClient(steam);
+
+            try
+            {
+                await client.DownloadManifestAsync(0, 0, "localhost", "12345");
+                throw new InvalidOperationException("This should be unreachable.");
+            }
+            catch (SteamKitWebRequestException ex)
+            {
+                Assert.Equal((HttpStatusCode)418, ex.StatusCode);
+            }
+        }
+
+        sealed class TeapotHttpMessageHandler : HttpMessageHandler
+        {
+            protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+                => Task.FromResult(new HttpResponseMessage((HttpStatusCode)418));
+        }
+    }
+}