Close OutOfProcess browser on Dispose

Author: amaitland

CefSharp.OutOfProcess.BrowserProcess/BrowserProcessHandler.cs

@@ -17,7 +17,7 @@ protected override void OnContextInitialized()
         {
             base.OnContextInitialized();
 
-            var browser = new ChromiumWebBrowser("https://github.com");
+            var browser = new OutOfProcessChromiumWebBrowser("https://github.com");
 
             var windowInfo = new WindowInfo();
             windowInfo.WindowName = "CefSharpBrowserProcess";

CefSharp.OutOfProcess.BrowserProcess/CefSharp.OutOfProcess.BrowserProcess.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>WinExe</OutputType>
@@ -12,6 +12,8 @@
 
   <ItemGroup>
     <PackageReference Include="CefSharp.Common.NETCore" Version="102.0.90-RCI4501" />
+    <PackageReference Include="PInvoke.Kernel32" Version="0.7.104" />
+    <PackageReference Include="StreamJsonRpc" Version="2.11.35" />
   </ItemGroup>
 
 </Project>

…ess.BrowserProcess/ChromiumWebBrowser.cs …rocess/OutOfProcessChromiumWebBrowser.csCefSharp.OutOfProcess.BrowserProcess/ChromiumWebBrowser.cs renamed to CefSharp.OutOfProcess.BrowserProcess/OutOfProcessChromiumWebBrowser.cs CefSharp.OutOfProcess.BrowserProcess/ChromiumWebBrowser.cs renamed to CefSharp.OutOfProcess.BrowserProcess/OutOfProcessChromiumWebBrowser.cs

@@ -3,13 +3,15 @@
 using System.Threading.Tasks;
 using System.Threading;
 using System.ComponentModel;
+using StreamJsonRpc;
+using PInvoke;
 
 namespace CefSharp.OutOfProcess.BrowserProcess
 {
     /// <summary>
     /// An ChromiumWebBrowser instance specifically for hosting CEF out of process
     /// </summary>
-    public partial class ChromiumWebBrowser : IWebBrowserInternal
+    public partial class OutOfProcessChromiumWebBrowser : IWebBrowserInternal
     {
         public const string BrowserNotInitializedExceptionErrorMessage =
             "The ChromiumWebBrowser instance creates the underlying Chromium Embedded Framework (CEF) browser instance in an async fashion. " +
@@ -21,9 +23,13 @@ public partial class ChromiumWebBrowser : IWebBrowserInternal
         /// </summary>
         private IBrowserAdapter managedCefBrowserAdapter;
 
+        /// <summary>
+        /// JSON RPC used for IPC with host
+        /// </summary>
+        private JsonRpc _jsonRpc;
 
         /// <summary>
-        /// Flag to guard the creation of the underlying offscreen browser - only one instance can be created
+        /// Flag to guard the creation of the underlying browser - only one instance can be created
         /// </summary>
         private bool browserCreated;
 
@@ -335,6 +341,23 @@ void IWebBrowserInternal.OnAfterBrowserCreated(IBrowser browser)
             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);
         }
 
         /// <summary>
@@ -611,7 +634,7 @@ public bool IsBrowserInitialized
         public event EventHandler<TitleChangedEventArgs> TitleChanged;
 
         /// <summary>
-        /// Create a new OffScreen Chromium Browser. If you use <see cref="CefSharp.JavascriptBinding.JavascriptBindingSettings.LegacyBindingEnabled"/> = true then you must
+        /// Create a new ChromiumWebBrowser. If you use <see cref="CefSharp.JavascriptBinding.JavascriptBindingSettings.LegacyBindingEnabled"/> = true then you must
         /// set <paramref name="automaticallyCreateBrowser"/> to false and call <see cref="CreateBrowser"/> after the objects are registered.
         /// The underlying Chromium Embedded Framework(CEF) Browser is created asynchronouly, to subscribe to the <see cref="BrowserInitialized"/> event it is recommended
         /// that you set <paramref name="automaticallyCreateBrowser"/> to false, subscribe to the event and then call <see cref="CreateBrowser(IWindowInfo, IBrowserSettings)"/>
@@ -627,7 +650,7 @@ 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 ChromiumWebBrowser(string address = "",
+        public OutOfProcessChromiumWebBrowser(string address = "",
             IRequestContext requestContext = null,
             Action<IBrowser> onAfterBrowserCreated = null)
         {
@@ -641,15 +664,15 @@ public ChromiumWebBrowser(string address = "",
         }
 
         /// <summary>
-        /// Finalizes an instance of the <see cref="ChromiumWebBrowser"/> class.
+        /// Finalizes an instance of the <see cref="OutOfProcessChromiumWebBrowser"/> class.
         /// </summary>
-        ~ChromiumWebBrowser()
+        ~OutOfProcessChromiumWebBrowser()
         {
             Dispose(false);
         }
 
         /// <summary>
-        /// Releases all resources used by the <see cref="ChromiumWebBrowser"/> object
+        /// Releases all resources used by the <see cref="OutOfProcessChromiumWebBrowser"/> object
         /// </summary>
         public void Dispose()
         {
@@ -658,7 +681,7 @@ public void Dispose()
         }
 
         /// <summary>
-        /// Releases unmanaged and - optionally - managed resources for the <see cref="ChromiumWebBrowser"/>
+        /// Releases unmanaged and - optionally - managed resources for the <see cref="OutOfProcessChromiumWebBrowser"/>
         /// </summary>
         /// <param name="disposing"><see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
         protected virtual void Dispose(bool disposing)
@@ -672,6 +695,9 @@ protected virtual void Dispose(bool disposing)
 
             if (disposing)
             {
+                _jsonRpc?.Dispose();
+                _jsonRpc = null;
+
                 CanExecuteJavascriptInMainFrame = false;
                 Interlocked.Exchange(ref browserInitialized, 0);
 
@@ -698,11 +724,8 @@ protected virtual void Dispose(bool disposing)
                 browser = null;
                 BrowserCore = null;
 
-                if (managedCefBrowserAdapter != null)
-                {
-                    managedCefBrowserAdapter.Dispose();
-                    managedCefBrowserAdapter = null;
-                }
+                managedCefBrowserAdapter?.Dispose();
+                managedCefBrowserAdapter = null;
 
                 // LifeSpanHandler is set to null after managedCefBrowserAdapter.Dispose so ILifeSpanHandler.DoClose
                 // is called.
@@ -717,12 +740,12 @@ protected virtual void Dispose(bool disposing)
         /// </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 offscreen browser has already been created, this method can only be called once.</exception>
+        /// <exception cref="System.Exception">An instance of the underlying browser has already been created, this method can only be called once.</exception>
         public void CreateBrowser(IWindowInfo windowInfo = null, IBrowserSettings browserSettings = null)
         {
             if (browserCreated)
             {
-                throw new Exception("An instance of the underlying offscreen browser has already been created, this method can only be called once.");
+                throw new Exception("An instance of the underlying browser has already been created, this method can only be called once.");
             }
 
             browserCreated = true;
@@ -768,7 +791,7 @@ public void CreateBrowser(IWindowInfo windowInfo = null, IBrowserSettings browse
         /// </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 offscreen browser has already been created, this method can only be called once.</exception>
+        /// <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.
@@ -833,7 +856,6 @@ public IJavascriptObjectRepository JavascriptObjectRepository
         /// <returns>returns false</returns>
         bool IChromiumWebBrowserBase.Focus()
         {
-            // no control to focus for offscreen browser
             return false;
         }
 
@@ -899,4 +921,4 @@ void IWebBrowserInternal.SetTooltipText(string tooltipText)
             TooltipText = tooltipText;
         }
     }
-}
+}

CefSharp.OutOfProcess.BrowserProcess/Program.cs

@@ -8,11 +8,13 @@ namespace CefSharp.OutOfProcess.BrowserProcess
 {
     public class Program
     {
+        private static bool _disposed;
+
         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"));
@@ -36,6 +38,11 @@ public static int Main(string[] args)
             {
                 parentProcess.WaitForExit();
 
+                if(_disposed)
+                {
+                    return;
+                }
+
                 CefThread.ExecuteOnUiThread(() =>
                 {
                     Cef.QuitMessageLoop();
@@ -44,7 +51,9 @@ public static int Main(string[] args)
                 });
             });
 
-            Cef.RunMessageLoop();            
+            Cef.RunMessageLoop();
+
+            _disposed = true;
 
             Cef.WaitForBrowsersToClose();
 

CefSharp.OutOfProcess.Example/ChromiumWebBrowser.cs

@@ -3,20 +3,24 @@
 using System.Drawing;
 using System.Windows.Forms;
 using PInvoke;
+using StreamJsonRpc;
 
 namespace CefSharp.OutOfProcess.Example
 {
     public class ChromiumWebBrowser : Control
     {
         private IntPtr _browserHwnd = IntPtr.Zero;
-        private Process _browserProces;
+        private int _remoteThreadId = -1;
+        private Process _browserProcess;
+        private bool _disposed;
+        private JsonRpc _jsonRpc;
 
         /// <summary>
         /// The <see cref="Process"/> in which the CEF Browser is actually running.
         /// </summary>
         public Process BrowserProcess
         {
-            get { return _browserProces; }
+            get { return _browserProcess; }
         }
 
         /// <summary>
@@ -38,7 +42,44 @@ protected override void OnHandleCreated(EventArgs e)
 
             var args = $"--parentProcessId={currentProcess.Id} --hostHwnd={Handle.ToInt32()}";
 
-            _browserProces = Process.Start("CefSharp.OutOfProcess.BrowserProcess.exe", args);
+            _browserProcess = Process.Start(new ProcessStartInfo("CefSharp.OutOfProcess.BrowserProcess.exe", args)
+            {
+                RedirectStandardInput = true,
+                RedirectStandardOutput = true,
+            });
+
+            Action<int, int> OnAfterBrowserCreatedDelegate = delegate (int ptr, int threadId)
+            {
+                _browserHwnd = new IntPtr(ptr);
+                _remoteThreadId = threadId;
+            };
+
+            _jsonRpc = JsonRpc.Attach(_browserProcess.StandardInput.BaseStream, _browserProcess.StandardOutput.BaseStream);
+            _jsonRpc.AllowModificationWhileListening = true;
+
+            _jsonRpc.AddLocalRpcMethod("OnAfterBrowserCreated", OnAfterBrowserCreatedDelegate);
+
+            _jsonRpc.AllowModificationWhileListening = false;
+        }
+
+        protected override void Dispose(bool disposing)
+        {
+            base.Dispose(disposing);
+
+            if(disposing)
+            {
+                _remoteThreadId = -1;
+
+#pragma warning disable VSTHRD110 // Observe result of async calls
+                _ = _jsonRpc?.NotifyAsync("CLOSE");
+#pragma warning restore VSTHRD110 // Observe result of async calls
+                _jsonRpc?.Dispose();
+                _jsonRpc = null;
+                _browserHwnd = IntPtr.Zero;
+                _disposed = true;
+
+                _browserProcess.WaitForExit();
+            }
         }
 
         /// <inheritdoc />
@@ -72,15 +113,6 @@ protected override void OnSizeChanged(EventArgs e)
         /// <param name="height">height</param>
         protected virtual void ResizeBrowser(int width, int height)
         {
-            if (_browserHwnd == IntPtr.Zero)
-            {
-                var result = ChromiumRenderWidgetHandleFinder.TryFindHandle(Handle, "CefBrowserWindow", out var handle);
-                if (result)
-                {
-                    _browserHwnd = handle;
-                }
-            }
-
             if (_browserHwnd != IntPtr.Zero)
             {
                 if (width == 0 && height == 0)

CefSharp.OutOfProcess.Example/HostForm.Designer.cs

@@ -32,5 +32,14 @@ private void ExitToolStripMenuItemClick(object sender, EventArgs e)
         {
             Close();
         }
+
+        private void CloseBrowserToolStripMenuItemClick(object sender, EventArgs e)
+        {
+            var ctrl = splitContainer.Panel2.Controls[0];
+
+            splitContainer.Panel2.Controls.Remove(ctrl);
+
+            ctrl.Dispose();
+        }
     }
 }