[scout] Add Jest events reporter#214662
Merged
dolaru merged 27 commits intoelastic:mainfrom Apr 3, 2025
Merged
Conversation
Same as for Playwright, this adds a custom Jest reporter that records and uploads test events.
dolaru
added
release_note:skip
Prevents issues around transpiling when invoking tests from an IDE.
To serve as an example.
csr
reviewed
Mar 19, 2025
csr
reviewed
Mar 19, 2025
wayneseymour
approved these changes
Mar 19, 2025
Contributor
wayneseymour
left a comment
wayneseymour
left a comment
There was a problem hiding this comment.
A question or two, but looks good. Ran it on my machine and I see that it did not upload, as it should not, but did record the results to .scout/reports/scout-jest-075d4121641ca89a/event-log.ndjson
csr
reviewed
Mar 20, 2025
jbudz
approved these changes
Mar 25, 2025
Contributor
jbudz
left a comment
jbudz
left a comment
There was a problem hiding this comment.
The jest-preset changes LGTM.
I'm out of the loop on where we're headed with the testing changes and am probably not the best source to review. I can do a closer look on specifics if needed but need to get up to speed on the background.
This will produce a decent amount of data, may be worth considering a gradual rollout.
Contributor
Author
Member
|
Following up - the color stripping is working well on my side! 👏 thanks! 
|
Contributor
💚 Build Succeeded
Metrics [docs]
History
cc @dolaru |
Contributor
|
Starting backport for target branches: 8.x, 9.0 https://github.com/elastic/kibana/actions/runs/14250021909 |
kibanamachine
added a commit
to kibanamachine/kibana
that referenced
this pull request
Apr 3, 2025
## Summary Same as for Playwright, this adds a custom Jest reporter that records and uploads test events. ## Quirks ### Config file path Jest is not including the path to the config file used to run the tests in any information passed to the reporter, so this needs to be passed in the `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the `scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable will be populated with the correct value automatically. ### All the events are produced when the run has completed This is different from the other reporters because the custom reporter interface in Jest is giving the reporter access to necessary info at init or when the run starts. The earliest we can start producing the Scout events is, unfortunately, only after the test run has completed. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Cesare de Cal <cesare.decal@elastic.co> (cherry picked from commit 563c7c3)
kibanamachine
added a commit
to kibanamachine/kibana
that referenced
this pull request
Apr 3, 2025
## Summary Same as for Playwright, this adds a custom Jest reporter that records and uploads test events. ## Quirks ### Config file path Jest is not including the path to the config file used to run the tests in any information passed to the reporter, so this needs to be passed in the `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the `scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable will be populated with the correct value automatically. ### All the events are produced when the run has completed This is different from the other reporters because the custom reporter interface in Jest is giving the reporter access to necessary info at init or when the run starts. The earliest we can start producing the Scout events is, unfortunately, only after the test run has completed. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Cesare de Cal <cesare.decal@elastic.co> (cherry picked from commit 563c7c3)
Contributor
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Apr 3, 2025
# Backport This will backport the following commits from `main` to `8.x`: - [[scout] Add Jest events reporter (#214662)](#214662) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"David Olaru","email":"dolaru@elastic.co"},"sourceCommit":{"committedDate":"2025-04-03T18:20:33Z","message":"[scout] Add Jest events reporter (#214662)\n\n## Summary\n\nSame as for Playwright, this adds a custom Jest reporter that records\nand uploads test events.\n\n## Quirks\n\n### Config file path\nJest is not including the path to the config file used to run the tests\nin any information passed to the reporter, so this needs to be passed in\nthe `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the\n`scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable\nwill be populated with the correct value automatically.\n\n### All the events are produced when the run has completed\nThis is different from the other reporters because the custom reporter\ninterface in Jest is giving the reporter access to necessary info at\ninit or when the run starts. The earliest we can start producing the\nScout events is, unfortunately, only after the test run has completed.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Cesare de Cal <cesare.decal@elastic.co>","sha":"563c7c3388bcef479a45ea69b45e4236822c8703","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:version","test:scout","v9.1.0","v8.19.0","v9.0.1"],"title":"[scout] Add Jest events reporter","number":214662,"url":"https://github.com/elastic/kibana/pull/214662","mergeCommit":{"message":"[scout] Add Jest events reporter (#214662)\n\n## Summary\n\nSame as for Playwright, this adds a custom Jest reporter that records\nand uploads test events.\n\n## Quirks\n\n### Config file path\nJest is not including the path to the config file used to run the tests\nin any information passed to the reporter, so this needs to be passed in\nthe `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the\n`scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable\nwill be populated with the correct value automatically.\n\n### All the events are produced when the run has completed\nThis is different from the other reporters because the custom reporter\ninterface in Jest is giving the reporter access to necessary info at\ninit or when the run starts. The earliest we can start producing the\nScout events is, unfortunately, only after the test run has completed.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Cesare de Cal <cesare.decal@elastic.co>","sha":"563c7c3388bcef479a45ea69b45e4236822c8703"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214662","number":214662,"mergeCommit":{"message":"[scout] Add Jest events reporter (#214662)\n\n## Summary\n\nSame as for Playwright, this adds a custom Jest reporter that records\nand uploads test events.\n\n## Quirks\n\n### Config file path\nJest is not including the path to the config file used to run the tests\nin any information passed to the reporter, so this needs to be passed in\nthe `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the\n`scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable\nwill be populated with the correct value automatically.\n\n### All the events are produced when the run has completed\nThis is different from the other reporters because the custom reporter\ninterface in Jest is giving the reporter access to necessary info at\ninit or when the run starts. The earliest we can start producing the\nScout events is, unfortunately, only after the test run has completed.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Cesare de Cal <cesare.decal@elastic.co>","sha":"563c7c3388bcef479a45ea69b45e4236822c8703"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: David Olaru <dolaru@elastic.co>
Contributor
|
Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync. |
kibanamachine
added
the
backport missing
kibanamachine
added a commit
that referenced
this pull request
Apr 8, 2025
# Backport This will backport the following commits from `main` to `9.0`: - [[scout] Add Jest events reporter (#214662)](#214662) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"David Olaru","email":"dolaru@elastic.co"},"sourceCommit":{"committedDate":"2025-04-03T18:20:33Z","message":"[scout] Add Jest events reporter (#214662)\n\n## Summary\n\nSame as for Playwright, this adds a custom Jest reporter that records\nand uploads test events.\n\n## Quirks\n\n### Config file path\nJest is not including the path to the config file used to run the tests\nin any information passed to the reporter, so this needs to be passed in\nthe `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the\n`scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable\nwill be populated with the correct value automatically.\n\n### All the events are produced when the run has completed\nThis is different from the other reporters because the custom reporter\ninterface in Jest is giving the reporter access to necessary info at\ninit or when the run starts. The earliest we can start producing the\nScout events is, unfortunately, only after the test run has completed.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Cesare de Cal <cesare.decal@elastic.co>","sha":"563c7c3388bcef479a45ea69b45e4236822c8703","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:version","test:scout","v9.1.0","v8.19.0","v9.0.1"],"title":"[scout] Add Jest events reporter","number":214662,"url":"https://github.com/elastic/kibana/pull/214662","mergeCommit":{"message":"[scout] Add Jest events reporter (#214662)\n\n## Summary\n\nSame as for Playwright, this adds a custom Jest reporter that records\nand uploads test events.\n\n## Quirks\n\n### Config file path\nJest is not including the path to the config file used to run the tests\nin any information passed to the reporter, so this needs to be passed in\nthe `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the\n`scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable\nwill be populated with the correct value automatically.\n\n### All the events are produced when the run has completed\nThis is different from the other reporters because the custom reporter\ninterface in Jest is giving the reporter access to necessary info at\ninit or when the run starts. The earliest we can start producing the\nScout events is, unfortunately, only after the test run has completed.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Cesare de Cal <cesare.decal@elastic.co>","sha":"563c7c3388bcef479a45ea69b45e4236822c8703"}},"sourceBranch":"main","suggestedTargetBranches":["8.x","9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214662","number":214662,"mergeCommit":{"message":"[scout] Add Jest events reporter (#214662)\n\n## Summary\n\nSame as for Playwright, this adds a custom Jest reporter that records\nand uploads test events.\n\n## Quirks\n\n### Config file path\nJest is not including the path to the config file used to run the tests\nin any information passed to the reporter, so this needs to be passed in\nthe `JEST_CONFIG_PATH` environment variable. If Jest is invoked with the\n`scripts/jest.js` script, the `JEST_CONFIG_PATH` environment variable\nwill be populated with the correct value automatically.\n\n### All the events are produced when the run has completed\nThis is different from the other reporters because the custom reporter\ninterface in Jest is giving the reporter access to necessary info at\ninit or when the run starts. The earliest we can start producing the\nScout events is, unfortunately, only after the test run has completed.\n\n---------\n\nCo-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>\nCo-authored-by: Cesare de Cal <cesare.decal@elastic.co>","sha":"563c7c3388bcef479a45ea69b45e4236822c8703"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"9.0","label":"v9.0.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: David Olaru <dolaru@elastic.co>
kibanamachine
added
v9.0.0
and removed
backport missing
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
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
Same as for Playwright, this adds a custom Jest reporter that records and uploads test events.
Quirks
Config file path
Jest is not including the path to the config file used to run the tests in any information passed to the reporter, so this needs to be passed in the
JEST_CONFIG_PATHenvironment variable. If Jest is invoked with thescripts/jest.jsscript, theJEST_CONFIG_PATHenvironment variable will be populated with the correct value automatically.All the events are produced when the run has completed
This is different from the other reporters because the custom reporter interface in Jest is giving the reporter access to necessary info at init or when the run starts. The earliest we can start producing the Scout events is, unfortunately, only after the test run has completed.