fix(client): include acquire timeout duration in pool timeout error message - #3382
Merged
nkaradzhov merged 1 commit intoJul 30, 2026
Merged
Conversation
nkaradzhov
approved these changes
Jul 30, 2026
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.
Description
This pull request addresses a maintainer TODO comment (
// TODO: message) inpool.tsby formatting theTimeoutErrormessage thrown whenacquireTimeoutexpires while waiting for a client from the pool.Background
Previously, when a task timed out waiting for an available client in
RedisClientPool, the operation rejected with a static stringTimeoutError('Timeout waiting for a client'). This lacked diagnostic details about the configured timeout duration.Key Changes
pool.tsto dynamically include the configured timeout duration in milliseconds:Timeout waiting for a client after ${acquireTimeout}ms.pool.spec.ts(rejects with TimeoutError when acquireTimeout expires) to verify that acquire timeout rejections produce aTimeoutErrorwith the formatted message.Checklist
npm testpass with this change (including linting)?Note
Low Risk
Only the timeout error message text changes; pool acquire logic is unchanged aside from clearer diagnostics.
Overview
When
RedisClientPoolcannot hand out a client beforeacquireTimeout, the rejection now uses aTimeoutErrormessage that includes the configured wait time (e.g.Timeout waiting for a client after 50ms) instead of a fixed string.A pool integration test was added to hold the sole client busy, trigger a second
executewith a shortacquireTimeout, and assert the error type and message.Reviewed by Cursor Bugbot for commit 1f72582. Bugbot is set up for automated code reviews on this repo. Configure here.