Devtools Client - Extract IDevToolsClient interface for testability

Improve xml doc comments

Author: amaitland

CefSharp.Test/DevTools/DevToolsClientFacts.cs

@@ -65,5 +65,28 @@ public async Task CanGetDevToolsProtocolVersion()
                 }
             }
         }
+
+        [Fact]
+        public async Task CanGetDevToolsProtocolGetWindowForTarget()
+        {
+            using (var browser = new ChromiumWebBrowser("www.google.com"))
+            {
+                await browser.LoadPageAsync();
+
+                using (var devToolsClient = browser.GetDevToolsClient())
+                {
+                    var response = await devToolsClient.Browser.GetWindowForTargetAsync();
+                    var windowId = response.WindowId;
+                    var bounds = response.Bounds;
+
+                    Assert.NotEqual(0, windowId);
+                    Assert.NotNull(bounds);
+                    Assert.True(bounds.Height > 0);
+                    Assert.True(bounds.Width > 0);
+                    Assert.True(bounds.WindowState.HasValue);
+                }
+            }
+        }
+
     }
 }

CefSharp/CefSharp.csproj

@@ -330,6 +330,7 @@
     <Compile Include="DevTools\HeapProfiler\SamplingHeapProfileNode.cs" />
     <Compile Include="DevTools\HeapProfiler\SamplingHeapProfileSample.cs" />
     <Compile Include="DevTools\HeapProfiler\StopSamplingResponse.cs" />
+    <Compile Include="DevTools\IDevToolsClient.cs" />
     <Compile Include="DevTools\IndexedDB\DatabaseWithObjectStores.cs" />
     <Compile Include="DevTools\IndexedDB\DataEntry.cs" />
     <Compile Include="DevTools\IndexedDB\GetMetadataResponse.cs" />

CefSharp/DevTools/Accessibility/Accessibility.cs

