feat: added support for redis v5 #1710

instanacd · 2025-04-30T17:32:34Z

Redis v5: Changes in this PR

Connection Termination
In Redis v5, the method client.quit() (or client.QUIT) has been deprecated and replaced by client.close().
Scan Iterator Behavior
- v4: Iterators yielded individual elements.
- v5: Iterators now yield entire collections.
Cluster Command Signature Change
In Redis v5, the method cluster.multi().addCommand() has an updated signature.
- The second argument is now a boolean (isReadonly), and the actual command array is passed as the third argument.
Connection Pool
Redis v5 introduces a dedicated RedisClientPool class for managing connection pools.
- v4: Pooling was handled internally by the RedisClient using an "Isolation Pool".
- v5: Pooling responsibilities are now abstracted into a separate class.
Internal File Structure Changes
Redis v5 introduces a new internal structure for the package, requiring updates to how we reference and mock internal modules.
Package Versioning Alignment
The @redis/client package versioning now aligns with the Redis server version:
- v4: @redis/client was versioned as 1.x.
- v5: @redis/client is now versioned as 5.x.

Additional Update

The Redis Docker image has been updated to the latest version.

Tasks

Replace client.quit() with client.close().
Update test to support scan iterator handling.
Adjust cluster.multi().addCommand() to new signature.
Docker image update to latest
Update internal imports and mocks for new file structure.
Support RedisClientPool https://github.com/redis/node-redis/blob/master/docs/pool.md
Add support for createSentinel() https://github.com/redis/node-redis/blob/master/docs/sentinel.md

References

Release notes: https://github.com/redis/node-redis/releases/tag/redis%405.0.0
Migration guide: https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md

Ref: https://jsw.ibm.com/browse/INSTA-35744

aryamohanan · 2025-05-02T04:13:48Z

Let's wait for the currencyJira card to be created.

aryamohanan · 2025-05-05T05:42:58Z

In v5, Redis moved “Isolation Pool” into RedisClientPool with a createClientPool export—but importing createClientPool throws “Not Found,” so the docs don’t match the package. Opened an issue in redis: redis/node-redis#2936

aryamohanan · 2025-05-13T10:02:42Z

The new sentinel API is not working for me created an issue: redis/node-redis#2962

aryamohanan · 2025-05-14T12:21:59Z

docker-compose-base.yaml

@@ -1,7 +1,7 @@
 version: '2'
 services:
  redis:
-    image: redis:5.0.14
+    image: redis:7.4.3


The Redis Docker image has been updated to the latest version.

aryamohanan · 2025-05-14T13:10:50Z

package.json

@@ -111,6 +111,7 @@
    "@opentelemetry/instrumentation": "0.50.0",
    "@opentelemetry/sdk-node": "^0.49.1",
    "@opentelemetry/sdk-trace-base": "^1.22.0",
+    "@redis/client-v4": "npm:@redis/[email protected]",


The @redis/client package was introduced with Redis v4 (@redis/client v1). In Redis v5, the versioning of @redis/client was synchronized with Redis, meaning @redis/client v5 corresponds to Redis v5.

To improve the testing setup, I’ve specified @redis/client v4 (corresponding to Redis v4) instead of v1.

"@redis/client-v4": "npm:@redis/[email protected]",

v4 = 1.6.0?

v4 = 1.6.0?

In v4, the redis/client was at version 1.6.x (see here). With v5, the client version was updated to v5.0 to align its versioning with Redis itself. For simplicity in testing, it is labeled as v4, and I have added a comment in the test file.

Additionally, for redis/client, after version 1.6, the major version jumped directly to v5, with no official stable releases in between—only prerelease versions were published. See: https://www.npmjs.com/package/@redis/client?activeTab=versions

Don't we have to add

@redis/client: 5.x
@redis/client-4: v1

?

So we test against all legacy package versions and the new releases?

Yea. Make sense!. @redis/client is a direct dependency of the redis package, so it gets installed automatically along with it. However, for better readability and maintainability, I can explicitly include it as well.

@redis/client: v5.x
@redis/client-4: v1.x

We also need it for currency?

aryamohanan · 2025-05-14T13:12:12Z

package.json

    "redis-v3": "npm:redis@^3.1.2",
+    "redis-v4": "npm:redis@^4.7.0",


I maintain tests for three versions of Redis, and each of these tests involves changes.

aryamohanan · 2025-05-14T13:53:49Z

As discussed the sentinel support will be added in a separate PR

kirrg001 · 2025-05-16T06:41:22Z

packages/collector/test/tracing/database/redis/test.js

@@ -721,8 +771,12 @@ const globalAgent = require('../../../globalAgent');
                            span => expect(span.n).to.equal('node.http.server'),
                            span => expect(span.data.http.method).to.equal('GET')
                          ]);
