Expose DevTools as a target (#2321)

kblok · web-flow · commit 06ce60a9f361 · 2023-09-20T23:30:14.000Z
* Expose DevTools as a target

* hide some methods

* add missing doc

* DevToolsTarget is a PageTarget

* fix constructor

* Ignore on windows
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)
         {
         }
 

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace PuppeteerSharp.Tests.HeadfulTests`
`13`	`13`	`public class HeadfulTests : PuppeteerBaseTest`
`14`	`14`	`{`
`15`	`15`	`private readonly LaunchOptions _forcedOopifOptions;`
`16`		`-`
	`16`	`+`
`17`	`17`	`public HeadfulTests(): base()`
`18`	`18`	`{`
`19`	`19`	`_forcedOopifOptions = TestConstants.DefaultBrowserOptions();`
`@@ -218,5 +218,23 @@ await Task.WhenAll(`
`218`	`218`	`browser.WaitForTargetAsync(target => target.Url.Contains("devtools://")));`
`219`	`219`	`}`
`220`	`220`	`}`
	`221`	`+`
	`222`	`+ [PuppeteerTest("headful.spec.ts", "HEADFUL", "should expose DevTools as a page")]`
	`223`	`+ [Skip(SkipAttribute.Targets.Firefox, SkipAttribute.Targets.Windows)]`
	`224`	`+ public async Task ShouldExposeDevToolsAsAPage()`
	`225`	`+ {`
	`226`	`+ var headfulOptions = TestConstants.DefaultBrowserOptions();`
	`227`	`+ headfulOptions.Devtools = true;`
	`228`	`+ await using var browser = await Puppeteer.LaunchAsync(headfulOptions);`
	`229`	`+ var context = await browser.CreateIncognitoBrowserContextAsync();`
	`230`	`+ var targetTask = browser.WaitForTargetAsync(target => target.Url.Contains("devtools://"));`
	`231`	`+ await Task.WhenAll(`
	`232`	`+ context.NewPageAsync(),`
	`233`	`+ targetTask);`
	`234`	`+`
	`235`	`+ var target = await targetTask;`
	`236`	`+ var page = await target.PageAsync();`
	`237`	`+ Assert.True(await page.EvaluateExpressionAsync<bool>("Boolean(DevToolsAPI)"));`
	`238`	`+ }`
`221`	`239`	`}`
`222`	`240`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,12 @@`
`3`	`3`
`4`	`4`	`namespace PuppeteerSharp`
`5`	`5`	`{`
`6`		`- internal class OtherTarget : Target`
	`6`	`+ /// <summary>`
	`7`	`+ /// Other target.`
	`8`	`+ /// </summary>`
	`9`	`+ public class OtherTarget : Target`
`7`	`10`	`{`
`8`		`- public OtherTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> createSession) : base(targetInfo, session, context, targetManager, createSession)`
	`11`	`+ internal OtherTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> createSession) : base(targetInfo, session, context, targetManager, createSession)`
`9`	`12`	`{`
`10`	`13`	`}`
`11`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,16 @@`
`4`	`4`
`5`	`5`	`namespace PuppeteerSharp`
`6`	`6`	`{`
`7`		`- internal class PageTarget : Target`
	`7`	`+ /// <summary>`
	`8`	`+ /// Page target.`
	`9`	`+ /// </summary>`
	`10`	`+ public class PageTarget : Target`
`8`	`11`	`{`
`9`	`12`	`private readonly bool _ignoreHTTPSErrors;`
`10`	`13`	`private readonly ViewPortOptions _defaultViewport;`
`11`	`14`	`private readonly TaskQueue _screenshotTaskQueue;`
`12`	`15`
`13`		`- public PageTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory, bool ignoreHTTPSErrors, ViewPortOptions defaultViewport, TaskQueue screenshotTaskQueue)`
	`16`	`+ internal PageTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory, bool ignoreHTTPSErrors, ViewPortOptions defaultViewport, TaskQueue screenshotTaskQueue)`
`14`	`17`	`: base(targetInfo, session, context, targetManager, sessionFactory)`
`15`	`18`	`{`
`16`	`19`	`_ignoreHTTPSErrors = ignoreHTTPSErrors;`
`@@ -71,7 +74,8 @@ internal override void Initialize()`
`71`	`74`	`CheckIfInitialized();`
`72`	`75`	`}`
`73`	`76`
`74`		`- protected override void CheckIfInitialized()`
	`77`	`+ /// <inheritdoc/>`
	`78`	`+ protected internal override void CheckIfInitialized()`
`75`	`79`	`{`
`76`	`80`	`if (IsInitialized)`
`77`	`81`	`{`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@ internal virtual void Initialize()`
`94`	`94`	`/// <summary>`
`95`	`95`	`/// Check is the target is not initialized.`
`96`	`96`	`/// </summary>`
`97`		`- protected virtual void CheckIfInitialized()`
	`97`	`+ protected internal virtual void CheckIfInitialized()`
`98`	`98`	`{`
`99`	`99`	`IsInitialized = true;`
`100`	`100`	`InitializedTaskWrapper.TrySetResult(InitializationStatus.Success);`
Original file line number	Diff line number	Diff line change
`@@ -3,11 +3,14 @@`
`3`	`3`
`4`	`4`	`namespace PuppeteerSharp`
`5`	`5`	`{`
`6`		`- internal class WorkerTarget : Target`
	`6`	`+ /// <summary>`
	`7`	`+ /// Worker target.`
	`8`	`+ /// </summary>`
	`9`	`+ public class WorkerTarget : Target`
`7`	`10`	`{`
`8`	`11`	`private Task<Worker> _workerTask;`
`9`	`12`
`10`		`- public WorkerTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory) : base(targetInfo, session, context, targetManager, sessionFactory)`
	`13`	`+ internal WorkerTarget(TargetInfo targetInfo, CDPSession session, BrowserContext context, ITargetManager targetManager, Func<bool, Task<CDPSession>> sessionFactory) : base(targetInfo, session, context, targetManager, sessionFactory)`
`11`	`14`	`{`
`12`	`15`	`}`
`13`	`16`