Add skipWaiting public API to Bswup (#10919)

[msynk]

closes #10919

Summary by CodeRabbit

• New Features

  • Added a method to allow skipping the waiting phase for service worker updates, enabling faster activation of new versions.

• Bug Fixes

  • Improved error handling to prevent issues if certain functions are undefined during message handling.

[coderabbitai]

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

The change introduces an asynchronous skipWaiting method to the BitBswup object, allowing external code to manually trigger the activation of a waiting service worker. Additionally, a minor update ensures that the invocation of blazorStartResolver is safe by using optional chaining to prevent errors if it is undefined.

Changes

File(s)	Change Summary
src/Bswup/Bit.Bswup/Scripts/bit-bswup.ts	Added BitBswup.skipWaiting() method; updated blazorStartResolver invocation with optional chaining.

Sequence Diagram(s)

sequenceDiagram
    participant ExternalCaller
    participant BitBswup
    participant ServiceWorkerRegistration
    participant WaitingServiceWorker

    ExternalCaller->>BitBswup: skipWaiting()
    BitBswup->>ServiceWorkerRegistration: getRegistration()
    alt Waiting SW exists
        BitBswup->>WaitingServiceWorker: postMessage('SKIP_WAITING')
        BitBswup-->>ExternalCaller: true
    else No waiting SW
        BitBswup-->>ExternalCaller: false
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add a public API to manually trigger skip-waiting for updates (#10919)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

A hop, a skip, a waiting game—
Now updates leap without the same!
With skipWaiting, swift and bright,
Your service worker takes new flight.
Bugs beware, the path is clear—
The rabbit’s code brings updates near!
🐇✨

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 52c41ec and f84f04f.

📒 Files selected for processing (1)

• src/Bswup/Bit.Bswup/Scripts/bit-bswup.ts (2 hunks)

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

• GitHub Check: build and test

🔇 Additional comments (1)

src/Bswup/Bit.Bswup/Scripts/bit-bswup.ts (1)

99-99: Good defensive programming practice.

The optional chaining prevents runtime errors if blazorStartResolver is undefined, which improves the robustness of the code.