Start to refactor to allow for multiple browsers per process

Author: amaitland

CefSharp.OutOfProcess.BrowserProcess/BrowserProcessHandler.cs

@@ -1,29 +1,93 @@
-using System;
+using CefSharp.Internals;
+using PInvoke;
+using StreamJsonRpc;
+using System;
+using System.Linq;
+using System.Collections.Generic;
+using System.Diagnostics;
 
 namespace CefSharp.OutOfProcess.BrowserProcess
 {
     public class BrowserProcessHandler : CefSharp.Handler.BrowserProcessHandler
     {
         private readonly int _parentProcessId;
-        private readonly IntPtr _hostHwnd;
+        private IList<OutOfProcessChromiumWebBrowser> _browsers = new List<OutOfProcessChromiumWebBrowser>();
+        /// <summary>
+        /// JSON RPC used for IPC with host
+        /// </summary>
+        private JsonRpc _jsonRpc;
 
-        public BrowserProcessHandler(int parentProcessId, IntPtr hostHwnd)
+        public BrowserProcessHandler(int parentProcessId)
         {
             _parentProcessId = parentProcessId;
-            _hostHwnd = hostHwnd;
         }
 
         protected override void OnContextInitialized()
         {
             base.OnContextInitialized();
 
-            var browser = new OutOfProcessChromiumWebBrowser("https://github.com");
+            _jsonRpc = JsonRpc.Attach(Console.OpenStandardOutput(), Console.OpenStandardInput());
+            _jsonRpc.AllowModificationWhileListening = true;
 
-            var windowInfo = new WindowInfo();
-            windowInfo.WindowName = "CefSharpBrowserProcess";
-            windowInfo.SetAsChild(_hostHwnd);
+            _jsonRpc.AddLocalRpcMethod("CloseBrowser", (Action<int>)delegate (int browserId)
+            {
+                _ = CefThread.ExecuteOnUiThread(() =>
+                {
+                    var p = _browsers.FirstOrDefault(x => x.Id == browserId);
 
-            browser.CreateBrowser(windowInfo);
+                    _browsers.Remove(p);
+
+                    p.Dispose();
+
+                    return true;
+                });
+            });
+
+            _jsonRpc.AddLocalRpcMethod("CloseHost", (Action)delegate ()
+            {
+                _ = CefThread.ExecuteOnUiThread(() =>
+                {
+                    Cef.QuitMessageLoop();
+
+                    return true;
+                });
+            });
+
+            _jsonRpc.AddLocalRpcMethod("CreateBrowser", (Action<int, string, int>)delegate (int parentHwnd, string url, int id)
+            {
+                Debugger.Break();
+
+                _ = CefThread.ExecuteOnUiThread(() =>
+                {
+
+                    var browser = new OutOfProcessChromiumWebBrowser(_jsonRpc, id, url);
+
+                    var windowInfo = new WindowInfo();
+                    windowInfo.WindowName = "CefSharpBrowserProcess";
+                    windowInfo.SetAsChild(new IntPtr(parentHwnd));
+
+                    browser.CreateBrowser(windowInfo);
+
+                    _browsers.Add(browser);
+
+                    return true;
+                });
+            });
+
+            var threadId = Kernel32.GetCurrentThreadId();
+
+            _ = _jsonRpc.NotifyAsync("OnContextInitialized", threadId);
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            base.Dispose(disposing);
+
+            if(disposing)
+            {
+                _jsonRpc?.Dispose();
+                _jsonRpc = null;
+            }
         }
     }
 }

CefSharp.OutOfProcess.BrowserProcess/OutOfProcessChromiumWebBrowser.cs

@@ -4,7 +4,6 @@
 using System.Threading;
 using System.ComponentModel;
 using StreamJsonRpc;
