feat: [#449] Implement HTTP response stream #77

krishankumar01 · 2024-07-31T14:38:56Z

📑 Description

Closes goravel/goravel#449

@coderabbitai summary

✅ Checks

Added test cases for my code

coderabbitai · 2024-07-31T14:39:02Z

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

hwbrzzl · 2024-08-02T13:59:43Z

context_response.go

 	return NewStatus(r.instance, code)
 }

+func (r *ContextResponse) Stream(step func(w contractshttp.StreamWriter) error, code int, contentType string) contractshttp.Response {


Do we need to set contentType for stream? If the contentType is only used by SSE, can we add another SSEvent method to deal with it?

It is not necessary; we can remove contentType. We don't need the SSEvent method since we provide the Header method, allowing the user to set it directly if needed.

ctx.Response().Header("Content-Type", "text/event-stream").Stream(...)

hwbrzzl · 2024-08-09T01:25:06Z

context_response_test.go

+	return r.closeChannel
+}
+
+func (r *TestResponseRecorder) closeClient() {


Is this method used?

Where? I don't find the case.

hwbrzzl · 2024-08-09T07:09:39Z

response.go

+
+	w := NewStreamWriter(r.instance)
+
+	clientGone := r.instance.Writer.CloseNotify()


I noticed the method is deprecated.

We should use:

ctx := r.instance.Request.Context() ... case <-ctx.Done():

Ohh, you are right, missed it.

…/#449

hwbrzzl · 2024-08-09T15:20:06Z

context_response_test.go

+type TestResponseRecorder struct {
+	*httptest.ResponseRecorder
+	closeChannel chan bool
+}
+
+func CreateTestResponseRecorder() *TestResponseRecorder {
+	return &TestResponseRecorder{
+		httptest.NewRecorder(),
+		make(chan bool, 1),
+	}
+}
+
+func (r *TestResponseRecorder) CloseNotify() <-chan bool {
+	return r.closeChannel
+}


Can we remove this now?

hwbrzzl

Great PR, LGTM

add stream function

c6035c5

krishankumar01 requested a review from a team as a code owner July 31, 2024 14:38

update framework

ee01ae1

krishankumar01 changed the title ~~feat: [#449] Implement HTTP response stream~~ feat: [#449] Implement HTTP response stream Aug 2, 2024

hwbrzzl reviewed Aug 2, 2024

View reviewed changes

krishankumar01 added 4 commits August 3, 2024 17:09

remove contentType

b897773

add stream to status

09f6d18

update go mod

f46cbca

add test for response

afda72a

hwbrzzl reviewed Aug 9, 2024

View reviewed changes

krishankumar01 and others added 2 commits August 9, 2024 08:48

optimize code

2f610f8

Merge branch 'master' into kkumar-gcc/#449

e4fc6b6

krishankumar01 requested a review from hwbrzzl August 9, 2024 03:23

hwbrzzl reviewed Aug 9, 2024

View reviewed changes

krishankumar01 added 2 commits August 9, 2024 20:36

remove deprecated

21222ae

Merge remote-tracking branch 'origin/kkumar-gcc/#449' into kkumar-gcc…

dd08894

…/#449

krishankumar01 requested a review from hwbrzzl August 9, 2024 15:08

hwbrzzl reviewed Aug 9, 2024

View reviewed changes

remove unnecessary code

d83e1be

krishankumar01 enabled auto-merge (squash) August 9, 2024 15:23

hwbrzzl approved these changes Aug 9, 2024

View reviewed changes

krishankumar01 merged commit bc664f7 into master Aug 9, 2024

krishankumar01 deleted the kkumar-gcc/#449 branch August 9, 2024 16:00


		w := NewStreamWriter(r.instance)

		clientGone := r.instance.Writer.CloseNotify()

feat: [#449] Implement HTTP response stream #77

feat: [#449] Implement HTTP response stream #77

Uh oh!

Conversation

krishankumar01 commented Jul 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📑 Description

✅ Checks

Uh oh!

coderabbitai bot commented Jul 31, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Choose a reason for hiding this comment

Uh oh!

krishankumar01 Aug 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

krishankumar01 commented Jul 31, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

krishankumar01 Aug 3, 2024 •

edited

Loading