Added new capability to NetworkRequestManager to allow removal of queued requests

Author: jamesmcroft

src/MADE.Networking/Http/INetworkRequestManager.cs

@@ -81,6 +81,24 @@ void AddOrUpdate<TRequest, TResponse, TErrorResponse>(
             Action<TErrorResponse> errorCallback)
             where TRequest : NetworkRequest;
 
+        /// <summary>
+        /// Removes a network request from the queue.
+        /// <para>
+        /// If the request is no longer in the queue, this method does nothing.
+        /// </para>
+        /// </summary>
+        /// <param name="request">The request to remove from the queue.</param>
+        void Remove(INetworkRequest request);
+
+        /// <summary>
+        /// Removes a network request from the queue by the registered key identifier.
+        /// <para>
+        /// If the request is no longer in the queue, this method does nothing.
+        /// </para>
+        /// </summary>
+        /// <param name="key">The key corresponding to the network request to remove from the queue.</param>
+        void RemoveByKey(string key);
+
         /// <summary>
         /// Processes the current queue of network requests.
         /// </summary>

src/MADE.Networking/Http/NetworkRequestManager.cs

@@ -9,10 +9,8 @@ namespace MADE.Networking.Http
     using System.Linq;
     using System.Threading;
     using System.Threading.Tasks;
-
     using MADE.Networking.Http.Requests;
     using MADE.Runtime;
-
     using Timer = MADE.Threading.Timer;
 
     /// <summary>
@@ -93,8 +91,8 @@ public void ProcessCurrentQueue()
                 while (this.CurrentQueue.Count > 0)
                 {
                     if (this.CurrentQueue.TryRemove(
-                        this.CurrentQueue.FirstOrDefault().Key,
-                        out NetworkRequestCallback request))
+                            this.CurrentQueue.FirstOrDefault().Key,
+                            out NetworkRequestCallback request))
                     {
                         requestCallbacks.Add(request);
                     }
@@ -164,7 +162,9 @@ public void AddOrUpdate<TRequest, TResponse, TErrorResponse>(
             where TRequest : NetworkRequest
         {
             var weakSuccessCallback = new WeakReferenceCallback(successCallback, typeof(TResponse));
-            var weakErrorCallback = new WeakReferenceCallback(errorCallback, typeof(TErrorResponse));
+            var weakErrorCallback = errorCallback == null
+                ? null
+                : new WeakReferenceCallback(errorCallback, typeof(TErrorResponse));
             var requestCallback = new NetworkRequestCallback(request, weakSuccessCallback, weakErrorCallback);
 
             this.CurrentQueue.AddOrUpdate(
@@ -173,6 +173,30 @@ public void AddOrUpdate<TRequest, TResponse, TErrorResponse>(
                 (s, callback) => requestCallback);
         }
 
+        /// <summary>
+        /// Removes a network request from the queue.
+        /// <para>
+        /// If the request is no longer in the queue, this method does nothing.
+        /// </para>
+        /// </summary>
+        /// <param name="request">The request to remove from the queue.</param>
+        public void Remove(INetworkRequest request)
+        {
+            RemoveByKey(request.Identifier.ToString());
+        }
+
+        /// <summary>
+        /// Removes a network request from the queue by the registered key identifier.
+        /// <para>
+        /// If the request is no longer in the queue, this method does nothing.
+        /// </para>
+        /// </summary>
+        /// <param name="key">The key corresponding to the network request to remove from the queue.</param>
+        public void RemoveByKey(string key)
+        {
+            this.CurrentQueue.TryRemove(key, out NetworkRequestCallback _);
+        }
+
         private static async Task ExecuteRequestsAsync(
             ConcurrentDictionary<string, NetworkRequestCallback> queue,
             NetworkRequestCallback requestCallback,
@@ -200,7 +224,7 @@ private static async Task ExecuteRequestsAsync(
             catch (Exception ex)
             {
                 successCallback.Invoke(Activator.CreateInstance(successCallback.Type));
-                errorCallback.Invoke(ex);
+                errorCallback?.Invoke(ex);
             }
         }
 

src/MADE.Networking/Http/Requests/INetworkRequest.cs

@@ -0,0 +1,56 @@
+namespace MADE.Networking.Http.Requests
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Threading;
+    using System.Threading.Tasks;
+
+    /// <summary>
+    /// Defines an interface for a basic network request.
+    /// </summary>
+    public interface INetworkRequest
+    {
+        /// <summary>
+        /// Gets the identifier for the request.
+        /// </summary>
+        Guid Identifier { get; }
+
+        /// <summary>
+        /// Gets or sets the URL for the request.
+        /// </summary>
+        string Url { get; set; }
+
+        /// <summary>
+        /// Gets the headers for the request.
+        /// </summary>
+        Dictionary<string, string> Headers { get; }
+
+        /// <summary>
+        /// Executes the network request.
+        /// </summary>
+        /// <typeparam name="TResponse">
+        /// The type of object returned from the request.
+        /// </typeparam>
+        /// <param name="cancellationToken">
+        /// The cancellation token.
+        /// </param>
+        /// <returns>
+        /// Returns the response of the request as the specified type.
+        /// </returns>
+        Task<TResponse> ExecuteAsync<TResponse>(CancellationToken cancellationToken = default);
+
+        /// <summary>
+        /// Executes the network request.
+        /// </summary>
+        /// <param name="expectedResponse">
+        /// The type expected by the response of the request.
+        /// </param>
+        /// <param name="cancellationToken">
+        /// The cancellation token.
+        /// </param>
+        /// <returns>
+        /// Returns the response of the request as an object.
+        /// </returns>
+        Task<object> ExecuteAsync(Type expectedResponse, CancellationToken cancellationToken = default);
+    }
+}

src/MADE.Networking/Http/Requests/NetworkRequest.cs

@@ -11,7 +11,7 @@ namespace MADE.Networking.Http.Requests
     /// <summary>
     /// Defines the model for a network request.
     /// </summary>
-    public abstract class NetworkRequest
+    public abstract class NetworkRequest : INetworkRequest
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="NetworkRequest"/> class.