New LaunchOptions config class (#71)

* added LaunchOptions file

* use new launch options

* cleaned launcher options

Author: Meir017

lib/PuppeteerSharp.Tests/Puppeteer/PuppeteerLaunchTests.cs

@@ -1,10 +1,5 @@
-using System;
-using System.Collections.Generic;
-using System.Diagnostics.Contracts;
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using Xunit;
-using PuppeteerSharp;
-using PuppeteerSharp.Helpers;
 
 namespace PuppeteerSharp.Tests.Puppeteer
 {
@@ -18,8 +13,8 @@ public PuppeteerLaunchTests()
         [Fact]
         public async Task ShouldSupportIgnoreHTTPSErrorsOption()
         {
-            var options = TestConstants.DefaultBrowserOptions.Clone();
-            options.Add("ignoreHTTPSErrors", true);
+            var options = TestConstants.DefaultBrowserOptions();
+            options.IgnoreHTTPSErrors = true;
 
             var browser = await PuppeteerSharp.Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision);
             var page = await browser.NewPageAsync();

lib/PuppeteerSharp.Tests/PuppeteerBaseTest.cs

@@ -18,7 +18,7 @@ public PuppeteerBaseTest()
                 dirInfo.Create();
             }
 
-            Browser = PuppeteerSharp.Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions,
+            Browser = PuppeteerSharp.Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions(),
                                                            TestConstants.ChromiumRevision).GetAwaiter().GetResult();
         }
 

lib/PuppeteerSharp.Tests/TestConstants.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 
 namespace PuppeteerSharp.Tests
 {
@@ -11,13 +10,13 @@ public static class TestConstants
         public const int ChromiumRevision = 526987;
         public static readonly string EmptyPage = $"{ServerUrl}/empty.html";
 
-        public static readonly Dictionary<string, object> DefaultBrowserOptions = new Dictionary<string, object>()
+        public static LaunchOptions DefaultBrowserOptions() => new LaunchOptions
         {
-            { "slowMo", Convert.ToInt32(Environment.GetEnvironmentVariable("SLOW_MO") ?? "0") },
-            { "headless", Convert.ToBoolean(Environment.GetEnvironmentVariable("HEADLESS") ?? "true") },
-            { "args", new[] { "--no-sandbox" }},
-            { "timeout", 0},
-            { "keepAliveInterval", 120}
+            SlowMo = Convert.ToInt32(Environment.GetEnvironmentVariable("SLOW_MO")),
+            Headless = Convert.ToBoolean(Environment.GetEnvironmentVariable("HEADLESS") ?? "true"),
+            Args = new[] { "--no-sandbox" },
+            Timeout = 0,
+            KeepAliveInterval = 120
         };
     }
 }

lib/PuppeteerSharp/Browser.cs

