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

♻️ Refactor: Reduce the Memory Usage of ignoreHeaders #3322

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ksw2000
Copy link
Contributor

@ksw2000 ksw2000 commented Feb 23, 2025

Description

When the value of a map is not used, using struct{} instead of any can significantly reduce memory usage. The following experiment demonstrates the improvement:

  • Go 1.24: Memory usage reduced from 616 bytes to 456 bytes. (-26%)
  • Go 1.23: Memory usage reduced from 576 bytes to 288 bytes. (-50%)

This change helps optimize memory consumption, making it more efficient when the value is not needed.

Go 1.24 introduced optimizations in the map implementation, further affecting memory consumption.

func main() {
	before := getMemUsage()
	ignoreHeaders := map[string]any{
		"Connection":          nil,
		"Keep-Alive":          nil,
		"Proxy-Authenticate":  nil,
		"Proxy-Authorization": nil,
		"TE":                  nil,
		"Trailers":            nil,
		"Transfer-Encoding":   nil,
		"Upgrade":             nil,
		"Content-Type":        nil,
		"Content-Encoding":    nil,
	}
	after := getMemUsage()
	fmt.Printf("Map memory usage: %d bytes\n", after-before)
	delete(ignoreHeaders, "")
}

func getMemUsage() uint64 {
	var m runtime.MemStats
	runtime.ReadMemStats(&m)
	return m.Alloc
}
  • In go 1.23: 576 bytes
  • In go 1.24: 616 bytes
func main() {
	before := getMemUsage()
	ignoreHeaders := map[string]struct{}{
		"Connection":          {},
		"Keep-Alive":          {},
		"Proxy-Authenticate":  {},
		"Proxy-Authorization": {},
		"TE":                  {},
		"Trailers":            {},
		"Transfer-Encoding":   {},
		"Upgrade":             {},
		"Content-Type":        {},
		"Content-Encoding":    {},
	}
	after := getMemUsage()
	fmt.Printf("Map memory usage: %d bytes\n", after-before)
	delete(ignoreHeaders, "")
}

func getMemUsage() uint64 {
	var m runtime.MemStats
	runtime.ReadMemStats(&m)
	return m.Alloc
}
  • In go 1.23: 288 bytes
  • In go 1.24: 456 bytes

Type of change

Please delete options that are not relevant.

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

Checklist

Before you submit your pull request, please make sure you meet these requirements:

  • Followed the inspiration of the Express.js framework for new functionalities, making them similar in usage.
  • Conducted a self-review of the code and provided comments for complex or critical parts.
  • Updated the documentation in the /docs/ directory for Fiber's documentation.
  • Added or updated unit tests to validate the effectiveness of the changes or new features.
  • Ensured that new and existing unit tests pass locally with the changes.
  • Verified that any new dependencies are essential and have been agreed upon by the maintainers/community.
  • Aimed for optimal performance with minimal allocations in the new code.
  • Provided benchmarks for the new code to analyze and improve upon.

@ksw2000 ksw2000 requested a review from a team as a code owner February 23, 2025 16:47
@ksw2000 ksw2000 requested review from gaby, sixcolors, ReneWerner87 and efectn and removed request for a team February 23, 2025 16:47
Copy link
Contributor

coderabbitai bot commented Feb 23, 2025

Walkthrough

The pull request alters a variable declaration in the cache middleware. The ignoreHeaders variable in middleware/cache/cache.go now uses a map with empty struct values instead of the any type. This change refines the data structure to improve memory efficiency while leaving the caching functionality and behavior unchanged.

Changes

File(s) Change Summary
middleware/cache/cache.go Changed type of ignoreHeaders from map[string]any to map[string]struct{} to optimize memory usage by using empty struct values.

Poem

Hoppin' in code, I twirl with glee,
Changing headers now set free.
Maps refined with empty grace,
Memory saved in every space.
A rabbit cheers each smart decree! 🐰✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4b62d3d and 157731b.

📒 Files selected for processing (1)
  • middleware/cache/cache.go (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • middleware/cache/cache.go
⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: unit (1.23.x, macos-13)
  • GitHub Check: unit (1.23.x, windows-latest)
  • GitHub Check: Compare
  • GitHub Check: Analyse
  • GitHub Check: repeated

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.

Copy link

codecov bot commented Feb 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.14%. Comparing base (4b62d3d) to head (2cd8495).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3322      +/-   ##
==========================================
- Coverage   84.21%   84.14%   -0.07%     
==========================================
  Files         116      116              
  Lines       11558    11558              
==========================================
- Hits         9734     9726       -8     
- Misses       1395     1401       +6     
- Partials      429      431       +2     
Flag Coverage Δ
unittests 84.14% <ø> (-0.07%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@gaby gaby changed the title ♻️ Refactor: Reduce the Memory Usage of ignoreHeaders ♻️ refactor: Reduce the Memory Usage of ignoreHeaders Feb 23, 2025
Copy link
Member

@gaby gaby left a comment

Choose a reason for hiding this comment

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

👍 LGTM, great find!

@gaby gaby changed the title ♻️ refactor: Reduce the Memory Usage of ignoreHeaders ♻️ Refactor: Reduce the Memory Usage of ignoreHeaders Feb 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants