contrib icon indicating copy to clipboard operation
contrib copied to clipboard

[otelfiber] fix: when body is stream middleware read everything into memory first, no streaming to client

Open Alantoo opened this issue 1 year ago • 6 comments

Bug Description When application stream some file middleware reads all the streamed data into the memory to calculate response size which can consume all the available memory.

How to Reproduce Steps to reproduce the behavior:

  • Stream some binary data from handler

Expected Behavior The middleware should skip response/request body size calculation when body is stream

Summary by CodeRabbit

  • New Features
    • Enhanced request and response body size handling, including stream management for improved performance and resource utilization.
  • Tests
    • Implemented new tests for streaming response body functionalities to ensure reliability and efficiency.

Alantoo avatar Jan 29 '24 09:01 Alantoo

@Alantoo could you pls provide a unittest for this case?

ReneWerner87 avatar Jan 29 '24 09:01 ReneWerner87

@Alantoo friendly ping

ReneWerner87 avatar Feb 09 '24 16:02 ReneWerner87

Walkthrough

The recent modifications introduce enhancements in handling request and response body sizes, particularly focusing on stream handling. This includes the introduction of a new struct for reading body stream sizes and improvements in testing capabilities for streamed response bodies by implementing a fake file interface and its concrete counterpart.

Changes

File(s) Summary
otelfiber/fiber.go - Added import for github.com/valyala/fasthttp and io
- Added bodyStreamSizeReader struct and Read method
- Modified handling of request and response body sizes, including stream handling
otelfiber/otelfiber_test/fiber_test.go - Added a new fakeFile interface and its implementation fakeFileImpl with a Read method for streaming response body testing in the TestStreamedResponseBody function

🐇✨
In the realm of code, where streams do flow,
A rabbit hopped, with changes in tow.
"Let's measure," it said, "the size of the stream,
And test with a fake, a coder's dream."
With a hop and a skip, improvements were sown,
In the land of the fibers, where speed is grown.
🚀📈

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot] avatar Mar 05 '24 13:03 coderabbitai[bot]

@Alantoo friendly ping

Hey. Sorry for long delay. Unfortunately had no time to work on it. I've pushed test to make sure response size computed in lazy way correctly. Please let me know if its fine or I should fix anything else. Thank you

Alantoo avatar Mar 05 '24 13:03 Alantoo

@Alantoo pls fix this image

ReneWerner87 avatar Mar 06 '24 08:03 ReneWerner87

@Alantoo image

but we still support go 1.19.x

ReneWerner87 avatar Mar 07 '24 15:03 ReneWerner87