@@ -7,11 +7,11 @@ namespace PuppeteerSharp
 {
     public class Browser
     {
-        public Browser(Connection connection, Dictionary<string, object> options, Func<Task> closeCallBack)
+        public Browser(Connection connection, LaunchOptions options, Func<Task> closeCallBack)
         {
             Connection = connection;
-            IgnoreHTTPSErrors = options.ContainsKey("ignoreHTTPSErrors") && (bool)options["ignoreHTTPSErrors"];
-            AppMode = options.ContainsKey("appMode") && (bool)options["appMode"];
+            IgnoreHTTPSErrors = options.IgnoreHTTPSErrors;
+            AppMode = options.AppMode;
             _targets = new Dictionary<string, Target>();
             ScreenshotTaskQueue = new TaskQueue();
 
@@ -157,7 +157,7 @@ private async Task CreateTarget(MessageEventArgs args)
 
         }
 
-        internal static async Task<Browser> CreateAsync(Connection connection, Dictionary<string, object> options,
+        internal static async Task<Browser> CreateAsync(Connection connection, LaunchOptions options,
                                                         Func<Task> closeCallBack)
         {
             var browser = new Browser(connection, options, closeCallBack);

lib/PuppeteerSharp/LaunchOptions.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+
+namespace PuppeteerSharp
+{
+    public class LaunchOptions
+    {
+        public bool AppMode { get; set; }
+
+        public bool IgnoreHTTPSErrors { get; set; }
+        
+        public bool Headless { get; set; } = true;
+
+        public string ExecutablePath { get; set; }
+
+        public int SlowMo { get; set; }
+
+        public string[] Args { get; set; } = Array.Empty<string>();
+        
+        public int Timeout { get; set; } = 30_000;
+
+        public bool DumpIO { get; set; }
+
+        public string UserDataDir { get; set; }
+
+        public IDictionary<string, string> Env { get; } = new Dictionary<string, string>();
+
+        public bool Devtools { get; set; }
+
+        public int KeepAliveInterval { get; set; } = 30;
+    }
+}

lib/PuppeteerSharp/Launcher.cs

@@ -13,7 +13,7 @@ namespace PuppeteerSharp
 {
     public class Launcher
     {
-        private static string[] _defaultArgs = {
+        private static readonly string[] _defaultArgs = {
             "--disable-background-networking",
             "--disable-background-timer-throttling",
             "--disable-client-side-phishing-detection",
@@ -30,7 +30,7 @@ public class Launcher
             "--safebrowsing-disable-auto-update",
         };
 
-        public static string[] _automationArgs = {
+        public static readonly string[] _automationArgs = {
             "--enable-automation",
             "--password-store=basic",
             "--use-mock-keychain"
@@ -42,40 +42,39 @@ public class Launcher
         private Connection _connection = null;
         private Timer _timer = null;
 
-        internal async Task<Browser> LaunchAsync(Dictionary<string, object> options, int chromiumRevision)
+        internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevision)
         {
             var chromeArguments = new List<string>(_defaultArgs);
 
-            if (options.ContainsKey("appMode"))
+            if (options.AppMode)
             {
-                options["headless"] = false;
+                options.Headless = false;
             }
             else
             {
                 chromeArguments.AddRange(_automationArgs);
             }
 
-            if (options.ContainsKey("args") &&
-               ((string[])options["args"]).Any(i => i.StartsWith("--user-data-dir", StringComparison.Ordinal)))
+            if (options.Args.Any(i => i.StartsWith("--user-data-dir", StringComparison.Ordinal)))
             {
-                if (!options.ContainsKey("userDataDir"))
+                if (string.IsNullOrEmpty(options.UserDataDir))
                 {
                     _temporaryUserDataDir = GetTemporaryDirectory();
                     chromeArguments.Add($"--user-data-dir=${_temporaryUserDataDir}");
                 }
                 else
                 {
-                    chromeArguments.Add($"--user-data-dir=${options["userDataDir"]}");
+                    chromeArguments.Add($"--user-data-dir=${options.UserDataDir}");
                 }
             }
 
-            if (options.TryGetValue("devtools", out var hasDevTools) && (bool)hasDevTools)
+            if (options.Devtools)
             {
                 chromeArguments.Add("--auto-open-devtools-for-tabs");
-                options["headless"] = false;
+                options.Headless = false;
             }
 
-            if (options.TryGetValue("headless", out var isHeadless) && (bool)isHeadless)
+            if (options.Headless)
             {
                 chromeArguments.AddRange(new[]{
                     "--headless",
@@ -85,7 +84,7 @@ internal async Task<Browser> LaunchAsync(Dictionary<string, object> options, int
                 });
             }
 
-            var chromeExecutable = (options.GetValueOrDefault("executablePath") ?? "").ToString();
+            var chromeExecutable = options.ExecutablePath;
 
             if (string.IsNullOrEmpty(chromeExecutable))
             {
@@ -94,20 +93,18 @@ internal async Task<Browser> LaunchAsync(Dictionary<string, object> options, int
                 chromeExecutable = revisionInfo.ExecutablePath;
             }
 
-            if (options.ContainsKey("args"))
+            if (options.Args.Any())
             {
-                chromeArguments.AddRange((string[])options["args"]);
+                chromeArguments.AddRange(options.Args);
             }
 
             _chromeProcess = new Process();
             _chromeProcess.StartInfo.FileName = chromeExecutable;
             _chromeProcess.StartInfo.Arguments = string.Join(" ", chromeArguments);
 
-            SetEnvVariables(_chromeProcess.StartInfo.Environment,
-                            options.ContainsKey("env") ? (IDictionary<string, string>)options["env"] : null,
-                            (IDictionary)Environment.GetEnvironmentVariables());
+            SetEnvVariables(_chromeProcess.StartInfo.Environment, options.Env, Environment.GetEnvironmentVariables());
 
-            if (!options.ContainsKey("dumpio"))
+            if(!options.DumpIO)
             {
                 _chromeProcess.StartInfo.RedirectStandardOutput = false;
                 _chromeProcess.StartInfo.RedirectStandardError = false;
@@ -121,11 +118,9 @@ internal async Task<Browser> LaunchAsync(Dictionary<string, object> options, int
 
             try
             {
-                var connectionDelay = (int)(options.GetValueOrDefault("slowMo") ?? 0);
-                var browserWSEndpoint = await WaitForEndpoint(_chromeProcess,
-                                                              (int)(options.GetValueOrDefault("timeout") ?? 30 * 100),
-                                                              options.ContainsKey("dumpio"));
-                var keepAliveInterval = options.ContainsKey("keepAliveInterval") ? Convert.ToInt32(options["keepAliveInterval"]) : 30;
+                var connectionDelay = options.SlowMo;
+                var browserWSEndpoint = await WaitForEndpoint(_chromeProcess, options.Timeout, options.DumpIO);
+                var keepAliveInterval = options.KeepAliveInterval;
 
                 _connection = await Connection.Create(browserWSEndpoint, connectionDelay, keepAliveInterval);
                 return await Browser.CreateAsync(_connection, options, KillChrome);

lib/PuppeteerSharp/Puppeteer.cs

@@ -6,7 +6,7 @@ namespace PuppeteerSharp
 {
     public class Puppeteer
     {
-        public static async Task<Browser> LaunchAsync(Dictionary<string, object> options, int chromiumRevision)
+        public static async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevision)
         {
             return await new Launcher().LaunchAsync(options, chromiumRevision);
         }