+                          // NOTE: v5 SCAN iterators yield batches of keys, enabling multi-key commands like MGET.
+                          // See: https://github.com/redis/node-redis/blob/master/docs/v4-to-v5.md#scan-iterators
+                          const expectedSpanCount = redisVersion === 'latest' ? 1 : 4;


QS: Could you please add an assertion for the batch property span.b

In case of scanIterators. It's not a batched span. The comment is confusing I will update

packages/collector/test/tracing/database/redis/test.js

kirrg001 · 2025-05-16T07:14:47Z

packages/collector/test/tracing/database/redis/test.js

+                  await controls.clearIpcMessages();
+                });
+
+                it('should trace blocking commands', () => testBlockingCommand(controls, setupType));


I don't understand this test. Blocking commands?

method: 'POST',

path: '/clearkeys'

packages/core/src/tracing/instrumentation/database/redis.js

kirrg001

💁‍♀️

instanacd requested a review from a team as a code owner April 30, 2025 17:32

aryamohanan self-assigned this May 2, 2025

aryamohanan marked this pull request as draft May 5, 2025 09:00

aryamohanan added the WIP label May 5, 2025

aryamohanan changed the title ~~[Currency Bot] Bumped redis from 4.7.0 to 5.0.0~~ feat: added support for redis v5 May 5, 2025

aryamohanan force-pushed the currency-bot-major-redis branch 3 times, most recently from e28b5da to 607a935 Compare May 6, 2025 11:34

aryamohanan reviewed May 14, 2025

View reviewed changes

aryamohanan force-pushed the currency-bot-major-redis branch from 88b438a to 10de7ff Compare May 14, 2025 13:53

aryamohanan marked this pull request as ready for review May 14, 2025 13:56

aryamohanan removed the WIP label May 15, 2025

kirrg001 reviewed May 16, 2025

View reviewed changes

packages/collector/test/tracing/database/redis/test.js Outdated Show resolved Hide resolved

kirrg001 reviewed May 16, 2025

View reviewed changes

packages/core/src/tracing/instrumentation/database/redis.js Outdated Show resolved Hide resolved

kirrg001 reviewed May 16, 2025

View reviewed changes

aryamohanan force-pushed the currency-bot-major-redis branch from 10de7ff to e221401 Compare May 16, 2025 09:03

Instanacd PAT for GitHub Public and others added 6 commits May 20, 2025 17:06

build: bumped redis from 4.7.0 to 5.0.0

79f4fec

test: fixed the failing tests

e91591c

test: fix redis client in tests v4

737e23f

test: fixed the cluster multi

8ea37b4

test: mocking

3c5e9c2

test: fix scan iterator

93d4e70

aryamohanan added 12 commits May 20, 2025 17:06

test: blocking fix

40b0516

test: fix pool

3449709

test: fix pool

72e3a0a

test: fix linting

72ef9ea

chore: comments updated

f9a7d68

test: removed

16e963a

chore: fine tuning

3333acf

chore: resolved review comments

d86bf1c

chore: updated comments

99b3420

test: test

8dc30b9

test: removed logs

ad09859

test: better code comments

faf4476

aryamohanan force-pushed the currency-bot-major-redis branch from c0363e0 to faf4476 Compare May 20, 2025 11:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added support for redis v5 #1710

feat: added support for redis v5 #1710

instanacd commented Apr 30, 2025 •

edited by aryamohanan

Loading

aryamohanan commented May 2, 2025

aryamohanan commented May 5, 2025

aryamohanan commented May 13, 2025

aryamohanan May 14, 2025

kirrg001 May 16, 2025

aryamohanan May 14, 2025

kirrg001 May 16, 2025

aryamohanan May 16, 2025

kirrg001 May 16, 2025

aryamohanan May 16, 2025

kirrg001 May 16, 2025

aryamohanan May 16, 2025

aryamohanan May 14, 2025

aryamohanan commented May 14, 2025 •

edited

Loading

kirrg001 May 16, 2025

aryamohanan May 19, 2025 •

edited

Loading

kirrg001 May 16, 2025

kirrg001 left a comment

		"redis-v3": "npm:redis@^3.1.2",
		"redis-v4": "npm:redis@^4.7.0",

feat: added support for redis v5 #1710

Are you sure you want to change the base?

feat: added support for redis v5 #1710

Conversation

instanacd commented Apr 30, 2025 • edited by aryamohanan Loading

Redis v5: Changes in this PR

Additional Update

Tasks

References

aryamohanan commented May 2, 2025

aryamohanan commented May 5, 2025

aryamohanan commented May 13, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aryamohanan commented May 14, 2025 • edited Loading

Choose a reason for hiding this comment

aryamohanan May 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kirrg001 left a comment

Choose a reason for hiding this comment

instanacd commented Apr 30, 2025 •

edited by aryamohanan

Loading

aryamohanan commented May 14, 2025 •

edited

Loading

aryamohanan May 19, 2025 •

edited

Loading