Fixed ignored custom launch parameters

stesee · web-flow · commit 6300442d461e · 2022-11-24T06:04:58.000+01:00
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -16,4 +16,5 @@
   - OS:
   - CPU Architecture:
   - .net Version:
-  - .net Trimming:
+  - .net Trimming:
+  - Linux: Output of `cat /proc/version`
diff --git a/Codeuctivity.HtmlRenderer.sln b/Codeuctivity.HtmlRenderer.sln
@@ -8,6 +8,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.editorconfig = .editorconfig
 		.github\dependabot.yml = .github\dependabot.yml
 		.github\workflows\dotnet.yml = .github\workflows\dotnet.yml
+		.github\ISSUE_TEMPLATE.md = .github\ISSUE_TEMPLATE.md
 		README.md = README.md
 	EndProjectSection
 EndProject
diff --git a/Codeuctivity.HtmlRenderer/Codeuctivity.HtmlRenderer.csproj b/Codeuctivity.HtmlRenderer/Codeuctivity.HtmlRenderer.csproj
@@ -40,7 +40,7 @@
 	<ItemGroup>
 		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="all" />
 		<PackageReference Include="PuppeteerSharp" Version="8.0.0" />
-		<PackageReference Include="SonarAnalyzer.CSharp" Version="8.48.0.56517">
+		<PackageReference Include="SonarAnalyzer.CSharp" Version="8.49.0.57237">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>
diff --git a/Codeuctivity.HtmlRenderer/Renderer.cs b/Codeuctivity.HtmlRenderer/Renderer.cs
@@ -12,13 +12,36 @@ namespace Codeuctivity.HtmlRenderer
     /// </summary>
     public class Renderer : IAsyncDisposable, IDisposable
     {
+        /// <summary>
+        /// Ctor
+        /// </summary>
+        /// <param name="customChromiumArgs"></param>
+        public Renderer(string? customChromiumArgs)
+        {
+            if (customChromiumArgs == null)
+            {
+                LaunchOptions = SystemSpecificConfig();
+            }
+            else
+            {
+                LaunchOptions = new LaunchOptions() { Args = new[] { customChromiumArgs } };
+            }
+        }
+
         /// <summary>
         /// Ctor
         /// </summary>
         /// <param name="launchOptions"></param>
-        public Renderer(string? launchOptions = null)
+        public Renderer(LaunchOptions? launchOptions = null)
         {
-            LaunchOptions = launchOptions;
+            if (launchOptions == null)
+            {
+                LaunchOptions = SystemSpecificConfig();
+            }
+            else
+            {
+                LaunchOptions = launchOptions;
+            }
         }
 
         private IBrowser Browser { get; set; } = default!;
@@ -29,7 +52,7 @@ public Renderer(string? launchOptions = null)
         /// </summary>
         public BrowserFetcher BrowserFetcher { get; private set; } = default!;
 
-        private string? LaunchOptions { get; }
+        private LaunchOptions LaunchOptions { get; }
 
         /// <summary>
         /// Call CreateAsync before using ConvertHtmlTo*
@@ -45,9 +68,20 @@ public static Task<Renderer> CreateAsync()
         /// Call CreateAsync before using ConvertHtmlTo*, accepts custom BrowserFetcher and custom chromium launch options
         /// </summary>
         /// <param name="browserFetcher"></param>
-        /// <param name="launchOptions">Adds launch options to chromium</param>
+        /// <param name="chromiumArguments">Adds custom arguments to chromium</param>
         /// <returns></returns>
-        public static Task<Renderer> CreateAsync(BrowserFetcher browserFetcher, string? launchOptions = null)
+        public static Task<Renderer> CreateAsync(BrowserFetcher browserFetcher, string chromiumArguments)
+        {
+            return CreateAsync(browserFetcher, new LaunchOptions() { Args = new[] { chromiumArguments } });
+        }
+
+        /// <summary>
+        /// Call CreateAsync before using ConvertHtmlTo*, accepts custom BrowserFetcher and custom chromium launch options
+        /// </summary>
+        /// <param name="browserFetcher"></param>
+        /// <param name="launchOptions">Adds launch options to puppeteer</param>
+        /// <returns></returns>
+        public static Task<Renderer> CreateAsync(BrowserFetcher browserFetcher, LaunchOptions? launchOptions = null)
         {
             var html2Pdf = new Renderer(launchOptions);
             return html2Pdf.InitializeAsync(browserFetcher);
@@ -59,18 +93,17 @@ private async Task<Renderer> InitializeAsync(BrowserFetcher browserFetcher)
             BrowserFetcher.DownloadProgressChanged += DownloadProgressChanged;
 
             _ = await BrowserFetcher.DownloadAsync(BrowserFetcher.DefaultChromiumRevision ?? string.Empty).ConfigureAwait(false);
-            Browser = await Puppeteer.LaunchAsync(SystemSpecificConfig()).ConfigureAwait(false);
+            Browser = await Puppeteer.LaunchAsync(LaunchOptions).ConfigureAwait(false);
             return this;
         }
 
         private LaunchOptions SystemSpecificConfig()
         {
-            if (string.IsNullOrEmpty(LaunchOptions) && (IsRunningOnWslOrAzure() || IsRunningOnAzureLinux()))
+            if (IsRunningOnWslOrAzure() || IsRunningOnAzureLinux())
             {
                 return new LaunchOptions { Headless = true, Args = new string[] { "--no-sandbox" } };
             }
-
-            return new LaunchOptions { Headless = true };
+            return new LaunchOptions();
         }
 
         private static bool IsRunningOnAzureLinux()
diff --git a/Codeuctivity.HtmlRendererCliTests/Codeuctivity.HtmlRendererCliTests.csproj b/Codeuctivity.HtmlRendererCliTests/Codeuctivity.HtmlRendererCliTests.csproj
@@ -8,7 +8,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.48.0.56517">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.49.0.57237">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/Codeuctivity.HtmlRendererCliTests/RendererCliTests.cs b/Codeuctivity.HtmlRendererCliTests/RendererCliTests.cs
@@ -56,7 +56,7 @@ public void PublishedSelfContainedBinaryShouldWork()
             };
 
             process.Start();
