[jest-util] Add ErrorWithStack class

[mattphillips]

Summary

Removes the duplication of:

const error = new Error('whatever');
if (Error.captureStackTrace) {
  Error.captureStackTrace(error, someFunction);
}

Motivation: see @SimenB's #7033 (comment)

Test plan

• Added unit test for new class
• All existing test should pass

Notes

I've not updated the expect package with this change as I believe it cannot depend on jest-util because of bundling for the browser, is this correct? cc/ @thymikee @rickhanlonii

[SimenB]

I believe it cannot depend on jest-util because of bundling for the browser

Correct, but we should fix that. Or have like jest-isomorphic-utils and jest-node-utils instead.

(Yes, that was a joke, but you know what I mean)

[SimenB]

So good! A changelog entry in case it breaks some traces would be nice, other than that this looks great

[thymikee]

so nice <3

[thymikee]

mind adding preamble and flow?

[mattphillips]

woops just added :)

[thymikee]

would be cool to flow it up

[mattphillips]

Not sure it's worth adding flow to the test, it causes the following issue (which I'd have to disable):

[flow] Cannot assign `jest.fn()` to `Error.captureStackTrace` because property `captureStackTrace` is not writable. (error_with_stack.test.js:17:11)

Happy to add it though if you think we should :)

[thymikee]

That's fine. It's just nice to have flow in tests too so you don't end up testing scenarios that are already covered/prevented by type checker.

[mattphillips]

Make sense, I've updated to use jest.spyOn instead and added @flow with no warnings 🎉

[SimenB]

Rebase on master and use for 49b2380?

[codecov-io]

Codecov Report

Merging #7067 into master will increase coverage by 0.06%.
The diff coverage is 35.29%.

@@            Coverage Diff            @@
##           master   #7067      +/-   ##
=========================================
+ Coverage   66.63%   66.7%   +0.06%     
=========================================
  Files         251     252       +1     
  Lines       10542   10521      -21     
  Branches        3       3              
=========================================
- Hits         7025    7018       -7     
+ Misses       3516    3502      -14     
  Partials        1       1

Impacted Files	Coverage Δ
packages/jest-jasmine2/src/jasmine/Env.js	0% <0%> (ø)	⬆️
packages/jest-runner/src/run_test.js	3.07% <0%> (+0.09%)	⬆️
packages/jest-jasmine2/src/error_on_private.js	0% <0%> (ø)	⬆️
packages/jest-util/src/index.js	0% <0%> (ø)	⬆️
packages/jest-cli/src/collectHandles.js	0% <0%> (ø)	⬆️
packages/jest-each/src/bind.js	71.29% <100%> (-1.92%)	⬇️
packages/jest-util/src/error_with_stack.js	100% <100%> (ø)
packages/jest-circus/src/index.js	72.54% <33.33%> (+6.92%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 49b2380...93bb48e. Read the comment docs.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.