Add OutOfProcessHost Settings

- Add new Settings object that maps to CefSettings object
- Allow for passing of additional command line args to the browser process
  (BrowserProcess will read args from command line by default)

Author: amaitland

CefSharp.OutOfProcess.BrowserProcess/Program.cs

@@ -18,13 +18,15 @@ public static int Main(string[] args)
 
             var parentProcessId = int.Parse(CommandLineArgsParser.GetArgumentValue(args, "--parentProcessId"));
             var cachePath = CommandLineArgsParser.GetArgumentValue(args, "--cachePath");
+            var rootCachePath = CommandLineArgsParser.GetArgumentValue(args, "--rootCachePath");
 
             var parentProcess = Process.GetProcessById(parentProcessId);
 
             var settings = new CefSettings()
             {
                 //By default CefSharp will use an in-memory cache, you need to specify a Cache Folder to persist data
                 CachePath = cachePath,
+                RootCachePath = rootCachePath,
                 MultiThreadedMessageLoop = false
             };
 

CefSharp.OutOfProcess.Core/OutOfProcessHost.cs

@@ -6,6 +6,7 @@
 using System.Collections.Concurrent;
 using System.Diagnostics;
 using System.IO;
+using System.Linq;
 using System.Threading.Tasks;
 
 namespace CefSharp.OutOfProcess
@@ -27,14 +28,14 @@ public class OutOfProcessHost : IOutOfProcessHostRpc, IDisposable
         private int _remoteuiThreadId;
         private int _browserIdentifier = 1;
         private string _outofProcessHostExePath;
-        private string _cachePath;
+        private Settings _settings;
         private ConcurrentDictionary<int, IChromiumWebBrowserInternal> _browsers = new ConcurrentDictionary<int, IChromiumWebBrowserInternal>();
         private TaskCompletionSource<OutOfProcessHost> _processInitialized = new TaskCompletionSource<OutOfProcessHost>(TaskCreationOptions.RunContinuationsAsynchronously);
 
-        private OutOfProcessHost(string outOfProcessHostExePath, string cachePath = null)
+        private OutOfProcessHost(string outOfProcessHostExePath, Settings settings = null)
         {
             _outofProcessHostExePath = outOfProcessHostExePath;
-            _cachePath = cachePath;
+            _settings = settings;
         }
 
         /// <summary>