-            var isExited = process.WaitForExit(60000);
+            var isExited = process.WaitForExit(80000);
 
             if (!isExited)
             {
diff --git a/Codeuctivity.HtmlRendererTests/Codeuctivity.HtmlRendererTests.csproj b/Codeuctivity.HtmlRendererTests/Codeuctivity.HtmlRendererTests.csproj
@@ -18,7 +18,7 @@
   <ItemGroup>
     <PackageReference Include="Codeuctivity.ImageSharpCompare" Version="2.0.76" />
     <PackageReference Include="Codeuctivity.PdfjsSharp" Version="1.2.70" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.48.0.56517">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.49.0.57237">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
diff --git a/Codeuctivity.HtmlRendererTests/Infrastructure/ChromiumProcessDisposedAsserter.cs b/Codeuctivity.HtmlRendererTests/Infrastructure/ChromiumProcessDisposedAsserter.cs
@@ -7,7 +7,7 @@ namespace Codeuctivity.HtmlRendererTests.Infrastructure
 {
     public static class ChromiumProcessDisposedAsserter
     {
-        public static async Task AssertNoChromeProcessIsRunning()
+        public static async Task AssertNoChromiumProcessIsRunning()
         {
             for (var i = 0; i < 20 && CountChromiumTasks() > 0; i++)
             {
diff --git a/Codeuctivity.HtmlRendererTests/RendererTests.cs b/Codeuctivity.HtmlRendererTests/RendererTests.cs
@@ -1,6 +1,7 @@
 ﻿using Codeuctivity.HtmlRenderer;
 using Codeuctivity.HtmlRendererTests.Infrastructure;
 using Codeuctivity.PdfjsSharp;
+using PuppeteerSharp;
 using System;
 using System.IO;
 using System.Linq;
@@ -39,13 +40,14 @@ public async Task ShouldConvertHtmlToPdf(string testFileName)
                     Assert.Single(actualImages);
                     DocumentAsserter.AssertImageIsEqual(actualImages.Single(), expectReferenceFilePath, 2000);
                 }
+                File.Delete(actualFilePath);
             }
-            await ChromiumProcessDisposedAsserter.AssertNoChromeProcessIsRunning();
+            await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
         }
 
         private static bool IsRunningOnWslOrAzureOrMacos()
         {
-            if(RuntimeInformation.IsOSPlatform(OSPlatform.OSX) || RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD))
+            if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX) || RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD))
             {
                 return true;
             }
