test(debugging): reduce flakiness in status logger [backport 1.16] (#6745)

Backport c46b216 from #6627 to 1.16.

We remove some flakiness around probe status message testing by adding a
wait logic to the mocked probe status logger.

## Checklist

- [x] Change(s) are motivated and described in the PR description.
- [x] Testing strategy is described if automated tests are not included
in the PR.
- [x] Risk is outlined (performance impact, potential for breakage,
maintainability, etc).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] [Library release note
guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html)
are followed. If no release note is required, add label
`changelog/no-changelog`.
- [x] Documentation is included (in-code, generated user docs, [public
corp docs](https://github.com/DataDog/documentation/)).
- [x] Backport labels are set (if
[applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting))

## Reviewer Checklist

- [x] Title is accurate.
- [x] No unnecessary changes are introduced.
- [x] Description motivates each change.
- [x] Avoids breaking
[API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces)
changes unless absolutely necessary.
- [x] Testing strategy adequately addresses listed risk(s).
- [x] Change is maintainable (easy to change, telemetry, documentation).
- [x] Release note makes sense to a user of the library.
- [x] Reviewer has explicitly acknowledged and discussed the performance
implications of this PR as reported in the benchmarks PR comment.
- [x] Backport labels are set in a manner that is consistent with the
[release branch maintenance
policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)

Co-authored-by: Gabriele N. Tornetta <[email protected]>

Author: github-actions[bot]

tests/debugging/mocking.py

@@ -71,6 +71,19 @@ def __init__(self, service, encoder):
         super(MockProbeStatusLogger, self).__init__(service, encoder)
         self.queue = []
 
+    def clear(self):
+        self.queue[:] = []
+
+    def wait(self, cond, timeout=1.0):
+        end = monotonic() + timeout
+
+        while monotonic() < end:
+            if cond(self.queue):
+                return True
+            sleep(0.01)
+
+        raise PayloadWaitTimeout()
+
 
 class TestSignalCollector(SignalCollector):
     def __init__(self, *args, **kwargs):

tests/debugging/test_debugger.py

@@ -693,7 +693,7 @@ def request(self, *args, **kwargs):
     RemoteConfigClient.request = request
     assert remoteconfig_poller.status == ServiceStatus.STOPPED
     try:
-        with rcm_endpoint(), debugger(diagnostics_interval=0.3, enabled=True) as d:
+        with rcm_endpoint(), debugger(diagnostics_interval=0.0, enabled=True) as d:
             d.add_probes(
                 create_snapshot_line_probe(
                     version=1,
@@ -713,7 +713,8 @@ def request(self, *args, **kwargs):
                 ),
             )
 
-            queue = d.probe_status_logger.queue
+            logger = d.probe_status_logger
+            queue = logger.queue
 
             def count_status(queue):
                 return Counter(_["debugger"]["diagnostics"]["status"] for _ in queue)
@@ -725,16 +726,14 @@ def versions(queue, status):
                     if _["debugger"]["diagnostics"]["status"] == status
                 ]
 
-            sleep(0.1)
-            assert count_status(queue) == {"INSTALLED": 2, "RECEIVED": 1}
+            logger.wait(lambda q: count_status(q) == {"INSTALLED": 2, "RECEIVED": 1})
             assert versions(queue, "INSTALLED") == [1, 2]
             assert versions(queue, "RECEIVED") == [1]
 
-            queue[:] = []
-            sleep(0.5)
+            logger.clear()
             remoteconfig_poller._client.request()
-            sleep(0.1)
-            assert count_status(queue) == {"INSTALLED": 1}
+
+            logger.wait(lambda q: count_status(q) == {"INSTALLED": 1})
             assert versions(queue, "INSTALLED") == [2]
 
     finally: