[Breaking] Replace WebClient with HttpClient (#2615)

kblok · actions-user · jnyrup · web-flow · commit 28134c7e0b72 · 2024-04-27T15:18:06.000-03:00
* [Breaking] Replace WebClient with HttpClient

* fix tests and bump

* Docs changes

* Fix demo project

* Update lib/PuppeteerSharp/BrowserFetcher.cs

Co-authored-by: Jonas Nyrup &lt;jnyrup@users.noreply.github.com&gt;

---------

Co-authored-by: GitHub Action &lt;action@github.com&gt;
Co-authored-by: Jonas Nyrup &lt;jnyrup@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ See [this document](https://github.com/hardkoded/puppeteer-sharp/blob/master/CON
 <!-- snippet: ScreenshotAsync -->
 <a id='snippet-ScreenshotAsync'></a>
 ```cs
-using var browserFetcher = new BrowserFetcher();
+var browserFetcher = new BrowserFetcher();
 await browserFetcher.DownloadAsync();
 await using var browser = await Puppeteer.LaunchAsync(
     new LaunchOptions { Headless = true });
@@ -82,7 +82,7 @@ await Page.SetViewportAsync(new ViewPortOptions
 <!-- snippet: PdfAsync -->
 <a id='snippet-PdfAsync'></a>
 ```cs
-using var browserFetcher = new BrowserFetcher();
+var browserFetcher = new BrowserFetcher();
 await browserFetcher.DownloadAsync();
 await using var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true });
 await using var page = await browser.NewPageAsync();
diff --git a/demos/PuppeteerSharpPdfDemo/Program.cs b/demos/PuppeteerSharpPdfDemo/Program.cs
@@ -14,7 +14,7 @@ public static async Task Main(string[] args)
 
             Console.WriteLine("Downloading chromium");
 
-            using var browserFetcher = new BrowserFetcher();
+            var browserFetcher = new BrowserFetcher();
             await browserFetcher.DownloadAsync();
 
             Console.WriteLine("Navigating google");
diff --git a/docfx_project/examples/DownloadFetcher.Download.md b/docfx_project/examples/DownloadFetcher.Download.md
@@ -18,7 +18,7 @@ Once you have the version you want, you can download it using the `BrowserFetche
 ```cs
 Console.WriteLine("Downloading browsers");
 
-using var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
+var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
 var chrome118 = await browserFetcher.DownloadAsync("118.0.5993.70");
 var chrome119 = await browserFetcher.DownloadAsync("119.0.5997.0");
 
diff --git a/lib/PuppeteerSharp.Tests.SingleFileDeployment/Program.cs b/lib/PuppeteerSharp.Tests.SingleFileDeployment/Program.cs
@@ -1,7 +1,7 @@
 using PuppeteerSharp;
 
 Console.WriteLine($"AppDomain.BaseDirectory: {AppContext.BaseDirectory}");
-using var browserFetcher = new BrowserFetcher();
+var browserFetcher = new BrowserFetcher();
 await browserFetcher.DownloadAsync();
 await using var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true });
 await using var page = await browser.NewPageAsync();
diff --git a/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs b/lib/PuppeteerSharp.Tests/Browsers/Chrome/ChromeDataTests.cs
@@ -14,7 +14,7 @@ public async Task Usage()
             #region CustomVersionsExample
             Console.WriteLine("Downloading browsers");
 
-            using var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
+            var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
             var chrome118 = await browserFetcher.DownloadAsync("118.0.5993.70");
             var chrome119 = await browserFetcher.DownloadAsync("119.0.5997.0");
 
