✨ [RUMF-1353] Add Error.cause property #1740
Merged
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
liywjl
commented
Sep 16, 2022
packages/rum-core/src/domain/rumEventsCollection/error/errorCollection.spec.ts
Outdated
Show resolved
Hide resolved
Codecov Report
@@ Coverage Diff @@
## main #1740 +/- ##
=======================================
Coverage 91.03% 91.03%
=======================================
Files 128 128
Lines 4985 4999 +14
Branches 1113 1117 +4
=======================================
+ Hits 4538 4551 +13
- Misses 447 448 +1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
bcaudan
reviewed
Sep 21, 2022
Comment on lines
+168
to
+170
| it('should only return the first 10 errors if nested chain is longer', () => { | ||
| const error = new Error('foo') as ErrorWithCause | ||
| error.cause = error |
Co-authored-by: Bastien Caudan <bastien.caudan@gmail.com>
bcaudan
reviewed
Sep 21, 2022
packages/rum-core/src/domain/rumEventsCollection/error/errorCollection.ts
Outdated
Show resolved
Hide resolved
liywjl
commented
Sep 22, 2022
bcaudan
reviewed
Sep 22, 2022
bcaudan
reviewed
Sep 22, 2022
bcaudan
reviewed
Sep 23, 2022
Comment on lines
138
to
166
| error.stack = 'Error: foo: bar\n at <anonymous>:1:15' | ||
|
|
||
| const nestedError = new Error('biz: buz') as ErrorWithCause | ||
| nestedError.stack = 'NestedError: biz: buz\n at <anonymous>:2:15' | ||
|
|
||
| const deepNestedError = new Error('fiz: buz') as ErrorWithCause | ||
| deepNestedError.stack = 'NestedError: fiz: buz\n at <anonymous>:3:15' | ||
|
|
||
| error.cause = nestedError | ||
| nestedError.cause = deepNestedError | ||
|
|
||
| const formatted = computeRawError({ | ||
| ...DEFAULT_RAW_ERROR_PARMS, | ||
| stackTrace: NOT_COMPUTED_STACK_TRACE, | ||
| stackTrace, | ||
| originalError: error, | ||
| handling: ErrorHandling.HANDLED, | ||
| source: ErrorSource.SOURCE, | ||
| }) | ||
|
|
||
| expect(formatted?.type).toEqual('TypeError') | ||
| expect(formatted?.message).toEqual('some typeError message') | ||
| expect(formatted.causes?.length).toBe(2) | ||
| const causes = formatted.causes as RawErrorCause[] | ||
| expect(causes[0].message).toContain(nestedError.message) | ||
| expect(causes[0].source).toContain(ErrorSource.SOURCE) | ||
| expect(causes[0].type).toEqual('Error') | ||
| expect(causes[1].message).toContain(deepNestedError.message) | ||
| expect(causes[1].source).toContain(ErrorSource.SOURCE) | ||
| expect(causes[1].type).toEqual('Error') |
There was a problem hiding this comment.
💬 suggestion: it seems that:
- the input errors stack are not used in the assertions
- except the message, we can't distinguish the two causes
could we improve that?
There was a problem hiding this comment.
🤦♂️ just saw that in face we were not actually extracting the stack traces from causes correctly. I have fixed that and updated the tests
There was a problem hiding this comment.
Could you ensure that the types are coming from the expected errors as well?
liywjl
changed the title
bcaudan
approved these changes
Sep 23, 2022
BenoitZugmeyer
approved these changes
Sep 29, 2022
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.
Motivation
We want to support the
Error.causeproperty when it is presentChanges
formatUnknownErrorandprocessErrorto addcausesto the RawError objectflattenErrorCausesto flattern nested error causesTesting
I have gone over the contributing documentation.