Add support for Redis v6 (#1380)

lrafeei · TimPansino · mergify[bot] · web-flow · commit dcb6839c0915 · 2025-05-01T15:22:03.000-07:00
* Add new redis methods

* Cleanup, part 1

* [MegaLinter] Apply linters fixes

* Add vectorset commands

* Clean up tests

* [MegaLinter] Apply linters fixes

* Bump tests

* Add (most) new methods

* [MegaLinter] Apply linters fixes

* Add retry in ignored methods

* [MegaLinter] Apply linters fixes

---------

Co-authored-by: Tim Pansino &lt;timpansino@gmail.com&gt;
Co-authored-by: mergify[bot] &lt;37929162+mergify[bot]@users.noreply.github.com&gt;
diff --git a/newrelic/config.py b/newrelic/config.py
@@ -3342,10 +3342,18 @@ def _process_module_builtin_defaults():
         "redis.commands.bf.commands", "newrelic.hooks.datastore_redis", "instrument_redis_commands_bf_commands"
     )
 
+    # Redis version <6.0
     _process_module_definition(
         "redis.commands.graph.commands", "newrelic.hooks.datastore_redis", "instrument_redis_commands_graph_commands"
     )
 
+    # Added in Redis v6.0+
+    _process_module_definition(
+        "redis.commands.vectorset.commands",
+        "newrelic.hooks.datastore_redis",
+        "instrument_redis_commands_vectorset_commands",
+    )
+
     _process_module_definition(
         "valkey.asyncio.client", "newrelic.hooks.datastore_valkey", "instrument_asyncio_valkey_client"
     )
diff --git a/newrelic/hooks/datastore_redis.py b/newrelic/hooks/datastore_redis.py
@@ -39,11 +39,14 @@
     "hexpire",
     "hexpireat",
     "hexpiretime",
+    "hgetdel",
+    "hgetex",
     "hpersist",
     "hpexpire",
     "hpexpireat",
     "hpexpiretime",
     "hpttl",
+    "hsetex",
     "httl",
     "latency_doctor",
     "latency_graph",
@@ -79,6 +82,17 @@
     "spop",
     "srandmember",
     "unwatch",
+    "vadd",
+    "vcard",
+    "vdim",
+    "vemb",
+    "vgetattr",
+    "vinfo",
+    "vlinks",
+    "vrandmember",
+    "vrem",
+    "vsetattr",
+    "vsim",
     "watch",
     "zlexcount",
     "zrevrangebyscore",
@@ -694,6 +708,10 @@ def instrument_redis_commands_graph_commands(module):
     _instrument_redis_commands_module(module, "GraphCommands")
 
 
+def instrument_redis_commands_vectorset_commands(module):
+    _instrument_redis_commands_module(module, "VectorSetCommands")
+
+
 def instrument_redis_commands_bf_commands(module):
     _instrument_redis_commands_module(module, "BFCommands")
     _instrument_redis_commands_module(module, "CFCommands")
diff --git a/tests/datastore_redis/test_custom_conn_pool.py b/tests/datastore_redis/test_custom_conn_pool.py
@@ -37,7 +37,7 @@ class FakeConnectionPool:
     def __init__(self, connection):
         self.connection = connection
 
-    def get_connection(self, name, *keys, **options):
+    def get_connection(self, name=None, *keys, **options):
         return self.connection
 
     def release(self, connection):
@@ -47,6 +47,15 @@ def disconnect(self):
         self.connection.disconnect()
 
 
+# Backwards compatibility between redis-py v4 and v6
+
+# Call to `get_connection` function with the usage of the command
+# name as an input argument has been deprecated since v5.3.0.
+_get_command_as_arg = [
+    (pytest.param(None, marks=pytest.mark.skipif(REDIS_PY_VERSION < (5, 3), reason="Deprecated after v5.3"))),
+    (pytest.param("GET", marks=pytest.mark.skipif(REDIS_PY_VERSION >= (5, 3), reason="Needed until v5.3"))),
+]
+
 # Settings
 
 _enable_instance_settings = {"datastore_tracer.instance_reporting.enabled": True}
