Bump PuppeteerSharp from 20.0.2 to 20.0.3

Codeuctivity.HtmlRenderer/Codeuctivity.HtmlRenderer.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
 	<TargetFrameworks>net8.0</TargetFrameworks>
@@ -15,11 +15,10 @@
 	<PackageReleaseNotes>$(LAST_COMMIT_MESSAGE)</PackageReleaseNotes>
 	<PackageIcon>NugetIcon.png</PackageIcon>
 	<PackageProjectUrl>https://github.com/Codeuctivity/PuppeteerSharp.Renderer</PackageProjectUrl>
-	<Description>Renders HTML to PNG or PDF, supports windows and linux</Description>
+	<Description>Renders HTML to PNG or PDF, supports windows, linux and macos</Description>
 	<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
 	<PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
 	<SignAssembly>True</SignAssembly>
-	<Optimize Condition="'$(GITHUB_ACTIONS)' == 'true'">true</Optimize>
 	<IncludeSymbols>true</IncludeSymbols>
 	<SymbolPackageFormat>snupkg</SymbolPackageFormat>
 	<PublishRepositoryUrl>true</PublishRepositoryUrl>
@@ -38,9 +37,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-	<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="all" />
-	<PackageReference Include="PuppeteerSharp" Version="20.0.2" />
-	<PackageReference Include="SonarAnalyzer.CSharp" Version="9.26.0.92422">
+	<PackageReference Include="PuppeteerSharp" Version="20.0.3" />
+	<PackageReference Include="SonarAnalyzer.CSharp" Version="9.32.0.97167">
 	  <PrivateAssets>all</PrivateAssets>
 	  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 	</PackageReference>

Codeuctivity.HtmlRenderer/Renderer.cs

@@ -1,5 +1,6 @@
 using PuppeteerSharp;
 using System;
+using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Runtime.InteropServices;
@@ -95,6 +96,9 @@
             BrowserFetcher = browserFetcher;
             var revisionInfo = await BrowserFetcher.DownloadAsync(PuppeteerSharp.BrowserData.Chrome.DefaultBuildId).ConfigureAwait(false);
             LaunchOptions.ExecutablePath = revisionInfo.GetExecutablePath();
+
+            // Temporary work around https://github.com/hardkoded/puppeteer-sharp/issues/2782 https://stackoverflow.com/questions/78996364/chrome-129-headless-shows-blank-window
+            LaunchOptions.Args = new List<string>(LaunchOptions.Args ?? Array.Empty<string>()) { "--headless=old" }.ToArray();
             Browser = await Puppeteer.LaunchAsync(LaunchOptions).ConfigureAwait(false);
 
             return this;
@@ -160,7 +164,7 @@
             }
 
             var absolutePath = Path.GetFullPath(sourceHtmlFilePath);
             await using var page = await GetPage().ConfigureAwait(false);
             await page.GoToAsync($"file://{absolutePath}").ConfigureAwait(false);
             // Wait for fonts to be loaded. Omitting this might result in no text rendered in PDF.
             await page.EvaluateExpressionHandleAsync("document.fonts.ready").ConfigureAwait(false);
@@ -171,7 +175,7 @@
         {
             if (Browser == null)
             {
-                throw new RendererException("Call CreateAsync first");
+                throw new RendererException($"Call {nameof(CreateAsync)} first");
             }
 
             return await Browser.NewPageAsync().ConfigureAwait(false);
@@ -201,7 +205,7 @@
             }
 
             var absolutePath = Path.GetFullPath(sourceHtmlFilePath);
             await using var page = await GetPage().ConfigureAwait(false);
             await page.GoToAsync($"file://{absolutePath}").ConfigureAwait(false);
             // Wait for fonts to be loaded. Omitting this might result in no text the screenshot.
             await page.EvaluateExpressionHandleAsync("document.fonts.ready").ConfigureAwait(false);
