Improve mechanism to start Blazor in windows apps (#9961)

[yasmoradi]

closes #9961

Summary by CodeRabbit

• Refactor
  • Enhanced the application startup process for a smoother and more reliable launch. The new mechanism continuously verifies readiness before completing initialization, reducing the likelihood of startup issues.

[coderabbitai]

Walkthrough

The changes modify the Blazor application startup logic in two separate Program.cs files. An event handler for navigation completion has been removed and replaced with a new asynchronous method called StartBlazor. This method continuously polls the Blazor startup script (Blazor.start()) until it returns a non-null value, indicating successful initialization. The refactoring shifts the control flow from an event-driven callback model to a polling mechanism without altering error handling or overall application initialization.

Changes

File(s)	Summary
src/BlazorUI/.../Program.cs and src/Templates/Boilerplate/.../Program.cs	Added a static asynchronous method StartBlazor(BlazorWebView) that encapsulates Blazor startup logic. Removed the NavigationCompleted event handler that previously triggered Blazor.start(). The new method polls until the executed script returns a non-null value.

Sequence Diagram(s)

sequenceDiagram
    participant P as Program
    participant BWV as BlazorWebView
    participant BA as Blazor Application

    P->>BWV: Invoke StartBlazor(blazorWebView)
    loop Polling Loop until startup succeeds
        BWV->>BA: Execute "Blazor.start()"
        BA-->>BWV: Return result (null or non-null)
    end
    BWV->>P: Signal Blazor Started Successfully

Loading

Poem

I hopped through the code so bright,
Removing events in the night.
I poll and wait with eager glee,
For Blazor’s spark to finally be.
With async hops and a joyful beat,
This rabbit cheers the update neat! 🐰✨

---

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: 2

🧹 Nitpick comments (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Program.cs (1)

127-133: Consider extracting StartBlazor to a shared utility class.

The StartBlazor method is duplicated between the Demo and Boilerplate templates. Consider moving it to a shared utility class to maintain consistency and reduce duplication.

Create a new shared utility class:

public static class BlazorStartupUtils
{
    public static async Task StartBlazor(BlazorWebView blazorWebView, Action<Exception>? onError = null)
    {
        using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(30));
        try
        {
            while (!cts.Token.IsCancellationRequested && 
                   await blazorWebView.WebView.ExecuteScriptAsync("Blazor.start()") is "null")
            {
                await Task.Yield();
            }
            if (cts.Token.IsCancellationRequested)
            {
                throw new TimeoutException("Blazor failed to start within the timeout period.");
            }
        }
        catch (Exception ex)
        {
            onError?.Invoke(ex);
            throw;
        }
    }
}

Also applies to: 114-120

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 255f1f5 and 193753b.

📒 Files selected for processing (2)

• src/BlazorUI/Demo/Client/Bit.BlazorUI.Demo.Client.Windows/Program.cs (1 hunks)
• src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Program.cs (1 hunks)

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

• GitHub Check: build and test

🔇 Additional comments (2)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Program.cs (2)

127-133: Apply the same timeout mechanism as in the Demo client.

This implementation has the same potential issue with infinite polling as identified in the Demo client's Program.cs.

Please apply the same timeout and error handling improvements suggested for the Demo client.

---

119-119: Apply the same error handling as in the Demo client.

This implementation has the same fire-and-forget issue as identified in the Demo client's Program.cs.

Please apply the same error handling improvements suggested for the Demo client.