⚡️ Delay computation of Error stack when no cause

[dubzzz]

Description

Up-to-now fast-check was always sealing the stack attached to errors as they popped. With error with cause capabilities we started to draft the required links to pass the instance of Error up to the end. We can thus safely delay the computation of the stack.

As delaying might have unwanted side-effects (maybe our instance of Error would be touched), we prefer not to make this change as part of a minor release.

Over all the breaking is justified by the change we do on the API of the failures. We dropped the previously precomputed errors and only keep the raw instance of errors. Users now have to manipulate it to extract the relevant error if needed.

First piece for #4416

Checklist — Don't delete this checklist and make sure you do the following before opening the PR

• The name of my PR follows gitmoji specification
• My PR references one of several related issues (if any)
  • New features or breaking changes must come with an associated Issue or Discussion
  • My PR does not add any new dependency without an associated Issue or Discussion
• My PR includes bumps details, please run yarn bump and flag the impacts properly
• My PR adds relevant tests and they would have failed without my PR (when applicable)

Advanced

💥 Breaking change: Change property failure output

• Category: ⚡️ Improve performance
• Impacts: Delay retrieval of the stack and message, change property failure output

[changeset-bot]

🦋 Changeset detected

Latest commit: 7f4631f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages

Name	Type
fast-check	Major
@fast-check/ava	Patch
@fast-check/jest	Patch
@fast-check/vitest	Patch
@fast-check/worker	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[pkg-pr-new]

Open in Stackblitz • @fast-check/examples

@fast-check/ava

npm i https://pkg.pr.new/@fast-check/ava@5584

@fast-check/expect-type

npm i https://pkg.pr.new/@fast-check/expect-type@5584

fast-check

npm i https://pkg.pr.new/fast-check@5584

@fast-check/jest

npm i https://pkg.pr.new/@fast-check/jest@5584

@fast-check/packaged

npm i https://pkg.pr.new/@fast-check/packaged@5584

@fast-check/poisoning

npm i https://pkg.pr.new/@fast-check/poisoning@5584

@fast-check/vitest

npm i https://pkg.pr.new/@fast-check/vitest@5584

@fast-check/worker

npm i https://pkg.pr.new/@fast-check/worker@5584

commit: 7f4631f

[github-actions]

👋 A preview of the new documentation is available at: http://677ec8602d825e8419b810e3--dubzzz-fast-check.netlify.app

[github-actions]

👋 A preview of the new documentation is available at: http://677f8880b7517df9440e30af--dubzzz-fast-check.netlify.app

[codecov]

Codecov Report

Attention: Patch coverage is 42.85714% with 20 lines in your changes missing coverage. Please review.

Project coverage is 94.70%. Comparing base (bb46b92) to head (7f4631f).
Report is 3 commits behind head on main.

Files with missing lines	Patch %	Lines
...heck/src/check/runner/utils/RunDetailsFormatter.ts	30.76%	18 Missing ⚠️
packages/fast-check/src/utils/globals.ts	50.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5584      +/-   ##
==========================================
- Coverage   94.91%   94.70%   -0.21%     
==========================================
  Files         235      235              
  Lines       10043    10036       -7     
  Branches     2836     2823      -13     
==========================================
- Hits         9532     9505      -27     
- Misses        511      531      +20     

Flag	Coverage Δ
unit-tests	94.70% <42.85%> (-0.21%)	⬇️
unit-tests-18.x-Linux	94.70% <42.85%> (-0.21%)	⬇️
unit-tests-20.x-Linux	94.70% <42.85%> (-0.21%)	⬇️
unit-tests-22.x-Linux	94.70% <42.85%> (-0.21%)	⬇️
unit-tests-latest-Linux	94.70% <42.85%> (-0.21%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.