Give client a name

[tdimnet]

Hi,

I am trying to add a name to my client when I create it.

On Python, I can do:

cache = redis.Redis(
    host='redis',
    port=6379,
    client_name='flask-app'
)

However I don't find how to do it with node-redis.
Here is how I create my client:

const client = createClient({
    socket: {
        host: 'redis',
        port: 6379
    }
})

I looked at the types definition inside the package but I haven't find something yet.
Should I add it elsewhere?

Thank you,
Tom.

[AnnAngela]

You can use this command to set the name of you client:

await client.sendCommand(["CLIENT", "SETNAME", "YOUR_CLIENT_NAME"]); // the wrong command has been fixed, see below

But it will be nice to have a dedicated command.

[tdimnet]

Hi @AnnAngela

Thank you for your answer!
I tried the command this morning and it still doesn't work. Here is the error message:

/products-api/node_modules/redis-parser/lib/parser.js:179
    return new ReplyError(string)
           ^

ReplyError: ERR unknown command `SETNAME`, with args beginning with: `YOUR_CLIENT_NAME`,
    at parseError (/products-api/node_modules/redis-parser/lib/parser.js:179:12)
    at parseType (/products-api/node_modules/redis-parser/lib/parser.js:302:14)

Once I've found what's wrong, I'll try to create the feature 😄

[tdimnet]

Ok, I've found it!

This is what you should do:

await redisClient.sendCommand(["CLIENT", "SETNAME", "products-api"])

And for instance if I want to pass another command, like CLIENT LIST, I could do:

const clients = await redisClient.sendCommand(["CLIENT", "LIST"])

And here is an example output:

id=8 addr=172.19.0.6:44138 laddr=172.19.0.2:6379 fd=12 name=flask-app age=1960 idle=1960 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 argv-mem=0 obl=0 oll=0 omem=0 tot-mem=20504 events=r cmd=keys user=default redir=-1

id=55 addr=172.19.0.4:44092 laddr=172.19.0.2:6379 fd=13 name=products-api age=120 idle=120 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 argv-mem=0 obl=0 oll=0 omem=0 tot-mem=20504 events=r cmd=get user=default redir=-1

id=5 addr=127.0.0.1:52888 laddr=127.0.0.1:6379 fd=10 name=toto age=4305 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=40928 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 events=r cmd=client user=default redir=-1

[AnnAngela]

@tdimnet sorry I forgot the full command (in V3 the code is client.client(["SETNAME", "YOUR_CLIENT_NAME"], _callback) because the client method automatically prepend CLIENT to the begin of the command)

So basically that's what you should do: just split the command to a array and pass to sendCommand.