@@ -224,7 +228,7 @@
         /// <param name="screenshotOptions"></param>
         public async Task<byte[]> ConvertHtmlStringToPngData(string sourceHtmlData, ScreenshotOptions screenshotOptions)
         {
             await using var page = await GetPage().ConfigureAwait(false);
             await page.SetContentAsync(sourceHtmlData).ConfigureAwait(false);
             // Wait for fonts to be loaded. Omitting this might result in no text the screenshot.
             await page.EvaluateExpressionHandleAsync("document.fonts.ready").ConfigureAwait(false);

Codeuctivity.HtmlRendererCliTests/Codeuctivity.HtmlRendererCliTests.csproj

@@ -7,13 +7,13 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="9.26.0.92422">
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="9.32.0.97167">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
-    <PackageReference Include="xunit" Version="2.8.1" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
+    <PackageReference Include="xunit" Version="2.9.2" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

Codeuctivity.HtmlRendererTests/.editorconfig

@@ -0,0 +1,4 @@
+[*.cs]
+
+# CA1416: Validate platform compatibility
+dotnet_diagnostic.CA1416.severity = none

Codeuctivity.HtmlRendererTests/Codeuctivity.HtmlRendererTests.csproj

@@ -1,35 +1,47 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-	<PropertyGroup>
-		<TargetFrameworks>net8.0</TargetFrameworks>
-		<IsPackable>false</IsPackable>
-		<Nullable>enable</Nullable>
-		<IsPackable>false</IsPackable>
-		<EnableNETAnalyzers>true</EnableNETAnalyzers>
-	</PropertyGroup>
+  <PropertyGroup>
+	<TargetFrameworks>net8.0</TargetFrameworks>
+	<IsPackable>false</IsPackable>
+	<Nullable>enable</Nullable>
+	<IsPackable>false</IsPackable>
+	<EnableNETAnalyzers>true</EnableNETAnalyzers>
+  </PropertyGroup>
 
-	<ItemGroup>
-		<Compile Remove="SourceTestFiles\**" />
-		<EmbeddedResource Remove="SourceTestFiles\**" />
-		<None Remove="SourceTestFiles\**" />
-	</ItemGroup>
+  <ItemGroup>
+	<Compile Remove="SourceTestFiles\**" />
+	<EmbeddedResource Remove="SourceTestFiles\**" />
+	<None Remove="SourceTestFiles\**" />
+
+	<SupportedPlatform Include="Linux" />
+	<SupportedPlatform Include="macOS" />
+	<SupportedPlatform Include="Windows" />
+  </ItemGroup>
 
-	<ItemGroup>
-		<PackageReference Include="Codeuctivity.ImageSharpCompare" Version="4.0.258" />
-		<PackageReference Include="PDFtoImage" Version="4.0.2" />
-		<PackageReference Include="SonarAnalyzer.CSharp" Version="9.26.0.92422">
-			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-			<PrivateAssets>all</PrivateAssets>
-		</PackageReference>
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.10.0" />
-		<PackageReference Include="xunit" Version="2.8.1" />
-		<PackageReference Include="xunit.runner.visualstudio" Version="2.8.1">
-			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-			<PrivateAssets>all</PrivateAssets>
-		</PackageReference>
-	</ItemGroup>
+  <ItemGroup>
+	<PackageReference Include="Codeuctivity.ImageSharpCompare" Version="4.0.273" />
+	<PackageReference Include="PDFtoImage" Version="4.1.1" />
+	<PackageReference Include="SonarAnalyzer.CSharp" Version="9.32.0.97167">
+	  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+	  <PrivateAssets>all</PrivateAssets>
+	</PackageReference>
+	<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
+	<PackageReference Include="xunit" Version="2.9.2" />
+	<PackageReference Include="xunit.runner.visualstudio" Version="2.8.2">
+	  <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+	  <PrivateAssets>all</PrivateAssets>
+	</PackageReference>
+  </ItemGroup>
 
-	<ItemGroup>
-		<ProjectReference Include="..\Codeuctivity.HtmlRenderer\Codeuctivity.HtmlRenderer.csproj" />
-	</ItemGroup>
+  <ItemGroup>
+	<ProjectReference Include="..\Codeuctivity.HtmlRenderer\Codeuctivity.HtmlRenderer.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <EditorConfigFiles Remove="C:\Users\Stefan\Documents\source\repo\PuppeteerSharp.Renderer\Codeuctivity.HtmlRendererTests\.editorconfig" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Include="C:\Users\Stefan\Documents\source\repo\PuppeteerSharp.Renderer\Codeuctivity.HtmlRendererTests\.editorconfig" />
+  </ItemGroup>
 </Project>

Codeuctivity.HtmlRendererTests/Infrastructure/DocumentAsserter.cs

@@ -8,7 +8,7 @@ internal static class DocumentAsserter
     {
         private const string TestOutputFirectory = "../../../../TestResult";
 
-        internal static void AssertImageIsEqual(string actualImagePath, string expectImageFilePath, int allowedPixelErrorCount)
+        internal static void AssertImageIsEqual(string actualImagePath, string expectImageFilePath, int allowedPixelErrorCount, int pixelColorShiftTolerance = 0)
         {
             var actualFullPath = Path.GetFullPath(actualImagePath);
             var expectFullPath = Path.GetFullPath(expectImageFilePath);
@@ -29,26 +29,28 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
                 osSpecificDiffFileSuffix = "osx";
             }
 
-            var allowedDiffImage = $"{expectFullPath}.diff.{osSpecificDiffFileSuffix}.png";
+            var osSpecificAllowedDiffImage = $"{expectFullPath}.diff.{osSpecificDiffFileSuffix}.png";
             var newDiffImage = $"{actualFullPath}.diff.png";
             using (var fileStreamDifferenceMask = File.Create(newDiffImage))
             using (var maskImage = ImageSharpCompare.ImageSharpCompare.CalcDiffMaskImage(actualFullPath, expectFullPath))
             {
                 SixLabors.ImageSharp.ImageExtensions.SaveAsPng(maskImage, fileStreamDifferenceMask);
             }
 
-            if (File.Exists(allowedDiffImage))
+            if (File.Exists(osSpecificAllowedDiffImage))
             {
-                var resultWithAllowedDiff = ImageSharpCompare.ImageSharpCompare.CalcDiff(actualFullPath, expectFullPath, allowedDiffImage);
+                var resultWithOsSpecificAllowedDiff = ImageSharpCompare.ImageSharpCompare.CalcDiff(actualFullPath, expectFullPath, osSpecificAllowedDiffImage);
 
-                if (allowedPixelErrorCount < resultWithAllowedDiff.PixelErrorCount)
+                if (allowedPixelErrorCount < resultWithOsSpecificAllowedDiff.PixelErrorCount)
                 {
                     CopyToTestOutput(actualImagePath);
                     CopyToTestOutput(expectImageFilePath);
                     CopyToTestOutput(newDiffImage);
                 }
 
-                Assert.True(resultWithAllowedDiff.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {resultWithAllowedDiff.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n Diff is {newDiffImage}");
+                //  File.Copy(newDiffImage, osSpecificAllowedDiffImage, true);
+
+                Assert.True(resultWithOsSpecificAllowedDiff.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {resultWithOsSpecificAllowedDiff.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n Diff is {newDiffImage}");
                 return;
             }
 
@@ -58,7 +60,7 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
                 SixLabors.ImageSharp.ImageExtensions.SaveAsPng(maskImage, fileStreamDifferenceMask);
             }
 
-            var result = ImageSharpCompare.ImageSharpCompare.CalcDiff(actualFullPath, expectFullPath);
+            var result = ImageSharpCompare.ImageSharpCompare.CalcDiff(actualFullPath, expectFullPath, pixelColorShiftTolerance: pixelColorShiftTolerance);
 
             if (allowedPixelErrorCount < result.PixelErrorCount)
             {
@@ -67,7 +69,7 @@ internal static void AssertImageIsEqual(string actualImagePath, string expectIma
                 CopyToTestOutput(actualImagePath);
             }
 
-            Assert.True(result.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {result.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n Diff is {newDiffImage}\nReplace {actualFullPath} with the new value or store the diff as {allowedDiffImage}.");
+            Assert.True(result.PixelErrorCount <= allowedPixelErrorCount, $"Expected PixelErrorCount beyond {allowedPixelErrorCount} but was {result.PixelErrorCount}\nExpected {expectFullPath}\ndiffers to actual {actualFullPath}\n Diff is {newDiffImage}\nReplace {actualFullPath} with the new value or store the diff as {osSpecificAllowedDiffImage}.");
         }
 
         private static void CopyToTestOutput(string testOutputFile)

Codeuctivity.HtmlRendererTests/RendererTests.cs

@@ -36,8 +36,8 @@ public async Task ShouldConvertHtmlToPdf(string testFileName)
 
                 if (!IsRunningOnAzureOrMacos())
                 {
-                    PDFtoImage.Conversion.SavePng(actualImagePathDirectory, await File.ReadAllBytesAsync(actualFilePath));
-                    DocumentAsserter.AssertImageIsEqual(actualImagePathDirectory, expectReferenceFilePath, 8080);
+                    PDFtoImage.Conversion.SavePng(actualImagePathDirectory, await File.ReadAllBytesAsync(actualFilePath), 0);
+                    DocumentAsserter.AssertImageIsEqual(actualImagePathDirectory, expectReferenceFilePath, 8080, 400);
                 }
                 File.Delete(actualFilePath);
             }
@@ -66,8 +66,8 @@ public async Task ShouldConvertHtmlToPdfWithOptions(string testFileName, bool pr
 
                 if (!IsRunningOnAzureOrMacos())
                 {
-                    PDFtoImage.Conversion.SavePng(actualImagePathDirectory, await File.ReadAllBytesAsync(actualFilePath));
-                    DocumentAsserter.AssertImageIsEqual(actualImagePathDirectory, expectReferenceFilePath, allowedPixelDiff);
+                    PDFtoImage.Conversion.SavePng(actualImagePathDirectory, await File.ReadAllBytesAsync(actualFilePath), 0);
+                    DocumentAsserter.AssertImageIsEqual(actualImagePathDirectory, expectReferenceFilePath, allowedPixelDiff, 400);
                 }
                 File.Delete(actualFilePath);
             }