update pool-config: document all supported config keys in README, clarify inheritance and defaults usage#23
Merged
Merged
Conversation
…rify inheritance and defaults usage - Added a section in the README.md detailing all keys supported for pool configuration tuning using `rq/create-client`. - Clarifies the use of `:inherit-defaults?` flag to opt-out of default pooling settings. - Shows examples for: custom pool config, using Jedis defaults with `:skip`, and totally custom config without fallback defaults. - Rewords some sentences for clarity and documents exact parameter names for easier mapping. - No functional code changes; documentation only. fixed: #22 Signed-off-by: Avelino <31996+avelino@users.noreply.github.com>
Contributor
|
Caution Review failedThe pull request is closed. Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughThis PR introduces configurable Redis connection pool settings. Users can now customize GenericObjectPoolConfig before client creation via the expanded create-client function, supporting multiple arities with optional pool configuration parameters and flexible reference handling. Changes
Sequence DiagramsequenceDiagram
participant User as User Code
participant API as create-client
participant Resolve as resolve-pool-config
participant Build as build-pool-config
participant Pool as create-pool
participant Jedis as JedisPooled
participant Ref as *redis-pool*
User->>API: (url, opts-map)
API->>API: Validate opts keys
API->>Resolve: pool-config from opts
alt pool-config is nil
Resolve->>Build: merge defaults
Build->>Resolve: GenericObjectPoolConfig
else pool-config is :skip
Resolve->>Resolve: Return :skip
else existing GenericObjectPoolConfig
Resolve->>Resolve: Return as-is
end
API->>Pool: url + resolved config
Pool->>Jedis: new JedisPooled(uri, config)
alt ref? = true
API->>Ref: Store pool
API->>User: Return stored pool
else ref? = false
API->>User: Return atom-wrapped pool
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Comment |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds configurable connection pool settings to the Redis client, allowing users to customize GenericObjectPoolConfig parameters when creating a client. Previously, the library relied on Jedis' default pool configuration without any customization options.
- Added pool configuration support with sensible defaults (max-total: 128, min-idle: 16, health checks enabled)
- Implemented flexible configuration resolution supporting maps, instances, or
:skipkeyword - Updated
create-clientto accept an options map as the second parameter (backward compatible)
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/com/moclojer/rq.clj | Core implementation: added pool configuration data structures, resolution logic, and updated create-client to support options map |
| test/com/moclojer/rq_test.clj | Comprehensive tests for pool configuration resolution and options map usage |
| README.md | Documentation for pool configuration feature with usage examples and supported keys |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -166,7 +165,35 @@ The `clj-rq` library provides a set of pub/sub functions that facilitate message | |||
| ```clojure | |||
| (rq-pubsub/unarquive-channel! client "my-channel") | |||
There was a problem hiding this comment.
Corrected spelling of 'unarquive' to 'unarchive'.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/com/moclojer/rq.clj (1)
138-144: Restore global pool reuse whenref?is true.When
ref?is true and*redis-pool*already holds a pool, we should hand that ref back without creating (and leaking) anotherJedisPooled. The current logic always builds a new pool and wraps it in a fresh atom, so callers lose the shared ref and we allocate an unused connection.([url ref? pool-config] - (let [pool (create-pool url pool-config) - store? (boolean ref?)] - (if (and store? (not @*redis-pool*)) - (dosync - (ref-set *redis-pool* pool) - *redis-pool*) - (atom pool)))) + (let [store? (boolean ref?)] + (if (and store? @*redis-pool*) + *redis-pool* + (let [pool (create-pool url pool-config)] + (if store? + (dosync + (ref-set *redis-pool* pool) + *redis-pool*) + (atom pool))))))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(2 hunks)src/com/moclojer/rq.clj(2 hunks)test/com/moclojer/rq_test.clj(2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2024-09-05T10:25:29.194Z
Learnt from: J0sueTM
Repo: moclojer/clj-rq PR: 0
File: :0-0
Timestamp: 2024-09-05T10:25:29.194Z
Learning: The `src/com/moclojer/rq/pubsub.clj` file contains the following functions: `publish!`, `group-handlers-by-channel`, `create-listener`, `unarquive-channel!`, `pack-workers-channels`, and `subscribe!`.
Applied to files:
README.md
📚 Learning: 2024-07-03T18:17:54.022Z
Learnt from: J0sueTM
Repo: moclojer/clj-rq PR: 5
File: test/com/moclojer/rq/pubsub_test.clj:8-27
Timestamp: 2024-07-03T18:17:54.022Z
Learning: In the `pubsub-test` function, the user prefers not to include `close-client` in the `finally` block, arguing that the client will be down automatically if there's a problem.
Applied to files:
README.md
📚 Learning: 2024-10-08T19:16:22.185Z
Learnt from: J0sueTM
Repo: moclojer/clj-rq PR: 6
File: src/com/moclojer/rq/queue.clj:10-13
Timestamp: 2024-10-08T19:16:22.185Z
Learning: In the `push!` function of `src/com/moclojer/rq/queue.clj`, options are passed directly as keyword arguments, not within a map.
Applied to files:
src/com/moclojer/rq.clj
Member
Author
|
@coderabbitai generate docstrings |
Contributor
✅ Actions performedInitiated docstring generation; will generate only if new commits exist. |
Contributor
|
Caution Docstrings generation - FAILED No docstrings were generated. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
rq/create-client.:inherit-defaults?flag to opt-out of default pooling settings.:skip, and totally custom config without fallback defaults.fixed: #22
Summary by CodeRabbit
Release Notes
New Features
Documentation
Tests
✏️ Tip: You can customize this high-level summary in your review settings.