Merge branch 'v20' of https://github.com/hardkoded/puppeteer-sharp in…

…to v20
hardkoded · Sep 3, 2024 · 8be0e19 · 8be0e19
2 parents c2696fb + b0f91e2
commit 8be0e19
Show file tree

Hide file tree

Showing 31 changed files with 142 additions and 96 deletions.
diff --git a/.github/workflows/on-push-do-docs.yml b/.github/workflows/on-push-do-docs.yml
@@ -3,9 +3,13 @@ on:
   push:
 jobs:
   docs:
-    runs-on: windows-latest
+    runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 7.0.x
     - name: Run MarkdownSnippets
       run: |
         dotnet tool install --global MarkdownSnippets.Tool

diff --git a/README.md b/README.md
@@ -49,8 +49,8 @@ See [this document](https://github.com/hardkoded/puppeteer-sharp/blob/master/CON
 
 ## Take screenshots
 
-<!-- snippet: ScreenshotAsync -->
-<a id='snippet-ScreenshotAsync'></a>
+<!-- snippet: screenshotasync_example -->
+<a id='snippet-screenshotasync_example'></a>
 ```cs
 var browserFetcher = new BrowserFetcher();
 await browserFetcher.DownloadAsync();
@@ -60,27 +60,27 @@ await using var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.ScreenshotAsync(outputFile);
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/ScreenshotTests/PageScreenshotTests.cs#L54-L62' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScreenshotAsync' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/ScreenshotTests/PageScreenshotTests.cs#L54-L62' title='Snippet source file'>snippet source</a> | <a href='#snippet-screenshotasync_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 You can also change the view port before generating the screenshot
 
-<!-- snippet: SetViewportAsync -->
-<a id='snippet-SetViewportAsync'></a>
+<!-- snippet: setviewportasync_example -->
+<a id='snippet-setviewportasync_example'></a>
 ```cs
 await Page.SetViewportAsync(new ViewPortOptions
 {
     Width = 500,
     Height = 500
 });
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/ScreenshotTests/ElementHandleScreenshotTests.cs#L13-L19' title='Snippet source file'>snippet source</a> | <a href='#snippet-SetViewportAsync' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/ScreenshotTests/ElementHandleScreenshotTests.cs#L13-L19' title='Snippet source file'>snippet source</a> | <a href='#snippet-setviewportasync_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ### Generate PDF files
 
-<!-- snippet: PdfAsync -->
-<a id='snippet-PdfAsync'></a>
+<!-- snippet: pdfasync_example -->
+<a id='snippet-pdfasync_example'></a>
 ```cs
 var browserFetcher = new BrowserFetcher();
 await browserFetcher.DownloadAsync();
@@ -90,32 +90,32 @@ await page.GoToAsync("http://www.google.com"); // In case of fonts being loaded
 await page.EvaluateExpressionHandleAsync("document.fonts.ready"); // Wait for fonts to be loaded. Omitting this might result in no text rendered in pdf.
 await page.PdfAsync(outputFile);
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/PageTests/PdfTests.cs#L23-L33' title='Snippet source file'>snippet source</a> | <a href='#snippet-PdfAsync' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/PageTests/PdfTests.cs#L23-L33' title='Snippet source file'>snippet source</a> | <a href='#snippet-pdfasync_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ### Inject HTML
 
-<!-- snippet: SetContentAsync -->
-<a id='snippet-SetContentAsync'></a>
+<!-- snippet: setcontentasync_example -->
+<a id='snippet-setcontentasync_example'></a>
 ```cs
 await using var page = await browser.NewPageAsync();
 await page.SetContentAsync("<div>My Receipt</div>");
 var result = await page.GetContentAsync();
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/PageTests/SetContentTests.cs#L14-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-SetContentAsync' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/PageTests/SetContentTests.cs#L14-L20' title='Snippet source file'>snippet source</a> | <a href='#snippet-setcontentasync_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ### Evaluate Javascript
 
-<!-- snippet: Evaluate -->
-<a id='snippet-Evaluate'></a>
+<!-- snippet: evaluate_example -->
+<a id='snippet-evaluate_example'></a>
 ```cs
 await using var page = await browser.NewPageAsync();
 var seven = await page.EvaluateExpressionAsync<int>("4 + 3");
 var someObject = await page.EvaluateFunctionAsync<JsonElement>("(value) => ({a: value})", 5);
 Console.WriteLine(someObject.GetProperty("a").GetString());
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/QuerySelectorTests/ElementHandleQuerySelectorEvalTests.cs#L17-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-Evaluate' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/QuerySelectorTests/ElementHandleQuerySelectorEvalTests.cs#L17-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-evaluate_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 ### Wait For Selector

diff --git a/docfx_project/docs/DownloadFetcher.Download.md b/docfx_project/docs/DownloadFetcher.Download.md
@@ -13,8 +13,8 @@ You will find the available versions [here](https://googlechromelabs.github.io/c
 Once you have the version you want, you can download it using the `BrowserFetcher` class.
 
 ```cs
-<!-- snippet: CustomVersionsExample -->
-<a id='snippet-CustomVersionsExample'></a>
+<!-- snippet: customversions_example -->
+<a id='snippet-customversions_example'></a>
 ```cs
 Console.WriteLine("Downloading browsers");
 
@@ -51,6 +51,6 @@ await using (var browser = await Puppeteer.LaunchAsync(new()
     Console.WriteLine("Export completed");
 }
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs#L24-L59' title='Snippet source file'>snippet source</a> | <a href='#snippet-CustomVersionsExample' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs#L24-L59' title='Snippet source file'>snippet source</a> | <a href='#snippet-customversions_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 ```
diff --git a/docfx_project/docs/ReuseChrome.md b/docfx_project/docs/ReuseChrome.md
@@ -11,15 +11,15 @@ from a location where it was previously downloaded instead of from the default l
 
 Use `BrowserFetcherOptions` to specify the full path for where to download Chrome.
 
-<!-- snippet: ReuseChromeExample -->
-<a id='snippet-ReuseChromeExample'></a>
+<!-- snippet: reusechrome_example -->
+<a id='snippet-reusechrome_example'></a>
 ```cs
 var downloadPath = "/Users/dario/chrome";
 var browserFetcherOptions = new BrowserFetcherOptions { Path = downloadPath };
 var browserFetcher = new BrowserFetcher(browserFetcherOptions);
 var installedBrowser = await browserFetcher.DownloadAsync();
 ```
-<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs#L14-L19' title='Snippet source file'>snippet source</a> | <a href='#snippet-ReuseChromeExample' title='Start of snippet'>anchor</a></sup>
+<sup><a href='https://github.com/hardkoded/puppeteer-sharp/blob/master/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs#L14-L19' title='Snippet source file'>snippet source</a> | <a href='#snippet-reusechrome_example' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Use `Puppeteer.LaunchAsync()` with `LaunchOptions` with the `LaunchOptions.ExecutablePath` property set to the

diff --git a/lib/PuppeteerSharp.AspNetFramework/AspNetWebSocketTransport.cs b/lib/PuppeteerSharp.AspNetFramework/AspNetWebSocketTransport.cs
@@ -9,8 +9,6 @@ namespace PuppeteerSharp.AspNetFramework
 {
     public class AspNetWebSocketTransport : WebSocketTransport
     {
-        #region Static fields
-
         /// <summary>
         /// Gets a <see cref="TransportFactory"/> that creates <see cref="AspNetWebSocketTransport"/> instances.
         /// </summary>
@@ -22,10 +20,6 @@ public class AspNetWebSocketTransport : WebSocketTransport
         /// </summary>
         public static readonly TransportTaskScheduler AspNetTransportScheduler = ScheduleBackgroundTask;
 
-        #endregion
-
-        #region Static methods
-
         private static async Task<IConnectionTransport> CreateAspNetTransport(Uri url, IConnectionOptions connectionOptions, CancellationToken cancellationToken)
         {
             var webSocketFactory = connectionOptions.WebSocketFactory ?? DefaultWebSocketFactory;
@@ -40,15 +34,9 @@ Task ExecuteAsync(CancellationToken hostingCancellationToken)
             HostingEnvironment.QueueBackgroundWorkItem(ExecuteAsync);
         }
 
-        #endregion
-
-        #region Constructor(s)
-
         /// <inheritdoc />
         public AspNetWebSocketTransport(WebSocket client, bool queueRequests)
             : base(client, AspNetTransportScheduler, queueRequests)
         { }
-
-        #endregion
     }
 }
diff --git a/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs b/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs
@@ -11,7 +11,7 @@ public class ChromeDataTests
     {
         public async Task ReuseChromeExample()
         {
-            #region ReuseChromeExample
+            #region reusechrome_example
             var downloadPath = "/Users/dario/chrome";
             var browserFetcherOptions = new BrowserFetcherOptions { Path = downloadPath };
             var browserFetcher = new BrowserFetcher(browserFetcherOptions);
@@ -21,7 +21,7 @@ public async Task ReuseChromeExample()
 
         public async Task Usage()
         {
-            #region CustomVersionsExample
+            #region customversions_example
             Console.WriteLine("Downloading browsers");
 
             var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);

diff --git a/lib/PuppeteerSharp.Tests/DeviceRequestPromptTests/WaitForDevicePromptTests.cs b/lib/PuppeteerSharp.Tests/DeviceRequestPromptTests/WaitForDevicePromptTests.cs
@@ -10,7 +10,7 @@ public class WaitForDevicePromptTests : PuppeteerPageBaseTest
     {
         public async Task Usage()
         {
-            #region DeviceRequestPromptUsage
+            #region devicerequestprompt_usage
             var promptTask = Page.WaitForDevicePromptAsync();
             await Task.WhenAll(
                 promptTask,
@@ -25,7 +25,7 @@ await devicePrompt.WaitForDeviceAsync(device => device.Name.Contains("My Device"
 
         public async Task PageUsage()
         {
-            #region IPageWaitForDevicePromptAsyncUsage
+            #region ipagewaitfordevicepromptasync_usage
             var promptTask = Page.WaitForDevicePromptAsync();
             await Task.WhenAll(
                 promptTask,
@@ -41,7 +41,7 @@ await devicePrompt.WaitForDeviceAsync(device => device.Name.Contains("My Device"
         public async Task FrameUsage()
         {
             var frame = Page.MainFrame;
-            #region IFrameWaitForDevicePromptAsyncUsage
+            #region iframewaitfordevicepromptasync_usage
             var promptTask = frame.WaitForDevicePromptAsync();
             await Task.WhenAll(
                 promptTask,