🐛 Revert Errors serialization behavior

[yannickadam]

Motivation

Change of behavior when serializing errors:
#2195

Previously, an errror was serialized as an empty object {}. However, additional properties (added manually or from a custom error) were serialized:

const err = new Error('test')
err.myProp = 42

JSON.stringify(err)
=> { myProp : 42 }

Errors fall in the catch-all within the sanitize process, resulting in :

sanitize(err)
=> '[Error]'

Changes

Specific handler for instanceof Error
Serialize additional properties from errors
=> [Error] reverts back to {} (empty object) for errors without additional properties.

Testing

• Local
• Staging
• Unit
• End to end

---

I have gone over the contributing documentation.

[codecov-commenter]

Codecov Report

Merging #2197 (6363cfa) into main (991e974) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #2197      +/-   ##
==========================================
+ Coverage   93.81%   93.90%   +0.08%     
==========================================
  Files         201      201              
  Lines        6082     6088       +6     
  Branches     1347     1349       +2     
==========================================
+ Hits         5706     5717      +11     
+ Misses        376      371       -5     

Impacted Files	Coverage Δ
packages/core/src/tools/serialisation/sanitize.ts	100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[yannickadam]

/to-staging

[dd-devflow]

🚂 Branch Integration

commit 859cdee will soon be integrated into staging-18.

This build is going to start soon! (estimated merge in less than 0s)

you can cancel this operation by commenting your pull request with /to-staging -c!

[dd-devflow]

🚂 Branch Integration

commit 859cdee has been merged into staging-18

[BenoitZugmeyer]

🥜 nitpick: ‏did you try using { ...error } or Object.assign({}, error) instead of JSON.stringify? It should yield better message when the assertion fails

Suggested change

	expect(JSON.stringify(sanitize(error))).toEqual(JSON.stringify(error))
	expect(sanitize(error)).toEqual({ ...error })