feat: add Abort method

[hwbrzzl]

📑 Description

Summary by CodeRabbit

• New Features

  • Added a new Abort method to ContextRequest with more flexible request termination options

• Deprecations

  • Marked AbortWithStatus and AbortWithStatusJson methods as deprecated
  • Recommended alternative methods for request abortion

• Bug Fixes

  • Updated timeout middleware to return more appropriate http.StatusRequestTimeout status code
  • Simplified error logging in context request initialization

[coderabbitai]

Warning

Rate limit exceeded

@hwbrzzl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 42 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 393c6d3 and b612c2c.

⛔ Files ignored due to path filters (1)

• go.sum is excluded by !**/*.sum

📒 Files selected for processing (1)

• go.mod (1 hunks)

Walkthrough

The pull request introduces modifications to the error handling and timeout middleware in the codebase. In context_request.go, a new Abort method is added to the ContextRequest struct, providing more flexible request termination. The timeout middleware in middleware_timeout.go has been updated to use a more appropriate HTTP status code (http.StatusRequestTimeout) when a request times out. Corresponding test cases in middleware_timeout_test.go have been adjusted to reflect this status code change.

Changes

File	Change Summary
context_request.go	- Added new Abort method with optional status code - Deprecated AbortWithStatus and AbortWithStatusJson methods - Modified error logging in NewContextRequest to log original error
middleware_timeout.go	- Changed timeout status code from http.StatusGatewayTimeout to http.StatusRequestTimeout
middleware_timeout_test.go	- Updated test case to expect http.StatusRequestTimeout instead of http.StatusGatewayTimeout

Sequence Diagram

sequenceDiagram
    participant Client
    participant Middleware
    participant Handler
    
    Client->>Middleware: Send Request
    Middleware->>Middleware: Start Timeout Timer
    alt Request Completes
        Middleware->>Handler: Process Request
        Handler-->>Client: Return Response
    else Request Times Out
        Middleware-->>Client: Abort with 408 Request Timeout
    end

Loading

---

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

🧹 Nitpick comments (1)

context_request.go (1)

47-47: Ensure consistent error logging approach.

Using log.Error(fmt.Sprintf("%+v", err)) logs the wrapped error with details. This is fine if the stack trace or detailed formatting is needed. However, confirm that the rest of the codebase uses a similar pattern for consistency or consider a simpler call like log.Error(err).

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6282f6e and 393c6d3.

📒 Files selected for processing (3)

• context_request.go (2 hunks)
• middleware_timeout.go (1 hunks)
• middleware_timeout_test.go (1 hunks)

🔇 Additional comments (5)

middleware_timeout.go (1)

37-37: Well-aligned status code change.

Switching from http.StatusGatewayTimeout to http.StatusRequestTimeout more accurately reflects a client-level timeout rather than a gateway issue. This is a valid adjustment and matches the updated test expectations.

middleware_timeout_test.go (1)

45-45: Tests correctly reflect the new status code behavior.

Confirming the http.StatusRequestTimeout status code in the test keeps the middleware implementation and tests in sync. This change is straightforward and correct.

context_request.go (3)

57-64: Flexible abort method with default status code.

The new Abort method defaults to http.StatusBadRequest when no code argument is supplied. This addition provides a versatile approach to request termination. Confirm that the fallback to 400 is desired, or consider a docstring clarifying why 400 is the default.

---

66-66: Deprecated method notice.

Marking AbortWithStatus as deprecated makes sense given that Abort is now the recommended approach. Consider adding a comment explaining the advantage of Abort to encourage migration.

---

71-71: Deprecated JSON abort method.

Clearly instructing developers to use Response().Json().Abort() or the new Abort method helps them transition away from this old approach. Ensure that any internal references are updated to the new method to avoid confusion.