Updates for list filters API #1257
Conversation
Adds query params `stream`, `user_id`, and `type` to the endpoint
WalkthroughThe changes add a new structure, Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant L as List Function
participant R as Regex Parser
C->>L: Send HTTP GET with query parameters
alt Query string is present
L->>R: Apply FILTER_QUERY_PARAMS_RE on query string
R-->>L: Return captured values (stream, user_id, type)
else No query string
L->>L: Use default filtering logic
end
L->>C: Return filtered user list
Poem
✨ 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:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
src/handlers/http/users/filters.rs (3)
57-71: Unnecessary regex cloning could be removed.Line 59 clones the static regex unnecessarily. The regex can be used directly without cloning.
- let re = FILTER_QUERY_PARAMS_RE.clone(); - - for cap in re.captures_iter(query_string) { + for cap in FILTER_QUERY_PARAMS_RE.captures_iter(query_string) {
77-79: Unnecessary cloning in user_id filter condition.The code unnecessarily clones the user_id value before unwrapping it, which could be avoided.
- filters.retain(|f| f.user_id == Some(params.user_id.clone().unwrap())); + filters.retain(|f| f.user_id.as_ref() == Some(¶ms.user_id.as_ref().unwrap()));
81-83: Unnecessary cloning in type_param filter condition.Similar to the user_id filter, there's unnecessary cloning of the type_param value.
- filters.retain(|f| f.query.filter_type == params.type_param.clone().unwrap()); + filters.retain(|f| f.query.filter_type == *params.type_param.as_ref().unwrap());
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/handlers/http/users/filters.rs(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: coverage
- GitHub Check: Build Default x86_64-pc-windows-msvc
- GitHub Check: Build Default aarch64-unknown-linux-gnu
- GitHub Check: Build Default x86_64-apple-darwin
- GitHub Check: Build Kafka x86_64-unknown-linux-gnu
- GitHub Check: Build Default x86_64-unknown-linux-gnu
- GitHub Check: Build Default aarch64-apple-darwin
- GitHub Check: Quest Smoke and Load Tests for Distributed deployments
- GitHub Check: Quest Smoke and Load Tests for Standalone deployments
🔇 Additional comments (6)
src/handlers/http/users/filters.rs (6)
34-36: Good addition of necessary dependencies for regex-based parameter extraction.The imports of
once_cell::sync::Lazyandregex::Regexare appropriate for implementing the query parameter filtering functionality.
38-44: Well-structured parameter encapsulation.The
FilterQueryParamsstruct provides a clean way to encapsulate the query parameters with appropriate use ofOption<String>for optional values. Thetype_paramfield name is a good choice to avoid conflict with the Rust keywordtype.
45-47: Effective pattern matching for query parameters.The
FILTER_QUERY_PARAMS_REregex is well-designed to extract query parameters regardless of their position in the query string. UsingLazyensures the regex is compiled only once.
51-56: Good handling of empty query case.Making
filtersmutable and adding an early return for empty query strings is an efficient approach that maintains backward compatibility.
73-75: Good filtering implementation for stream parameter.The filtering logic correctly uses
retainto keep only the filters matching the provided stream name.
85-86: Overall implementation enhances API functionality.The implementation successfully adds the requested query parameter filtering capability to the list endpoint, meeting the PR objectives.
Adds query params
stream,user_id, andtypeto the endpointFixes #XXXX.
Description
This PR has:
Summary by CodeRabbit