Skip to content

feat: [#507] Add Abort method for Response#776

Merged
krishankumar01 merged 17 commits intomasterfrom
kkumar-gcc/#507
Dec 21, 2024
Merged

feat: [#507] Add Abort method for Response#776
krishankumar01 merged 17 commits intomasterfrom
kkumar-gcc/#507

Conversation

@krishankumar01
Copy link
Member

@krishankumar01 krishankumar01 commented Dec 18, 2024

📑 Description

RelatedTo goravel/goravel#507

@coderabbitai summary

✅ Checks

  • Added test cases for my code

@krishankumar01 krishankumar01 requested a review from a team as a code owner December 18, 2024 15:55
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 18, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • 🚀 Review Ready

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.


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.

@codecov
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.76%. Comparing base (9b776be) to head (9441fe7).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #776   +/-   ##
=======================================
  Coverage   69.76%   69.76%           
=======================================
  Files         214      214           
  Lines       18337    18337           
=======================================
  Hits        12793    12793           
  Misses       4842     4842           
  Partials      702      702           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


type AbortResponse interface {
Response
Abort() error
Copy link
Contributor

Choose a reason for hiding this comment

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

Any concerns about not adding Abort to Response directly?

Copy link
Member Author

Choose a reason for hiding this comment

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

I decided not to implement the abort method for streaming, downloads, and other formats as it was unnecessary. Currently, it is implemented only for StringResponse and JsonResponse, which makes more sense to me.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think Data and Redirect are needed, too.


type AbortResponse interface {
Response
Abort() error
Copy link
Contributor

Choose a reason for hiding this comment

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

I think Data and Redirect are needed, too.

hwbrzzl
hwbrzzl previously approved these changes Dec 20, 2024
Copy link
Contributor

@hwbrzzl hwbrzzl left a comment

Choose a reason for hiding this comment

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

LGTM

@krishankumar01 krishankumar01 enabled auto-merge (squash) December 20, 2024 05:30
@krishankumar01 krishankumar01 enabled auto-merge (squash) December 21, 2024 07:15
@krishankumar01 krishankumar01 merged commit be88582 into master Dec 21, 2024
@krishankumar01 krishankumar01 deleted the kkumar-gcc/#507 branch December 21, 2024 07:24
hwbrzzl added a commit that referenced this pull request Dec 23, 2024
hwbrzzl added a commit that referenced this pull request Dec 23, 2024
krishankumar01 added a commit that referenced this pull request Dec 28, 2024
krishankumar01 added a commit that referenced this pull request Dec 29, 2024
* Revert "Revert "feat: [#507] Add `Abort` method for Response (#776)" (#782)"

This reverts commit a6cfbad.

* rename `ResponseWithAbort` to `AbortableResponse`

* chore: update mocks

* remove unnecessary mocks

---------

Co-authored-by: kkumar-gcc <kkumar-gcc@users.noreply.github.com>
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.

2 participants