feat(core): Add compatibility to redis > 6 ACLs system using username in queue-mode

[intel44]

Github issue / Community forum post (link here to close automatically): https://community.n8n.io/t/add-a-configuration-variable-for-the-redis-username-queue-mode/15878

[CLAassistant]

All committers have signed the CLA.

[netroy]

@intel44 Have you tested this in the queue mode?
I assume that we need to update ioredis to 4.x or 5.x to be able to use any new redis features.

[intel44]

Hi @netroy, thanks for your feedback.

Have you tested this in the queue mode?
I assume that we need to update ioredis to 4.x or 5.x to be able to use any new redis features.

After verification, no need to update any package. The current versions are fully compatible without adjustment.

Current packages :

• packages/cli :
  • ioredis@4.28.5
  • bull@3.19.0
    • including ioredis@4.27.0

The authentication feature has been include to ioredis@4.17.0 : redis/ioredis#1130

---

Some tests to ensure compatibility

Config

My redis users for tests :

$ redis-cli
127.0.0.1:6379> acl list
1) "user default on nopass ~* &* +@all"
2) "user user-with-password on #a1159e9df3670d549d04524532629f5477ceb7deec9b45e47e8c009506ecb2c8 ~* &* +@all"
3) "user user-without-password on nopass ~* &* +@all"

Tests

I added a log of redisConfig in Queue.js to show the config used in queue mode.

Default mode

$ pnpm worker

> n8n@0.209.3 worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{ host: 'localhost', port: 6379, db: 80 }

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Specific user without password

$ export QUEUE_BULL_REDIS_USERNAME=user-without-password 
$ pnpm worker

> n8n@0.209.3 worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{
  host: 'localhost',
  username: 'user-without-password',
  port: 6379,
  db: 80
}

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Specific user with password

$ export QUEUE_BULL_REDIS_USERNAME=user-with-password 
$ export QUEUE_BULL_REDIS_PASSWORD=pwd
$ pnpm worker

> n8n@0.209.3 worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{
  host: 'localhost',
  username: 'user-with-password',
  password: 'pwd',
  port: 6379,
  db: 80
}

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Rotten case : Specific user with bad password

$ export QUEUE_BULL_REDIS_PASSWORD=pwdbad
$ pnpm worker

> n8n@0.209.3 worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{
  host: 'localhost',
  username: 'user-with-password',
  password: 'pwdbad',
  port: 6379,
  db: 80
}

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Error from queue: 

/var/www/n8n/node_modules/.pnpm/redis-parser@3.0.0/node_modules/redis-parser/lib/parser.js:179
    return new ReplyError(string)
           ^
ReplyError: WRONGPASS invalid username-password pair or user is disabled.
    at parseError (/var/www/n8n/node_modules/.pnpm/redis-parser@3.0.0/node_modules/redis-parser/lib/parser.js:179:12)
    at parseType (/var/www/n8n/node_modules/.pnpm/redis-parser@3.0.0/node_modules/redis-parser/lib/parser.js:302:14)
 ELIFECYCLE  Command failed with exit code 1.

Rotten case : Unknow user

$ export QUEUE_BULL_REDIS_USERNAME=user-unknow          
$ pnpm worker

> n8n@0.209.3 worker /var/www/n8n
> ./packages/cli/bin/n8n worker

Starting n8n worker...
{ host: 'localhost', username: 'user-unknow', port: 6379, db: 80 }

n8n worker is now ready
 * Version: 0.209.3
 * Concurrency: 10

Error from queue: 

/var/www/n8n/node_modules/.pnpm/redis-parser@3.0.0/node_modules/redis-parser/lib/parser.js:179
    return new ReplyError(string)
           ^
ReplyError: WRONGPASS invalid username-password pair or user is disabled.
    at parseError (/var/www/n8n/node_modules/.pnpm/redis-parser@3.0.0/node_modules/redis-parser/lib/parser.js:179:12)
    at parseType (/var/www/n8n/node_modules/.pnpm/redis-parser@3.0.0/node_modules/redis-parser/lib/parser.js:302:14)
 ELIFECYCLE  Command failed with exit code 1.

[StarfallProjects]

If/when this gets merged, can someone either give me a heads-up, or also merge the related docs PR? n8n-io/n8n-docs#1055 (and check it's still correct, if there are further code changes)

[netroy]

@StarfallProjects both PRs merged

[intel44]

Hi @netroy
With this commit, you remove my modifications: when the variable QUEUE_BULL_REDIS_USERNAME is not set, it will send username: ''
Is this going to be a problem ?

[netroy]

It didn't seem to be an issue when I tested it on redis 5 and 6.

[janober]

Got released with n8n@0.210.0