Improve Boilerplate exception handling (#10998)

[ysmoradi]

closes #10998

Summary by CodeRabbit

• Bug Fixes
  • Improved handling of sign-out errors to better manage scenarios when access tokens are expired or the client is outdated.
  • Adjusted error display behavior so that unauthorized access errors are now shown as non-interrupting notifications.

[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

Exception handling in the boilerplate project's client code was updated. The SignOut method now ignores ClientNotSupportedException in addition to other exceptions. The GetDisplayKind method in the exception handler now treats UnauthorizedException as non-interrupting, aligning its behavior with ServerConnectionException.

Changes

Files	Change Summary
.../Boilerplate.Client.Core/Services/AuthManager.cs	Extended SignOut method's exception filter to include ClientNotSupportedException; updated explanatory comment.
.../Boilerplate.Client.Core/Services/ClientExceptionHandlerBase.cs	Modified GetDisplayKind to return NonInterrupting for UnauthorizedException as well as ServerConnectionException.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant AuthManager
    participant ExceptionHandler

    Client->>AuthManager: SignOut()
    AuthManager->>AuthManager: Try sign-out logic
    alt Exception thrown
        AuthManager->>AuthManager: Catch ServerConnectionException/UnauthorizedException/ResourceNotFoundException/ClientNotSupportedException
        AuthManager->>AuthManager: Ignore exception
    end
    AuthManager-->>Client: Complete

    Client->>ExceptionHandler: HandleException(exception)
    alt exception is ServerConnectionException or UnauthorizedException
        ExceptionHandler-->>Client: Display as NonInterrupting
    else
        ExceptionHandler-->>Client: Display as Interrupting
    end

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Improve exception handling in boilerplate project template (#10998)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

A hop, a skip, a leap through code,
Where exceptions once blocked the rabbit's road.
Now sign-outs are smoother, less abrupt,
And errors less rude, more gently interrupt.
With paws on the keys and a twitch of delight,
This bunny says, "Exception handling feels just right!" 🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

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 auto-generate unit tests to generate unit tests for 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.

[Copilot]

Pull Request Overview

This PR refines how certain exceptions are handled in the client boilerplate by classifying UnauthorizedException as non-interrupting and extending the sign-out logic to ignore a new exception type.

• Classify UnauthorizedException as NonInterrupting in GetDisplayKind
• Extend AuthManager.SignOut to ignore ClientNotSupportedException
• Update comments to explain ignored exception scenarios

Reviewed Changes

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

File	Description
src/.../ClientExceptionHandlerBase.cs	Added UnauthorizedException branch to return NonInterrupting
src/.../AuthManager.cs	Updated catch filter to include ClientNotSupportedException and revised comments

Comments suppressed due to low confidence (2)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientExceptionHandlerBase.cs:83

• Add a unit test to ensure UnauthorizedException is classified as NonInterrupting in GetDisplayKind for full coverage.

        if (exception is UnauthorizedException)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AuthManager.cs:78

• Introduce a test case to verify that ClientNotSupportedException is correctly ignored during SignOut.

        catch (Exception exp) when (exp is ServerConnectionException or UnauthorizedException or ResourceNotFoundException or ClientNotSupportedException)