Summary
An index created with redis_url owns the client it lazily creates, so _owns_redis_client is True. The deprecated set_client() does not reset that flag, so after a caller swaps in their own client the index still believes it owns it and will close it. __init__(redis_client=...) already gets this right and marks such a client as not owned.
Before 0.25.0 this was latent, because the client finalizer never fired (see #657). Now that the finalizer works, the index closes the caller's client when it is garbage collected.
Affects both SearchIndex and AsyncSearchIndex, on 0.25.0.
Reproduction
import gc
from unittest import mock
from redisvl.index import SearchIndex
SCHEMA = {
"index": {"name": "probe", "prefix": "p", "storage_type": "hash"},
"fields": [{"name": "a", "type": "tag"}],
}
caller_client = mock.MagicMock()
index = SearchIndex.from_dict(SCHEMA, redis_url="redis://localhost:6379")
with mock.patch("redisvl.index.index.RedisConnectionFactory.validate_sync_redis"):
index.set_client(caller_client)
print("owns:", index._owns_redis_client) # True, should be False
del index
gc.collect()
print("caller client closed:", caller_client.close.called) # True, should be False
Observed on 0.25.0:
owns: True
caller client closed: True
The async path behaves the same, awaiting aclose() on the caller's client. Calling disconnect() explicitly closes it too, for the same reason.
Impact
Low severity but real. redis-py clients recover from close() and aclose() by reconnecting on next use, so the practical effect is unexpected connection churn on a client the caller still owns rather than a permanently broken client. Verified: ping() returns True after both close() and aclose() for sync and async clients.
The exposure is further limited because set_client() is deprecated.
Additional problem in the same method
The sync set_client() also abandons the client the index created for itself, without closing it. It overwrites __redis_client and (since 0.25.0) detaches that client's finalizer, so nothing ever closes it. The async set_client() does not have this problem because it awaits disconnect() before swapping.
Suggested fix
set_client() should mark the client as not owned, since a caller-provided client is by definition not the index's to close, and it should release the previously owned client first.
The deprecated async connect() needs care here: it creates its own client and then delegates to set_client(), so a naive ownership flip would leave a client the index created with nobody to close it. That path must keep ownership. Routing both through a small internal helper that takes ownership as a parameter handles this.
Worth covering with tests on all three entry points: constructor injection (already correct), set_client() (must not own), and connect() (must own).
Summary
An index created with
redis_urlowns the client it lazily creates, so_owns_redis_clientisTrue. The deprecatedset_client()does not reset that flag, so after a caller swaps in their own client the index still believes it owns it and will close it.__init__(redis_client=...)already gets this right and marks such a client as not owned.Before 0.25.0 this was latent, because the client finalizer never fired (see #657). Now that the finalizer works, the index closes the caller's client when it is garbage collected.
Affects both
SearchIndexandAsyncSearchIndex, on 0.25.0.Reproduction
Observed on 0.25.0:
The async path behaves the same, awaiting
aclose()on the caller's client. Callingdisconnect()explicitly closes it too, for the same reason.Impact
Low severity but real. redis-py clients recover from
close()andaclose()by reconnecting on next use, so the practical effect is unexpected connection churn on a client the caller still owns rather than a permanently broken client. Verified:ping()returnsTrueafter bothclose()andaclose()for sync and async clients.The exposure is further limited because
set_client()is deprecated.Additional problem in the same method
The sync
set_client()also abandons the client the index created for itself, without closing it. It overwrites__redis_clientand (since 0.25.0) detaches that client's finalizer, so nothing ever closes it. The asyncset_client()does not have this problem because it awaitsdisconnect()before swapping.Suggested fix
set_client()should mark the client as not owned, since a caller-provided client is by definition not the index's to close, and it should release the previously owned client first.The deprecated async
connect()needs care here: it creates its own client and then delegates toset_client(), so a naive ownership flip would leave a client the index created with nobody to close it. That path must keep ownership. Routing both through a small internal helper that takes ownership as a parameter handles this.Worth covering with tests on all three entry points: constructor injection (already correct),
set_client()(must not own), andconnect()(must own).