Skip to content

Improve http response exception handling in Boilerplate (#10014)#10015

Merged
msynk merged 3 commits intobitfoundation:developfrom
yasmoradi:10014
Feb 22, 2025
Merged

Improve http response exception handling in Boilerplate (#10014)#10015
msynk merged 3 commits intobitfoundation:developfrom
yasmoradi:10014

Conversation

@yasmoradi
Copy link
Member

@yasmoradi yasmoradi commented Feb 22, 2025

closes #10014

Summary by CodeRabbit

  • Refactor
    • Streamlined the system’s error management to ensure more consistent error reporting and improve diagnostics.
  • Chores
    • Updated logging settings by introducing a dedicated diagnostics category for development and simplifying production log levels.

@yasmoradi yasmoradi requested a review from msynk February 22, 2025 13:06
@coderabbitai
Copy link

coderabbitai bot commented Feb 22, 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 restructures error handling and logging across both client and server components. In the client, the SendAsync method of the exception handler now uses a nullable variable to capture the “Request-Id” header, reorganizing try-catch blocks to adjust exception handling and status publishing for internal requests. In the server handler, an unused dependency field is removed. Additionally, the logging configurations have been updated by adding a new diagnostic section in one settings file and removing an explicit middleware log level in another.

Changes

File(s) Change Summary
src/Templates/Boilerplate/.../ExceptionDelegatingHandler.cs Refactored the SendAsync method: introduced a nullable requestIdValue, restructured try-catch blocks, reorganized logging of several response headers, and updated exception handling and server communication status for internal requests.
src/Templates/Boilerplate/.../ServerExceptionHandler.cs Removed the unused IWebHostEnvironment webHostEnvironment field from the ServerExceptionHandler class while preserving other dependency injections and internal structure.
src/Templates/Boilerplate/.../appsettings.Development.json and src/Templates/Boilerplate/.../appsettings.json Added a new DiagnosticLogger section with specified log levels in appsettings.Development.json and removed the explicit log level entry for Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware in appsettings.json.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant EDH as ExceptionDelegatingHandler
    participant Base as BaseHandler
    participant PubSub as pubSubService

    Client->>EDH: SendAsync(request)
    EDH->>EDH: Extract "Request-Id" header into requestIdValue
    EDH->>Base: Call base.SendAsync(request)
    Base-->>EDH: Return response
    alt Successful response
      EDH->>PubSub: Publish communication status (if internal)
      EDH-->>Client: Return response
    else Error encountered
      EDH->>EDH: Log headers and attach requestIdValue to exception
      EDH->>Client: Throw exception
    end
Loading

Poem

I'm a busy rabbit, coding on the run,
Hoping through error logs under the shining sun.
I captured the "Request-Id" with a twitch of my nose,
Simplified my servers, where unused fields decompose.
With tweaks in settings and logs kept so neat,
I celebrate this change with a cheerful, bouncy beat!


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
🪧 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 10799cf and d2598d4.

📒 Files selected for processing (4)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/ExceptionDelegatingHandler.cs (1 hunks)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/ServerExceptionHandler.cs (0 hunks)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/appsettings.Development.json (1 hunks)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/appsettings.json (1 hunks)
💤 Files with no reviewable changes (1)
  • src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/ServerExceptionHandler.cs
🧰 Additional context used
🪛 Biome (1.9.4)
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/appsettings.Development.json

[error] 70-70: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 70-70: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 70-75: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

🔇 Additional comments (4)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/ExceptionDelegatingHandler.cs (2)

20-20: LGTM! Good practice to track request IDs.

The addition of requestIdValue variable helps in correlating exceptions with their corresponding requests, improving observability.


99-103: LGTM! Good practice to enrich exceptions with request IDs.

Adding the request ID to exception data helps in correlating errors with their corresponding requests in logs.

src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/appsettings.json (1)

74-74: LGTM! Appropriate log level for HTTP client.

Setting the log level to "Warning" for HTTP client's logical handler is appropriate as it will capture important issues while avoiding noise from successful operations.

src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/appsettings.Development.json (1)

70-75: LGTM! Good separation of diagnostic logging concerns.

The new DiagnosticLogger section provides better organization of diagnostic-specific logging settings, making it easier to manage and maintain logging configuration.

🧰 Tools
🪛 Biome (1.9.4)

[error] 70-70: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 70-70: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)


[error] 70-75: End of file expected

Use an array for a sequence of values: [1, 2]

(parse)

@msynk msynk merged commit 912d7e5 into bitfoundation:develop Feb 22, 2025
3 checks passed
@yasmoradi yasmoradi deleted the 10014 branch February 22, 2025 17: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.

Boilerplate project template http response exception handling needs improvements

2 participants