Core: Fix missing second frame in QUnit.stack() in Safari #1776
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
Safari implements ES6 Tail-Call Optimization, which is when: - the file is in strict mode, - and, in a regular function (not async or generator), - and, the return statement ends in a simple function call. Then, the current function is removed from the stack before the child function begins. TCO applies even for calls that are not recursive. The result is that, given: > makeFakeFailure -> exampleMain -> exampleParent -> exampleCurrent -> > QUnit.stack -> sourceFromStacktrace -> new Error. In Firefox and Chrome, `e.stack` is: ``` [0] sourceFromStacktrace (SLICED) [1] QUnit.stack (SLICED) [2] exampleCurrent [3] exampleParent [4] exampleMain [5] makeFakeFailure ``` But, in Safari, the second frame gets lost because our tiny `QUnit.stack()` function is a candidate for Tail-Call Optimization. ``` [0] sourceFromStacktrace (SLICED) [1] exampleCurrent (SLICED) [2] exampleParent [3] exampleMain [4] makeFakeFailure ``` This, combined with the fact that we strip the first two frames as a way to hide internal offsets, meant that in Safari we ended up attributing failed assertions and test definitions to the parent of the caller rather than the actual caller, e.g. exampleParent() instead of exampleCurrent. Ref https://bugs.webkit.org/show_bug.cgi?id=276187.
Krinkle
added a commit
that referenced
this pull request
Jul 19, 2024
Cherry-picked from 52f37b8 (3.0.0-dev) > Ref #1776. > Ref https://bugs.webkit.org/show_bug.cgi?id=276187.
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.
Safari implements ES6 Tail-Call Optimization, which is when:
Then, the current function is removed from the stack before the child function begins. TCO applies even for calls that are not recursive.
The result is that, given:
In Firefox and Chrome,
e.stackis:But, in Safari, the second frame gets lost because our tiny
QUnit.stack()function is a candidate for Tail-Call Optimization.This, combined with the fact that we strip the first two frames as a way to hide internal offsets, meant that in Safari we ended up attributing failed assertions and test definitions to the parent of the caller rather than the actual caller, e.g. exampleParent() instead of exampleCurrent.
Ref https://bugs.webkit.org/show_bug.cgi?id=276187.