@@ -79,10 +81,11 @@ public async Task ShouldConvertHtmlToPng(string testFileName)
             {
                 await chromiumRenderer.ConvertHtmlToPng(sourceHtmlFilePath, actualFilePath);
 
-                DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 7200);
+                DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 9000);
             }
 
-            await ChromiumProcessDisposedAsserter.AssertNoChromeProcessIsRunning();
+            File.Delete(actualFilePath);
+            await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
         }
 
         [Fact]
@@ -97,5 +100,29 @@ public async Task ShouldDisposeGracefull()
             var afterDisposeChromiumTasks = ChromiumProcessDisposedAsserter.CountChromiumTasks();
             Assert.Equal(afterDisposeChromiumTasks, initialChromiumTasks);
         }
+
+        [Theory]
+        [InlineData("BasicTextFormated.html")]
+        public async Task ShouldConvertHtmlToPngNoSandbox(string testFileName)
+        {
+            var sourceHtmlFilePath = $"../../../TestInput/{testFileName}";
+            var actualFilePath = Path.Combine(Path.GetTempPath(), $"ActualConvertHtmlToPng{testFileName}.png");
+            var expectReferenceFilePath = $"../../../ExpectedTestOutcome/ExpectedConvertHtmlToPng{testFileName}.png";
+
+            if (File.Exists(actualFilePath))
+            {
+                File.Delete(actualFilePath);
+            }
+
+            using (var chromiumRenderer = await Renderer.CreateAsync(new BrowserFetcher(), "--no-sandbox"))
+            {
+                await chromiumRenderer.ConvertHtmlToPng(sourceHtmlFilePath, actualFilePath);
+
+                DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 9000);
+            }
+
+            File.Delete(actualFilePath);
+            await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();
+        }
     }
 }
diff --git a/README.md b/README.md
@@ -31,3 +31,9 @@ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
 exit
 nvm install 18
 ```
+
+... and if that fails you can either find out which dependency is missing on your system or you take a shortcut
+
+```bash
+sudo apt install -y chromium-browser
+```

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public void PublishedSelfContainedBinaryShouldWork()`
`56`	`56`	`};`
`57`	`57`
`58`	`58`	`process.Start();`
`59`		`- var isExited = process.WaitForExit(60000);`
	`59`	`+ var isExited = process.WaitForExit(80000);`
