Skip to content

feat(Playwright): add BootstrapBlazor.Html2Pdf.Playwright project#435

Merged
ArgoZhang merged 1 commit intomasterfrom
refactor-player
May 6, 2025
Merged

feat(Playwright): add BootstrapBlazor.Html2Pdf.Playwright project#435
ArgoZhang merged 1 commit intomasterfrom
refactor-player

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented May 6, 2025

Link issues

fixes #434

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add a new Playwright-based HTML to PDF conversion service for the BootstrapBlazor project

New Features:

  • Implement HTML to PDF conversion using Playwright
  • Add service extension method for dependency injection
  • Support converting URLs and HTML strings to PDF

Enhancements:

  • Provide flexible PDF generation with optional style and script links
  • Support both byte array and stream output for PDF conversion

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 6, 2025

Reviewer's Guide

This pull request introduces a new project, BootstrapBlazor.Html2Pdf.Playwright, which provides an implementation of the IHtml2Pdf interface using the Playwright library. It adds a DefaultPdfService that uses a headless Chromium browser via Playwright to convert HTML content (from a URL or string) into PDF data or a stream. An extension method is included for easy dependency injection registration.

File-Level Changes

Change Details Files
Added a new project and implemented HTML-to-PDF conversion using Playwright.
  • Created the BootstrapBlazor.Html2Pdf.Playwright project file.
  • Implemented DefaultPdfService using Playwright to launch Chromium, navigate/load HTML, and generate PDF.
  • Added methods to handle PDF generation from both URLs and raw HTML strings.
  • Included logic to inject custom CSS links and JavaScript tags into the HTML before PDF generation.
  • Configured Playwright browser launch options (headless, sandbox settings).
  • Added the new project to the solution file.
src/components/BootstrapBlazor.Html2Pdf.Playwright/Services/DefaultPdfService.cs
src/components/BootstrapBlazor.Html2Pdf.Playwright/BootstrapBlazor.Html2Pdf.Playwright.csproj
src/components/BootstrapBlazor.Html2Pdf.Playwright/_Imports.razor
BootstrapBlazor.Extensions.sln
Added dependency injection support for the new Playwright PDF service.
  • Created the AddBootstrapBlazorHtml2PdfUsePlaywrightService extension method for IServiceCollection.
  • Registered DefaultPdfService as a singleton implementation for IHtml2Pdf.
  • Included conditional registration using keyed services for .NET 8 and later.
src/components/BootstrapBlazor.Html2Pdf.Playwright/Extensions/ServiceCollectionExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#434 Add a new project named BootstrapBlazor.Html2Pdf.Playwright to the solution.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto Bot added the enhancement New feature or request label May 6, 2025
@bb-auto bb-auto Bot added this to the v9.2.0 milestone May 6, 2025
@ArgoZhang ArgoZhang merged commit 05443ea into master May 6, 2025
1 check passed
@ArgoZhang ArgoZhang deleted the refactor-player branch May 6, 2025 04:09
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

  • Consider managing the Playwright browser instance lifecycle outside of individual PDF generation requests to improve performance and resource usage.
  • Consider allowing PDF generation options like format and orientation to be configured instead of being hardcoded.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟡 Complexity: 1 issue found
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Args = ["--no-sandbox", "--disable-setuid-sandbox", "--disable-web-security"]
};

private static async Task AddStyleTagAsync(IPage page, IEnumerable<string>? links = null)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

issue (complexity): Consider iterating directly over the input enumerable in AddStyleTagAsync and AddScriptTagAsync to avoid creating intermediate lists.

Consider simplifying the tag helpers to avoid creating intermediate lists. For example, you can iterate directly over the supplied enumerable. This reduces unnecessary nesting and improves readability without changing functionality. Here's a suggestion:

private static async Task AddStyleTagAsync(IPage page, IEnumerable<string>? links = null)
{
    if (links == null) return;

    foreach (var link in links)
    {
        await page.AddStyleTagAsync(new PageAddStyleTagOptions { Url = link });
    }
}

private static async Task AddScriptTagAsync(IPage page, IEnumerable<string>? scripts = null)
{
    if (scripts == null) return;

    foreach (var script in scripts)
    {
        await page.AddScriptTagAsync(new PageAddScriptTagOptions { Url = script, Type = "script" });
    }
}

These concise changes remove unnecessary list instantiation while keeping functionality intact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(Playwright): add BootstrapBlazor.Html2Pdf.Playwright project

1 participant