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

fix(client): make unstable cmds throw (#2990)

Browse Source 
As per the docs, unstableResp3 commands should throw
when client is created with { RESP: 3, unstableResp3: false|undefined }

fixes #2989
This commit is contained in:
Nikolay Karadzhov
2025-06-06 15:38:52 +03:00
committed by GitHub
parent ca91718b59
commit 62ac8b7c32
4 changed files with 72 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/v5.md
View File

@@ -42,9 +42,9 @@ RESP3 uses a different mechanism for handling Pub/Sub messages. Instead of modif
## Known Limitations ## Known Limitations
### Unstable Module Commands ### Unstable Commands
Some Redis module commands have unstable RESP3 transformations. These commands will throw an error when used with RESP3 unless you explicitly opt in to using them by setting `unstableResp3: true` in your client configuration: Some Redis commands have unstable RESP3 transformations. These commands will throw an error when used with RESP3 unless you explicitly opt in to using them by setting `unstableResp3: true` in your client configuration:
```javascript ```javascript
const client = createClient({ const client = createClient({

4
packages/client/lib/commander.ts
View File

@@ -38,8 +38,12 @@ export function attachConfig<
Class: any = class extends BaseClass {}; Class: any = class extends BaseClass {};
for (const [name, command] of Object.entries(commands)) { for (const [name, command] of Object.entries(commands)) {
if (config?.RESP == 3 && command.unstableResp3 && !config.unstableResp3) {
Class.prototype[name] = throwResp3SearchModuleUnstableError;
} else {
Class.prototype[name] = createCommand(command, RESP); Class.prototype[name] = createCommand(command, RESP);
} }
}
if (config?.modules) { if (config?.modules) {
for (const [moduleName, module] of Object.entries(config.modules)) { for (const [moduleName, module] of Object.entries(config.modules)) {

33
packages/client/lib/commands/XREAD.spec.ts
View File

@@ -131,4 +131,37 @@ describe('XREAD', () => {
client: GLOBAL.SERVERS.OPEN, client: GLOBAL.SERVERS.OPEN,
cluster: GLOBAL.CLUSTERS.OPEN cluster: GLOBAL.CLUSTERS.OPEN
}); });
testUtils.testWithClient('client.xRead should throw with resp3 and unstableResp3: false', async client => {
assert.throws(
() => client.xRead({
key: 'key',
id: '0-0'
}),
{
message: 'Some RESP3 results for Redis Query Engine responses may change. Refer to the readme for guidance'
}
);
}, {
...GLOBAL.SERVERS.OPEN,
clientOptions: {
RESP: 3
}
});
testUtils.testWithClient('client.xRead should not throw with resp3 and unstableResp3: true', async client => {
assert.doesNotThrow(
() => client.xRead({
key: 'key',
id: '0-0'
})
);
}, {
...GLOBAL.SERVERS.OPEN,
clientOptions: {
RESP: 3,
unstableResp3: true
}
});
}); });

32
packages/client/lib/commands/XREADGROUP.spec.ts
View File

@@ -155,4 +155,36 @@ describe('XREADGROUP', () => {
client: GLOBAL.SERVERS.OPEN, client: GLOBAL.SERVERS.OPEN,
cluster: GLOBAL.CLUSTERS.OPEN cluster: GLOBAL.CLUSTERS.OPEN
}); });
testUtils.testWithClient('client.xReadGroup should throw with resp3 and unstableResp3: false', async client => {
assert.throws(
() => client.xReadGroup('group', 'consumer', {
key: 'key',
id: '>'
}),
{
message: 'Some RESP3 results for Redis Query Engine responses may change. Refer to the readme for guidance'
}
);
}, {
...GLOBAL.SERVERS.OPEN,
clientOptions: {
RESP: 3
}
});
testUtils.testWithClient('client.xReadGroup should not throw with resp3 and unstableResp3: true', async client => {
assert.doesNotThrow(
() => client.xReadGroup('group', 'consumer', {
key: 'key',
id: '>'
})
);
}, {
...GLOBAL.SERVERS.OPEN,
clientOptions: {
RESP: 3,
unstableResp3: true
}
});
}); });