`60`	`60`
`61`	`61`	`if (!isExited)`
`62`	`62`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ namespace Codeuctivity.HtmlRendererTests.Infrastructure`
`7`	`7`	`{`
`8`	`8`	`public static class ChromiumProcessDisposedAsserter`
`9`	`9`	`{`
`10`		`- public static async Task AssertNoChromeProcessIsRunning()`
	`10`	`+ public static async Task AssertNoChromiumProcessIsRunning()`
`11`	`11`	`{`
`12`	`12`	`for (var i = 0; i < 20 && CountChromiumTasks() > 0; i++)`
`13`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using Codeuctivity.HtmlRenderer;`
`2`	`2`	`using Codeuctivity.HtmlRendererTests.Infrastructure;`
`3`	`3`	`using Codeuctivity.PdfjsSharp;`
	`4`	`+using PuppeteerSharp;`
`4`	`5`	`using System;`
`5`	`6`	`using System.IO;`
`6`	`7`	`using System.Linq;`
`@@ -39,13 +40,14 @@ public async Task ShouldConvertHtmlToPdf(string testFileName)`
`39`	`40`	`Assert.Single(actualImages);`
`40`	`41`	`DocumentAsserter.AssertImageIsEqual(actualImages.Single(), expectReferenceFilePath, 2000);`
`41`	`42`	`}`
	`43`	`+ File.Delete(actualFilePath);`
`42`	`44`	`}`
`43`		`- await ChromiumProcessDisposedAsserter.AssertNoChromeProcessIsRunning();`
	`45`	`+ await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();`
`44`	`46`	`}`
`45`	`47`
`46`	`48`	`private static bool IsRunningOnWslOrAzureOrMacos()`
`47`	`49`	`{`
`48`		`- if(RuntimeInformation.IsOSPlatform(OSPlatform.OSX) \|\| RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD))`
	`50`	`+ if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX) \|\| RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD))`
`49`	`51`	`{`
`50`	`52`	`return true;`
`51`	`53`	`}`
`@@ -79,10 +81,11 @@ public async Task ShouldConvertHtmlToPng(string testFileName)`
`79`	`81`	`{`
`80`	`82`	`await chromiumRenderer.ConvertHtmlToPng(sourceHtmlFilePath, actualFilePath);`
`81`	`83`
`82`		`- DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 7200);`
	`84`	`+ DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 9000);`
`83`	`85`	`}`
`84`	`86`
`85`		`- await ChromiumProcessDisposedAsserter.AssertNoChromeProcessIsRunning();`
	`87`	`+ File.Delete(actualFilePath);`
	`88`	`+ await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();`
`86`	`89`	`}`
`87`	`90`
`88`	`91`	`[Fact]`
`@@ -97,5 +100,29 @@ public async Task ShouldDisposeGracefull()`
`97`	`100`	`var afterDisposeChromiumTasks = ChromiumProcessDisposedAsserter.CountChromiumTasks();`
`98`	`101`	`Assert.Equal(afterDisposeChromiumTasks, initialChromiumTasks);`
`99`	`102`	`}`
	`103`	`+`
	`104`	`+ [Theory]`
	`105`	`+ [InlineData("BasicTextFormated.html")]`
	`106`	`+ public async Task ShouldConvertHtmlToPngNoSandbox(string testFileName)`
	`107`	`+ {`
	`108`	`+ var sourceHtmlFilePath = $"../../../TestInput/{testFileName}";`
	`109`	`+ var actualFilePath = Path.Combine(Path.GetTempPath(), $"ActualConvertHtmlToPng{testFileName}.png");`
	`110`	`+ var expectReferenceFilePath = $"../../../ExpectedTestOutcome/ExpectedConvertHtmlToPng{testFileName}.png";`
	`111`	`+`
	`112`	`+ if (File.Exists(actualFilePath))`
	`113`	`+ {`
	`114`	`+ File.Delete(actualFilePath);`
	`115`	`+ }`
	`116`	`+`
	`117`	`+ using (var chromiumRenderer = await Renderer.CreateAsync(new BrowserFetcher(), "--no-sandbox"))`
	`118`	`+ {`
	`119`	`+ await chromiumRenderer.ConvertHtmlToPng(sourceHtmlFilePath, actualFilePath);`
	`120`	`+`
	`121`	`+ DocumentAsserter.AssertImageIsEqual(actualFilePath, expectReferenceFilePath, 9000);`
	`122`	`+ }`
	`123`	`+`
	`124`	`+ File.Delete(actualFilePath);`
	`125`	`+ await ChromiumProcessDisposedAsserter.AssertNoChromiumProcessIsRunning();`
	`126`	`+ }`
`100`	`127`	`}`
`101`	`128`	`}`