@@ -10,12 +10,12 @@ namespace CefSharp.DevTools.Accessibility
     /// </summary>
     public partial class Accessibility : DevToolsDomainBase
     {
-        public Accessibility(CefSharp.DevTools.DevToolsClient client)
+        public Accessibility(CefSharp.DevTools.IDevToolsClient client)
         {
             _client = (client);
         }
 
-        private CefSharp.DevTools.DevToolsClient _client;
+        private CefSharp.DevTools.IDevToolsClient _client;
         /// <summary>
         /// Disables the accessibility domain.
         /// </summary>
@@ -28,6 +28,8 @@ public async System.Threading.Tasks.Task<DevToolsMethodResponse> DisableAsync()
 
         /// <summary>
         /// Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls.
+        /// This turns on accessibility for the page, which can impact performance until accessibility is disabled.
+        /// </summary>
         public async System.Threading.Tasks.Task<DevToolsMethodResponse> EnableAsync()
         {
             System.Collections.Generic.Dictionary<string, object> dict = null;

CefSharp/DevTools/Accessibility/Enums/AXPropertyName.cs

@@ -5,6 +5,12 @@ namespace CefSharp.DevTools.Accessibility
 {
     /// <summary>
     /// Values of AXProperty name:
+    /// - from 'busy' to 'roledescription': states which apply to every AX node
+    /// - from 'live' to 'root': attributes which apply to nodes in live regions
+    /// - from 'autocomplete' to 'valuetext': attributes which apply to widgets
+    /// - from 'checked' to 'selected': states which apply to widgets
+    /// - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
+    /// </summary>
     public enum AXPropertyName
     {
         /// <summary>

CefSharp/DevTools/Accessibility/GetPartialAXTreeResponse.cs

@@ -17,7 +17,8 @@ internal System.Collections.Generic.IList<CefSharp.DevTools.Accessibility.AXNode
         }
 
         /// <summary>
-        /// The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and
+        /// nodes
+        /// </summary>
         public System.Collections.Generic.IList<CefSharp.DevTools.Accessibility.AXNode> Nodes
         {
             get

CefSharp/DevTools/Animation/Animation.cs

@@ -10,12 +10,12 @@ namespace CefSharp.DevTools.Animation
     /// </summary>
     public partial class Animation : DevToolsDomainBase
     {
-        public Animation(CefSharp.DevTools.DevToolsClient client)
+        public Animation(CefSharp.DevTools.IDevToolsClient client)
         {
             _client = (client);
         }
 
-        private CefSharp.DevTools.DevToolsClient _client;
+        private CefSharp.DevTools.IDevToolsClient _client;
         /// <summary>
         /// Disables animation domain notifications.
         /// </summary>

CefSharp/DevTools/Animation/GetCurrentTimeResponse.cs

@@ -17,7 +17,7 @@ internal long currentTime
         }
 
         /// <summary>
-        /// Current time of the page.
+        /// currentTime
         /// </summary>
         public long CurrentTime
         {

CefSharp/DevTools/Animation/GetPlaybackRateResponse.cs

@@ -17,7 +17,7 @@ internal long playbackRate
         }
 
         /// <summary>
-        /// Playback rate for animations on page.
+        /// playbackRate
         /// </summary>
         public long PlaybackRate
         {

CefSharp/DevTools/Animation/ResolveAnimationResponse.cs

@@ -17,7 +17,7 @@ internal CefSharp.DevTools.Runtime.RemoteObject remoteObject
         }
 
         /// <summary>
-        /// Corresponding remote object.
+        /// remoteObject
         /// </summary>
         public CefSharp.DevTools.Runtime.RemoteObject RemoteObject
         {

CefSharp/DevTools/ApplicationCache/ApplicationCache.cs

@@ -10,12 +10,12 @@ namespace CefSharp.DevTools.ApplicationCache
     /// </summary>
     public partial class ApplicationCache : DevToolsDomainBase
     {
-        public ApplicationCache(CefSharp.DevTools.DevToolsClient client)
+        public ApplicationCache(CefSharp.DevTools.IDevToolsClient client)
         {
             _client = (client);
         }
 
-        private CefSharp.DevTools.DevToolsClient _client;
+        private CefSharp.DevTools.IDevToolsClient _client;
         /// <summary>
         /// Enables application cache domain notifications.
         /// </summary>
@@ -39,6 +39,8 @@ public async System.Threading.Tasks.Task<GetApplicationCacheForFrameResponse> Ge
 
         /// <summary>
         /// Returns array of frame identifiers with manifest urls for each frame containing a document
+        /// associated with some application cache.
+        /// </summary>
         public async System.Threading.Tasks.Task<GetFramesWithManifestsResponse> GetFramesWithManifestsAsync()
         {
             System.Collections.Generic.Dictionary<string, object> dict = null;

CefSharp/DevTools/ApplicationCache/GetApplicationCacheForFrameResponse.cs

@@ -17,7 +17,7 @@ internal CefSharp.DevTools.ApplicationCache.ApplicationCache applicationCache
         }
 
         /// <summary>
-        /// Relevant application cache data for the document in given frame.
+        /// applicationCache
         /// </summary>
         public CefSharp.DevTools.ApplicationCache.ApplicationCache ApplicationCache
         {

CefSharp/DevTools/ApplicationCache/GetFramesWithManifestsResponse.cs

@@ -17,7 +17,8 @@ internal System.Collections.Generic.IList<CefSharp.DevTools.ApplicationCache.Fra
         }
 
         /// <summary>
-        /// Array of frame identifiers with manifest urls for each frame containing a document
+        /// frameIds
+        /// </summary>
         public System.Collections.Generic.IList<CefSharp.DevTools.ApplicationCache.FrameWithManifest> FrameIds
         {
             get

CefSharp/DevTools/ApplicationCache/GetManifestForFrameResponse.cs

@@ -17,7 +17,7 @@ internal string manifestURL
         }
 
         /// <summary>
-        /// Manifest URL for document in the given frame.
+        /// manifestURL
         /// </summary>
         public string ManifestURL
         {

CefSharp/DevTools/Audits/Audits.cs

@@ -10,14 +10,16 @@ namespace CefSharp.DevTools.Audits
     /// </summary>
     public partial class Audits : DevToolsDomainBase
     {
-        public Audits(CefSharp.DevTools.DevToolsClient client)
+        public Audits(CefSharp.DevTools.IDevToolsClient client)
         {
             _client = (client);
         }
 
-        private CefSharp.DevTools.DevToolsClient _client;
+        private CefSharp.DevTools.IDevToolsClient _client;
         /// <summary>
         /// Returns the response body and size if it were re-encoded with the specified settings. Only
+        /// applies to images.
+        /// </summary>
         public async System.Threading.Tasks.Task<GetEncodedResponseResponse> GetEncodedResponseAsync(string requestId, string encoding, long? quality = null, bool? sizeOnly = null)
         {
             var dict = new System.Collections.Generic.Dictionary<string, object>();
@@ -49,6 +51,8 @@ public async System.Threading.Tasks.Task<DevToolsMethodResponse> DisableAsync()
 
         /// <summary>
         /// Enables issues domain, sends the issues collected so far to the client by means of the
+        /// `issueAdded` event.
+        /// </summary>
         public async System.Threading.Tasks.Task<DevToolsMethodResponse> EnableAsync()
         {
             System.Collections.Generic.Dictionary<string, object> dict = null;

CefSharp/DevTools/Audits/Enums/InspectorIssueCode.cs

@@ -5,6 +5,9 @@ namespace CefSharp.DevTools.Audits
 {
     /// <summary>
     /// A unique identifier for the type of issue. Each type may use one of the
+    /// optional fields in InspectorIssueDetails to convey more specific
+    /// information about the kind of issue.
+    /// </summary>
     public enum InspectorIssueCode
     {
         /// <summary>

CefSharp/DevTools/Audits/GetEncodedResponseResponse.cs

@@ -17,7 +17,7 @@ internal string body
         }
 
         /// <summary>
-        /// The encoded body as a base64 string. Omitted if sizeOnly is true.
+        /// body
         /// </summary>
         public byte[] Body
         {
@@ -35,7 +35,7 @@ internal int originalSize
         }
 
         /// <summary>
-        /// Size before re-encoding.
+        /// originalSize
         /// </summary>
         public int OriginalSize
         {
@@ -53,7 +53,7 @@ internal int encodedSize
         }
 
         /// <summary>
-        /// Size after re-encoding.
+        /// encodedSize
         /// </summary>
         public int EncodedSize
         {

CefSharp/DevTools/Audits/InspectorIssueDetails.cs

@@ -5,6 +5,9 @@ namespace CefSharp.DevTools.Audits
 {
     /// <summary>
     /// This struct holds a list of optional fields with additional information
+    /// specific to the kind of issue. When adding a new issue code, please also
+    /// add a new optional field to this type.
+    /// </summary>
     public class InspectorIssueDetails : CefSharp.DevTools.DevToolsDomainEntityBase
     {
         /// <summary>

CefSharp/DevTools/Audits/MixedContentIssueDetails.cs

@@ -10,6 +10,10 @@ public class MixedContentIssueDetails : CefSharp.DevTools.DevToolsDomainEntityBa
     {
         /// <summary>
         /// The type of resource causing the mixed content issue (css, js, iframe,
+        /// form,...). Marked as optional because it is mapped to from
+        /// blink::mojom::RequestContextType, which will be replaced
+        /// by network::mojom::RequestDestination
+        /// </summary>
         [System.Runtime.Serialization.DataMemberAttribute(Name = ("resourceType"), IsRequired = (false))]
         public CefSharp.DevTools.Audits.MixedContentResourceType? ResourceType
         {
@@ -49,6 +53,8 @@ public string MainResourceURL
 
         /// <summary>
         /// The mixed content request.
+        /// Does not always exist (e.g. for unsafe form submission urls).
+        /// </summary>
         [System.Runtime.Serialization.DataMemberAttribute(Name = ("request"), IsRequired = (false))]
         public CefSharp.DevTools.Audits.AffectedRequest Request
         {

CefSharp/DevTools/Audits/SameSiteCookieIssueDetails.cs

@@ -5,6 +5,9 @@ namespace CefSharp.DevTools.Audits
 {
     /// <summary>
     /// This information is currently necessary, as the front-end has a difficult
+    /// time finding a specific cookie. With this, we can convey specific error
+    /// information without the cookie.
+    /// </summary>
     public class SameSiteCookieIssueDetails : CefSharp.DevTools.DevToolsDomainEntityBase
     {
         /// <summary>
@@ -39,6 +42,8 @@ public CefSharp.DevTools.Audits.SameSiteCookieExclusionReason[] CookieExclusionR
 
         /// <summary>
         /// Optionally identifies the site-for-cookies and the cookie url, which
+        /// may be used by the front-end as additional context.
+        /// </summary>
         [System.Runtime.Serialization.DataMemberAttribute(Name = ("operation"), IsRequired = (true))]
         public CefSharp.DevTools.Audits.SameSiteCookieOperation Operation
         {

CefSharp/DevTools/BackgroundService/BackgroundService.cs

@@ -10,12 +10,12 @@ namespace CefSharp.DevTools.BackgroundService
     /// </summary>
     public partial class BackgroundService : DevToolsDomainBase
     {
-        public BackgroundService(CefSharp.DevTools.DevToolsClient client)
+        public BackgroundService(CefSharp.DevTools.IDevToolsClient client)
         {
             _client = (client);
         }
 
-        private CefSharp.DevTools.DevToolsClient _client;
+        private CefSharp.DevTools.IDevToolsClient _client;
         /// <summary>
         /// Enables event updates for the service.
         /// </summary>

CefSharp/DevTools/BackgroundService/Enums/ServiceName.cs

@@ -5,6 +5,9 @@ namespace CefSharp.DevTools.BackgroundService
 {
     /// <summary>
     /// The Background Service that will be associated with the commands/events.
+    /// Every Background Service operates independently, but they share the same
+    /// API.
+    /// </summary>
     public enum ServiceName
     {
         /// <summary>

CefSharp/DevTools/Browser/Browser.cs

@@ -10,12 +10,12 @@ namespace CefSharp.DevTools.Browser
     /// </summary>
     public partial class Browser : DevToolsDomainBase
     {
-        public Browser(CefSharp.DevTools.DevToolsClient client)
+        public Browser(CefSharp.DevTools.IDevToolsClient client)
         {
             _client = (client);
         }
 
-        private CefSharp.DevTools.DevToolsClient _client;
+        private CefSharp.DevTools.IDevToolsClient _client;
         /// <summary>
         /// Set permission settings for given origin.
         /// </summary>
@@ -137,6 +137,8 @@ public async System.Threading.Tasks.Task<GetVersionResponse> GetVersionAsync()
 
         /// <summary>
         /// Returns the command line switches for the browser process if, and only if
+        /// --enable-automation is on the commandline.
+        /// </summary>
         public async System.Threading.Tasks.Task<GetBrowserCommandLineResponse> GetBrowserCommandLineAsync()
         {
             System.Collections.Generic.Dictionary<string, object> dict = null;

CefSharp/DevTools/Browser/GetBrowserCommandLineResponse.cs

@@ -17,7 +17,7 @@ internal string[] arguments
         }
 
         /// <summary>
-        /// Commandline parameters
+        /// arguments
         /// </summary>
         public string[] Arguments
         {

CefSharp/DevTools/Browser/GetHistogramResponse.cs

@@ -17,7 +17,7 @@ internal CefSharp.DevTools.Browser.Histogram histogram
         }
 
         /// <summary>
-        /// Histogram.
+        /// histogram
         /// </summary>
         public CefSharp.DevTools.Browser.Histogram Histogram
         {

CefSharp/DevTools/Browser/GetHistogramsResponse.cs

@@ -17,7 +17,7 @@ internal System.Collections.Generic.IList<CefSharp.DevTools.Browser.Histogram> h
         }
 
         /// <summary>
-        /// Histograms.
+        /// histograms
         /// </summary>
         public System.Collections.Generic.IList<CefSharp.DevTools.Browser.Histogram> Histograms
         {