@@ -108,7 +109,22 @@ private void Init()
         {
             var currentProcess = Process.GetCurrentProcess();
 
-            var args = $"--parentProcessId={currentProcess.Id} --cachePath={_cachePath}";
+            var args = $"--parentProcessId={currentProcess.Id}";
+
+            if (_settings != null)
+            {
+                if (!string.IsNullOrEmpty(_settings.CachePath))
+                {
+                    args += $" --cachePath={_settings.CachePath}";
+                }
+
+                if (!string.IsNullOrEmpty(_settings.RootCachePath))
+                {
+                    args += $" --rootCachePath={_settings.RootCachePath}";
+                }
+
+                args = _settings.AdditionalCommandLineArgs.Aggregate(args, (current, next) => $"{current} {next}");
+            }
 
             _browserProcess = Process.Start(new ProcessStartInfo(_outofProcessHostExePath, args)
             {
@@ -234,7 +250,7 @@ public void Dispose()
             _jsonRpc = null;
         }
 
-        public static Task<OutOfProcessHost> CreateAsync(string path = HostExeName, string cachePath = null)
+        public static Task<OutOfProcessHost> CreateAsync(string path = HostExeName, Settings settings = null)
         {
             if(string.IsNullOrEmpty(path))
             {
@@ -248,7 +264,7 @@ public static Task<OutOfProcessHost> CreateAsync(string path = HostExeName, stri
                 throw new FileNotFoundException("Unable to find Host executable.", path);
             }
 
-            var host = new OutOfProcessHost(fullPath, cachePath);
+            var host = new OutOfProcessHost(fullPath, settings);
 
             host.Init();            
 

CefSharp.OutOfProcess.Core/Settings.cs

@@ -0,0 +1,59 @@
+using System.Collections.Generic;
+
+namespace CefSharp.OutOfProcess
+{
+    /// <summary>
+    /// Initialization settings. Many of these and other settings can also configured using command-line switches.
+    /// </summary>
+    public sealed class Settings
+    {
+        /// <summary>
+        /// The location where data for the global browser cache will be stored on disk. In this value is non-empty then it must be
+        /// an absolute path that is must be either equal to or a child directory of RootCachePath (if RootCachePath is
+        /// empty it will default to this value). If the value is empty then browsers will be created in "incognito mode" where
+        /// in-memory caches are used for storage and no data is persisted to disk. HTML5 databases such as localStorage will only
+        /// persist across sessions if a cache path is specified. Can be overridden for individual RequestContext instances via the
+        /// RequestContextSettings.CachePath value.
+        /// </summary>
+        public string CachePath { get; set; }
+
+        /// <summary>
+        /// The root directory that all CefSettings.CachePath and RequestContextSettings.CachePath values must have in common. If this
+        /// value is empty and CefSettings.CachePath is non-empty then it will default to the CefSettings.CachePath value.
+        /// If this value is non-empty then it must be an absolute path.  Failure to set this value correctly may result in the sandbox
+        /// blocking read/write access to the CachePath directory. NOTE: CefSharp does not implement the CHROMIUM SANDBOX. A non-empty
+        /// RootCachePath can be used in conjuncation with an empty CefSettings.CachePath in instances where you would like browsers
+        /// attached to the Global RequestContext (the default) created in "incognito mode" and instances created with a custom
+        /// RequestContext using a disk based cache.
+        /// </summary>
+        public string RootCachePath { get; set; }
+
+        /// <summary>
+        /// Command line args passed to the BrowserProcess
+        /// </summary>
+        public ICollection<string> AdditionalCommandLineArgs { get; } = new List<string>();
+
+        /// <summary>
+        /// Adds the command line arg to the <see cref="AdditionalCommandLineArgs"/> collection.
+        /// </summary>
+        /// <param name="arg">command line arg</param>
+        /// <returns>The current instance</returns>
+        public Settings AddCommandLineArg(string arg)
+        {
+            AdditionalCommandLineArgs.Add(arg);
+
+            return this;
+        }
+
+        /// <summary>
+        /// Creates a new <see cref="Settings"/> instance with the specified
+        /// <paramref name="cachePath"/>.
+        /// </summary>
+        /// <param name="cachePath">sets <see cref="CachePath"/></param>
+        /// <returns>new Settings instance.</returns>
+        public static Settings WithCachePath(string cachePath)
+        {
+            return new Settings { CachePath = cachePath };
+        }
+    }
+}

CefSharp.OutOfProcess.WinForms.Example/BrowserForm.cs

@@ -55,7 +55,11 @@ private async void BrowserFormLoad(object sender, EventArgs e)
             var outOfProcessHostPath = Path.GetFullPath($"..\\..\\..\\..\\..\\CefSharp.OutOfProcess.BrowserProcess\\bin\\{_buildType}");
             outOfProcessHostPath = Path.Combine(outOfProcessHostPath, OutOfProcessHost.HostExeName);
             var cachePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "CefSharp\\OutOfProcessCache");
-            _outOfProcessHost = await OutOfProcessHost.CreateAsync(outOfProcessHostPath, cachePath);
+
+            var settings = Settings.WithCachePath(cachePath)
+                .AddCommandLineArg("--lang=en-GB");
+
+            _outOfProcessHost = await OutOfProcessHost.CreateAsync(outOfProcessHostPath, settings);
 
             AddTab(DefaultUrlForAddedTabs);
         }

CefSharp.OutOfProcess.Wpf.HwndHost.Example/MainWindow.xaml.cs

@@ -29,7 +29,10 @@ private async void OnMainWindowLoaded(object sender, RoutedEventArgs e)
             var outOfProcessHostPath = Path.GetFullPath($"..\\..\\..\\..\\CefSharp.OutOfProcess.BrowserProcess\\bin\\{_buildType}");
             outOfProcessHostPath = Path.Combine(outOfProcessHostPath, OutOfProcessHost.HostExeName);
             var cachePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "CefSharp\\OutOfProcessCache");
-            _outOfProcessHost = await OutOfProcessHost.CreateAsync(outOfProcessHostPath, cachePath);
+
+            var settings = Settings.WithCachePath(cachePath);
+
+            _outOfProcessHost = await OutOfProcessHost.CreateAsync(outOfProcessHostPath, settings);
 
             BrowserContentPresenter.Content = new ChromiumWebBrowser(_outOfProcessHost, "https://google.com");
         }

CefSharp.OutOfProcess.sln

@@ -1,7 +1,7 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio Version 16
-VisualStudioVersion = 16.0.32510.428
+# Visual Studio Version 17
+VisualStudioVersion = 17.5.33424.131
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CefSharp.OutOfProcess.WinForms.Example", "CefSharp.OutOfProcess.WinForms.Example\CefSharp.OutOfProcess.WinForms.Example.csproj", "{A1C85784-7C6F-4C83-9AC4-B3413F32FF31}"
 EndProject
@@ -19,6 +19,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CefSharp.OutOfProcess.Wpf.H
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CefSharp.Dom.OutOfProcess", "CefSharp.Dom\lib\PuppeteerSharp\CefSharp.Dom.OutOfProcess.csproj", "{7D39CC02-FB02-4F03-B329-E5DB567EC354}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{3E9517EE-C843-4480-A847-3B8473F6188E}"
+	ProjectSection(SolutionItems) = preProject
+		Directory.Build.props = Directory.Build.props
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

Directory.Build.props

@@ -0,0 +1,6 @@
+<Project>
+  <PropertyGroup>
+    <!--<Nullable>enable</Nullable>-->
+    <LangVersion>latest</LangVersion>
+  </PropertyGroup>
+</Project>