Merge v1.2.1 into v1.x.x (#336)

Fix memory leak in the timer.
frequenz-floss · Nov 19, 2024 · b3c98e5 · b3c98e5
2 parents db33fbc + 5d6aedc
commit b3c98e5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -13,3 +13,7 @@
   ```
 
 * `Receiver.filter()` can now properly handle `TypeGuard`s. The resulting receiver will now have the narrowed type when a `TypeGuard` is used.
+
+## Bug Fixes
+
+- Fixed a memory leak in the timer.
diff --git a/src/frequenz/channels/timer.py b/src/frequenz/channels/timer.py
@@ -684,14 +684,20 @@ async def ready(self) -> bool:  # noqa: DOC502
         # could be reset while we are sleeping, in which case we need to recalculate
         # the time to the next tick and try again.
         while time_to_next_tick > 0:
-            await next(
-                asyncio.as_completed(
-                    [
-                        asyncio.sleep(time_to_next_tick / 1_000_000),
-                        self._reset_event.wait(),
-                    ]
-                )
+            _, pending = await asyncio.wait(
+                [
+                    asyncio.create_task(asyncio.sleep(time_to_next_tick / 1_000_000)),
+                    asyncio.create_task(self._reset_event.wait()),
+                ],
+                return_when=asyncio.FIRST_COMPLETED,
             )
+            for task in pending:
+                task.cancel()
+                try:
+                    await task
+                except asyncio.CancelledError:
+                    pass
+
             self._reset_event.clear()
             now = self._now()
             time_to_next_tick = self._next_tick_time - now