feat: Add command timeout #2981
Open
+82
−8
Conversation
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
florian-schunk
force-pushed
the
addCommandTimeout
branch
3 times, most recently
from
4ad6a4a to
90f8fe9
Compare
florian-schunk
force-pushed
the
addCommandTimeout
branch
from
90f8fe9 to
e8eb95b
Compare
|
Hi @nkaradzhov sorry for pinging you directly, but I couldn't find information on how to contact maintainers for this project. |
|
@florian-schunk hi, sorry for the delay, been a bit busy. I will take a look at this. |
nkaradzhov
requested changes
Jun 19, 2025
Comment on lines
+896
to
+910
| let controller: AbortController; | ||
| if (this._self.#options?.commandTimeout) { | ||
| controller = new AbortController() | ||
| let abortSignal = controller.signal; | ||
| if (options?.abortSignal) { | ||
| abortSignal = AbortSignal.any([ | ||
| abortSignal, | ||
| options.abortSignal | ||
| ]); | ||
| } | ||
| options = { | ||
| ...options, | ||
| abortSignal | ||
| } | ||
| } |
There was a problem hiding this comment.
We can simplify this by using the AbortSignal.timeout static method:
if (this._self.#options?.commandTimeout) {
let abortSignal = AbortSignal.timeout(
this._self.#options?.commandTimeout
);
if (options?.abortSignal) {
abortSignal = AbortSignal.any([abortSignal, options.abortSignal]);
}
options = {
...options,
abortSignal
};
}
There was a problem hiding this comment.
I tried this, also together with the change in the test that you proposed, but somehow for me the test keeps failing with this approach. I am not quite understanding, why.
packages/client/lib/client/index.ts
Outdated
Comment on lines
912
to
930
|
|
||
| this._self.#scheduleWrite(); | ||
| return promise; | ||
| if (!this._self.#options?.commandTimeout) { | ||
| return promise; | ||
| } | ||
|
|
||
| return new Promise<T>((resolve, reject) => { | ||
| const timeoutId = setTimeout(() => { | ||
| controller.abort(); | ||
| reject(new CommandTimeoutError()); | ||
| }, this._self.#options?.commandTimeout) | ||
| promise.then(result => { | ||
| clearInterval(timeoutId); | ||
| resolve(result) | ||
| }).catch(error => { | ||
| clearInterval(timeoutId); | ||
| reject(error) | ||
| }); | ||
| }) |
There was a problem hiding this comment.
Then, this change becomes obsolete
packages/client/lib/errors.ts
Outdated
Comment on lines
25
to
30
| export class CommandTimeoutError extends Error { | ||
| constructor() { | ||
| super('Command timeout'); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
No need to introduce another error, we can use the AbortError
There was a problem hiding this comment.
Ok, I changed it to use AbortError, but couldn't there be situation where it makes sense to distinguish between a timeout and having the command manually aborted? Wouldn't it then make more sense to have a different error?
Comment on lines
285
to
300
| testUtils.testWithClient('CommandTimeoutError', async client => { | ||
| const promise = assert.rejects(client.sendCommand(['PING']), CommandTimeoutError), | ||
| start = process.hrtime.bigint(); | ||
|
|
||
| while (process.hrtime.bigint() - start < 50_000_000) { | ||
| // block the event loop for 1ms, to make sure the connection will timeout | ||
| } | ||
|
|
||
| await promise; | ||
| }, { | ||
| ...GLOBAL.SERVERS.OPEN, | ||
| clientOptions: { | ||
| commandTimeout: 50, | ||
| } | ||
| }); | ||
|
|
There was a problem hiding this comment.
This test would need to change like this:
testUtils.testWithClient('CommandTimeoutError', async client => {
const promise = client.sendCommand(['PING'])
const start = process.hrtime.bigint();
while (process.hrtime.bigint() - start < 50_000_000) {
// block the event loop for 50ms, to make sure the connection will timeout
}
assert.rejects(promise, AbortError);
}, {
...GLOBAL.SERVERS.OPEN,
clientOptions: {
commandTimeout: 50,
}
});
3 tasks
|
I will take a look, maybe will make a pr to your pr
…On Fri, Jun 20, 2025, 6:16 PM florian-schunk ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In packages/client/lib/client/index.ts
<#2981 (comment)>:
> + let controller: AbortController;
+ if (this._self.#options?.commandTimeout) {
+ controller = new AbortController()
+ let abortSignal = controller.signal;
+ if (options?.abortSignal) {
+ abortSignal = AbortSignal.any([
+ abortSignal,
+ options.abortSignal
+ ]);
+ }
+ options = {
+ ...options,
+ abortSignal
+ }
+ }
I tried this, also together with the change in the test that you proposed,
but somehow for me the test keeps failing with this approach. I am not
quite understanding, why.
—
Reply to this email directly, view it on GitHub
<#2981 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AALIHLDULWEBI6J3YYY37E33EQQUVAVCNFSM6AAAAAB6CNSAFSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDSNBWGU2DKMRQGE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
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 PR introduces a timeout for commands sent to redis.
Our use-case is that we are using node-rate-limiter-flexible with node-redis, but sometimes the connection to redis is slow. In these cases we want to fall back the the insurance limiter of node-rate-limiter-flexible.
This feature was also requested in #2175
Checklist
npm testpass with this change (including linting)?