Fix/issue 465 async sentinel connection pool

[nkanu17]

Fix: Async Sentinel connections use correct AsyncSentinel class

Fixes #465

Problem

When using redis+sentinel:// URLs with async connections, the _redis_sentinel_client() method was only using the sync redis.sentinel.Sentinel class. This caused AsyncRedis clients to be backed by a sync SentinelConnectionPool, resulting in runtime failures when async operations were attempted.

Error observed: TypeError: object MasterFor is not callable

Root Cause

The _redis_sentinel_client() method in redisvl/redis/connection.py only imported and used the sync Sentinel class, regardless of whether the client was sync or async.

Solution

• Import AsyncSentinel from redis.asyncio.sentinel
• Branch on redis_class to use AsyncSentinel when creating async clients
• Sync clients continue to use the sync Sentinel class

Changes

File	Change
redisvl/redis/connection.py	Added AsyncSentinel import; updated _redis_sentinel_client() to use appropriate Sentinel class
tests/unit/test_sentinel_url.py	Updated existing tests to mock correct Sentinel class; added edge case tests

Testing

• All 12 Sentinel tests pass
• Type checking passes (make check-types)
• Pre-commit hooks pass

New Test Coverage

• Default port (26379) when not specified in URL
• Default service name ('mymaster') when path is empty
• Password-only authentication (no username)
• Custom kwargs passthrough to master_for()

---

Note

Medium Risk
Moderate risk because it changes Redis connection instantiation for Sentinel URLs, which can affect connectivity/HA behavior at runtime; coverage is improved with targeted unit tests.

Overview
Fixes redis+sentinel:// handling so async connections (get_async_redis_connection / AsyncRedis) use redis.asyncio.sentinel.AsyncSentinel rather than the sync Sentinel, preventing runtime failures caused by a sync Sentinel connection pool.

Adds/updates unit tests to mock the correct Sentinel class for sync vs async, plus additional parsing/kwarg passthrough edge cases and class-selection assertions. Documentation is updated to show both SearchIndex and AsyncSearchIndex Sentinel examples and clarifies defaults (service name mymaster).

^{Written by Cursor Bugbot for commit 9d8f90a. This will update automatically on new commits. Configure here.}

[jit-ci]

🛡️ Jit Security Scan Results

✅ No security findings were detected in this PR

---

^{Security scan by Jit}

[Copilot]

Pull request overview

Fixes async redis+sentinel:// connection construction so async clients are backed by the correct asyncio Sentinel implementation, preventing runtime failures like TypeError: object MasterFor is not callable for async operations.

Changes:

• Use redis.asyncio.sentinel.Sentinel (aliased as AsyncSentinel) when constructing async Sentinel clients; keep sync clients on redis.sentinel.Sentinel.
• Expand/adjust unit tests to validate correct Sentinel class selection and several URL parsing edge cases.
• Update user docs to show Sentinel usage for both SearchIndex and AsyncSearchIndex.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.

File	Description
redisvl/redis/connection.py	Selects AsyncSentinel vs Sentinel based on sync/async client type; adds typing/docstrings.
tests/unit/test_sentinel_url.py	Updates mocks for async vs sync Sentinel class and adds edge-case parsing/kwargs tests.
docs/user_guide/installation.md	Documents Sentinel connections for both sync and async index usage.
uv.lock	Updates locked editable redisvl version metadata.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

The with (patch(...), patch(...)): parenthesized context-manager syntax requires Python 3.10+, but this project supports Python >=3.9.2. Please rewrite this to a Python 3.9-compatible form (e.g., with patch(...) as ..., patch(...) as ...: or nested with blocks).

Suggested change

	with (
	patch("redisvl.redis.connection.Sentinel", side_effect=track_sync_sentinel),
	patch(
	"redisvl.redis.connection.AsyncSentinel", side_effect=track_async_sentinel
	),
	with patch(
	"redisvl.redis.connection.Sentinel", side_effect=track_sync_sentinel
	), patch(
	"redisvl.redis.connection.AsyncSentinel", side_effect=track_async_sentinel

[Copilot]

The list says the Sentinel service name is required, but RedisConnectionFactory._parse_sentinel_url() defaults to "mymaster" when the URL has no path (and there’s now a unit test asserting that behavior). Please update this bullet to match the implementation (service name optional with default mymaster, or clarify that omitting it uses mymaster).

Suggested change

	- Service name (required - the name of the Redis master)
	- Optional service name (defaults to `mymaster`; this is the name of the Redis master)

[Copilot]

The docstring describes the URL format as requiring /service, but _parse_sentinel_url() (and the tests in this PR) allow the service name to be omitted and default to "mymaster". Please update the format description here to reflect that the service segment is optional (or explicitly document the default).

[Copilot]

The with (patch(...), patch(...)): parenthesized context-manager syntax requires Python 3.10+, but this project supports Python >=3.9.2. Please rewrite this to a Python 3.9-compatible form (e.g., with patch(...) as ..., patch(...) as ...: or nested with blocks).