createAdapter(pubClient, subClient) breaks subClient.connect(): "Error: Cannot send commands in PubSub mode"

[akifd]

package.json

    "@socket.io/redis-adapter": "7.1.0",
    "redis": "4.0.1",
    "socket.io": "4.4.0"

The Redis itself is running in Docker with the image redis:6.2.6-alpine3.15.

Here is the code that doesn't work for some reason:

import { Server } from 'socket.io'
import { createClient } from 'redis'
import { createAdapter } from '@socket.io/redis-adapter'

const io = new Server()
const pubClient = createClient({url: `redis://redis:6379/1`})
const subClient = pubClient.duplicate()

io.adapter(createAdapter(pubClient, subClient))

Promise.all([pubClient.connect(), subClient.connect()]).then(() => {
  io.listen(9003)
  console.log('Listening on port 9003...')

  async function redisTest() {
    await subClient.subscribe('channel', (message) => {
      console.log('Received message', message)
    })
    await pubClient.publish('channel', 'Hello')
    await pubClient.publish('channel', 'World!')
  }
  redisTest()
})

The code gives me the following error:

/code/node_modules/@node-redis/client/dist/lib/client/commands-queue.js:68
            return Promise.reject(new Error('Cannot send commands in PubSub mode'));
                                  ^

Error: Cannot send commands in PubSub mode
    at RedisCommandsQueue.addCommand (/code/node_modules/@node-redis/client/dist/lib/client/commands-queue.js:68:35)
    at RedisSocket.socketInitiator (/code/node_modules/@node-redis/client/dist/lib/client/index.js:304:81)
    at RedisSocket._RedisSocket_connect (/code/node_modules/@node-redis/client/dist/lib/client/socket.js:122:77)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Commander.connect (/code/node_modules/@node-redis/client/dist/lib/client/index.js:156:9)
    at async Promise.all (index 1)

If I remove the line io.adapter(createAdapter(pubClient, subClient)), it starts working again:

Listening on port 9003...
Received message Hello
Received message World!

If I remove the subClient.connect(), but leave the adapter, it doesn't crash, but I obviously won't receive the published messages:

Listening on port 9003...

Do I just need to downgrade some packages or why might I have this problem? It feels like the README is using outdated packages, as an example, the Redis createClient now takes the url option instead of the host and port mentioned in the README.

[akifd]

Hmm it seems to work if I move the io.adapter() after connecting the Redis clients:

import { Server } from 'socket.io'
import { createClient } from 'redis'
import { createAdapter } from '@socket.io/redis-adapter'

const io = new Server()
const pubClient = createClient({url: `redis://redis:6379/1`})
const subClient = pubClient.duplicate()

Promise.all([pubClient.connect(), subClient.connect()]).then(() => {
  io.adapter(createAdapter(pubClient, subClient))
  io.listen(9003)
  console.log('Listening on port 9003...')

  async function redisTest() {
    await subClient.subscribe('channel', (message) => {
      console.log('Received message', message)
    })
    await pubClient.publish('channel', 'Hello')
    await pubClient.publish('channel', 'World!')
  }
  redisTest()
})

Is this intentional? If yes, the documentation should be updated to reflect this.

[darrachequesne]

Hi! Unfortunately, I wasn't able to reproduce the issue. Could it be linked to redis/node-redis@ac808ea?

[LebonNic]

Hi! I got the same issue when deploying my app on a cloud provider. I had to move the io.adapter(createAdapter(pubClient, subClient)) part after the Promise.all([pubClient.connect(), subClient.connect()]) too.

[darrachequesne]

OK, so I've updated the README and the documentation on the website: https://socket.io/docs/v4/redis-adapter/

Thanks for the heads-up!

[JoshBot-Debug]

@darrachequesne You need to update this page as well, I was stuck here for ages lol. https://socket.io/docs/v4/server-api/#serveradaptervalue

const pubClient = createClient({
url: redis://${REDDIS_USER}:${REDDIS_PASSWORD}@${REDDIS_HOST}:${REDDIS_PORT},
})

And

// redis@4
Promise.all([pubClient.connect(), subClient.connect()])
.then(() =>
{
io.adapter(createAdapter(pubClient, subClient));
io.listen(PORT)
})