This repository was archived by the owner on Oct 17, 2021. It is now read-only.
Fix memory leaks #22
Merged
Fix memory leaks #22
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
Member
Author
|
FYI: this seems to still need some work. I'm on it, stay tuned (aiming for later today)! |
Contributor
|
@regexident Thanks for the heads-up. Awesome work so far! I converted this PR to a draft to make sure this doesn't get merged accidentally before it's ready. What else needs to go in? |
Member
Author
|
The remaining issues at hand:
See latest commits. |
Member
Author
|
With these latest commits pushed this PR should be (almost) ready to review/merge. I say "almost" since interestingly now the XCTAssertEqual failed: (
"<p><a href="https://www.un.org/en/universal-declaration-human-rights/" title="View full version">Universal Declaration of
Human Rights</a></p>
"
) is not equal to (
"<p><a href="https://www.un.org/en/universal-declaration-human-rights/" title="View full version"></a></p>
"
)
As you can see the description lacks the title "Universal Declaration of Human Rights" for some weird reason. So to get an idea of where the fault is I added this to the test method: print()
print("Initial:", link)
print()
print("Initial title:", link.title as Any)
print()
print("Commonmark:", commonmark)
print()
print("Decoded:", decoded[0])
print()
print("Decoded title:", decoded[0].title as Any)
print()Which produced the following: So it looks like the title gets lost in the decoding somehow. Which is weird, since it's based on the same call to But wait, it gets even weirder! 🤯 If I call Any idea what's going on here, @mattt? |
Due to the memory leak caused by never setting `self.managed = true` on decoding of `Document` the dangling pointers produced by `Node.init(from:)` did not cause a crash before. The implementation simply decoded a `Document` and then pulled its root node out without properly unlinking it from the document and re-assigning the memory management duties.
Remove implicit internal access modifier
…anaged:` argument
…with `node.drain()`
…'s underlying format anyway
… failing `func testInlineElementCodingRoundTrip()`
Contributor
|
Running the unit tests with Address Sanitizer enabled shows the root cause of the test failure for |
Contributor
|
@regexident I spent a good hour or two trying to find anything wrong with the code you wrote. After exhausting all of my leads, I considered whether the memory bug was in cmark itself (as ASAN seemed to indicate). Sure enough, updating to 0.29.0 (#24) resolves the failing test case. |
Member
Author
|
Hah! I spent some time in the cmark code-base looking, too. But mostly looking for things that might point to CommonMark making wrong use of their API, but couldn't find anything. Thanks for the helping hand @mattt! |
mattt
reviewed
Jan 2, 2021
Annotate removeChildren with @discardableResult Move removeChildren declaration under remove Rewrite inline comments
Make references to node, inline elements, block structures, and list items consistent
Member
Author
|
LGTM! 💪 |
Contributor
|
Thanks for your patience and all of your help with this, @regexident. Merging this in now! |
Member
Author
|
Awesome! Glad I could help. 🙂 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Fixes a memory leak in
Document.init(_:options:), as well as a memory safety bug (dangling pointers) caused by an erroneous implementation ofNode.init(from:), which was hidden by the memory leak.Due to the memory leak caused by never setting
self.managed = trueon decoding ofDocumentthe dangling pointers produced byNode.init(from:)did not cause a crash before.The previous implementation simply decoded a
Documentand then pulled its root node out without properly unlinking it from the document and re-assigning the memory management duties. So when theDocumentgets deinitialized any pointers to its contents are no longer valid (unless the document leaks its contents, which it did).Fixes #19