Fix thread safety issue in CrewAIEventsBus emit and register_handler methods

- Add proper locking using existing _lock mechanism in emit() method
- Add thread safety to register_handler() method
- Add comprehensive thread safety tests for concurrent event emission
- Add tests for concurrent handler registration
- Add tests for mixed concurrent operations
- Fixes issue #2991 where streaming events could get mixed between users

The emit() method now uses the existing _lock to ensure thread-safe access
to the _handlers dictionary and signal emission. This prevents race conditions
that could cause data mixing when multiple users interact with streaming
functionality simultaneously.

Resolves #2991

Co-Authored-By: João <joao@crewai.com>
This commit is contained in:
Devin AI
2025-06-11 02:26:13 +00:00
parent 06c991d8c3
commit 4c9abe3128
2 changed files with 132 additions and 15 deletions

View File

@@ -67,27 +67,29 @@ class CrewAIEventsBus:
source: The object emitting the event
event: The event instance to emit
"""
for event_type, handlers in self._handlers.items():
if isinstance(event, event_type):
for handler in handlers:
try:
handler(source, event)
except Exception as e:
print(
f"[EventBus Error] Handler '{handler.__name__}' failed for event '{event_type.__name__}': {e}"
)
with CrewAIEventsBus._lock:
for event_type, handlers in self._handlers.items():
if isinstance(event, event_type):
for handler in handlers:
try:
handler(source, event)
except Exception as e:
print(
f"[EventBus Error] Handler '{handler.__name__}' failed for event '{event_type.__name__}': {e}"
)
self._signal.send(source, event=event)
self._signal.send(source, event=event)
def register_handler(
self, event_type: Type[EventTypes], handler: Callable[[Any, EventTypes], None]
) -> None:
"""Register an event handler for a specific event type"""
if event_type not in self._handlers:
self._handlers[event_type] = []
self._handlers[event_type].append(
cast(Callable[[Any, EventTypes], None], handler)
)
with CrewAIEventsBus._lock:
if event_type not in self._handlers:
self._handlers[event_type] = []
self._handlers[event_type].append(
cast(Callable[[Any, EventTypes], None], handler)
)
@contextmanager
def scoped_handlers(self):

View File

@@ -1,7 +1,11 @@
import threading
import time
from concurrent.futures import ThreadPoolExecutor
from unittest.mock import Mock
from crewai.utilities.events.base_events import BaseEvent
from crewai.utilities.events.crewai_event_bus import crewai_event_bus
from crewai.utilities.events.llm_events import LLMStreamChunkEvent
class TestEvent(BaseEvent):
@@ -45,3 +49,114 @@ def test_event_bus_error_handling(capfd):
out, err = capfd.readouterr()
assert "Simulated handler failure" in out
assert "Handler 'broken_handler' failed" in out
def test_concurrent_event_emission_thread_safety():
"""Test that concurrent event emission is thread-safe"""
handler1_events = []
handler2_events = []
handler_lock = threading.Lock()
with crewai_event_bus.scoped_handlers():
@crewai_event_bus.on(LLMStreamChunkEvent)
def handler1(source, event: LLMStreamChunkEvent):
with handler_lock:
handler1_events.append(f"Handler1: {event.chunk}")
@crewai_event_bus.on(LLMStreamChunkEvent)
def handler2(source, event: LLMStreamChunkEvent):
with handler_lock:
handler2_events.append(f"Handler2: {event.chunk}")
def emit_events(thread_id, num_events=20):
"""Emit events from a specific thread"""
for i in range(num_events):
event = LLMStreamChunkEvent(
type="llm_stream_chunk",
chunk=f"Thread-{thread_id}-Chunk-{i}"
)
crewai_event_bus.emit(f"source-{thread_id}", event)
num_threads = 5
events_per_thread = 20
with ThreadPoolExecutor(max_workers=num_threads) as executor:
futures = []
for thread_id in range(num_threads):
future = executor.submit(emit_events, thread_id, events_per_thread)
futures.append(future)
for future in futures:
future.result()
expected_total = num_threads * events_per_thread
assert len(handler1_events) == expected_total, f"Handler1 received {len(handler1_events)} events, expected {expected_total}"
assert len(handler2_events) == expected_total, f"Handler2 received {len(handler2_events)} events, expected {expected_total}"
def test_concurrent_handler_registration_thread_safety():
"""Test that concurrent handler registration is thread-safe"""
registered_handlers = []
def register_handler(thread_id):
"""Register a handler from a specific thread"""
def handler(source, event):
pass
handler.__name__ = f"handler_{thread_id}"
crewai_event_bus.register_handler(TestEvent, handler)
registered_handlers.append(handler)
num_threads = 10
with ThreadPoolExecutor(max_workers=num_threads) as executor:
futures = []
for thread_id in range(num_threads):
future = executor.submit(register_handler, thread_id)
futures.append(future)
for future in futures:
future.result()
assert len(registered_handlers) == num_threads
assert len(crewai_event_bus._handlers[TestEvent]) >= num_threads
def test_thread_safety_with_mixed_operations():
"""Test thread safety when mixing event emission and handler registration"""
received_events = []
event_lock = threading.Lock()
with crewai_event_bus.scoped_handlers():
def emit_events(thread_id):
for i in range(10):
event = TestEvent(type="test_event")
crewai_event_bus.emit(f"source-{thread_id}", event)
time.sleep(0.001)
def register_handlers(thread_id):
for i in range(5):
def handler(source, event):
with event_lock:
received_events.append(f"Handler-{thread_id}-{i}: {event.type}")
handler.__name__ = f"handler_{thread_id}_{i}"
crewai_event_bus.register_handler(TestEvent, handler)
time.sleep(0.001)
with ThreadPoolExecutor(max_workers=6) as executor:
futures = []
for thread_id in range(3):
futures.append(executor.submit(emit_events, thread_id))
for thread_id in range(3):
futures.append(executor.submit(register_handlers, thread_id))
for future in futures:
future.result()
assert len(received_events) >= 0