Implement browser context options (#2346)

Author: kblok

lib/PuppeteerSharp/Browser.cs

@@ -148,9 +148,15 @@ public ITarget[] Targets()
             => TargetManager.GetAvailableTargets().Values.ToArray();
 
         /// <inheritdoc/>
-        public async Task<IBrowserContext> CreateIncognitoBrowserContextAsync()
+        public async Task<IBrowserContext> CreateIncognitoBrowserContextAsync(BrowserContextOptions options = null)
         {
-            var response = await Connection.SendAsync<CreateBrowserContextResponse>("Target.createBrowserContext", null).ConfigureAwait(false);
+            var response = await Connection.SendAsync<CreateBrowserContextResponse>(
+                "Target.createBrowserContext",
+                new TargetCreateBrowserContextRequest
+                {
+                    ProxyServer = options?.ProxyServer ?? string.Empty,
+                    ProxyBypassList = string.Join(",", options?.ProxyBypassList ?? Array.Empty<string>()),
+                }).ConfigureAwait(false);
             var context = new BrowserContext(Connection, this, response.BrowserContextId);
             _contexts.TryAdd(response.BrowserContextId, context);
             return context;

lib/PuppeteerSharp/BrowserContextOptions.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Linq;
+using System.Runtime.InteropServices;
+using System.Threading.Tasks;
+using Microsoft.Extensions.Logging;
+using PuppeteerSharp.Helpers;
+using PuppeteerSharp.Helpers.Json;
+using PuppeteerSharp.Messaging;
+using PuppeteerSharp.QueryHandlers;
+
+namespace PuppeteerSharp
+{
+    /// <summary>
+    /// BrowserContext options.
+    /// </summary>
+    public class BrowserContextOptions
+    {
+        /// <summary>
+        /// Proxy server with optional port to use for all requests.
+        /// Username and password can be set in <see cref="IPage.AuthenticateAsync(Credentials)"/>.
+        /// </summary>
+        public string ProxyServer { get; set; }
+
+        /// <summary>
+        /// Bypass the proxy for the given semi-colon-separated list of hosts.
+        /// </summary>
+        public string[] ProxyBypassList { get; set; }
+    }
+}

lib/PuppeteerSharp/IBrowser.cs

@@ -71,7 +71,7 @@ public interface IBrowser : IDisposable, IAsyncDisposable
         IBrowserContext DefaultContext { get; }
 
         /// <summary>
-        /// Dafault wait time in milliseconds. Defaults to 30 seconds.
+        /// Default wait time in milliseconds. Defaults to 30 seconds.
         /// </summary>
         int DefaultWaitForTimeout { get; set; }
 
@@ -127,6 +127,7 @@ public interface IBrowser : IDisposable, IAsyncDisposable
         /// <summary>
         /// Creates a new incognito browser context. This won't share cookies/cache with other browser contexts.
         /// </summary>
+        /// <param name="options">Options.</param>
         /// <returns>Task which resolves to a new <see cref="IBrowserContext"/> object.</returns>
         /// <example>
         /// <code>
@@ -143,7 +144,7 @@ public interface IBrowser : IDisposable, IAsyncDisposable
         /// ]]>
         /// </code>
         /// </example>
-        Task<IBrowserContext> CreateIncognitoBrowserContextAsync();
+        Task<IBrowserContext> CreateIncognitoBrowserContextAsync(BrowserContextOptions options = null);
 
         /// <summary>
         /// Disconnects Puppeteer from the browser, but leaves the process running. After calling <see cref="Disconnect"/>, the browser object is considered disposed and cannot be used anymore.
@@ -220,7 +221,7 @@ public interface IBrowser : IDisposable, IAsyncDisposable
         void RegisterCustomQueryHandler(string name, CustomQueryHandler queryHandler);
 
         /// <summary>
-        /// Unregisters a custom query handler.
+        /// Unregister a custom query handler.
         /// </summary>
         /// <param name="name">The name of the query handler to unregistered.</param>
         void UnregisterCustomQueryHandler(string name);

lib/PuppeteerSharp/Messaging/TargetCreateBrowserContextRequest.cs

@@ -0,0 +1,9 @@
+namespace PuppeteerSharp.Messaging
+{
+    internal class TargetCreateBrowserContextRequest
+    {
+        public string ProxyServer { get; set; }
+
+        public string ProxyBypassList { get; set; }
+    }
+}