Core - Refactor JavascriptObjectRepository to IJavascriptObjectRepositoryInternal

Basic refactoring in preparation for allowing users(advanced) to provide their own custom JavascriptObjectRepository implementation

Author: amaitland

CefSharp.Core/ManagedCefBrowserAdapter.cpp

@@ -179,7 +179,7 @@ IJavascriptCallbackFactory^ ManagedCefBrowserAdapter::JavascriptCallbackFactory:
     return _javascriptCallbackFactory;
 }
 
-JavascriptObjectRepository^ ManagedCefBrowserAdapter::JavascriptObjectRepository::get()
+IJavascriptObjectRepositoryInternal^ ManagedCefBrowserAdapter::JavascriptObjectRepository::get()
 {
     return _javaScriptObjectRepository;
 }

CefSharp.Core/ManagedCefBrowserAdapter.h

@@ -36,7 +36,7 @@ namespace CefSharp
         BrowserProcessServiceHost^ _browserProcessServiceHost;
 #endif
         IWebBrowserInternal^ _webBrowserInternal;
-        JavascriptObjectRepository^ _javaScriptObjectRepository;
+        IJavascriptObjectRepositoryInternal^ _javaScriptObjectRepository;
         JavascriptCallbackFactory^ _javascriptCallbackFactory;
         IMethodRunnerQueue^ _methodRunnerQueue;
         IBrowser^ _browserWrapper;
@@ -138,9 +138,9 @@ namespace CefSharp
             CefSharp::Internals::IJavascriptCallbackFactory^ get();
         }
 
-        virtual property JavascriptObjectRepository^ JavascriptObjectRepository
+        virtual property IJavascriptObjectRepositoryInternal^ JavascriptObjectRepository
         {
-            CefSharp::Internals::JavascriptObjectRepository^ get();
+            CefSharp::Internals::IJavascriptObjectRepositoryInternal^ get();
         }
 
         virtual property IMethodRunnerQueue^ MethodRunnerQueue

CefSharp.Test/Framework/ConcurrentMethodRunnerQueueFacts.cs

