Fix memory leaks & Improve README #24
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nao-ris
changed the title
DamienVoreiter
approved these changes
Mar 24, 2025
Nao-ris
added a commit
that referenced
this pull request
Mar 26, 2025
In PR #24 I started removing memory leaks by checking them when the utility function `with_db` was used in unit tests. This PR finalizes that process. It contains a new utility class `LeakChecker` that checks the leaks for a unit test. `LeakChecker` is added to the utility classes `ReplicationTwoDbsTester` and `ReplicationThreeDbsTester`, used to test replication use cases. `LeakChecker` is also added to all tests that do not use one of the three utility function & classes. Three new sources of memory leaks were discovered this time: - in `src/encryptable.rs`, `reference` was used instead of `take_ownership` when creating a new `Encryptable` - in `src/replicator.rs`, the struct `Endpoint` was not implementing `Drop` - in `src/replicator.rs`, when a `Replicator` was created we were not giving ownership of the `CBLDatabase` object to the `CBLReplicatorConfiguration` object
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
TestGh workflow is enhanced by also running the whole test suite with theLEAK_CHECKenvironment variable.While testing this functionality, it became apparent that we had memory leaks on
CBLCollection,CBLScope&CBLQueryIndexobjects.The functions
retainandwrapwere not clear enough on what they did, especially with the doc comments that were inverted. So the changes are:retaintoreferencewraptotake_ownershipCBLCollection,CBLScope&CBLQueryIndexDropforQueryIndexThe tests are now passing with the
LEAK_CHECKenvironment variable.Additional changes:
community&enterprise) more understandablesrc/main.rsis deleted as this is a library