♻️ Refactor: improve iterator performance. #3562
Conversation
```
goos: darwin
goarch: arm64
pkg: github.com/gofiber/fiber/v3/client
cpu: Apple M4
│ old.txt │ new.txt │
│ sec/op │ sec/op vs base │
_Request_Headers-10 140.15n ± 0% 99.39n ± 1% -29.08% (n=50)
_Request_Params-10 135.70n ± 0% 41.01n ± 0% -69.78% (n=50)
_Request_AllFormData-10 135.60n ± 0% 94.67n ± 0% -30.18% (n=50)
_Headers-10 291.3n ± 0% 156.8n ± 1% -46.17% (n=50)
geomean 165.6n 88.20n -46.73%
│ old.txt │ new.txt │
│ B/op │ B/op vs base │
_Request_Headers-10 200.0 ± 0% 184.0 ± 0% -8.00% (n=50)
_Request_Params-10 232.00 ± 0% 88.00 ± 0% -62.07% (n=50)
_Request_AllFormData-10 232.0 ± 0% 184.0 ± 0% -20.69% (n=50)
_Headers-10 296.0 ± 0% 376.0 ± 0% +27.03% (p=0.000 n=50)
geomean 237.6 182.9 -23.00%
│ old.txt │ new.txt │
│ allocs/op │ allocs/op vs base │
_Request_Headers-10 7.000 ± 0% 6.000 ± 0% -14.29% (n=50)
_Request_Params-10 9.000 ± 0% 4.000 ± 0% -55.56% (n=50)
_Request_AllFormData-10 9.000 ± 0% 6.000 ± 0% -33.33% (n=50)
_Headers-10 9.000 ± 0% 6.000 ± 0% -33.33% (n=50)
geomean 8.452 5.422 -35.85%
```
WalkthroughThe changes standardize map iteration in request parameter handling by introducing a Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant Request
participant PairSorter
participant MapsUtil
Client->>Request: Call Params()/AllFormData()
Request->>PairSorter: Collect and sort key-value pairs
PairSorter-->>Request: Sorted pairs
Request->>Client: Yield sorted key-value pairs
Client->>Request: Call Cookies()/PathParams()
Request->>MapsUtil: Retrieve all entries
MapsUtil-->>Request: All key-value pairs
Request->>Client: Return all pairs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🧠 Learnings (2)📓 Common learningsclient/request.go (4)🔇 Additional comments (10)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ksw2000, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request focuses on enhancing the performance of several iterator methods within the Request and Response objects by optimizing their time complexity. It also includes refactoring efforts to streamline other iterator and reset methods, making the codebase more efficient and leveraging modern Go language features.
Highlights
- Performance Optimization: The time complexity for iterator methods
Request.Headers(),Request.AllFormData(), andResponse.Headers()has been significantly reduced from O(n^2) to O(n log n). This was achieved by collecting all key-value pairs, sorting them, and then iterating, leading to substantial improvements in execution time, memory allocations, and bytes allocated as demonstrated by the provided benchmarks. - Behavioral Change for
Request.Params(): TheRequest.Params()method has been updated to iterate over form data (r.formData) instead of its previous parameter source (r.params). This change also incorporates the O(n log n) performance optimization. - Code Simplification and Refactoring: The implementations of
Request.Cookies(),Request.PathParams(),Cookie.All(),Cookie.Reset(),PathParam.All(), andPathParam.Reset()have been simplified. This was done by directly calling existing helper functions likemaps.All()for iteration and utilizing theclear()built-in function for resetting maps, leading to more concise and idiomatic Go code.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request improves iterator performance by reducing time complexity from O(n^2) to O(n log n) for several methods. However, there are a few critical issues related to slice indexing and data sources that need to be addressed to ensure the correctness of the changes. The Request.Params() method was also incorrectly changed to use form data, which needs to be corrected to use query parameters instead.
2 participants
Description
Reduce iterator time complexity from O(n2) to O(n log n)
Request.Params()Request.AllFormData()Refactor: call existing functions directly
Request.Cookies()Request.PathParams()Cookie.All()Cookie.Reset()PathParam.All()PathParam.Reset()Type of change
Checklist
Before you submit your pull request, please make sure you meet these requirements:
/docs/directory for Fiber's documentation.