New LaunchOptions properties DefaultViewport and IgnoredDefaultArgs (#615)

* New LaunchOptions properties DefaultViewport and IgnoredDefaultArgs

* CodeFactor

* appveyor

* Make it build luke

* Add #566 tests

* #565 tests

* cr

Author: kblok

lib/PuppeteerSharp.Tests/Issues/Issue0128.cs

@@ -14,7 +14,7 @@ public async Task LauncherShouldFailGracefully()
             await Assert.ThrowsAsync<ChromiumProcessException>(async () =>
             {
                 var options = TestConstants.DefaultBrowserOptions();
-                options.Args = new[] { "-remote-debugging-port=-2" };
+                options.Args = new[] { "--remote-debugging-port=-2" };
                 await Puppeteer.LaunchAsync(options, TestConstants.LoggerFactory);
             });
         }

lib/PuppeteerSharp.Tests/PuppeteerTests/AppModeTests.cs

@@ -210,8 +210,16 @@ await page.EvaluateExpressionAsync(
         [Fact]
         public void ShouldReturnTheDefaultChromeArguments()
         {
-            var args = Puppeteer.DefaultArgs;
-            Assert.Contains("--no-first-run", args);
+            Assert.Contains("--no-first-run", Puppeteer.GetDefaultArgs());
+            Assert.Contains("--headless", Puppeteer.GetDefaultArgs());
+            Assert.DoesNotContain("--headless", Puppeteer.GetDefaultArgs(new LaunchOptions
+            {
+                Headless = false
+            }));
+            Assert.Contains("--user-data-dir=\"foo\"", Puppeteer.GetDefaultArgs(new LaunchOptions
+            {
+                UserDataDir = "foo"
+            }));
         }
 
         [Fact]
@@ -332,6 +340,21 @@ public async Task ShouldWorkWithNoDefaultArguments()
             }
         }
 
+        [Fact]
+        public async Task ShouldFilterOutIgnoredDefaultArguments()
+        {
+            var defaultArgs = Puppeteer.GetDefaultArgs();
+            var options = TestConstants.DefaultBrowserOptions();
+            options.IgnoredDefaultArgs = new[] { defaultArgs[0], defaultArgs[2] };
+            using (var browser = await Puppeteer.LaunchAsync(options))
+            {
+                var spawnargs = browser.Process.StartInfo.Arguments;
+                Assert.DoesNotContain(defaultArgs[0], spawnargs);
+                Assert.Contains(defaultArgs[1], spawnargs);
+                Assert.DoesNotContain(defaultArgs[2], spawnargs);
+            }
+        }
+
         [Fact]
         public async Task ShouldHaveDefaultUrlWhenLaunchingBrowser()
         {
@@ -360,6 +383,37 @@ public async Task ShouldHaveCustomUrlWhenLaunchingBrowser()
             }
         }
 
+        [Fact]
+        public async Task ShouldSetTheDefaultViewport()
+        {
+            var options = TestConstants.DefaultBrowserOptions();
+            options.DefaultViewport = new ViewPortOptions
+            {
+                Width = 456,
+                Height = 789
+            };
+
+            using (var browser = await Puppeteer.LaunchAsync(options))
+            using (var page = await browser.NewPageAsync())
+            {
+                Assert.Equal(456, await page.EvaluateExpressionAsync<int>("window.innerWidth"));
+                Assert.Equal(789, await page.EvaluateExpressionAsync<int>("window.innerHeight"));
+            }
+        }
+
+        [Fact]
+        public async Task ShouldDisableTheDefaultViewport()
+        {
+            var options = TestConstants.DefaultBrowserOptions();
+            options.DefaultViewport = null;
+
+            using (var browser = await Puppeteer.LaunchAsync(options))
+            using (var page = await browser.NewPageAsync())
+            {
+                Assert.Null(page.Viewport);
+            }
+        }
+
         [Fact]
         public async Task ShouldSupportCustomWebSocket()
         {

lib/PuppeteerSharp.Tests/PuppeteerTests/PuppeteerLaunchTests.cs

@@ -46,18 +46,18 @@ public class Browser : IDisposable
         /// <param name="connection">The connection</param>
         /// <param name="contextIds">The context ids></param>
         /// <param name="ignoreHTTPSErrors">The option to ignoreHTTPSErrors</param>
-        /// <param name="setDefaultViewport">The option to setDefaultViewport</param>
+        /// <param name="defaultViewport">Default viewport</param>
         /// <param name="chromiumProcess">The Chromium process</param>
         public Browser(
             Connection connection,
             string[] contextIds,
             bool ignoreHTTPSErrors,
-            bool setDefaultViewport,
+            ViewPortOptions defaultViewport,
             ChromiumProcess chromiumProcess)
         {
             Connection = connection;
             IgnoreHTTPSErrors = ignoreHTTPSErrors;
-            SetDefaultViewport = setDefaultViewport;
+            DefaultViewport = defaultViewport;
             TargetsMap = new Dictionary<string, Target>();
             ScreenshotTaskQueue = new TaskQueue();
             _defaultContext = new BrowserContext(this, null);
@@ -141,7 +141,7 @@ public Browser(
 
         internal TaskQueue ScreenshotTaskQueue { get; set; }
         internal Connection Connection { get; }
-        internal bool SetDefaultViewport { get; }
+        internal ViewPortOptions DefaultViewport { get; }
 
         #endregion
 
@@ -399,10 +399,10 @@ internal static async Task<Browser> CreateAsync(
             Connection connection,
             string[] contextIds,
             bool ignoreHTTPSErrors,
-            bool appMode,
+            ViewPortOptions defaultViewPort,
             ChromiumProcess chromiumProcess)
         {
-            var browser = new Browser(connection, contextIds, ignoreHTTPSErrors, appMode, chromiumProcess);
+            var browser = new Browser(connection, contextIds, ignoreHTTPSErrors, defaultViewPort, chromiumProcess);
             await connection.SendAsync("Target.setDiscoverTargets", new
             {
                 discover = true

lib/PuppeteerSharp/Browser.cs

@@ -235,7 +235,7 @@ public static string GetExecutablePath(Platform platform, string folderPath)
 
         #region Private Methods
 
-        private static Platform GetCurrentPlatform()
+        internal static Platform GetCurrentPlatform()
         {
             if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
             {

lib/PuppeteerSharp/BrowserFetcher.cs

@@ -36,10 +36,7 @@ public class ChromiumProcess : IDisposable
             "--disable-translate",
             "--metrics-recording-only",
             "--no-first-run",
-            "--safebrowsing-disable-auto-update"
-        };
-
-        internal static readonly string[] AutomationArgs = {
+            "--safebrowsing-disable-auto-update",
             "--enable-automation",
             "--password-store=basic",
             "--use-mock-keychain"
@@ -205,69 +202,71 @@ public async Task<bool> WaitForExitAsync(TimeSpan? timeout)
 
         private static (List<string> chromiumArgs, TempDirectory tempUserDataDir) PrepareChromiumArgs(LaunchOptions options)
         {
-            var chromiumArgs = new List<string>(DefaultArgs);
-            TempDirectory tempUserDataDir = null;
 
-            if (options.AppMode)
+            var chromiumArgs = new List<string>();
+
+            if (!options.IgnoreDefaultArgs)
             {
-                options.Headless = false;
+                chromiumArgs.AddRange(GetDefaultArgs(options));
+            }
+            else if (options.IgnoredDefaultArgs?.Length > 0)
+            {
+                chromiumArgs.AddRange(GetDefaultArgs(options).Except(options.IgnoredDefaultArgs));
             }
             else
             {
-                chromiumArgs.AddRange(AutomationArgs);
+                chromiumArgs.AddRange(options.Args);
             }
 
-            if (!options.IgnoreDefaultArgs ||
-                !chromiumArgs.Any(argument => argument.StartsWith("--remote-debugging-", StringComparison.Ordinal)))
+            TempDirectory tempUserDataDir = null;
+
+            if (!chromiumArgs.Any(argument => argument.StartsWith("--remote-debugging-", StringComparison.Ordinal)))
             {
                 chromiumArgs.Add("--remote-debugging-port=0");
             }
 
-            var userDataDirOption = options.Args.FirstOrDefault(i => i.StartsWith(UserDataDirArgument, StringComparison.Ordinal));
+            var userDataDirOption = chromiumArgs.FirstOrDefault(i => i.StartsWith(UserDataDirArgument, StringComparison.Ordinal));
             if (string.IsNullOrEmpty(userDataDirOption))
             {
-                if (string.IsNullOrEmpty(options.UserDataDir))
-                {
-                    tempUserDataDir = new TempDirectory();
-                    chromiumArgs.Add($"{UserDataDirArgument}={tempUserDataDir.Path.Quote()}");
-                }
-                else
-                {
-                    chromiumArgs.Add($"{UserDataDirArgument}={options.UserDataDir.Quote()}");
-                }
+                tempUserDataDir = new TempDirectory();
+                chromiumArgs.Add($"{UserDataDirArgument}={tempUserDataDir.Path.Quote()}");
             }
-            else
+
+            return (chromiumArgs, tempUserDataDir);
+        }
+
+        internal static string[] GetDefaultArgs(LaunchOptions options)
+        {
+            var chromeArguments = new List<string>(DefaultArgs);
+
+            if (!string.IsNullOrEmpty(options.UserDataDir))
             {
-                options.UserDataDir = userDataDirOption.Replace($"{UserDataDirArgument}=", string.Empty).UnQuote();
+                chromeArguments.Add($"{UserDataDirArgument}={options.UserDataDir.Quote()}");
             }
-
             if (options.Devtools)
             {
-                chromiumArgs.Add("--auto-open-devtools-for-tabs");
-                options.Headless = false;
+                chromeArguments.Add("--auto-open-devtools-for-tabs");
             }
-
             if (options.Headless)
             {
-                chromiumArgs.AddRange(new[]{
+                chromeArguments.AddRange(new[]{
                     "--headless",
-                    "--disable-gpu",
                     "--hide-scrollbars",
                     "--mute-audio"
                 });
+                if (BrowserFetcher.GetCurrentPlatform() == Platform.Win32)
+                {
+                    chromeArguments.Add("--disable-gpu");
+                }
             }
 
             if (options.Args.All(arg => arg.StartsWith("-", StringComparison.Ordinal)))
             {
-                chromiumArgs.Add("about:blank");
-            }
-
-            if (options.Args.Any())
-            {
-                chromiumArgs.AddRange(options.Args);
+                chromeArguments.Add("about:blank");
             }
 
-            return (chromiumArgs, tempUserDataDir);
+            chromeArguments.AddRange(options.Args);
+            return chromeArguments.ToArray();
         }
 
         private static void SetEnvVariables(IDictionary<string, string> environment, IDictionary<string, string> customEnv, IDictionary realEnv)
@@ -601,12 +600,7 @@ private class ExitingState : State
             {
                 public Task EnterFromAsync(ChromiumProcess p, State fromState, TimeSpan timeout)
                 {
-                    if (!TryEnter(p, fromState))
-                    {
-                        return p._currentState.ExitAsync(p, timeout);
-                    }
-
-                    return ExitAsync(p, timeout);
+                    return !TryEnter(p, fromState) ? p._currentState.ExitAsync(p, timeout) : ExitAsync(p, timeout);
                 }
 
                 public override async Task ExitAsync(ChromiumProcess p, TimeSpan timeout)

lib/PuppeteerSharp/ChromiumProcess.cs

@@ -41,5 +41,11 @@ public class ConnectOptions : IBrowserOptions, IConnectionOptions
         /// Optional factory for <see cref="WebSocket"/> implementations.
         /// </summary>
         public Func<Uri, IConnectionOptions, CancellationToken, Task<WebSocket>> WebSocketFactory { get; set; }
+
+        /// <summary>
+        /// Gets or sets the default Viewport.
+        /// </summary>
+        /// <value>The default Viewport.</value>
+        public ViewPortOptions DefaultViewport { get; set; } = ViewPortOptions.Default;
     }
 }

lib/PuppeteerSharp/ConnectOptions.cs

@@ -11,8 +11,9 @@ public interface IBrowserOptions
         bool IgnoreHTTPSErrors { get; }
 
         /// <summary>
-        /// If set to true, sets Headless = false, otherwise, enables automation.
+        /// Gets or sets the default Viewport.
         /// </summary>
-        bool AppMode { get; }
+        /// <value>The default Viewport.</value>
+        ViewPortOptions DefaultViewport { get; set; }
     }
-}
+}

lib/PuppeteerSharp/IBrowserOptions.cs

@@ -11,20 +11,13 @@ namespace PuppeteerSharp
     /// </summary>
     public class LaunchOptions : IBrowserOptions, IConnectionOptions
     {
+        private string[] _ignoredDefaultArgs;
+
         /// <summary>
         /// Whether to ignore HTTPS errors during navigation. Defaults to false.
         /// </summary>
         public bool IgnoreHTTPSErrors { get; set; }
 
-        /// <summary>
-        /// If set to true, sets Headless = false, otherwise, enables automation.
-        /// </summary>
-        /// <remarks>
-        /// AppMode won't neither add the argument '--remote-debugging-pipe' nor implement Pipes
-        /// due to limitations in .NET see <see href="https://github.com/dotnet/corefx/issues/30575"/> 
-        /// </remarks>
-        public bool AppMode { get; set; }
-
         /// <summary>
         /// Whether to run browser in headless mode. Defaults to true unless the devtools option is true.
         /// </summary>
@@ -82,14 +75,33 @@ public class LaunchOptions : IBrowserOptions, IConnectionOptions
         public bool LogProcess { get; set; }
 
         /// <summary>
-        /// Do not use it. Dangerous option; use with care. Defaults to false.
+        /// If <c>true</c>, then do not use <see cref="Puppeteer.DefaultArgs"/>.
+        /// Dangerous option; use with care. Defaults to <c>false</c>.
         /// </summary>
-        /// <value><c>true</c> if ignore default arguments; otherwise, <c>false</c>.</value>
         public bool IgnoreDefaultArgs { get; set; }
 
+        /// <summary>
+        /// if <see cref="IgnoreDefaultArgs"/> is set to <c>false</c> this list will be used to filter <see cref="Puppeteer.DefaultArgs"/>
+        /// </summary>
+        public string[] IgnoredDefaultArgs
+        {
+            get => _ignoredDefaultArgs;
+            set
+            {
+                IgnoreDefaultArgs = true;
+                _ignoredDefaultArgs = value;
+            }
+        }
+
         /// <summary>
         /// Optional factory for <see cref="WebSocket"/> implementations.
         /// </summary>
         public Func<Uri, IConnectionOptions, CancellationToken, Task<WebSocket>> WebSocketFactory { get; set; }
+
+        /// <summary>
+        /// Gets or sets the default Viewport.
+        /// </summary>
+        /// <value>The default Viewport.</value>
+        public ViewPortOptions DefaultViewport { get; set; } = ViewPortOptions.Default;
     }
 }