phanos 0.3.2__tar.gz → 0.3.3__tar.gz

{phanos-0.3.2 → phanos-0.3.3}/CHANGELOG.md

@@ -6,6 +6,14 @@ this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.3] - 2026-10-26
+
+### Fixed
+
+ - `ContextTree.find_and_delete_node` searched only the first branch of the tree - with concurrent requests
+   (async) a node of a finished request was not found and stayed in the tree forever (memory leak)
+ - `ContextTree.clear` skipped every other sibling node
+
 ## [0.3.2] - 2024-03-21
 
 ### Changed
@@ -14,6 +22,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
  - `Profiler.tree` is now initialized in `Profiler.__init__` instead of in configuration methods
 
 ### Fixed
+
  - `curr_node` ContextVar and `Profiler.tree` are now properly initialized in `Profiler` instance
 
 ## [0.3.1] - 2024-03-21

{phanos-0.3.2 → phanos-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.5
 Name: phanos
-Version: 0.3.2
+Version: 0.3.3
 Summary: Python client to gather data for Prometheus logging in server with multiple instances and workers.
 Project-URL: Homepage, https://github.com/kajotgames/phanos
 Project-URL: Bug Tracker, https://github.com/kajotgames/phanos/issues

{phanos-0.3.2 → phanos-0.3.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "phanos"
-version = "0.3.2"
+version = "0.3.3"
 authors = [
   { name="Miroslav Bulička", email="bulickamiroslav@gmail.com" },
 ]

{phanos-0.3.2 → phanos-0.3.3}/src/phanos/tree.py

@@ -122,7 +122,8 @@ class ContextTree(log.InstanceLoggerMixin):
             return deleted
 
         for child in root.children:
-            return self._find_and_delete_node(node, child)
+            if self._find_and_delete_node(node, child):
+                return True
 
         return False
 
@@ -141,7 +142,8 @@ class ContextTree(log.InstanceLoggerMixin):
 
     def _clear(self, root: MethodTreeNode) -> None:
         """Deletes whole subtree starting from param 'root'. Deletes from bottom to top"""
-        for child in root.children:
+        # a copy - deleting a child removes it from `root.children`
+        for child in list(root.children):
             self._clear(child)
 
         if not root == self.root:

{phanos-0.3.2 → phanos-0.3.3}/test/test_tree.py

@@ -153,6 +153,21 @@ class TestContextTree(unittest.TestCase):
             self.assertTrue(ctx_tree.find_and_delete_node(node))
             mock_delete_node.assert_called_with(node)
 
+    @unittest.skipUnless(test_init, SKIP_REASON_INIT)
+    def test_find_and_delete_node_beyond_first_branch(self):
+        """concurrent requests leave sibling nodes - a node in any branch must be found, not only in the first one"""
+        ctx_tree, node, child1, child2 = construct_tree()
+        sibling = MethodTreeNode(dummy_api.DummyDbAccess.test_method)
+        ctx_tree.root.add_child(sibling)
+
+        with self.subTest("second child of the root"):
+            self.assertTrue(ctx_tree.find_and_delete_node(sibling))
+            self.assertEqual(ctx_tree.root.children, [node])
+
+        with self.subTest("second child of a nested node"):
+            self.assertTrue(ctx_tree.find_and_delete_node(child2))
+            self.assertEqual(node.children, [child1])
+
     @unittest.skipUnless(test_init, SKIP_REASON_INIT)
     @patch("src.phanos.tree.ContextTree.delete_node")
     def test_clear(self, mock_delete_node: MagicMock):
@@ -166,3 +181,16 @@ class TestContextTree(unittest.TestCase):
         self.assertIn(node, call_nodes)
         self.assertIn(child1, call_nodes)
         self.assertIn(child2, call_nodes)
+
+    @unittest.skipUnless(test_init, SKIP_REASON_INIT)
+    def test_clear_deletes_all_siblings(self):
+        ctx_tree, node, child1, child2 = construct_tree()
+        siblings = [MethodTreeNode(dummy_api.DummyDbAccess.test_method) for _ in range(3)]
+        for sibling in siblings:
+            ctx_tree.root.add_child(sibling)
+
+        ctx_tree.clear()
+
+        self.assertEqual(ctx_tree.root.children, [])
+        for deleted in [node, child1, child2, *siblings]:
+            self.assertIsNone(deleted.parent)