Files
VoiceStudio/tests/backend/services/test_lazy_registry_concurrency.py
T
b6ec4e23f3 fix(engines): snapshot lazy registry keys so /engines can't 500 under concurrency (#940)
* fix(engines): snapshot lazy registry keys so /engines can't 500 under concurrency

`list_backends()` runs in a FastAPI threadpool and iterates the lazy TTS/ASR
registries via `items()` → `__iter__`, which held a *live* `dict.__iter__(self)`
open across each engine's slow `is_available()` probe. Meanwhile the lazy
`__getitem__` resolves a deferred entry by mutating the dict (`self[key] = cls`).
A second concurrent `/engines` request (or any ASR op) materializing the lazy
`faster-whisper-isolated` entry therefore changed the dict size mid-iteration:

    RuntimeError: dictionary changed size during iteration
      asr_backend.py:1729 list_backends → _REGISTRY.items()
      asr_backend.py:1665 __iter__ → for k in dict.__iter__(self)

Both `_LazyRegistry` (TTS) and `_LazyASRRegistry` (ASR) now snapshot their live
keys up front with `list(dict.__iter__(self))` — consumed atomically under the
GIL — so a concurrent lazy insert can no longer trip the iteration. The slow
per-engine probes then run over the snapshot, not the live iterator.

Deterministic fail-before/pass-after regression for both registries:
tests/backend/services/test_lazy_registry_concurrency.py.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* docs(changelog): add the /engines concurrency fix under [Unreleased] (#940)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: mergetest <test@local>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-04 16:53:57 +05:30

39 lines
1.8 KiB
Python

"""Regression: the lazy TTS/ASR registries must not raise "dictionary changed
size during iteration" when a lazy ``__getitem__`` inserts a resolved key while
another caller iterates — the ``/engines`` 500 seen in production logs.
FastAPI runs ``list_backends()`` in a threadpool, so two concurrent ``/engines``
requests race: one iterates ``_REGISTRY.items()`` (which held a *live* dict
iterator open across the slow per-engine ``is_available()`` probes) while the
other materializes the lazy entry via ``__getitem__`` (``self[key] = cls``).
The insert then tripped the open iterator. ``__iter__`` now snapshots the live
keys up front (``list(dict.__iter__(self))``, atomic under the GIL), so a
concurrent insert can no longer trip the iteration.
The tests drive the exact crash site (``__iter__``) deterministically: begin
iterating, insert mid-iteration, then drain. Pre-fix this raises on the drain;
post-fix it completes.
"""
def _assert_iter_survives_concurrent_insert(reg):
it = iter(reg) # the generator items()/list_backends() drives
first = next(it) # first yield → the real-key snapshot is taken here
reg["zzz-concurrent-insert"] = object() # a concurrent lazy insert, mid-iteration
drained = [first, *it] # must NOT raise "dictionary changed size during iteration"
assert first in drained
def test_tts_lazy_registry_iter_survives_concurrent_insert():
from services.tts_backend import _LazyRegistry
reg = _LazyRegistry({"omnivoice": object(), "b": object(), "c": object()})
_assert_iter_survives_concurrent_insert(reg)
def test_asr_lazy_registry_iter_survives_concurrent_insert():
from services.asr_backend import _LazyASRRegistry
reg = _LazyASRRegistry({"whisperx": object(), "faster-whisper": object()})
_assert_iter_survives_concurrent_insert(reg)