Implement BrowserFetcher (hardkoded#342)

TheBlubb14 · Jun 26, 2018 · c65c6d8 · c65c6d8
1 parent 73cce69
commit c65c6d8
Show file tree

Hide file tree

Showing 25 changed files with 438 additions and 280 deletions.
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -19,7 +19,7 @@ E.g.
 ```csharp
 // Arrange
 var options = new LaunchOptions { /*  */ };
-var chromiumRevision = Downloader.DefaultRevision;
+var chromiumRevision = BrowserFetcher.DefaultRevision;
 var browser = await Puppeteer.LaunchAsync(options, chromiumRevision);
 var page = browser.NewPageAsync();
 

diff --git a/README.md b/README.md
@@ -25,11 +25,11 @@ Puppeteer Sharp is a .NET port of the official [Node.JS Puppeteer API](https://g
 ## Take screenshots
 
 ```cs
-await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+await Downloader.CreateDefault().DownloadAsync(chromiumRevision);
 var browser = await Puppeteer.LaunchAsync(new LaunchOptions
 {
     Headless = true
-}, chromiumRevision);
+});
 var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.ScreenshotAsync(outputFile);
@@ -50,11 +50,11 @@ await page.SetViewport(new ViewPortOptions
 ## Generate PDF files
 
 ```cs
-await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+await new BrowserFetcher().DownloadAsync(BrowserFetcher.DefaultRevision);
 var browser = await Puppeteer.LaunchAsync(new LaunchOptions
 {
     Headless = true
-}, chromiumRevision);
+});
 var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.PdfAsync(outputFile);

diff --git a/demos/PuppeteerSharpPdfDemo/Program.cs b/demos/PuppeteerSharpPdfDemo/Program.cs
@@ -16,10 +16,10 @@ public static async Task Main(string[] args)
             };
 
             Console.WriteLine("Downloading chromium");
-            await Downloader.CreateDefault().DownloadRevisionAsync(Downloader.DefaultRevision);
+            await new BrowserFetcher().DownloadAsync(BrowserFetcher.DefaultRevision);
 
             Console.WriteLine("Navigating google");
-            using (var browser = await Puppeteer.LaunchAsync(options, Downloader.DefaultRevision))
+            using (var browser = await Puppeteer.LaunchAsync(options))
             using (var page = await browser.NewPageAsync())
             {
                 await page.GoToAsync("http://www.google.com");

diff --git a/docfx_project/api/index.md b/docfx_project/api/index.md
@@ -7,11 +7,11 @@ Puppeteer Sharp is a .NET port of the official [Node.JS Puppeteer API](https://g
 ## Take screenshots
 
 ```cs
-await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+await Downloader.CreateDefault().DownloadAsync(chromiumRevision);
 var browser = await Puppeteer.LaunchAsync(new LaunchOptions
 {
     Headless = true
-}, chromiumRevision);
+});
 var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.ScreenshotAsync(outputFile);
@@ -32,11 +32,11 @@ await page.SetViewport(new ViewPortOptions
 ## Generate PDF files
 
 ```cs
-await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+await new BrowserFetcher().DownloadAsync(BrowserFetcher.DefaultRevision);
 var browser = await Puppeteer.LaunchAsync(new LaunchOptions
 {
     Headless = true
-}, chromiumRevision);
+});
 var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.PdfAsync(outputFile);

diff --git a/docfx_project/index.md b/docfx_project/index.md
@@ -7,11 +7,11 @@ Puppeteer Sharp is a .NET port of the official [Node.JS Puppeteer API](https://g
 ## Take screenshots
 
 ```cs
-await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+await Downloader.CreateDefault().DownloadAsync(chromiumRevision);
 var browser = await Puppeteer.LaunchAsync(new LaunchOptions
 {
     Headless = true
-}, chromiumRevision);
+});
 var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.ScreenshotAsync(outputFile);
