Expose DevTools as a target (#2321)

* Expose DevTools as a target * hide some methods * add missing doc * DevToolsTarget is a PageTarget * fix constructor * Ignore on windows
hardkoded · Sep 20, 2023 · 06ce60a · 06ce60a
1 parent 19c75cd
commit 06ce60a
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 9 deletions.
diff --git a/lib/PuppeteerSharp.Tests/HeadfulTests/HeadfulTests.cs b/lib/PuppeteerSharp.Tests/HeadfulTests/HeadfulTests.cs
@@ -13,7 +13,7 @@ namespace PuppeteerSharp.Tests.HeadfulTests
     public class HeadfulTests : PuppeteerBaseTest
     {
         private readonly LaunchOptions _forcedOopifOptions;
-        
+
         public HeadfulTests(): base()
         {
             _forcedOopifOptions = TestConstants.DefaultBrowserOptions();
@@ -218,5 +218,23 @@ await Task.WhenAll(
                     browser.WaitForTargetAsync(target => target.Url.Contains("devtools://")));
             }
         }
+
+        [PuppeteerTest("headful.spec.ts", "HEADFUL", "should expose DevTools as a page")]
+        [Skip(SkipAttribute.Targets.Firefox, SkipAttribute.Targets.Windows)]
+        public async Task ShouldExposeDevToolsAsAPage()
+        {
+            var headfulOptions = TestConstants.DefaultBrowserOptions();
+            headfulOptions.Devtools = true;
+            await using var browser = await Puppeteer.LaunchAsync(headfulOptions);
+            var context = await browser.CreateIncognitoBrowserContextAsync();
+            var targetTask = browser.WaitForTargetAsync(target => target.Url.Contains("devtools://"));
+            await Task.WhenAll(
+                context.NewPageAsync(),
+                targetTask);
+
+            var target = await targetTask;
+            var page = await target.PageAsync();
+            Assert.True(await page.EvaluateExpressionAsync<bool>("Boolean(DevToolsAPI)"));
+        }
     }
 }
diff --git a/lib/PuppeteerSharp/Browser.cs b/lib/PuppeteerSharp/Browser.cs
@@ -482,6 +482,19 @@ private Target CreateTarget(TargetInfo targetInfo, CDPSession session)
                 TargetManager,
                 createSession);
 
+            if (targetInfo.Url?.StartsWith("devtools://", StringComparison.OrdinalIgnoreCase) == true)
+            {
+                return new DevToolsTarget(
+                    targetInfo,
+                    session,
+                    context,
+                    TargetManager,
+                    createSession,
+                    IgnoreHTTPSErrors,
+                    DefaultViewport,
+                    ScreenshotTaskQueue);
+            }
+
             if (IsPageTargetFunc(otherTarget))
             {
                 return new PageTarget(

diff --git a/lib/PuppeteerSharp/DevToolsTarget.cs b/lib/PuppeteerSharp/DevToolsTarget.cs
@@ -0,0 +1,25 @@
+using System;
+using System.Threading.Tasks;
+using PuppeteerSharp.Helpers;
+
+namespace PuppeteerSharp
+{
+    /// <summary>
+    /// DevTools target.
+    /// </summary>
+    public class DevToolsTarget : PageTarget
+    {
+        internal DevToolsTarget(
+            TargetInfo targetInfo,
+            CDPSession session,
+            BrowserContext context,
+            ITargetManager targetManager,
+            Func<bool, Task<CDPSession>> sessionFactory,
+            bool ignoreHTTPSErrors,
+            ViewPortOptions defaultViewport,
+            TaskQueue screenshotTaskQueue)
+            : base(targetInfo, session, context, targetManager, sessionFactory, ignoreHTTPSErrors, defaultViewport, screenshotTaskQueue)
+        {
+        }
+    }
+}
diff --git a/lib/PuppeteerSharp/OtherTarget.cs b/lib/PuppeteerSharp/OtherTarget.cs
@@ -3,9 +3,12 @@
 
 namespace PuppeteerSharp
 {
-    internal class OtherTarget : Target
+    /// <summary>
+    /// Other target.
+    /// </summary>
+    public class OtherTarget : Target
     {
-        public OtherTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> createSession) : base(targetInfo, session, context, targetManager, createSession)
+        internal OtherTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> createSession) : base(targetInfo, session, context, targetManager, createSession)
         {
         }
     }

diff --git a/lib/PuppeteerSharp/PageTarget.cs b/lib/PuppeteerSharp/PageTarget.cs
@@ -4,13 +4,16 @@
 
 namespace PuppeteerSharp
 {
-    internal class PageTarget : Target
+    /// <summary>
+    /// Page target.
+    /// </summary>
+    public class PageTarget : Target
     {
         private readonly bool _ignoreHTTPSErrors;
         private readonly ViewPortOptions _defaultViewport;
         private readonly TaskQueue _screenshotTaskQueue;
 
-        public PageTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory, bool ignoreHTTPSErrors, ViewPortOptions defaultViewport, TaskQueue screenshotTaskQueue)
+        internal PageTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory, bool ignoreHTTPSErrors, ViewPortOptions defaultViewport, TaskQueue screenshotTaskQueue)
             : base(targetInfo, session, context, targetManager, sessionFactory)
         {
             _ignoreHTTPSErrors = ignoreHTTPSErrors;
@@ -71,7 +74,8 @@ internal override void Initialize()
             CheckIfInitialized();
         }
 
-        protected override void CheckIfInitialized()
+        /// <inheritdoc/>
+        protected internal override void CheckIfInitialized()
         {
             if (IsInitialized)
             {

diff --git a/lib/PuppeteerSharp/Target.cs b/lib/PuppeteerSharp/Target.cs
@@ -94,7 +94,7 @@ internal virtual void Initialize()
         /// <summary>
         /// Check is the target is not initialized.
         /// </summary>
-        protected virtual void CheckIfInitialized()
+        protected internal virtual void CheckIfInitialized()
         {
             IsInitialized = true;
             InitializedTaskWrapper.TrySetResult(InitializationStatus.Success);

diff --git a/lib/PuppeteerSharp/WorkerTarget.cs b/lib/PuppeteerSharp/WorkerTarget.cs
@@ -3,11 +3,14 @@
 
 namespace PuppeteerSharp
 {
-    internal class WorkerTarget : Target
+    /// <summary>
+    /// Worker target.
+    /// </summary>
+    public class WorkerTarget : Target
     {
         private Task<Worker> _workerTask;
 
-        public WorkerTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory) : base(targetInfo, session, context, targetManager, sessionFactory)
+        internal WorkerTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory) : base(targetInfo, session, context, targetManager, sessionFactory)
         {
         }