qunitjs / qunit

🔮 An easy-to-use JavaScript unit testing framework.
https://qunitjs.com
MIT License
4.02k stars 783 forks source link

Core: Fix missing second frame in QUnit.stack() in Safari #1776

Closed Krinkle closed 1 week ago

Krinkle commented 1 week ago

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:

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.