-using PInvoke;
 
 namespace CefSharp.OutOfProcess.BrowserProcess
 {
@@ -18,6 +17,11 @@ public partial class OutOfProcessChromiumWebBrowser : IWebBrowserInternal
             "The undelying CefBrowser instance is not yet initialized. Use the IsBrowserInitializedChanged event and check " +
             "the IsBrowserInitialized property to determine when the browser has been initialized.";
 
+        /// <summary>
+        /// Internal ID used for tracking browsers between Processes;
+        /// </summary>
+        private int _id;
+
         /// <summary>
         /// The managed cef browser adapter
         /// </summary>
@@ -33,12 +37,6 @@ public partial class OutOfProcessChromiumWebBrowser : IWebBrowserInternal
         /// </summary>
         private bool browserCreated;
 
-        /// <summary>
-        /// Action which is called immediately before the <see cref="BrowserInitialized"/> event after the
-        /// uderlying Chromium Embedded Framework (CEF) browser has been created.
-        /// </summary>
-        private Action<IBrowser> onAfterBrowserCreatedDelegate;
-
         /// <summary>
         /// Used as workaround for issue https://github.com/cefsharp/CefSharp/issues/3021
         /// </summary>
@@ -70,6 +68,11 @@ public partial class OutOfProcessChromiumWebBrowser : IWebBrowserInternal
         /// </summary>
         private Action<bool?, CefErrorCode?> initialLoadAction;
 
+        /// <summary>
+        /// Id
+        /// </summary>
+        public int Id => _id;
+
         /// <summary>
         /// Get access to the core <see cref="IBrowser"/> instance.
         /// Maybe null if the underlying CEF Browser has not yet been
@@ -258,7 +261,7 @@ void IWebBrowserInternal.SetCanExecuteJavascriptOnMainFrame(long frameId, bool c
         void IWebBrowserInternal.SetJavascriptMessageReceived(JavascriptMessageReceivedEventArgs args)
         {
             //Run the event on the ThreadPool (rather than the CEF Thread we are currently on).
-            Task.Run(() => JavascriptMessageReceived?.Invoke(this, args));
+            _ = Task.Run(() => JavascriptMessageReceived?.Invoke(this, args));
         }
 
         /// <summary>
@@ -340,24 +343,7 @@ void IWebBrowserInternal.OnAfterBrowserCreated(IBrowser browser)
             initialLoadAction = InitialLoad;
             Interlocked.Exchange(ref browserInitialized, 1);
 
-            OnAfterBrowserCreated(browser);
-
-            _jsonRpc = JsonRpc.Attach(Console.OpenStandardOutput(), Console.OpenStandardInput());
-            _jsonRpc.AllowModificationWhileListening = true;
-
-            _jsonRpc.AddLocalRpcMethod("CLOSE", (Action) delegate ()
-            {
-                _ = CefThread.ExecuteOnUiThread(() =>
-                {
-                    Cef.QuitMessageLoop();
-
-                    return true;
-                });
-            });
-
-            var threadId = Kernel32.GetCurrentThreadId();
-
-            _ = _jsonRpc.NotifyAsync("OnAfterBrowserCreated", browser.GetHost().GetWindowHandle().ToInt32(), threadId);
+            _ = _jsonRpc.NotifyAsync("OnAfterBrowserCreated", _id, browser.GetHost().GetWindowHandle().ToInt32());
         }
 
         /// <summary>
@@ -481,8 +467,6 @@ private void InitialLoad(bool? isLoading, CefErrorCode? errorCode)
             }
         }
 
-        partial void OnAfterBrowserCreated(IBrowser browser);
-
         partial void SetLoadingStateChange(LoadingStateChangedEventArgs args);
 
         /// <summary>
@@ -609,14 +593,6 @@ public bool IsBrowserInitialized
         /// <value>The accessibility handler.</value>
         public IAccessibilityHandler AccessibilityHandler { get; set; }
         /// <summary>
-        /// Event called after the underlying CEF browser instance has been created. 
-        /// It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
-        /// thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
-        /// To access UI elements you'll need to Invoke/Dispatch onto the UI Thread.
-        /// (The exception to this is when you're running with settings.MultiThreadedMessageLoop = false, then they'll be the same thread).
-        /// </summary>
-        public event EventHandler BrowserInitialized;
-        /// <summary>
         /// Occurs when the browser address changed.
         /// It's important to note this event is fired on a CEF UI thread, which by default is not the same as your application UI
         /// thread. It is unwise to block on this thread for any length of time as your browser will become unresponsive and/or hang..
@@ -640,6 +616,7 @@ public bool IsBrowserInitialized
         /// that you set <paramref name="automaticallyCreateBrowser"/> to false, subscribe to the event and then call <see cref="CreateBrowser(IWindowInfo, IBrowserSettings)"/>
         /// to ensure you are subscribe to the event before it's fired (Issue https://github.com/cefsharp/CefSharp/issues/3552).
         /// </summary>
+        /// <param name="id">id</param>
         /// <param name="address">Initial address (url) to load</param>
         /// <param name="browserSettings">The browser settings to use. If null, the default settings are used.</param>
         /// <param name="requestContext">See <see cref="RequestContext" /> for more details. Defaults to null</param>
@@ -650,15 +627,15 @@ public bool IsBrowserInitialized
         /// you have a chance to subscribe to the event as the CEF Browser is created async. (Issue https://github.com/cefsharp/CefSharp/issues/3552).
         /// </param>
         /// <exception cref="System.InvalidOperationException">Cef::Initialize() failed</exception>