@@ -32,11 +32,11 @@ await page.SetViewport(new ViewPortOptions
 ## Generate PDF files
 
 ```cs
-await Downloader.CreateDefault().DownloadRevisionAsync(chromiumRevision);
+await new BrowserFetcher().DownloadAsync(BrowserFetcher.DefaultRevision);
 var browser = await Puppeteer.LaunchAsync(new LaunchOptions
 {
     Headless = true
-}, chromiumRevision);
+});
 var page = await browser.NewPageAsync();
 await page.GoToAsync("http://www.google.com");
 await page.PdfAsync(outputFile);

diff --git a/lib/PuppeteerSharp.TestServer/wwwroot/chromium-linux.zip b/lib/PuppeteerSharp.TestServer/wwwroot/chromium-linux.zip
diff --git a/lib/PuppeteerSharp.Tests/BrowserTests/Events/DisconnectedTests.cs b/lib/PuppeteerSharp.Tests/BrowserTests/Events/DisconnectedTests.cs
@@ -14,7 +14,7 @@ public DisconnectedTests(ITestOutputHelper output) : base(output)
         [Fact]
         public async Task ShouldEmittedWhenBrowserGetsClosedDisconnectedOrUnderlyingWebsocketGetsClosed()
         {
-            var originalBrowser = await Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions(), TestConstants.ChromiumRevision, TestConstants.LoggerFactory);
+            var originalBrowser = await Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions(), TestConstants.LoggerFactory);
             var connectOptions = new ConnectOptions { BrowserWSEndpoint = originalBrowser.WebSocketEndpoint };
             var remoteBrowser1 = await Puppeteer.ConnectAsync(connectOptions, TestConstants.LoggerFactory);
             var remoteBrowser2 = await Puppeteer.ConnectAsync(connectOptions, TestConstants.LoggerFactory);
@@ -37,4 +37,4 @@ public async Task ShouldEmittedWhenBrowserGetsClosedDisconnectedOrUnderlyingWebs
             Assert.Equal(1, disconnectedRemote2);
         }
     }
-}
+}
diff --git a/lib/PuppeteerSharp.Tests/Issues/Issue0128.cs b/lib/PuppeteerSharp.Tests/Issues/Issue0128.cs
@@ -15,8 +15,8 @@ await Assert.ThrowsAsync<ChromeProcessException>(async () =>
             {
                 var options = TestConstants.DefaultBrowserOptions();
                 options.Args = new[] { "-remote-debugging-port=-2" };
-                await Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision, TestConstants.LoggerFactory);
+                await Puppeteer.LaunchAsync(options, TestConstants.LoggerFactory);
             });
         }
     }
-}
+}
diff --git a/lib/PuppeteerSharp.Tests/PuppeteerBrowserBaseTest.cs b/lib/PuppeteerSharp.Tests/PuppeteerBrowserBaseTest.cs
@@ -24,7 +24,7 @@ public PuppeteerBrowserBaseTest(ITestOutputHelper output) : base(output)
 
         protected virtual async Task InitializeAsync()
         {
-            Browser = await Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions(), TestConstants.ChromiumRevision, TestConstants.LoggerFactory);
+            Browser = await Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions(), TestConstants.LoggerFactory);
         }
 
         protected virtual async Task DisposeAsync() => await Browser.CloseAsync();

diff --git a/lib/PuppeteerSharp.Tests/PuppeteerLoaderFixture.cs b/lib/PuppeteerSharp.Tests/PuppeteerLoaderFixture.cs
@@ -21,7 +21,7 @@ public void Dispose()
 
         private async Task SetupAsync()
         {
-            var downloaderTask = Downloader.CreateDefault().DownloadRevisionAsync(TestConstants.ChromiumRevision);
+            var downloaderTask = new BrowserFetcher().DownloadAsync(BrowserFetcher.DefaultRevision);
 
             Server = SimpleServer.Create(TestConstants.Port, TestUtils.FindParentDirectory("PuppeteerSharp.TestServer"));
             HttpsServer = SimpleServer.CreateHttps(TestConstants.HttpsPort, TestUtils.FindParentDirectory("PuppeteerSharp.TestServer"));
@@ -32,4 +32,4 @@ private async Task SetupAsync()
             await Task.WhenAll(downloaderTask, serverStart, httpsServerStart);
         }
     }
-}
+}
diff --git a/lib/PuppeteerSharp.Tests/PuppeteerTests/AppModeTests.cs b/lib/PuppeteerSharp.Tests/PuppeteerTests/AppModeTests.cs
@@ -20,7 +20,7 @@ public async Task ShouldWork()
             var options = TestConstants.DefaultBrowserOptions();
             options.AppMode = true;
 
-            using (var browser = await Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision, TestConstants.LoggerFactory))
+            using (var browser = await Puppeteer.LaunchAsync(options, TestConstants.LoggerFactory))
             using (var page = await browser.NewPageAsync())
             {
                 Assert.Equal(121, await page.EvaluateExpressionAsync<int>("11 * 11"));

diff --git a/lib/PuppeteerSharp.Tests/PuppeteerTests/BrowserFetcherTests.cs b/lib/PuppeteerSharp.Tests/PuppeteerTests/BrowserFetcherTests.cs
@@ -0,0 +1,42 @@
+using System;
+using System.IO;
+using System.Threading.Tasks;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace PuppeteerSharp.Tests.PuppeteerTests
+{
+    [Collection("PuppeteerLoaderFixture collection")]
+    public class BrowserFetcherTests : PuppeteerBaseTest
+    {
+        public BrowserFetcherTests(ITestOutputHelper output) : base(output) { }
+
+        [Fact]
+        public async Task ShouldDownloadAndExtractLinuxBinary()
+        {
+            var downloadsFolder = Path.Combine(Directory.GetCurrentDirectory(), ".test-chromium");
+            var browserFetcher = Puppeteer.CreateBrowserFetcher(new BrowserFetcherOptions
+            {
+                Platform = Platform.Linux,
+                Path = downloadsFolder,
+                Host = TestConstants.ServerUrl
+            });
+            var revisionInfo = browserFetcher.RevisionInfo(123456);
+
+            Server.SetRedirect(revisionInfo.Url.Substring(TestConstants.ServerUrl.Length), "/chromium-linux.zip");
+            Assert.False(revisionInfo.Local);
+            Assert.Equal(Platform.Linux, revisionInfo.Platform);
+            Assert.False(await browserFetcher.CanDownloadAsync(100000));
+            Assert.True(await browserFetcher.CanDownloadAsync(123456));
+
+            revisionInfo = await browserFetcher.DownloadAsync(123456);
+            Assert.True(revisionInfo.Local);
+            Assert.Equal("LINUX BINARY\n", File.ReadAllText(revisionInfo.ExecutablePath));
+            Assert.Equal(new[] { 123456 }, browserFetcher.LocalRevisions());
+            browserFetcher.Remove(123456);
+            Assert.Empty(browserFetcher.LocalRevisions());
+
+            new DirectoryInfo(downloadsFolder).Delete(true);
+        }
+    }
+}
diff --git a/lib/PuppeteerSharp.Tests/PuppeteerTests/DownloaderTests.cs b/lib/PuppeteerSharp.Tests/PuppeteerTests/DownloaderTests.cs