@@ -102,7 +111,7 @@ def exercise_redis(client):
 # Tests
 
 
-@pytest.mark.skipif(REDIS_PY_VERSION < (2, 7), reason="Client list command introduced in 2.7")
+@pytest.mark.parametrize("command_name", _get_command_as_arg)
 @override_application_settings(_enable_instance_settings)
 @validate_transaction_metrics(
     "test_custom_conn_pool:test_fake_conn_pool_enable_instance",
@@ -111,12 +120,12 @@ def exercise_redis(client):
     background_task=True,
 )
 @background_task()
-def test_fake_conn_pool_enable_instance():
+def test_fake_conn_pool_enable_instance(command_name):
     client = redis.StrictRedis(host=DB_SETTINGS["host"], port=DB_SETTINGS["port"], db=0)
 
     # Get a real connection
 
-    conn = client.connection_pool.get_connection("GET")
+    conn = client.connection_pool.get_connection(command_name)
 
     # Replace the original connection pool with one that doesn't
     # have the `connection_kwargs` attribute.
@@ -128,7 +137,7 @@ def test_fake_conn_pool_enable_instance():
     exercise_redis(client)
 
 
-@pytest.mark.skipif(REDIS_PY_VERSION < (2, 7), reason="Client list command introduced in 2.7")
+@pytest.mark.parametrize("command_name", _get_command_as_arg)
 @override_application_settings(_disable_instance_settings)
 @validate_transaction_metrics(
     "test_custom_conn_pool:test_fake_conn_pool_disable_instance",
@@ -137,12 +146,12 @@ def test_fake_conn_pool_enable_instance():
     background_task=True,
 )
 @background_task()
-def test_fake_conn_pool_disable_instance():
+def test_fake_conn_pool_disable_instance(command_name):
     client = redis.StrictRedis(host=DB_SETTINGS["host"], port=DB_SETTINGS["port"], db=0)
 
     # Get a real connection
 
-    conn = client.connection_pool.get_connection("GET")
+    conn = client.connection_pool.get_connection(command_name)
 
     # Replace the original connection pool with one that doesn't
     # have the `connection_kwargs` attribute.
diff --git a/tests/datastore_redis/test_instance_info.py b/tests/datastore_redis/test_instance_info.py
@@ -20,6 +20,13 @@
 
 REDIS_PY_VERSION = get_package_version_tuple("redis")
 
