Skip to content

feat(Html2Pdf): add support to ARM browsers #492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ArgoZhang merged 2 commits into from
Jul 18, 2025
Merged

feat(Html2Pdf): add support to ARM browsers #492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
411162d
chore: bump version 9.0.3
ArgoZhang Jul 18, 2025
d659f77
feat: 增加 Logger 支持
ArgoZhang Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/components/BootstrapBlazor.Html2Pdf/BootstrapBlazor.Html2Pdf.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk.Razor">

<PropertyGroup>
<Version>9.0.2</Version>
<Version>9.0.3</Version>
</PropertyGroup>

<PropertyGroup>
Expand Down
110 changes: 85 additions & 25 deletions src/components/BootstrapBlazor.Html2Pdf/Services/DefaultPdfService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,61 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
// Website: https://www.blazor.zone or https://argozhang.github.io/

using Microsoft.Extensions.Logging;
using PuppeteerSharp;
using System.Net;

namespace BootstrapBlazor.Components;

/// <summary>
/// 默认 Html to Pdf 实现
/// </summary>
class DefaultPdfService : IHtml2Pdf
class DefaultPdfService(ILogger<DefaultPdfService> logger) : IHtml2Pdf
{
/// <summary>
/// 获得/设置 WebProxy 对象用于网络请求代理
/// <para>Get or set the WebProxy object for network request proxy</para>
/// </summary>
public IWebProxy? WebProxy { get; set; }

/// <summary>
/// <inheritdoc/>
/// </summary>
public async Task<byte[]> PdfDataAsync(string url)
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.GoToAsync(url);
try
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot Jul 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (complexity): Consider extracting a single helper method to handle try/catch/log logic for all PDF generation methods.

You can remove almost all of the duplicated try/catch/log boiler-plate by extracting a single “execute and log” helper and then passing in only the unique bits (navigate/set-up + PdfData vs PdfStream). For example:

// add this helper to DefaultPdfService
private async Task<T> ExecuteAsync<T>(Func<IPage, Task<T>> work, string message, params object?[] args)
{
  try
  {
    await using var browser = await LaunchBrowserAsync();
    await using var page    = await browser.NewPageAsync();
    return await work(page);
  }
  catch (Exception ex)
  {
    _logger.LogError(ex, message, args);
    throw;
  }
}

Then each public method collapses down to a one-liner:

public Task<byte[]> PdfDataAsync(string url) =>
  ExecuteAsync(
    async page => { await page.GoToAsync(url); return await page.PdfDataAsync(); },
    "Error generating PDF from URL: {Url}", url);

public Task<Stream> PdfStreamAsync(string url) =>
  ExecuteAsync(
    async page => { await page.GoToAsync(url); return await page.PdfStreamAsync(); },
    "Error generating PDF from URL: {Url}", url);

public Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null) =>
  ExecuteAsync(
    async page =>
    {
      await page.SetContentAsync(html);
      await AddStyleTagAsync(page, links);
      await AddScriptTagAsync(page, scripts);
      return await page.PdfDataAsync();
    },
    "Error generating PDF from HTML content");

public Task<Stream> PdfStreamFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null) =>
  ExecuteAsync(
    async page =>
    {
      await page.SetContentAsync(html);
      await AddStyleTagAsync(page, links);
      await AddScriptTagAsync(page, scripts);
      return await page.PdfStreamAsync();
    },
    "Error generating PDF from HTML content");

This preserves all behavior, removes four-fold duplication, and keeps your logger usage consistent.

{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();

return await page.PdfDataAsync();
await page.GoToAsync(url);
return await page.PdfDataAsync();
}
catch (Exception ex)
{
Log(ex, "Error generating PDF from URL: {Url}", url);
throw;
}
}

/// <summary>
/// <inheritdoc/>
/// </summary>
public async Task<Stream> PdfStreamAsync(string url)
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.GoToAsync(url);
try
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.GoToAsync(url);

return await page.PdfStreamAsync();
return await page.PdfStreamAsync();
}
catch (Exception ex)
{
Log(ex, "Error generating PDF from URL: {Url}", url);
throw;
}
}

/// <summary>
Expand All @@ -43,14 +67,22 @@ public async Task<Stream> PdfStreamAsync(string url)
/// <param name="scripts"></param>
public async Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null)
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.SetContentAsync(html);
try
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.SetContentAsync(html);

await AddStyleTagAsync(page, links);
await AddScriptTagAsync(page, scripts);
await AddStyleTagAsync(page, links);
await AddScriptTagAsync(page, scripts);

return await page.PdfDataAsync();
return await page.PdfDataAsync();
}
catch (Exception ex)
{
Log(ex, "Error generating PDF from HTML content");
throw;
}
}

/// <summary>
Expand All @@ -61,14 +93,22 @@ public async Task<byte[]> PdfDataFromHtmlAsync(string html, IEnumerable<string>?
/// <param name="scripts"></param>
public async Task<Stream> PdfStreamFromHtmlAsync(string html, IEnumerable<string>? links = null, IEnumerable<string>? scripts = null)
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.SetContentAsync(html);
try
{
await using var browser = await LaunchBrowserAsync();
await using var page = await browser.NewPageAsync();
await page.SetContentAsync(html);

await AddStyleTagAsync(page, links);
await AddScriptTagAsync(page, scripts);
await AddStyleTagAsync(page, links);
await AddScriptTagAsync(page, scripts);

return await page.PdfStreamAsync();
return await page.PdfStreamAsync();
}
catch (Exception ex)
{
Log(ex, "Error generating PDF from HTML content");
throw;
}
}

private static async Task AddStyleTagAsync(IPage page, IEnumerable<string>? links = null)
Expand Down Expand Up @@ -103,11 +143,31 @@ private static async Task AddScriptTagAsync(IPage page, IEnumerable<string>? scr

private static LaunchOptions CreateOptions() => new() { Headless = true, Args = ["--no-sandbox", "--disable-setuid-sandbox", "--disable-web-security"] };

private static async Task<IBrowser> LaunchBrowserAsync()
private async Task<IBrowser> LaunchBrowserAsync()
{
var browserFetcher = new BrowserFetcher();
await browserFetcher.DownloadAsync();
var browserFetcher = new BrowserFetcher
{
WebProxy = WebProxy
};

Log(null, "Ready to start downloading browser");
var browser = await browserFetcher.DownloadAsync();
Log(null, $"Browser downloaded successfully. installed browser {browser.BuildId}");

return await Puppeteer.LaunchAsync(CreateOptions());
var options = CreateOptions();
Log(null, "Start your browser", "--no-sandbox", "--disable-setuid-sandbox", "--disable-web-security");
return await Puppeteer.LaunchAsync(options);
}

private void Log(Exception? exception, string? message, params object?[] args)
{
if (args.Length != 0)
{
logger.LogInformation(exception, "{Message} | Args: {Args}", message, args);
}
else
{
logger.LogInformation(exception, "{Message}", message);
}
}
}