un-monkey-patch OpenElementStack to avoid leaks #2831
Closed
Conversation
This file contains 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
A monkey-patch as modified by commit 75a921e maintains a reference to the most recent JSDOMParse5Adapter (and all its options) through the push/pop closures. Because the monkey-patches are never cleaned up, there is always a reference to the most recent JSDOMParse5Adapter and its related objects. This fixes jestjs/jest#9507 This may fix jsdom#2757
|
I just noticed #2825 beat me to the punch by a few days. I'll happily close this if y'all maintainers prefer the other approach. I assume the unintentional test fix is due to how this code stacks parser adapters rather than keeping and overwriting one reference. |
domenic
added a commit
that referenced
this pull request
Feb 16, 2020
The monkey-patch for maintaining the open element stack, as modified by commit 75a921e, maintained a reference to the most recent JSDOMParse5Adapter (and all its options) through the push/pop closures. This means there was always a reference from the rooted OpenElementStack.prototype.{push,pop} functions to the most recent JSDOMParse5Adapter and its related objects. This commit instead uses the this.treeAdapter pointer, which already exists in parse5. Doing so also allows us to move the monkeypatch back into the top level, instead of establishing it on construction of each tree adapter. Closes #2831. Closes #2825. Fixes jestjs/jest#9507.
TimothyGu
reviewed
Feb 16, 2020
| // Horrible monkey-patch to implement https://github.com/inikulin/parse5/issues/237 | ||
| OpenElementStack.prototype.push = function (...args) { | ||
| OpenElementStackOriginalPush.apply(this, args); | ||
| adapterStack[adapterStack.length - 1]._currentElement = this.current; |
There was a problem hiding this comment.
This should have a check for adapterStack not empty, just in case parse5 is used elsewhere not in jsdom.
domenic
added a commit
that referenced
this pull request
Feb 16, 2020
The monkey-patch for maintaining the open element stack, as modified by commit 75a921e, maintained a reference to the most recent JSDOMParse5Adapter through the push/pop closures. This means there was always a reference from the rooted OpenElementStack.prototype.{push,pop} functions to the most recent JSDOMParse5Adapter and its related objects. Since one of the related objects was an element, which has a pointer to a document and window, essentially the whole JSDOM would be retained. This commit instead uses the this.treeAdapter pointer, which already exists in parse5. Doing so also allows us to move the monkeypatch back into the top level, instead of establishing it on construction of each tree adapter. Closes #2831. Closes #2825. Helps with the root cause of jestjs/jest#9507.
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.
A monkey-patch as modified by commit 75a921e
maintains a reference to the most recent JSDOMParse5Adapter (and all its
options) through the push/pop closures. Because the monkey-patches are
never cleaned up, there is always a reference to the most recent
JSDOMParse5Adapter and its related objects.
This fixes jestjs/jest#9507
This may fix #2757