🧹 chore: Add iterator helpers for client types #3560
Conversation
WalkthroughThis change replaces the callback-based Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Client
participant Cookie/PathParam
User->>Client: Call All() on Cookie/PathParam
Client->>Cookie/PathParam: All() returns iterator
loop For each key, val in All()
Client->>Client: Process key, val
end
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ Context from checks skipped due to timeout of 90000ms (3)
✨ 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 (
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces new iterator helpers for client types by adding All iterators for Cookie and PathParam, deprecating the VisitAll methods, and updating hooks and documentation to use the new APIs.
- Introduces All() iterators that yield key-value pairs for Cookie and PathParam types.
- Deprecates the VisitAll functions in favor of the new iterator-based approach.
- Updates client docs and hooks to reflect the new APIs.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/client/request.md | Adds documentation for the new All iterators on Cookie and PathParam. |
| docs/client/hooks.md | Updates example code to use All() iterators instead of VisitAll. |
| client/request.go | Implements new All() iterators and deprecates VisitAll for Cookie and PathParam. |
| client/hooks.go | Refactors header, cookie, and path parameter iteration to use All() iterators. |
Comments suppressed due to low confidence (3)
docs/client/request.md:1210
- Clarify in the documentation that the keys and values returned by All() should not be stored beyond the loop’s scope to prevent unintended side effects.
**All** returns an iterator over all cookies. The key and value returned
client/request.go:775
- Consider adding a brief inline comment to explain that returning false from yield will terminate the iteration, which can help maintainers understand this control flow decision.
if !yield(k, v) {
client/hooks.go:74
- [nitpick] Ensure consistent formatting and indentation for the new iteration loops across the codebase to enhance readability.
for key, val := range req.path.All() {
![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 @ReneWerner87, 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 modernizes the iteration patterns for Cookie and PathParam types within the client library by introducing new All() methods that return Go 1.22+ iterator sequences. This change aims to provide a more idiomatic and potentially more efficient way to access key-value pairs, while gracefully deprecating the older VisitAll() methods. The update also includes necessary adjustments to internal code that consumes these types and comprehensive documentation updates to guide users on the new API.
Highlights
- New Iterator Methods: Introduced new
All()iterator methods forCookieandPathParamtypes. These methods returniter.Seq2[string, string], leveraging Go's new iterator functionality to provide a more idiomatic way to iterate over key-value pairs. - Deprecation and Delegation: The existing
VisitAll()methods onCookieandPathParamtypes have been deprecated. Their implementations now delegate to the newly introducedAll()iterators, ensuring backward compatibility while encouraging adoption of the new API. - Internal Code Updates: Internal client hooks in
client/hooks.gohave been updated to utilize the newAll()iterators for processing path parameters and cookies, replacing direct calls to the deprecatedVisitAll()methods. - Documentation Updates: The client documentation has been updated to reflect these changes. This includes adding detailed documentation for the new
All()methods indocs/client/request.mdand updating an example indocs/client/hooks.mdto demonstrate the use ofAll()for iterating over response headers.
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. ↩
|
should we remove the VisitorAll function ? |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3560 +/- ##
==========================================
- Coverage 90.97% 90.93% -0.04%
==========================================
Files 110 110
Lines 11064 11066 +2
==========================================
- Hits 10065 10063 -2
- Misses 745 747 +2
- Partials 254 256 +2
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Code Review
This pull request introduces idiomatic iterators for Cookie and PathParam types, which improves the client API. I've identified a potential performance improvement in the URL parsing hook, some leftover comments, and an incorrect code example in the documentation.
|
@ksw2000 check again |
gaby
changed the title
Summary
Alliterators forCookieandPathParamVisitAlland delegate to the new iterators