+# Call to `get_connection` function with the usage of the command
+# name as an input argument has been deprecated since v5.3.0.
+_select_command_as_arg = [
+    (pytest.param(None, marks=pytest.mark.skipif(REDIS_PY_VERSION < (5, 3), reason="Deprecated after v5.3"))),
+    (pytest.param("SELECT", marks=pytest.mark.skipif(REDIS_PY_VERSION >= (5, 3), reason="Needed until v5.3"))),
+]
+
 _instance_info_tests = [
     ((), {}, ("localhost", "6379", "0")),
     ((), {"host": None}, ("localhost", "6379", "0")),
@@ -71,11 +78,12 @@ def test_redis_connection_instance_info(args, kwargs, expected):
         r.connection_pool.release(connection)
 
 
+@pytest.mark.parametrize("command_name", _select_command_as_arg)
 @pytest.mark.parametrize("args,kwargs,expected", _instance_info_tests)
-def test_strict_redis_connection_instance_info(args, kwargs, expected):
+def test_strict_redis_connection_instance_info(args, kwargs, expected, command_name):
     r = redis.StrictRedis(*args, **kwargs)
     r.connection_pool.connection_class = DisabledConnection
-    connection = r.connection_pool.get_connection("SELECT")
+    connection = r.connection_pool.get_connection(command_name)
     try:
         conn_kwargs = _conn_attrs_to_dict(connection)
         assert _instance_info(conn_kwargs) == expected
@@ -93,49 +101,35 @@ def test_strict_redis_connection_instance_info(args, kwargs, expected):
     (("redis://:1234/",), {}, ("localhost", "1234", "0")),
     (("redis://@:1234/",), {}, ("localhost", "1234", "0")),
     (("redis://localhost:1234/garbage",), {}, ("localhost", "1234", "0")),
+    (("redis://localhost:6379/2/",), {}, ("localhost", "6379", "2")),
+    (("redis://localhost:6379",), {"host": "someotherhost"}, ("localhost", "6379", "0")),
+    (("redis://localhost:6379/2",), {"db": 3}, ("localhost", "6379", "2")),
+    (("redis://localhost:6379/2/?db=111",), {}, ("localhost", "6379", "111")),
+    (("redis://localhost:6379?db=2",), {}, ("localhost", "6379", "2")),
+    (("redis://localhost:6379/2?db=111",), {}, ("localhost", "6379", "111")),
+    (("unix:///path/to/socket.sock",), {}, ("localhost", "/path/to/socket.sock", "0")),
+    (("unix:///path/to/socket.sock?db=2",), {}, ("localhost", "/path/to/socket.sock", "2")),
+    (("unix:///path/to/socket.sock",), {"db": 2}, ("localhost", "/path/to/socket.sock", "2")),
 ]
 
-# Behavior to default port to 6379 was added in v2.7.5
-# (https://github.com/redis/redis-py/commit/cfe1041bbb8a8887531810429879bffbe705b03a)
-# and removed in v4.0.0b1 (https://github.com/redis/redis-py/blame/v4.0.0b1/redis/connection.py#L997)
-if (3, 5, 3) >= REDIS_PY_VERSION >= (2, 7, 5):
-    _instance_info_from_url_tests.append((("redis://127.0.0.1",), {}, ("127.0.0.1", "6379", "0")))
-
-if REDIS_PY_VERSION >= (2, 10):
-    _instance_info_from_url_tests.extend(
-        [
-            (("rediss://localhost:6379/2/",), {}, ("localhost", "6379", "2")),
-            (("redis://localhost:6379",), {"host": "someotherhost"}, ("localhost", "6379", "0")),
-            (("redis://localhost:6379/2",), {"db": 3}, ("localhost", "6379", "2")),
-            (("redis://localhost:6379/2/?db=111",), {}, ("localhost", "6379", "111")),
-            (("redis://localhost:6379?db=2",), {}, ("localhost", "6379", "2")),
-            (("redis://localhost:6379/2?db=111",), {}, ("localhost", "6379", "111")),
-            (("unix:///path/to/socket.sock",), {}, ("localhost", "/path/to/socket.sock", "0")),
-            (("unix:///path/to/socket.sock?db=2",), {}, ("localhost", "/path/to/socket.sock", "2")),
-            (("unix:///path/to/socket.sock",), {"db": 2}, ("localhost", "/path/to/socket.sock", "2")),
-        ]
-    )
-
-
-@pytest.mark.skipif(REDIS_PY_VERSION < (2, 6), reason="from_url not yet implemented in this redis-py version")
+
 @pytest.mark.parametrize("args,kwargs,expected", _instance_info_from_url_tests)
 def test_redis_client_from_url(args, kwargs, expected):
     r = redis.Redis.from_url(*args, **kwargs)
     conn_kwargs = r.connection_pool.connection_kwargs
     assert _instance_info(conn_kwargs) == expected
 
 
-@pytest.mark.skipif(REDIS_PY_VERSION < (2, 6), reason="from_url not yet implemented in this redis-py version")
 @pytest.mark.parametrize("args,kwargs,expected", _instance_info_from_url_tests)
 def test_strict_redis_client_from_url(args, kwargs, expected):
     r = redis.StrictRedis.from_url(*args, **kwargs)
     conn_kwargs = r.connection_pool.connection_kwargs
     assert _instance_info(conn_kwargs) == expected
 
 
