topk commands don't work?

[simonprickett]

Description

When running the stock topk example from the examples folder and using node-redis 5.8.3 I see this:

topk % node topk.js
Error, maybe RedisBloom is not installed?:
TypeError: Cannot read properties of undefined (reading 'reserve')
    at file:///Users/simon/tmp/topk/topk.js:18:21
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
file:///Users/simon/tmp/topk/topk.js:51
  await client.topK.incrBy('mytopk', {
                    ^

TypeError: Cannot read properties of undefined (reading 'incrBy')
    at file:///Users/simon/tmp/topk/topk.js:51:21
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)

Command is in my Redis instance which is a latest Redis Stack Docker container:

127.0.0.1:6379> topk.incrby
(error) ERR wrong number of arguments for 'topk.incrby' command

Running the script:

topk % node topk.js
Error, maybe RedisBloom is not installed?:
TypeError: Cannot read properties of undefined (reading 'reserve')
    at file:///Users/simon/tmp/topk/topk.js:18:21
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
file:///Users/simon/tmp/topk/topk.js:51
  await client.topK.incrBy('mytopk', {
                    ^

TypeError: Cannot read properties of undefined (reading 'incrBy')
    at file:///Users/simon/tmp/topk/topk.js:51:21
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)

Node.js v24.6.0

Code (which is just the example from the examples folder):

// This example demonstrates the use of the Top K
// in the RedisBloom module (https://redis.io/docs/stack/bloom/)

import { createClientPool } from 'redis';

const client = createClientPool({
  url: 'redis://localhost:6379'
});

await client.connect();

// Delete any pre-existing Top K.
await client.del('mytopk');

// Reserve a Top K to track the 10 most common items.
// https://redis.io/commands/topk.reserve/
try {
  await client.topK.reserve('mytopk', 10, { width: 400, depth: 10, decay: 0.9 });
  console.log('Reserved Top K.');
} catch (e) {
  if (e.message.endsWith('key already exists')) {
    console.log('Top K already reserved.');
  } else {
    console.log('Error, maybe RedisBloom is not installed?:');
    console.log(e);
  }
}

const teamMembers = [
  'leibale',
  'simon',
  'guy',
  'suze',
  'brian',
  'steve',
  'kyleb',
  'kyleo',
  'josefin',
  'alex',
  'nava',
  'lance',
  'rachel',
  'kaitlyn'
];

// Add random counts for random team members with TOPK.INCRBY
// https://redis.io/commands/topk.incrby/
for (let n = 0; n < 1000; n++) {
  const teamMember = teamMembers[Math.floor(Math.random() * teamMembers.length)];
  const points = Math.floor(Math.random() * 1000) + 1;
  await client.topK.incrBy('mytopk', {
    item: teamMember,
    incrementBy: points
  });
  console.log(`Added ${points} points for ${teamMember}.`);
}

// List out the top 10 with TOPK.LIST
// https://redis.io/commands/topk.list/
const top10 = await client.topK.list('mytopk');
console.log('The top 10:');
// top10 looks like this:
//   [
//     'guy',     'nava',
//     'kaitlyn', 'brian',
//     'simon',   'suze',
//     'lance',   'alex',
//     'steve',   'kyleo'
// ]
console.log(top10);

// List out the top 10 with their counts (requires RedisBloom >=2.2.9)
// https://redis.io/commands/topk.list/
const top10WithCounts = await client.topK.listWithCount('mytopk');
console.log('The top 10 with counts:');
console.log(top10WithCounts);
// top10WithCounts looks like this:
// [
//    { item: 'suze', count: 42363 },
//    { item: 'lance', count: 41982 },
//    { item: 'simon', count: 41831 },
//    { item: 'steve', count: 39237 },
//    { item: 'guy', count: 39078 },
//    { item: 'kyleb', count: 37338 },
//    { item: 'leibale', count: 34230 },
//    { item: 'kyleo', count: 33812 },
//    { item: 'alex', count: 33679 },
//    { item: 'nava', count: 32663 }
// ]

// Check if a few team members are in the top 10 with TOPK.QUERY:
// https://redis.io/commands/topk.query/
const [ steve, suze, leibale, frederick ] = await client.topK.query('mytopk', [
  'steve',
  'suze',
  'leibale',
  'frederick'
]);

console.log(`steve ${steve ? 'is': 'is not'} in the top 10.`);
console.log(`suze ${suze ? 'is': 'is not'} in the top 10.`);
console.log(`leibale ${leibale ? 'is': 'is not'} in the top 10.`);
console.log(`frederick ${frederick ? 'is': 'is not'} in the top 10.`);

// Get count estimate for some team members with TOPK.COUNT:
// https://redis.io/commands/topk.count/
const [ simonCount, lanceCount ] = await client.topK.count('mytopk', [
  'simon',
  'lance'
]);

console.log(`Count estimate for simon: ${simonCount}.`);
console.log(`Count estimate for lance: ${lanceCount}.`);

client.close();

Script source here fails to create the topk too, it's like no topk commands are working.

Node.js Version

24.6.0

Redis Server Version

7.4.5 (Redis Stack)

Node Redis Version

5.8.3

Platform

macOS

Logs

[nkaradzhov]

Hi @simonprickett, I was able to reproduce your issue intermittently. Still trying to figure out why the functions are there sometimes and not there some other times...

While investigating this, I found another issue with the createClientPool function which I will address in a separate PR.

Lastly, if you wanna use topk and all other bf stuff, you dont need to use a pool. You can substitute const client = createClientPool... with const client = createClient... ( thats actually what we have in the example ) - this is the default and desirable way to use this library. Pool is only needed if you have blocking commands, otherwise there arent any real benefits of using a pool vs a standalone client. So I would suggest you go with standalone client via createClient. If you still insist on using a pool, you can use the pool.execute(async client => {/*do stuff*/}) function. It should work properly.

[simonprickett]

Hi @nkaradzhov I can confirm that I don't get this behavior when I run the code using createClient.