@@ -26,7 +26,7 @@ public async Task StopConcurrentMethodRunnerQueueWhenMethodRunning()
         {
             var boundObject = new AsyncBoundObject();
 
-            var objectRepository = new JavascriptObjectRepository();
+            IJavascriptObjectRepositoryInternal objectRepository = new JavascriptObjectRepository();
             objectRepository.NameConverter = null;
 #if NETCOREAPP
             objectRepository.Register("testObject", boundObject, BindingOptions.DefaultBinder);
@@ -53,7 +53,7 @@ public async Task ValidateAsyncTaskMethodOutput()
             const string expectedResult = "Echo Me!";
             var boundObject = new AsyncBoundObject();
 
-            var objectRepository = new JavascriptObjectRepository();
+            IJavascriptObjectRepositoryInternal objectRepository = new JavascriptObjectRepository();
             objectRepository.NameConverter = null;
 #if NETCOREAPP
             objectRepository.Register("testObject", boundObject, BindingOptions.DefaultBinder);

CefSharp/CefSharp.csproj

@@ -139,6 +139,7 @@
     <Compile Include="Internals\BrowserRefCounter.cs" />
     <Compile Include="Internals\CommandLineArgDictionary.cs" />
     <Compile Include="Internals\CookieManagerDecorator.cs" />
+    <Compile Include="Internals\IJavascriptObjectRepositoryInternal.cs" />
     <Compile Include="Internals\ParentProcessMonitor.cs" />
     <Compile Include="Internals\HeaderNameValueCollection.cs" />
     <Compile Include="Internals\StringCheck.cs" />

CefSharp/Internals/ConcurrentMethodRunnerQueue.cs

@@ -16,12 +16,12 @@ namespace CefSharp.Internals
     /// </summary>
     public class ConcurrentMethodRunnerQueue : IMethodRunnerQueue
     {
-        private readonly JavascriptObjectRepository repository;
+        private readonly IJavascriptObjectRepositoryInternal repository;
         private CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
 
         public event EventHandler<MethodInvocationCompleteArgs> MethodInvocationComplete;
 
-        public ConcurrentMethodRunnerQueue(JavascriptObjectRepository repository)
+        public ConcurrentMethodRunnerQueue(IJavascriptObjectRepositoryInternal repository)
         {
             this.repository = repository;
         }

CefSharp/Internals/IBrowserAdapter.cs

@@ -11,7 +11,7 @@ namespace CefSharp.Internals
     public interface IBrowserAdapter
     {
         IMethodRunnerQueue MethodRunnerQueue { get; }
-        JavascriptObjectRepository JavascriptObjectRepository { get; }
+        IJavascriptObjectRepositoryInternal JavascriptObjectRepository { get; }
         IJavascriptCallbackFactory JavascriptCallbackFactory { get; }
         void OnAfterBrowserCreated(IBrowser browser);
         IBrowser GetBrowser(int browserId);

CefSharp/Internals/IJavascriptObjectRepositoryInternal.cs

@@ -0,0 +1,21 @@
+// Copyright © 2020 The CefSharp Authors. All rights reserved.
+//
+// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
+// 
+
+using System;
+using System.Collections.Generic;
+
+namespace CefSharp.Internals
+{
+    public interface IJavascriptObjectRepositoryInternal : IJavascriptObjectRepository
+    {
+        bool TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception);
+        bool TryGetProperty(long objectId, string name, out object result, out string exception);
+        bool TrySetProperty(long objectId, string name, object value, out string exception);
+        bool IsBrowserInitialized { get; set; }
+        List<JavascriptObject> GetObjects(List<string> names = null);
+        List<JavascriptObject> GetLegacyBoundObjects();
+        void ObjectsBound(List<Tuple<string, bool, bool>> objs);
+    }
+}

CefSharp/Internals/JavascriptObjectRepository.cs

@@ -31,7 +31,7 @@ namespace CefSharp.Internals
     /// All of the registered objects are tracked via meta-data for the objects 
     /// expressed starting with the JavaScriptObject type.
     /// </summary>
-    public class JavascriptObjectRepository : FreezableBase, IJavascriptObjectRepository
+    public class JavascriptObjectRepository : FreezableBase, IJavascriptObjectRepositoryInternal
     {
         public const string AllObjects = "All";
         public const string LegacyObjects = "Legacy";
@@ -47,7 +47,7 @@ public class JavascriptObjectRepository : FreezableBase, IJavascriptObjectReposi
         /// this is done to speed up finding the object in O(1) time
         /// instead of traversing the JavaScriptRootObject tree.
         /// </summary>
-        private readonly ConcurrentDictionary<long, JavascriptObject> objects = new ConcurrentDictionary<long, JavascriptObject>();
+        protected readonly ConcurrentDictionary<long, JavascriptObject> objects = new ConcurrentDictionary<long, JavascriptObject>();
 
         /// <summary>
         /// Javascript Name converter
@@ -103,7 +103,7 @@ public bool IsBound(string name)
             return objects.Values.Any(x => x.Name == name);
         }
 
-        public List<JavascriptObject> GetLegacyBoundObjects()
+        List<JavascriptObject> IJavascriptObjectRepositoryInternal.GetLegacyBoundObjects()
         {
             RaiseResolveObjectEvent(LegacyObjects);
 
@@ -112,7 +112,7 @@ public List<JavascriptObject> GetLegacyBoundObjects()
 
         //Ideally this would internal, unfurtunately it's used in C++
         //and it's hard to expose internals
-        public List<JavascriptObject> GetObjects(List<string> names = null)
+        List<JavascriptObject> IJavascriptObjectRepositoryInternal.GetObjects(List<string> names)
         {
             //If there are no objects names or the count is 0 then we will raise
             //the resolve event then return all objects that are registered,
@@ -140,7 +140,7 @@ public List<JavascriptObject> GetObjects(List<string> names = null)
             return objectsByName;
         }
 
-        public void ObjectsBound(List<Tuple<string, bool, bool>> objs)
+        void IJavascriptObjectRepositoryInternal.ObjectsBound(List<Tuple<string, bool, bool>> objs)
         {
             var boundObjectHandler = ObjectBoundInJavascript;
             var boundObjectsHandler = ObjectsBoundInJavascript;
@@ -255,7 +255,12 @@ public bool UnRegister(string name)
             return false;
         }
 
-        internal bool TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception)
+        bool IJavascriptObjectRepositoryInternal.TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception)
+        {
+            return TryCallMethod(objectId, name, parameters, out result, out exception);
+        }
+
+        protected virtual bool TryCallMethod(long objectId, string name, object[] parameters, out object result, out string exception)
         {
             exception = "";
             result = null;
@@ -384,7 +389,12 @@ internal bool TryCallMethod(long objectId, string name, object[] parameters, out
             return false;
         }
 
-        internal bool TryGetProperty(long objectId, string name, out object result, out string exception)
+        bool IJavascriptObjectRepositoryInternal.TryGetProperty(long objectId, string name, out object result, out string exception)
+        {
+            return TryGetProperty(objectId, name, out result, out exception);
+        }
+
+        protected virtual bool TryGetProperty(long objectId, string name, out object result, out string exception)
         {
             exception = "";
             result = null;
@@ -414,7 +424,12 @@ internal bool TryGetProperty(long objectId, string name, out object result, out
             return false;
         }
 
-        internal bool TrySetProperty(long objectId, string name, object value, out string exception)
+        bool IJavascriptObjectRepositoryInternal.TrySetProperty(long objectId, string name, object value, out string exception)
+        {
+            return TrySetProperty(objectId, name, value, out exception);
+        }
+
+        protected virtual bool TrySetProperty(long objectId, string name, object value, out string exception)
         {
             exception = "";
             JavascriptObject obj;

CefSharp/Internals/MethodRunnerQueue.cs

@@ -14,12 +14,12 @@ public sealed class MethodRunnerQueue : IMethodRunnerQueue
         //Limit to 1 task per methodRunnerQueue
         //https://social.msdn.microsoft.com/Forums/vstudio/en-US/d0bcb415-fb1e-42e4-90f8-c43a088537fb/aborting-a-long-running-task-in-tpl?forum=parallelextensions
         private readonly LimitedConcurrencyLevelTaskScheduler taskScheduler = new LimitedConcurrencyLevelTaskScheduler(1);
-        private readonly JavascriptObjectRepository repository;
+        private readonly IJavascriptObjectRepositoryInternal repository;
         private CancellationTokenSource cancellationTokenSource = new CancellationTokenSource();
 
         public event EventHandler<MethodInvocationCompleteArgs> MethodInvocationComplete;
 
-        public MethodRunnerQueue(JavascriptObjectRepository repository)
+        public MethodRunnerQueue(IJavascriptObjectRepositoryInternal repository)
         {
             this.repository = repository;
         }

CefSharp/Internals/Wcf/BrowserProcessService.cs

@@ -9,7 +9,7 @@ namespace CefSharp.Internals.Wcf
     [ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession, ConcurrencyMode = ConcurrencyMode.Multiple)]
     internal class BrowserProcessService : IBrowserProcess
     {
-        private readonly JavascriptObjectRepository javascriptObjectRepository;
+        private readonly IJavascriptObjectRepositoryInternal javascriptObjectRepository;
         private readonly BrowserProcessServiceHost host;
 
         public BrowserProcessService()