-@pytest.mark.skipif(REDIS_PY_VERSION < (2, 6), reason="from_url not yet implemented in this redis-py version")
+@pytest.mark.parametrize("command_name", _select_command_as_arg)
 @pytest.mark.parametrize("args,kwargs,expected", _instance_info_from_url_tests)
-def test_redis_connection_from_url(args, kwargs, expected):
+def test_redis_connection_from_url(args, kwargs, expected, command_name):
     r = redis.Redis.from_url(*args, **kwargs)
     if r.connection_pool.connection_class is redis.Connection:
         r.connection_pool.connection_class = DisabledConnection
@@ -145,17 +139,17 @@ def test_redis_connection_from_url(args, kwargs, expected):
         r.connection_pool.connection_class = DisabledSSLConnection
     else:
         raise AssertionError(r.connection_pool.connection_class)
-    connection = r.connection_pool.get_connection("SELECT")
+    connection = r.connection_pool.get_connection(command_name)
     try:
         conn_kwargs = _conn_attrs_to_dict(connection)
         assert _instance_info(conn_kwargs) == expected
     finally:
         r.connection_pool.release(connection)
 
 
-@pytest.mark.skipif(REDIS_PY_VERSION < (2, 6), reason="from_url not yet implemented in this redis-py version")
+@pytest.mark.parametrize("command_name", _select_command_as_arg)
 @pytest.mark.parametrize("args,kwargs,expected", _instance_info_from_url_tests)
-def test_strict_redis_connection_from_url(args, kwargs, expected):
+def test_strict_redis_connection_from_url(args, kwargs, expected, command_name):
     r = redis.StrictRedis.from_url(*args, **kwargs)
     if r.connection_pool.connection_class is redis.Connection:
         r.connection_pool.connection_class = DisabledConnection
@@ -165,7 +159,7 @@ def test_strict_redis_connection_from_url(args, kwargs, expected):
         r.connection_pool.connection_class = DisabledSSLConnection
     else:
         raise AssertionError(r.connection_pool.connection_class)
-    connection = r.connection_pool.get_connection("SELECT")
+    connection = r.connection_pool.get_connection(command_name)
     try:
         conn_kwargs = _conn_attrs_to_dict(connection)
         assert _instance_info(conn_kwargs) == expected
diff --git a/tests/datastore_redis/test_uninstrumented_methods.py b/tests/datastore_redis/test_uninstrumented_methods.py
@@ -86,11 +86,12 @@
     "set_path",
     "set_response_callback",
     "set_retry",
+    "single_connection_lock",  # this is just the threading lock object
     "transaction",
     "version",
 }
 
-REDIS_MODULES = {"bf", "cf", "cms", "ft", "graph", "json", "tdigest", "topk", "ts"}
+REDIS_MODULES = {"bf", "cf", "cms", "ft", "graph", "json", "tdigest", "topk", "ts", "vset"}
 
 IGNORED_METHODS |= REDIS_MODULES
 
diff --git a/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py b/tests/datastore_rediscluster/test_uninstrumented_rediscluster_methods.py
@@ -99,7 +99,8 @@
     "cluster_addslotsrange",
     "cluster_bumpepoch",
     "cluster_delslotsrange",
-    "cluster_error_retry_attempts",
+    "cluster_error_retry_attempts",  # Deprecated in redis-py v5.3.0
+    "retry",  # Use instead of cluster_error_retry_attempts after v5.3.0
     "cluster_flushslots",
     "cluster_links",
     "cluster_myid",
@@ -129,7 +130,8 @@
     "nodes_manager",
     "on_connect",
     "pubsub",