-        public OutOfProcessChromiumWebBrowser(string address = "",
-            IRequestContext requestContext = null,
-            Action<IBrowser> onAfterBrowserCreated = null)
+        public OutOfProcessChromiumWebBrowser(JsonRpc jsonRpc, int id, string address = "",
+            IRequestContext requestContext = null)
         {
+            _id = id;
             RequestContext = requestContext;
+            _jsonRpc = jsonRpc;
 
             Cef.AddDisposable(this);
             Address = address;
-            onAfterBrowserCreatedDelegate = onAfterBrowserCreated;
 
             managedCefBrowserAdapter = ManagedCefBrowserAdapter.Create(this, false);
         }
@@ -695,15 +672,11 @@ protected virtual void Dispose(bool disposing)
 
             if (disposing)
             {
-                _jsonRpc?.Dispose();
-                _jsonRpc = null;
-
                 CanExecuteJavascriptInMainFrame = false;
                 Interlocked.Exchange(ref browserInitialized, 0);
 
                 // Don't reference event listeners any longer:
                 AddressChanged = null;
-                BrowserInitialized = null;
                 ConsoleMessage = null;
                 FrameLoadEnd = null;
                 FrameLoadStart = null;
@@ -784,40 +757,6 @@ public void CreateBrowser(IWindowInfo windowInfo = null, IBrowserSettings browse
 
         }
 
-        /// <summary>
-        /// Create the underlying CEF browser. The address and request context passed into the constructor
-        /// will be used. If a <see cref="Action{IBrowser}"/> delegate was passed
-        /// into the constructor it will not be called as this method overrides that value internally.
-        /// </summary>
-        /// <param name="windowInfo">Window information used when creating the browser</param>
-        /// <param name="browserSettings">Browser initialization settings</param>
-        /// <exception cref="System.Exception">An instance of the underlying browser has already been created, this method can only be called once.</exception>
-        /// <returns>
-        /// A <see cref="Task{IBrowser}"/> that represents the creation of the underlying CEF browser (<see cref="IBrowser"/> instance.
-        /// When the task completes then the CEF Browser will have been created and you can start performing basic tasks.
-        /// Note that the control's <see cref="BrowserInitialized"/> event will be invoked after this task completes.
-        /// </returns>
-        public Task<IBrowser> CreateBrowserAsync(IWindowInfo windowInfo = null, IBrowserSettings browserSettings = null)
-        {
-            var tcs = new TaskCompletionSource<IBrowser>();
-
-            onAfterBrowserCreatedDelegate += new Action<IBrowser>(b =>
-            {
-                tcs.TrySetResultAsync(b);
-            });
-
-            try
-            {
-                CreateBrowser(windowInfo, browserSettings);
-            }
-            catch (Exception ex)
-            {
-                tcs.TrySetExceptionAsync(ex);
-            }
-
-            return tcs.Task;
-        }
-
         /// <inheritdoc/>
         public void Load(string url)
         {
@@ -851,12 +790,18 @@ public IJavascriptObjectRepository JavascriptObjectRepository
         }
 
         /// <summary>
-        /// Has Focus - Always False
+        /// TODO: Improve focus
+        /// Has Focus 
         /// </summary>
         /// <returns>returns false</returns>
         bool IChromiumWebBrowserBase.Focus()
         {
-            return false;
+            ThrowExceptionIfDisposed();
+            ThrowExceptionIfBrowserNotInitialized();
+
+            BrowserCore.GetHost().SetFocus(true);
+
+            return true;
         }
 
         /// <summary>
@@ -871,16 +816,6 @@ public IBrowser GetBrowser()
             return browser;
         }
 
-        /// <summary>
-        /// Called when [after browser created].
-        /// </summary>
-        /// <param name="browser">The browser.</param>
-        partial void OnAfterBrowserCreated(IBrowser browser)
-        {
-            onAfterBrowserCreatedDelegate?.Invoke(browser);
-            BrowserInitialized?.Invoke(this, EventArgs.Empty);
-        }
-
         /// <summary>
         /// Sets the address.
         /// </summary>

CefSharp.OutOfProcess.BrowserProcess/Program.cs

@@ -14,10 +14,9 @@ public static int Main(string[] args)
         {
             Cef.EnableHighDPISupport();
 
-            //Debugger.Launch();
+            Debugger.Launch();
 
             var parentProcessId = int.Parse(CommandLineArgsParser.GetArgumentValue(args, "--parentProcessId"));
-            var hostHwnd = int.Parse(CommandLineArgsParser.GetArgumentValue(args, "--hostHwnd"));
 
             var parentProcess = Process.GetProcessById(parentProcessId);
 
@@ -28,7 +27,7 @@ public static int Main(string[] args)
                 MultiThreadedMessageLoop = false
             };
 
-            var browserProcessHandler = new BrowserProcessHandler(parentProcessId, new IntPtr(hostHwnd));
+            var browserProcessHandler = new BrowserProcessHandler(parentProcessId);
 
             Cef.EnableWaitForBrowsersToClose();