Ignore RenderingCancelledException in render page function of BitPdfReader (#9850)

[msynk]

closes #9850

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error handling for PDF rendering to manage common interruptions more gracefully, ensuring a smoother and more stable document viewing experience.

[coderabbitai]

Walkthrough

This change introduces additional error handling in the renderPage method of the PdfReader class. A new catch block has been added to capture exceptions during the rendering process. If the caught error is not a RenderingCancelledException, it is rethrown. No modifications were made to the exported or public entities.

Changes

File	Change Summary
src/BlazorUI/.../BitPdfReader.ts	Added a catch block in the renderPage method to handle exceptions. If an error is not a RenderingCancelledException, it gets rethrown.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant PdfReader
    Caller->>PdfReader: call renderPage()
    alt Rendering succeeds
        PdfReader-->>Caller: return rendered page
    else Error occurs
        PdfReader->>PdfReader: catch exception
        alt Exception is RenderingCancelledException
            PdfReader-->>Caller: handle cancellation quietly
        else Other exception
            PdfReader-->>Caller: rethrow exception
        end
    end

Loading

Poem

I'm a hopping rabbit with a tale to tell,
In code, I've leaped where errors dwell.
A clever catch to check each case,
Only letting certain faults embrace.
Bug hops away — oh what a swell spell!
🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/BlazorUI/Bit.BlazorUI.Extras/Components/PdfReader/BitPdfReader.ts (2)

101-104: LGTM! Consider adding documentation.

The error handling implementation correctly ignores RenderingCancelledException while preserving other error cases. Consider adding a comment explaining why this exception is safely ignorable.

 try {
     const page = await config.pdfDoc.getPage(pageNumber);
     // ... rendering logic ...
 } catch (err: any) {
+    // Ignore RenderingCancelledException as it occurs when rendering is intentionally cancelled
+    // and doesn't indicate an error condition
     if (err.name !== 'RenderingCancelledException') {
         throw err;
     }
 }

---

101-104: Consider adding debug logging.

For better debugging and monitoring, consider adding debug logging when RenderingCancelledException occurs.

 } catch (err: any) {
+    if (err.name === 'RenderingCancelledException') {
+        console.debug(`PDF rendering cancelled for page ${pageNumber}`);
+        return;
+    }
-    if (err.name !== 'RenderingCancelledException') {
-        throw err;
-    }
+    throw err;
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75c11b5 and 1e33a9a.

📒 Files selected for processing (1)

• src/BlazorUI/Bit.BlazorUI.Extras/Components/PdfReader/BitPdfReader.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build and test