Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 bug: Use Content-Length for bytesReceived and bytesSent tags in Logger Middleware in v2 #3067

Merged
merged 1 commit into from
Jul 18, 2024

Conversation

gaby
Copy link
Member

@gaby gaby commented Jul 9, 2024

Description

  • Use Content-Length header when calculating the bytesSent and bytesReceived tags in the Logger Middleware.
    • The current implementation will load big files to memory to calculate the len causing Fiber to use a high amount of RAM.

Fixes #3060

Type of change

  • Performance improvement (non-breaking change which improves efficiency)
  • Code consistency (non-breaking change which improves code reliability and robustness)

Copy link
Contributor

coderabbitai bot commented Jul 9, 2024

Walkthrough

Recent changes to the logger middleware in the Go-Fiber framework address an issue causing out-of-memory errors when downloading large files. These modifications involve adjusting how content length is computed and logged, and updating related test cases to match the new expectations.

Changes

Files/Group Change Summary
middleware/logger/logger_test.go Updated test cases to reflect new behavior in content length logging.
middleware/logger/tags.go Imported strconv and modified TagBytesReceived and TagBytesSent functions to utilize strconv.Itoa.

Assessment against linked issues

Objective Addressed Explanation
🐛 [Bug]: Prevent OOM when using logger ${bytesSent} and ${bytesReceived} (#3060)

Poem

In lines of code, solutions we weave,
To stop the logger's memory thieve.
With strconv added, bytes we count,
No more will memory threats mount.
Now Fiber sails, strong and stout,
Without the fear of running out.


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 Configration 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
Contributor

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6968d51 and b990caa.

Files selected for processing (2)
  • middleware/logger/logger_test.go (2 hunks)
  • middleware/logger/tags.go (2 hunks)
Additional comments not posted (6)
middleware/logger/tags.go (3)

5-5: LGTM!

The import of the strconv package is appropriate for converting integers to strings.


89-89: LGTM!

Using strconv.Itoa to convert the content length to a string is a correct approach.

Ensure that the function handles cases where the content length is not set or is zero.


92-92: LGTM!

Using strconv.Itoa to convert the content length to a string is a correct approach.

Ensure that the function handles cases where the content length is not set or is zero.

middleware/logger/logger_test.go (3)

389-389: LGTM!

Setting the content length to 5 is necessary to test the updated TagBytesSent function.


396-396: Update expected output.

The expected output has been correctly updated to "-2 5 200" to reflect the changes in the TagBytesSent function.

Ensure the test covers all relevant cases, including when the content length is not set.


633-633: Update expected output.

The expected output has been correctly updated to "-2 -1 200" to reflect the changes in the TagBytesSent function.

Ensure the test covers all relevant cases, including when the content length is not set.

@ReneWerner87 ReneWerner87 added this to the Next Release milestone Jul 18, 2024
@ReneWerner87 ReneWerner87 merged commit 1c52689 into v2 Jul 18, 2024
21 checks passed
@gaby gaby deleted the fix-3060-v2 branch July 21, 2024 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants