Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions src/braket/tracking/tracking_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,34 +13,43 @@

from __future__ import annotations

import threading


class TrackingContext:
def __init__(self):
self._trackers = set()
self._lock = threading.Lock()

def register_tracker(self, tracker: Tracker) -> None: # ruff:ignore[undefined-name]
"""Registers a tracker.

Args:
tracker (Tracker): The tracker.
"""
self._trackers.add(tracker)
with self._lock:
self._trackers.add(tracker)

def deregister_tracker(self, tracker: Tracker) -> None: # ruff:ignore[undefined-name]
"""Deregisters a tracker.

Args:
tracker (Tracker): The tracker.
"""
self._trackers.remove(tracker)
with self._lock:
self._trackers.remove(tracker)

def broadcast_event(self, event: _TrackingEvent) -> None: # ruff:ignore[undefined-name]
"""Broadcasts an event to all trackers.

Args:
event (_TrackingEvent): The event to broadcast.
"""
for tracker in self._trackers:
# Iterate over a snapshot so that trackers registering or deregistering
# concurrently (or from receive_event) cannot mutate the set mid-iteration.
with self._lock:
trackers = list(self._trackers)
for tracker in trackers:
tracker.receive_event(event)

def active_trackers(self) -> set:
Expand Down
17 changes: 17 additions & 0 deletions test/unit_tests/braket/tracking/test_tracking_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,20 @@ def test_broadcast_event():
broadcast_event("EVENT")
tracker.receive_event.assert_called_with("EVENT")
deregister_tracker(tracker)


def test_broadcast_event_tracker_deregisters_during_broadcast():
class SelfDeregisteringTracker:
def __init__(self):
self.events = []

def receive_event(self, event):
self.events.append(event)
deregister_tracker(self)

trackers = [SelfDeregisteringTracker() for _ in range(2)]
for tracker in trackers:
register_tracker(tracker)
broadcast_event("EVENT")
assert all(tracker.events == ["EVENT"] for tracker in trackers)
assert active_trackers() == set()
Loading