[dotnet] [bidi] Context aware network collector (#16866)

Author: nvborisenko

dotnet/src/webdriver/BiDi/BrowsingContext/BrowsingContextNetworkModule.cs

@@ -19,6 +19,7 @@
 
 using OpenQA.Selenium.BiDi.Network;
 using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 
 namespace OpenQA.Selenium.BiDi.BrowsingContext;
@@ -79,6 +80,16 @@ await interception.OnAuthRequiredAsync(
         return interception;
     }
 
+    public Task<AddDataCollectorResult> AddDataCollectorAsync(IEnumerable<DataType> dataTypes, int maxEncodedDataSize, BrowsingContextAddDataCollectorOptions? options = null)
+    {
+        AddDataCollectorOptions addDataCollectorOptions = new(options)
+        {
+            Contexts = [context]
+        };
+
+        return networkModule.AddDataCollectorAsync(dataTypes, maxEncodedDataSize, addDataCollectorOptions);
+    }
+
     public Task<SetCacheBehaviorResult> SetCacheBehaviorAsync(CacheBehavior behavior, BrowsingContextSetCacheBehaviorOptions? options = null)
     {
         SetCacheBehaviorOptions setCacheBehaviorOptions = new(options)

dotnet/src/webdriver/BiDi/Network/AddDataCollectorCommand.cs

@@ -28,15 +28,28 @@ internal sealed class AddDataCollectorCommand(AddDataCollectorParameters @params
 
 internal sealed record AddDataCollectorParameters(IEnumerable<DataType> DataTypes, int MaxEncodedDataSize, CollectorType? CollectorType, IEnumerable<BrowsingContext.BrowsingContext>? Contexts, IEnumerable<Browser.UserContext>? UserContexts) : Parameters;
 
-public class AddDataCollectorOptions : CommandOptions
+public class AddDataCollectorOptions() : CommandOptions
 {
+    internal AddDataCollectorOptions(BrowsingContextAddDataCollectorOptions? options) : this()
+    {
+        CollectorType = options?.CollectorType;
+        UserContexts = options?.UserContexts;
+    }
+
     public CollectorType? CollectorType { get; set; }
 
     public IEnumerable<BrowsingContext.BrowsingContext>? Contexts { get; set; }
 
     public IEnumerable<Browser.UserContext>? UserContexts { get; set; }
 }
 
+public class BrowsingContextAddDataCollectorOptions
+{
+    public CollectorType? CollectorType { get; set; }
+
+    public IEnumerable<Browser.UserContext>? UserContexts { get; set; }
+}
+
 public sealed record AddDataCollectorResult(Collector Collector) : EmptyResult;
 
 [JsonConverter(typeof(CamelCaseEnumConverter<DataType>))]

dotnet/src/webdriver/BiDi/Network/NetworkModule.cs

@@ -30,13 +30,11 @@ public sealed partial class NetworkModule : Module
 {
     private NetworkJsonSerializerContext _jsonContext = null!;
 
-    public async Task<Collector> AddDataCollectorAsync(IEnumerable<DataType> DataTypes, int MaxEncodedDataSize, AddDataCollectorOptions? options = null)
+    public async Task<AddDataCollectorResult> AddDataCollectorAsync(IEnumerable<DataType> dataTypes, int maxEncodedDataSize, AddDataCollectorOptions? options = null)
     {
-        var @params = new AddDataCollectorParameters(DataTypes, MaxEncodedDataSize, options?.CollectorType, options?.Contexts, options?.UserContexts);
+        var @params = new AddDataCollectorParameters(dataTypes, maxEncodedDataSize, options?.CollectorType, options?.Contexts, options?.UserContexts);
 
-        var result = await Broker.ExecuteCommandAsync(new AddDataCollectorCommand(@params), options, _jsonContext.AddDataCollectorCommand, _jsonContext.AddDataCollectorResult).ConfigureAwait(false);
-
-        return result.Collector;
+        return await Broker.ExecuteCommandAsync(new AddDataCollectorCommand(@params), options, _jsonContext.AddDataCollectorCommand, _jsonContext.AddDataCollectorResult).ConfigureAwait(false);
     }
 
     public async Task<AddInterceptResult> AddInterceptAsync(IEnumerable<InterceptPhase> phases, AddInterceptOptions? options = null)

dotnet/src/webdriver/BiDi/Network/SetCacheBehaviorCommand.cs

@@ -28,14 +28,9 @@ internal sealed class SetCacheBehaviorCommand(SetCacheBehaviorParameters @params
 
 internal sealed record SetCacheBehaviorParameters(CacheBehavior CacheBehavior, IEnumerable<BrowsingContext.BrowsingContext>? Contexts) : Parameters;
 
-public sealed class SetCacheBehaviorOptions : CommandOptions
+public sealed class SetCacheBehaviorOptions() : CommandOptions
 {
-    public SetCacheBehaviorOptions()
-    {
-
-    }
-
-    internal SetCacheBehaviorOptions(BrowsingContextSetCacheBehaviorOptions? options)
+    internal SetCacheBehaviorOptions(BrowsingContextSetCacheBehaviorOptions? options) : this()
     {
 
     }

dotnet/test/common/BiDi/Network/NetworkTest.cs

@@ -31,9 +31,16 @@ public async Task CanAddDataCollector()
     {
         // Firefox doesn't like int.MaxValue as max encoded data size
         // invalid argument: Expected "maxEncodedDataSize" to be less than the max total data size available (200000000), got 2147483647
-        var collector = await bidi.Network.AddDataCollectorAsync([DataType.Response], 200000000);
+        var addDataCollectorResult = await bidi.Network.AddDataCollectorAsync([DataType.Response], 200000000);
+
+        Assert.That(addDataCollectorResult, Is.Not.Null);
+        Assert.That(addDataCollectorResult.Collector, Is.Not.Null);
+
+        // or context aware
+        addDataCollectorResult = await context.Network.AddDataCollectorAsync([DataType.Response], 200000000);
 
-        Assert.That(collector, Is.Not.Null);
+        Assert.That(addDataCollectorResult, Is.Not.Null);
+        Assert.That(addDataCollectorResult.Collector, Is.Not.Null);
     }
 
     [Test]