[Ops] Add debug logging to certain jest error cases #175988
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
|
Pinging @elastic/kibana-operations (Team:Operations) |
💚 Build Succeeded
Metrics [docs]
To update your PR or re-run it, just comment with: |
jbudz
approved these changes
Jan 31, 2024
fkanout
pushed a commit
to fkanout/kibana
that referenced
this pull request
Feb 7, 2024
## Summary We see quite frequently this kind of error in Jest unit tests: ``` Error: The `document` global was defined when React was initialized, but is not defined anymore. This can happen in a test environment if a component schedules an update from an asynchronous callback, but the test has already finished running. To solve this, you can either unmount the component at the end of your test (and ensure that any asynchronous operations get canceled in `componentWillUnmount`), or you can change the test itself to be asynchronous. ``` As the test execution stops due to this runtime error, and the console logging is disabled in CI, we don't see a lot of the context of the error. This PR adds minimal extra logging when the case of this error happens.
CoenWarmer
pushed a commit
to CoenWarmer/kibana
that referenced
this pull request
Feb 15, 2024
## Summary We see quite frequently this kind of error in Jest unit tests: ``` Error: The `document` global was defined when React was initialized, but is not defined anymore. This can happen in a test environment if a component schedules an update from an asynchronous callback, but the test has already finished running. To solve this, you can either unmount the component at the end of your test (and ensure that any asynchronous operations get canceled in `componentWillUnmount`), or you can change the test itself to be asynchronous. ``` As the test execution stops due to this runtime error, and the console logging is disabled in CI, we don't see a lot of the context of the error. This PR adds minimal extra logging when the case of this error happens.
fkanout
pushed a commit
to fkanout/kibana
that referenced
this pull request
Mar 4, 2024
## Summary We see quite frequently this kind of error in Jest unit tests: ``` Error: The `document` global was defined when React was initialized, but is not defined anymore. This can happen in a test environment if a component schedules an update from an asynchronous callback, but the test has already finished running. To solve this, you can either unmount the component at the end of your test (and ensure that any asynchronous operations get canceled in `componentWillUnmount`), or you can change the test itself to be asynchronous. ``` As the test execution stops due to this runtime error, and the console logging is disabled in CI, we don't see a lot of the context of the error. This PR adds minimal extra logging when the case of this error happens.
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.
Summary
We see quite frequently this kind of error in Jest unit tests:
As the test execution stops due to this runtime error, and the console logging is disabled in CI, we don't see a lot of the context of the error.
This PR adds minimal extra logging when the case of this error happens.