-    "read_from_replicas",
+    "read_from_replicas",  # Deprecated in redis-py v5.3.0
+    "load_balancing_strategy",  # Use instead of read_from_replicas after v5.3.0
     "reinitialize_counter",
     "reinitialize_steps",
     "replace_default_node",
@@ -138,7 +140,7 @@
     "user_on_connect_func",
 }
 
-REDIS_MODULES = {"bf", "cf", "cms", "ft", "graph", "json", "tdigest", "topk", "ts"}
+REDIS_MODULES = {"bf", "cf", "cms", "ft", "graph", "json", "tdigest", "topk", "ts", "vset"}
 
 IGNORED_METHODS |= REDIS_MODULES
 
diff --git a/tox.ini b/tox.ini
@@ -168,8 +168,9 @@ envlist =
     rabbitmq-messagebroker_pika-{py37,py38,py39,py310,py311,py312,py313,pypy310}-pikalatest,
     rabbitmq-messagebroker_kombu-{py38,py39,py310,py311,py312,py313,pypy310}-kombulatest,
     rabbitmq-messagebroker_kombu-{py38,py39,py310,pypy310}-kombu050204,
-    redis-datastore_redis-{py37,py311,pypy310}-redis04,
-    redis-datastore_redis-{py37,py38,py39,py310,py311,py312,py313,pypy310}-redislatest,
+    redis-datastore_redis-{py37,py38,py39,py310,py311,pypy310}-redis04,
+    redis-datastore_redis-{py38,py39,py310,py311,py312,pypy310}-redis05,
+    redis-datastore_redis-{py38,py39,py310,py311,py312,py313,pypy310}-redislatest,
     rediscluster-datastore_rediscluster-{py37,py312,py313,pypy310}-redislatest,
     valkey-datastore_valkey-{py38,py39,py310,py311,py312,py313,pypy310}-valkeylatest,
     solr-datastore_pysolr-{py37,py38,py39,py310,py311,py312,py313,pypy310},
@@ -292,9 +293,9 @@ deps =
     datastore_pymysql: cryptography
     datastore_pysolr: pysolr<4.0
     datastore_redis-redis04: redis<5
-    ; Pinning redis tests until official redis v6 support is added
-    datastore_redis-redislatest: redis<5.3.0
-    datastore_rediscluster-redislatest: redis<5.3.0
+    datastore_redis-redis05: redis<6
+    datastore_redis-redislatest: redis
+    datastore_rediscluster-redislatest: redis
     datastore_valkey-valkeylatest: valkey
     external_aiobotocore-aiobotocorelatest: aiobotocore[awscli]
     external_aiobotocore-aiobotocorelatest: flask

Original file line number	Diff line number	Diff line change
`@@ -3342,10 +3342,18 @@ def _process_module_builtin_defaults():`
`3342`	`3342`	`"redis.commands.bf.commands", "newrelic.hooks.datastore_redis", "instrument_redis_commands_bf_commands"`
`3343`	`3343`	`)`
`3344`	`3344`
	`3345`	`+ # Redis version <6.0`
`3345`	`3346`	`_process_module_definition(`
`3346`	`3347`	`"redis.commands.graph.commands", "newrelic.hooks.datastore_redis", "instrument_redis_commands_graph_commands"`
`3347`	`3348`	`)`
`3348`	`3349`
	`3350`	`+ # Added in Redis v6.0+`
	`3351`	`+ _process_module_definition(`
	`3352`	`+ "redis.commands.vectorset.commands",`
	`3353`	`+ "newrelic.hooks.datastore_redis",`
	`3354`	`+ "instrument_redis_commands_vectorset_commands",`
	`3355`	`+ )`
	`3356`	`+`
`3349`	`3357`	`_process_module_definition(`
`3350`	`3358`	`"valkey.asyncio.client", "newrelic.hooks.datastore_valkey", "instrument_asyncio_valkey_client"`
`3351`	`3359`	`)`