MerginProject may not get cleaned up properly
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
Research direction
Start by locating MerginProject's pygeodiff GeoDiff creation and logger-callback setup, then compare the cleanup fix in mergin-db-sync PR 79 and the related geodiff issue 190. Done means repeated MerginProject creation no longer retains the cyclic references or causes resources to grow, using the reproduction loop to verify cleanup.
Written by the indexing model from the issue text.
Description
When MerginProject is created, it creates geodiff object and assigns an internal logger to geodiff. This creates a cyclic reference (pygeodiff refs MerginProject, and MerginProject refs pygeodiff) that may keep resources held, which may be a problem if MerginProject object is created many times. See also fix for this in db-sync: https://github.com/MerginMaps/mergin-db-sync/pull/79
Also somehow related: https://github.com/MerginMaps/geodiff/issues/190
Code snippet to replicate the cleanup issue:
import pygeodiff
class MerginProjectX:
def __init__(self, directory):
def _logger_callback(level, text_bytes):
self.x() # not a real function, but refs this object...
self.geodiff = pygeodiff.GeoDiff()
self.geodiff.set_logger_callback(_logger_callback)
# this will keep consuming more and more resources
for i in range(50000):
print(i)
mp = MerginProjectX("x")
#mp.geodiff = None # this helps to break ref cycle
time.sleep(0.005)
- Dominant language
- Python
- Stars
- 23
- Forks
- 12
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 7
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from MerginMaps/python-api-client
-
Vacuuming Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
MerginMaps/python-api-client#320 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
MerginMaps/python-api-client#270 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
MerginMaps/python-api-client#257 · 3 comments ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 25/100
MerginMaps/python-api-client#254 · 1 comment ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
MerginMaps/python-api-client#245 ·
All issues in MerginMaps/python-api-client
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·