redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-04 15:02:09 +03:00
Code Activity

fix #2665 - handle errors in multi/pipeline replies (#2666)

Browse Source 
* fix #2665 - handle errors in multi/pipeline replies

* fix MultiErrorReply replies type

* run tests on all versions, remove console.log, fix bug

* add errors iterator helper

* test `.errors()` as well
This commit is contained in:
Leibale Eidelman
2023-12-18 15:15:21 -05:00
committed by GitHub
parent d6d2064c72
commit f4680f0849
3 changed files with 52 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
packages/client/lib/client/index.spec.ts
View File

@@ -3,7 +3,7 @@ import testUtils, { GLOBAL, waitTillBeenCalled } from '../test-utils';
import RedisClient, { RedisClientType } from '.'; import RedisClient, { RedisClientType } from '.';
import { RedisClientMultiCommandType } from './multi-command'; import { RedisClientMultiCommandType } from './multi-command';
import { RedisCommandRawReply, RedisModules, RedisFunctions, RedisScripts } from '../commands'; import { RedisCommandRawReply, RedisModules, RedisFunctions, RedisScripts } from '../commands';
import { AbortError, ClientClosedError, ClientOfflineError, ConnectionTimeoutError, DisconnectsClientError, SocketClosedUnexpectedlyError, WatchError } from '../errors'; import { AbortError, ClientClosedError, ClientOfflineError, ConnectionTimeoutError, DisconnectsClientError, ErrorReply, MultiErrorReply, SocketClosedUnexpectedlyError, WatchError } from '../errors';
import { defineScript } from '../lua-script'; import { defineScript } from '../lua-script';
import { spy } from 'sinon'; import { spy } from 'sinon';
import { once } from 'events'; import { once } from 'events';
@@ -602,6 +602,23 @@ describe('Client', () => {
...GLOBAL.SERVERS.OPEN, ...GLOBAL.SERVERS.OPEN,
minimumDockerVersion: [6, 2] // CLIENT INFO minimumDockerVersion: [6, 2] // CLIENT INFO
}); });
testUtils.testWithClient('should handle error replies (#2665)', async client => {
await assert.rejects(
client.multi()
.set('key', 'value')
.hGetAll('key')
.exec(),
err => {
assert.ok(err instanceof MultiErrorReply);
assert.equal(err.replies.length, 2);
assert.deepEqual(err.errorIndexes, [1]);
assert.ok(err.replies[1] instanceof ErrorReply);
assert.deepEqual([...err.errors()], [err.replies[1]]);
return true;
}
);
}, GLOBAL.SERVERS.OPEN);
}); });
testUtils.testWithClient('scripts', async client => { testUtils.testWithClient('scripts', async client => {

19
packages/client/lib/errors.ts
View File

@@ -1,3 +1,5 @@
import { RedisCommandRawReply } from './commands';
export class AbortError extends Error { export class AbortError extends Error {
constructor() { constructor() {
super('The command was aborted'); super('The command was aborted');
@@ -63,3 +65,20 @@ export class ErrorReply extends Error {
this.stack = undefined; this.stack = undefined;
} }
} }
export class MultiErrorReply extends ErrorReply {
replies;
errorIndexes;
constructor(replies: Array<RedisCommandRawReply | ErrorReply>, errorIndexes: Array<number>) {
super(`${errorIndexes.length} commands failed, see .replies and .errorIndexes for more information`);
this.replies = replies;
this.errorIndexes = errorIndexes;
}
*errors() {
for (const index of this.errorIndexes) {
yield this.replies[index];
}
}
}

22
packages/client/lib/multi-command.ts
View File

@@ -1,6 +1,6 @@
import { fCallArguments } from './commander'; import { fCallArguments } from './commander';
import { RedisCommand, RedisCommandArguments, RedisCommandRawReply, RedisFunction, RedisScript } from './commands'; import { RedisCommand, RedisCommandArguments, RedisCommandRawReply, RedisFunction, RedisScript } from './commands';
import { WatchError } from './errors'; import { ErrorReply, MultiErrorReply, WatchError } from './errors';
export interface RedisMultiQueuedCommand { export interface RedisMultiQueuedCommand {
args: RedisCommandArguments; args: RedisCommandArguments;
@@ -69,7 +69,7 @@ export default class RedisMultiCommand {
return transformedArguments; return transformedArguments;
} }
handleExecReplies(rawReplies: Array<RedisCommandRawReply>): Array<RedisCommandRawReply> { handleExecReplies(rawReplies: Array<RedisCommandRawReply | ErrorReply>): Array<RedisCommandRawReply> {
const execReply = rawReplies[rawReplies.length - 1] as (null | Array<RedisCommandRawReply>); const execReply = rawReplies[rawReplies.length - 1] as (null | Array<RedisCommandRawReply>);
if (execReply === null) { if (execReply === null) {
throw new WatchError(); throw new WatchError();
@@ -78,10 +78,18 @@ export default class RedisMultiCommand {
return this.transformReplies(execReply); return this.transformReplies(execReply);
} }
transformReplies(rawReplies: Array<RedisCommandRawReply>): Array<RedisCommandRawReply> { transformReplies(rawReplies: Array<RedisCommandRawReply | ErrorReply>): Array<RedisCommandRawReply> {
return rawReplies.map((reply, i) => { const errorIndexes: Array<number> = [],
const { transformReply, args } = this.queue[i]; replies = rawReplies.map((reply, i) => {
return transformReply ? transformReply(reply, args.preserve) : reply; if (reply instanceof ErrorReply) {
}); errorIndexes.push(i);
return reply;
}
const { transformReply, args } = this.queue[i];
return transformReply ? transformReply(reply, args.preserve) : reply;
});
if (errorIndexes.length) throw new MultiErrorReply(replies, errorIndexes);
return replies;
} }
} }