Skip to content

bug: make sure all pullers in child combine puller also get stopped #3990

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mingkun2020 merged 4 commits into from
Jun 22, 2022
Merged

bug: make sure all pullers in child combine puller also get stopped #3990

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6e495d1
make sure all pullers in child combine puller also get stopped
mingkun2020 Jun 22, 2022
bdcfd79
update unit test
mingkun2020 Jun 22, 2022
b26bfde
remove useless for loop
mingkun2020 Jun 22, 2022
9d2ca13
Merge branch 'develop' into trace_exit_bug
mingkun2020 Jun 22, 2022
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
12 changes: 10 additions & 2 deletions samcli/lib/observability/observability_info_puller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ def load_events(self, event_ids: Union[List[Any], Dict]):
List of event ids that will be pulled
"""

def stop_tailing(self):
self.cancelled = True


# pylint: disable=fixme
# fixme add ABC parent class back once we bump the pylint to a version 2.8.2 or higher
Expand Down Expand Up @@ -187,8 +190,7 @@ def tail(self, start_time: Optional[datetime] = None, filter_pattern: Optional[s
async_context.run_async()
except KeyboardInterrupt:
LOG.info(" CTRL+C received, cancelling...")
for puller in self._pullers:
puller.cancelled = True
self.stop_tailing()

def load_time_period(
self,
Expand Down Expand Up @@ -218,3 +220,9 @@ def load_events(self, event_ids: Union[List[Any], Dict]):
async_context.add_async_task(puller.load_events, event_ids)
LOG.debug("Running all 'load_time_period' tasks in parallel")
async_context.run_async()

def stop_tailing(self):
# if ObservabilityCombinedPuller A is a child puller in other ObservabilityCombinedPuller B, make sure A's child
# pullers stop as well when B stops.
for puller in self._pullers:
puller.stop_tailing()
11 changes: 8 additions & 3 deletions tests/unit/lib/observability/test_observability_info_puller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,11 @@ def test_tail_cancel(self, patched_async_context):

mock_puller_1 = Mock()
mock_puller_2 = Mock()
mock_puller_3 = Mock()

combined_puller = ObservabilityCombinedPuller([mock_puller_1, mock_puller_2])
child_combined_puller = ObservabilityCombinedPuller([mock_puller_3])

combined_puller = ObservabilityCombinedPuller([mock_puller_1, mock_puller_2, child_combined_puller])

given_start_time = Mock()
given_filter_pattern = Mock()
Expand All @@ -97,12 +100,14 @@ def test_tail_cancel(self, patched_async_context):
[
call.add_async_task(mock_puller_1.tail, given_start_time, given_filter_pattern),
call.add_async_task(mock_puller_2.tail, given_start_time, given_filter_pattern),
call.add_async_task(child_combined_puller.tail, given_start_time, given_filter_pattern),
call.run_async(),
]
)

self.assertTrue(mock_puller_1.cancelled)
self.assertTrue(mock_puller_2.cancelled)
self.assertTrue(mock_puller_1.stop_tailing.called)
self.assertTrue(mock_puller_2.stop_tailing.called)
self.assertTrue(mock_puller_3.stop_tailing.called)

@patch("samcli.lib.observability.observability_info_puller.AsyncContext")
def test_load_time_period(self, patched_async_context):
Expand Down