Skip to content
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.

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

fix external js runner close issue in Boilerplate (#10316) #10317

Merged
merged 9 commits into from
Mar 28, 2025

Conversation

ysmoradi
Copy link
Member

@ysmoradi ysmoradi commented Mar 26, 2025

closes #10316

Summary by CodeRabbit

  • Refactor
    • Updated the handling of external session closures across platforms to use non-blocking operations. This adjustment improves responsiveness by allowing subsequent actions to proceed without waiting for the external interaction to finish.

@ysmoradi ysmoradi requested review from msynk and Copilot March 26, 2025 20:31
Copy link

coderabbitai bot commented Mar 26, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request updates the asynchronous handling in the CloseExternalBrowser method for both Maui and Windows client services. The invocation of the external JS runner's request is now fired without waiting for its completion by discarding the task’s result. This alteration potentially modifies the control flow and error propagation during the external browser closing process.

Changes

File Change Summary
src/.../Boilerplate.Client.{Maui,Windows}/Services/MauiWebAuthnService.cs
src/.../Boilerplate.Client.{Maui,Windows}/Services/WindowsWebAuthnService.cs
In the CloseExternalBrowser method, the awaited call to the external JS runner has been replaced with a discard (_ =), making the call non-blocking.

Sequence Diagram(s)

sequenceDiagram
    participant S as WebAuthnService
    participant E as ExternalJsRunner
    S->>E: RequestToBeSent (invoked non-blocking)
    Note right of S: Continues execution immediately
Loading

Assessment against linked issues

Objective Addressed Explanation
External JS runner's close functionality (#10316)

Poem

I'm a rabbit in the code, hopping through the night,
With async leaps and bounds, making everything light.
No waiting at the burrow, the task moves on quick,
A non-blocking journey—yes, that's the trick!
🐇 Cheers to smoother closes and code that clicks!


🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR aims to fix the external JavaScript runner close issue by changing the way the close command is invoked in both the Maui and Windows services.

  • Changed from awaiting the invocation to using a fire-and-forget pattern in both Maui and Windows implementations.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/Services/MauiWebAuthnService.cs Changed await to fire-and-forget for the external JS runner close call
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Services/WindowsWebAuthnService.cs Changed await to fire-and-forget for the external JS runner close call
Comments suppressed due to low confidence (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Services/WindowsWebAuthnService.cs:29

  • Changing from an await to fire-and-forget might obscure errors from the JS runner invocation. It is recommended to include error logging or additional error handling to ensure any exceptions are captured.
_ = WindowsExternalJsRunner.RequestToBeSent!.Invoke(JsonSerializer.SerializeToDocument(new { Type = "close" }, JsonSerializerOptions.Web));

@ysmoradi ysmoradi marked this pull request as draft March 26, 2025 21:10
@bitfoundation bitfoundation deleted a comment from Copilot bot Mar 26, 2025
@msynk msynk merged commit c58059a into bitfoundation:develop Mar 28, 2025
29 of 30 checks passed
@ysmoradi ysmoradi deleted the 10316 branch March 29, 2025 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

External js runner's close doesn't work in Boilerplate project template
2 participants