Reporters fixed

Author: svrooij

DevProxy.Abstractions/Plugins/BasePlugin.cs

@@ -10,7 +10,6 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
-using Unobtanium.Web.Proxy.Events;
 
 namespace DevProxy.Abstractions.Plugins;
 
@@ -27,16 +26,19 @@ public abstract class BasePlugin(
     /// <summary>
     /// Implement this to handle requests, if you won't be modifying requests or respond, use <see cref="OnRequestLogAsync"/>.
     /// </summary>
+    /// <remarks>This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     public virtual Func<RequestArguments, CancellationToken, Task<PluginResponse>>? OnRequestAsync { get; }
 
     /// <summary>
     /// Implement this to log requests, you cannot modify the request or response here.
     /// </summary>
+    /// <remarks>This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     public virtual Func<RequestArguments, CancellationToken, Task>? OnRequestLogAsync { get; }
 
     /// <summary>
     /// Implement this to modify responses from the remote server.
     /// </summary>
+    /// <remarks>This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     public virtual Func<ResponseArguments, CancellationToken, Task<PluginResponse?>>? OnResponseAsync { get; }
 
     /// <summary>

DevProxy.Abstractions/Plugins/IPlugin.cs

@@ -23,26 +23,46 @@ public interface IPlugin
     /// <summary>
     /// Implement this to handle requests.
     /// </summary>
+    /// <remarks>This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     Func<RequestArguments, CancellationToken, Task<PluginResponse>>? OnRequestAsync { get; }
 
     /// <summary>
     /// Implement this to log requests, you cannot modify the request or response here.
     /// </summary>
+    /// <remarks>This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     Func<RequestArguments, CancellationToken, Task>? OnRequestLogAsync { get; }
 
     /// <summary>
     /// Implement this to modify responses from the remote server.
     /// </summary>
+    /// <remarks>This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     Func<ResponseArguments, CancellationToken, Task<PluginResponse?>>? OnResponseAsync { get; }
 
     /// <summary>
-    /// Implement this to modify responses from the remote server.
+    /// Implement this to log responses from the remote server.
     /// </summary>
+    /// <remarks>Think caching after the fact, combined with <see cref="OnRequestAsync"/>. This is <see langword="null"/> by default, so we can filter plugins based on implementation.</remarks>
     Func<ResponseArguments, CancellationToken, Task>? OnResponseLogAsync { get; }
+
     Task BeforeRequestAsync(ProxyRequestArgs e, CancellationToken cancellationToken);
     Task BeforeResponseAsync(ProxyResponseArgs e, CancellationToken cancellationToken);
     Task AfterResponseAsync(ProxyResponseArgs e, CancellationToken cancellationToken);
+
+    /// <summary>
+    /// Receiving RequestLog messages for each <see cref="Microsoft.Extensions.Logging.ILoggerExtensions.LogRequest(Microsoft.Extensions.Logging.ILogger, string, MessageType, HttpRequestMessage)"/> call.
+    /// </summary>
+    /// <remarks>This is for collecting log messages not requests itself</remarks>
+    /// <param name="e"></param>
+    /// <param name="cancellationToken"></param>
+    /// <returns></returns>
     Task AfterRequestLogAsync(RequestLogArgs e, CancellationToken cancellationToken);
+
+    /// <summary>
+    /// Executes post-processing tasks after a recording has stopped.
+    /// </summary>
+    /// <param name="e">The arguments containing details about the recording that has stopped.</param>
+    /// <param name="cancellationToken">A token to monitor for cancellation requests.</param>
+    /// <returns>A task that represents the asynchronous operation.</returns>
     Task AfterRecordingStopAsync(RecordingArgs e, CancellationToken cancellationToken);
     Task MockRequestAsync(EventArgs e, CancellationToken cancellationToken);
 }

DevProxy.Abstractions/Proxy/ProxyEvents.cs

@@ -98,7 +98,7 @@ private RequestLog(string message, MessageType messageType, string? method, stri
     //}
 }
 
-public class RecordingArgs(IEnumerable<RequestLog> requestLogs) : ProxyEventArgsBase
+public class RecordingArgs(IEnumerable<RequestLog> requestLogs)// : ProxyEventArgsBase
 {
     public IEnumerable<RequestLog> RequestLogs { get; set; } = requestLogs ??
         throw new ArgumentNullException(nameof(requestLogs));

DevProxy.Plugins/Reporters/BaseReporter.cs

@@ -11,7 +11,8 @@ namespace DevProxy.Plugins.Reporters;
 
 public abstract class BaseReporter(
     ILogger logger,
-    ISet<UrlToWatch> urlsToWatch) : BasePlugin(logger, urlsToWatch)
+    ISet<UrlToWatch> urlsToWatch,
+    IProxyStorage proxyStorage) : BasePlugin(logger, urlsToWatch)
 {
     public abstract string FileExtension { get; }
 
@@ -23,7 +24,7 @@ public override async Task AfterRecordingStopAsync(RecordingArgs e, Cancellation
 
         await base.AfterRecordingStopAsync(e, cancellationToken);
 
-        if (!e.GlobalData.TryGetValue(ProxyUtils.ReportsKey, out var value) ||
+        if (!proxyStorage.GlobalData.TryGetValue(ProxyUtils.ReportsKey, out var value) ||
             value is not Dictionary<string, object> reports ||
             reports.Count == 0)
         {

DevProxy.Plugins/Reporters/JsonReporter.cs

@@ -12,7 +12,8 @@ namespace DevProxy.Plugins.Reporters;
 
 public class JsonReporter(
     ILogger<JsonReporter> logger,
-    ISet<UrlToWatch> urlsToWatch) : BaseReporter(logger, urlsToWatch)
+    ISet<UrlToWatch> urlsToWatch,
+    IProxyStorage proxyStorage) : BaseReporter(logger, urlsToWatch, proxyStorage)
 {
     private string _fileExtension = ".json";
 

DevProxy.Plugins/Reporters/MarkdownReporter.cs

@@ -10,7 +10,8 @@ namespace DevProxy.Plugins.Reporters;
 
 public class MarkdownReporter(
     ILogger<MarkdownReporter> logger,
-    ISet<UrlToWatch> urlsToWatch) : BaseReporter(logger, urlsToWatch)
+    ISet<UrlToWatch> urlsToWatch,
+    IProxyStorage proxyStorage) : BaseReporter(logger, urlsToWatch, proxyStorage)
 {
     public override string Name => nameof(MarkdownReporter);
     public override string FileExtension => ".md";

DevProxy.Plugins/Reporters/PlainTextReporter.cs

@@ -10,7 +10,8 @@ namespace DevProxy.Plugins.Reporters;
 
 public class PlainTextReporter(
     ILogger<PlainTextReporter> logger,
-    ISet<UrlToWatch> urlsToWatch) : BaseReporter(logger, urlsToWatch)
+    ISet<UrlToWatch> urlsToWatch,
+    IProxyStorage proxyStorage) : BaseReporter(logger, urlsToWatch, proxyStorage)
 {
     public override string Name => nameof(PlainTextReporter);
     public override string FileExtension => ".txt";