diff --git a/lib/PuppeteerSharp.Tests/Browsers/Chrome/CliTests.cs b/lib/PuppeteerSharp.Tests/Browsers/Chrome/CliTests.cs
@@ -25,7 +25,7 @@ public void DeleteDir()
         [Test, Retry(2), PuppeteerTest("CLI.spec", "Chrome CLI", "should download Chrome binaries")]
         public async Task ShouldDownloadChromeBinaries()
         {
-            using var fetcher = new BrowserFetcher(SupportedBrowser.Chrome)
+            var fetcher = new BrowserFetcher(SupportedBrowser.Chrome)
             {
                 CacheDir = _cacheDir,
                 Platform = Platform.Linux
diff --git a/lib/PuppeteerSharp.Tests/Browsers/Firefox/CliTests.cs b/lib/PuppeteerSharp.Tests/Browsers/Firefox/CliTests.cs
@@ -25,7 +25,7 @@ public void DeleteDir()
         [Test, Retry(2), PuppeteerTest("CLI.spec", "Chrome CLI", "should download Chrome binaries")]
         public async Task ShouldDownloadChromeBinaries()
         {
-            using var fetcher = new BrowserFetcher(SupportedBrowser.Chrome)
+            var fetcher = new BrowserFetcher(SupportedBrowser.Chrome)
             {
                 CacheDir = _cacheDir,
                 Platform = Platform.Linux
diff --git a/lib/PuppeteerSharp.Tests/FixturesTests/FixturesTests.cs b/lib/PuppeteerSharp.Tests/FixturesTests/FixturesTests.cs
@@ -15,7 +15,7 @@ public void ShouldDumpBrowserProcessStderr()
         {
             var success = false;
             var browser = TestConstants.IsChrome ? "chrome" : "firefox";
-            using var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
+            var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
             using var process = GetTestAppProcess(
                 "PuppeteerSharp.Tests.DumpIO",
                 $"\"{browserFetcher.GetInstalledBrowsers().First().GetExecutablePath()}\" \"${browser}\"");
@@ -34,7 +34,7 @@ public void ShouldDumpBrowserProcessStderr()
         public async Task ShouldCloseTheBrowserWhenTheConnectedProcessCloses()
         {
             var browserClosedTaskWrapper = new TaskCompletionSource<bool>();
-            using var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
+            var browserFetcher = new BrowserFetcher(SupportedBrowser.Chrome);
             var chromiumLauncher = new ChromeLauncher(
                 browserFetcher.GetInstalledBrowsers().First().GetExecutablePath(),
                 new LaunchOptions { Headless = true });
diff --git a/lib/PuppeteerSharp.Tests/PageTests/PdfTests.cs b/lib/PuppeteerSharp.Tests/PageTests/PdfTests.cs
@@ -22,7 +22,7 @@ public async Task Usage()
 
             #region PdfAsync
 
-            using var browserFetcher = new BrowserFetcher();
+            var browserFetcher = new BrowserFetcher();
             await browserFetcher.DownloadAsync();
             await using var browser = await Puppeteer.LaunchAsync(new LaunchOptions { Headless = true });
             await using var page = await browser.NewPageAsync();
diff --git a/lib/PuppeteerSharp.Tests/ScreenshotTests/PageScreenshotTests.cs b/lib/PuppeteerSharp.Tests/ScreenshotTests/PageScreenshotTests.cs
@@ -51,7 +51,7 @@ public async Task Usage()
                 fileInfo.Delete();
             }
             #region ScreenshotAsync
-            using var browserFetcher = new BrowserFetcher();
+            var browserFetcher = new BrowserFetcher();
             await browserFetcher.DownloadAsync();
             await using var browser = await Puppeteer.LaunchAsync(
                 new LaunchOptions { Headless = true });
diff --git a/lib/PuppeteerSharp.Tests/TestServerSetup.cs b/lib/PuppeteerSharp.Tests/TestServerSetup.cs
@@ -14,7 +14,7 @@ public class TestServerSetup
         [OneTimeSetUp]
         public async Task InitAllAsync()
         {
-            using var browserFetcher = new BrowserFetcher(TestConstants.IsChrome ? SupportedBrowser.Chrome : SupportedBrowser.Firefox);
+            var browserFetcher = new BrowserFetcher(TestConstants.IsChrome ? SupportedBrowser.Chrome : SupportedBrowser.Firefox);
             var downloaderTask = browserFetcher.DownloadAsync();
 
             Server = SimpleServer.Create(TestConstants.Port, TestUtils.FindParentDirectory("PuppeteerSharp.TestServer"));
diff --git a/lib/PuppeteerSharp/BrowserFetcher.cs b/lib/PuppeteerSharp/BrowserFetcher.cs
@@ -5,6 +5,7 @@
 using System.IO.Compression;
 using System.Linq;
 using System.Net;
+using System.Net.Http;
 using System.Runtime.InteropServices;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
@@ -16,7 +17,7 @@
 namespace PuppeteerSharp
 {
     /// <inheritdoc/>
-    public class BrowserFetcher : IBrowserFetcher
+    public sealed class BrowserFetcher : IBrowserFetcher
     {
         private const string PublishSingleFileLocalApplicationDataFolderName = "PuppeteerSharp";
 
@@ -28,17 +29,15 @@ public class BrowserFetcher : IBrowserFetcher
             [SupportedBrowser.Firefox] = Firefox.ResolveDownloadUrl,
         };
 
-        private readonly WebClient _webClient = new();
         private readonly CustomFileDownloadAction _customFileDownload;
-        private bool _isDisposed;
 
         /// <inheritdoc cref="BrowserFetcher"/>
         public BrowserFetcher()
         {
             CacheDir = GetBrowsersLocation();
             Platform = GetCurrentPlatform();
             Browser = SupportedBrowser.Chrome;
-            _customFileDownload = _webClient.DownloadFileTaskAsync;
+            _customFileDownload = DownloadFileUsingHttpClientTaskAsync;
         }
 
         /// <inheritdoc cref="BrowserFetcher"/>
@@ -57,12 +56,9 @@ public BrowserFetcher(BrowserFetcherOptions options)
             Browser = options.Browser;
             CacheDir = string.IsNullOrEmpty(options.Path) ? GetBrowsersLocation() : options.Path;
             Platform = options.Platform ?? GetCurrentPlatform();
-            _customFileDownload = options.CustomFileDownload ?? _webClient.DownloadFileTaskAsync;
+            _customFileDownload = options.CustomFileDownload ?? DownloadFileUsingHttpClientTaskAsync;
         }
 
-        /// <inheritdoc/>
-        public event DownloadProgressChangedEventHandler DownloadProgressChanged;
-
         /// <inheritdoc/>
         public string CacheDir { get; set; }
 
@@ -76,11 +72,7 @@ public BrowserFetcher(BrowserFetcherOptions options)
         public SupportedBrowser Browser { get; set; }
 
         /// <inheritdoc/>
-        public IWebProxy WebProxy
-        {
-            get => _webClient.Proxy;
-            set => _webClient.Proxy = value;
-        }
+        public IWebProxy WebProxy { get; set; }
 
         /// <inheritdoc/>
         public async Task<bool> CanDownloadAsync(string revision)
@@ -89,10 +81,16 @@ public async Task<bool> CanDownloadAsync(string revision)
             {
                 var url = GetDownloadURL(Browser, Platform, BaseUrl, revision);
 
-                var client = WebRequest.Create(url);
-                client.Proxy = _webClient.Proxy;
-                client.Method = "HEAD";
-                using var response = (HttpWebResponse)await client.GetResponseAsync().ConfigureAwait(false);
+                using var handler = new HttpClientHandler();
+                if (WebProxy != null)
+                {
+                    handler.Proxy = WebProxy;
+                    handler.UseProxy = true;
+                }
+
+                using var client = new HttpClient(handler);
+                using var requestMessage = new HttpRequestMessage(HttpMethod.Head, url);
+                using var response = await client.SendAsync(requestMessage).ConfigureAwait(false);
                 return response.StatusCode == HttpStatusCode.OK;
             }
             catch (WebException)
@@ -147,13 +145,6 @@ public string GetExecutablePath(string buildId)
                 buildId,
                 Platform).GetExecutablePath();
 
-        /// <inheritdoc/>
-        public void Dispose()
-        {
-            Dispose(true);
-            GC.SuppressFinalize(this);
-        }
-
         internal static Platform GetCurrentPlatform()
         {
             if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
@@ -198,33 +189,14 @@ internal static string GetBrowsersLocation()
                 assemblyDirectory = new FileInfo(assemblyLocation).Directory;
             }
 
-            if (!assemblyDirectory.Exists || !File.Exists(Path.Combine(assemblyDirectory.FullName, assemblyName)))
+            if (!assemblyDirectory!.Exists || !File.Exists(Path.Combine(assemblyDirectory.FullName, assemblyName)))
             {
                 assemblyDirectory = new DirectoryInfo(Directory.GetCurrentDirectory());
             }
 
             return assemblyDirectory.FullName;
         }
 
-        /// <summary>
-        /// Dispose <see cref="WebClient"/>.
-        /// </summary>
-        /// <param name="disposing">Indicates whether disposal was initiated by <see cref="Dispose()"/> operation.</param>
-        protected virtual void Dispose(bool disposing)
-        {
-            if (_isDisposed)
-            {
-                return;
-            }
-
-            if (disposing)
-            {
-                _webClient.Dispose();
-            }
-
-            _isDisposed = true;
-        }
-
         private static string GetDownloadURL(SupportedBrowser product, Platform platform, string baseUrl, string buildId)
             => _downloadsUrl[product](platform, buildId, baseUrl);
 
@@ -253,11 +225,6 @@ private async Task<InstalledBrowser> DownloadAsync(SupportedBrowser browser, str
                 downloadFolder.Create();
             }
 
-            if (DownloadProgressChanged != null)
-            {
-                _webClient.DownloadProgressChanged += DownloadProgressChanged;
-            }
-
             var outputPath = cache.GetInstallationDir(browser, Platform, buildId);
 
             if (new DirectoryInfo(outputPath).Exists)
@@ -280,7 +247,7 @@ private async Task<InstalledBrowser> DownloadAsync(SupportedBrowser browser, str
             return new InstalledBrowser(cache, browser, buildId, Platform);
         }
 
-        private Task InstallDMGAsync(string dmgPath, string folderPath)
+        private Task InstallDmgAsync(string dmgPath, string folderPath)
         {
             try
             {
@@ -402,7 +369,7 @@ private async Task UnpackArchiveAsync(string archivePath, string outputPath, str
             }
             else
             {
-                await InstallDMGAsync(archivePath, outputPath).ConfigureAwait(false);
+                await InstallDmgAsync(archivePath, outputPath).ConfigureAwait(false);
             }
 
             if (GetCurrentPlatform() == Platform.Linux)
@@ -439,5 +406,24 @@ private async Task UnpackArchiveAsync(string archivePath, string outputPath, str
                 }
             }
         }
+
+        private async Task DownloadFileUsingHttpClientTaskAsync(string address, string filename)
+        {
+            using var handler = new HttpClientHandler();
+            if (WebProxy != null)
+            {
+                handler.Proxy = WebProxy;
+                handler.UseProxy = true;
+            }
+
+            using var client = new HttpClient(handler);
+
+            // Send the GET request and retrieve the response as a stream
+            using var downloadStream = await client.GetStreamAsync(address).ConfigureAwait(false);
+
+            // Write the stream to a file
+            using var fileStream = File.Create(filename);
+            await downloadStream.CopyToAsync(fileStream).ConfigureAwait(false);
+        }
     }
 }
diff --git a/lib/PuppeteerSharp/IBrowserFetcher.cs b/lib/PuppeteerSharp/IBrowserFetcher.cs
@@ -1,4 +1,3 @@
-using System;
 using System.Collections.Generic;
 using System.Net;
 using System.Threading.Tasks;
@@ -14,16 +13,11 @@ namespace PuppeteerSharp
     /// <code>
     /// var browserFetcher = Puppeteer.CreateBrowserFetcher();
     /// var revisionInfo = await browserFetcher.DownloadAsync(BrowserData.Chrome.DefaultBuildId);
-    /// var browser = await await Puppeteer.LaunchAsync(new LaunchOptions { ExecutablePath = revisionInfo.ExecutablePath});
+    /// var browser = await Puppeteer.LaunchAsync(new LaunchOptions { ExecutablePath = revisionInfo.ExecutablePath});
     /// </code>
     /// </example>
-    public interface IBrowserFetcher : IDisposable
+    public interface IBrowserFetcher
     {
-        /// <summary>
-        /// Occurs when download progress in <see cref="DownloadAsync()"/>/<see cref="DownloadAsync(string)"/> changes.
-        /// </summary>
-        event DownloadProgressChangedEventHandler DownloadProgressChanged;
-
         /// <summary>
         /// A download host to be used.
         /// </summary>
@@ -45,7 +39,7 @@ public interface IBrowserFetcher : IDisposable
         SupportedBrowser Browser { get; set; }
 
         /// <summary>
-        /// Proxy used by the WebClient in <see cref="DownloadAsync()"/>, <see cref="DownloadAsync(string)"/> and <see cref="CanDownloadAsync"/>.
+        /// Proxy used by the HttpClient in <see cref="DownloadAsync()"/>, <see cref="DownloadAsync(string)"/> and <see cref="CanDownloadAsync"/>.
         /// </summary>
         IWebProxy WebProxy { get; set; }
 
diff --git a/lib/PuppeteerSharp/PuppeteerSharp.csproj b/lib/PuppeteerSharp/PuppeteerSharp.csproj
@@ -12,10 +12,10 @@
     <Description>Headless Browser .NET API</Description>
     <PackageId>PuppeteerSharp</PackageId>
     <PackageReleaseNotes></PackageReleaseNotes>
-    <PackageVersion>17.0.0</PackageVersion>
-    <ReleaseVersion>17.0.0</ReleaseVersion>
-    <AssemblyVersion>17.0.0</AssemblyVersion>
-    <FileVersion>17.0.0</FileVersion>
+    <PackageVersion>18.0.0</PackageVersion>
+    <ReleaseVersion>18.0.0</ReleaseVersion>
+    <AssemblyVersion>18.0.0</AssemblyVersion>
+    <FileVersion>18.0.0</FileVersion>
     <SynchReleaseVersion>false</SynchReleaseVersion>
     <StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>
     <DebugType>embedded</DebugType>

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public void DeleteDir()`
`25`	`25`	`[Test, Retry(2), PuppeteerTest("CLI.spec", "Chrome CLI", "should download Chrome binaries")]`
`26`	`26`	`public async Task ShouldDownloadChromeBinaries()`
`27`	`27`	`{`
`28`		`- using var fetcher = new BrowserFetcher(SupportedBrowser.Chrome)`
	`28`	`+ var fetcher = new BrowserFetcher(SupportedBrowser.Chrome)`
`29`	`29`	`{`
`30`	`30`	`CacheDir = _cacheDir,`
`31`	`31`	`Platform = Platform.Linux`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public async Task Usage()`
`51`	`51`	`fileInfo.Delete();`
`52`	`52`	`}`
`53`	`53`	`#region ScreenshotAsync`
`54`		`- using var browserFetcher = new BrowserFetcher();`
	`54`	`+ var browserFetcher = new BrowserFetcher();`
`55`	`55`	`await browserFetcher.DownloadAsync();`
`56`	`56`	`await using var browser = await Puppeteer.LaunchAsync(`
`57`	`57`	`new LaunchOptions { Headless = true });`