[scout] unique runId for reporting, disabled failed test reporter locally by dmlemeshko · Pull Request #209507 · elastic/kibana

dmlemeshko · 2025-02-04T11:16:20Z

Summary

This PR makes few changes to scout reporter:

Recently I found out that Playwright load configuration file multiple times:

first time after you run npx playwright test -c ...
on every worker start

log before:

[main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts
[createPlaywrightConfig] called with runId: 18f35f735a10155c

Running 1 test using 1 worker

[createPlaywrightConfig] called with runId: 2633b4e4c20afa15
[chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess

With our current logic unique runId will be generated on each configuration load, meaning for parallel run we will report failures in different directories instead of the same one.

Playwright doesn't expose any unique identifier for the run, so we have do something similar described in
microsoft/playwright#28941 (comment)

log after fix:

[main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts
[createPlaywrightConfig] called with runId: 310a576f32d3b8a5

Running 1 test using 1 worker

[createPlaywrightConfig] called with runId: 310a576f32d3b8a5
[chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess

We also had a chat with @dolaru and agreed that Scout reporters to be disabled for local test run. Few reasons:

Scout custom reporting targets CI execution: events-based reporter was already disabled
Failed test reporter purpose is to provide html boilerplate to be annotated in pipeline build
When you run tests with IDE playwright plugin it provides its own reporter / history, should be enough.

… local

…reporter-by-default

wayneseymour · 2025-02-04T12:16:07Z

packages/kbn-scout-reporting/src/reporting/index.ts

 ): ReporterDescription => {
-  return ['@kbn/scout-reporting/src/reporting/playwright/failed_test', options];
+  return SCOUT_REPORTER_ENABLED
+    ? ['@kbn/scout-reporting/src/reporting/playwright/failed_test', options]


why is this an array?

It is by design https://playwright.dev/docs/api/class-reporter

Ok, I presume it's to contain more than one reporter much like other test runners. Cool

wayneseymour

Just one question.

wayneseymour · 2025-02-04T12:16:49Z

packages/kbn-scout/src/playwright/config/create_config.test.ts


  beforeEach(() => {
    jest.clearAllMocks();
+    delete process.env.TEST_RUN_ID;


I had no idea you could do this...deleting an env var that was on the cli? Pretty cool

I found few examples of it online: not sure if it is the most optimal, but it works

elasticmachine · 2025-02-04T14:50:47Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 3931d60

Failed CI Steps

Jest Tests #18

Test Failures

[job] [logs] Jest Tests #18 / CustomFieldsForm renders text as default custom field type

Metrics [docs]

✅ unchanged

cc @dmlemeshko

kibanamachine · 2025-02-05T15:35:51Z

Starting backport for target branches: 9.0

https://github.com/elastic/kibana/actions/runs/13160957488

@ess

…ally (elastic#209507) ## Summary This PR makes few changes to scout reporter: Recently I found out that Playwright load configuration file _multiple times_: - first time after you run `npx playwright test -c ...` - on every worker start log before: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 18f35f735a10155c Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 2633b4e4c20afa15 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` With our current logic unique `runId` will be generated on each configuration load, meaning for parallel run we will report failures in different directories instead of the same one. Playwright doesn't expose any unique identifier for the run, so we have do something similar described in microsoft/playwright#28941 (comment) log after fix: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` We also had a chat with @dolaru and agreed that Scout reporters to be disabled for local test run. Few reasons: - Scout custom reporting targets CI execution: events-based reporter was already disabled - Failed test reporter purpose is to provide html boilerplate to be annotated in pipeline build - When you run tests with IDE playwright plugin it provides its own reporter / history, should be enough. (cherry picked from commit 6635fe5)

kibanamachine · 2025-02-05T15:41:59Z

💚 All backports created successfully

Status	Branch	Result
✅	9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@ess

…er locally (#209507) (#209808) # Backport This will backport the following commits from `main` to `9.0`: - [[scout] unique runId for reporting, disabled failed test reporter locally (#209507)](#209507)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>

kibanamachine · 2025-02-06T17:41:04Z

Starting backport for target branches: 8.16, 8.17, 8.18, 8.x, 9.0

https://github.com/elastic/kibana/actions/runs/13184675839

@ess

…ally (elastic#209507) ## Summary This PR makes few changes to scout reporter: Recently I found out that Playwright load configuration file _multiple times_: - first time after you run `npx playwright test -c ...` - on every worker start log before: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 18f35f735a10155c Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 2633b4e4c20afa15 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` With our current logic unique `runId` will be generated on each configuration load, meaning for parallel run we will report failures in different directories instead of the same one. Playwright doesn't expose any unique identifier for the run, so we have do something similar described in microsoft/playwright#28941 (comment) log after fix: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` We also had a chat with @dolaru and agreed that Scout reporters to be disabled for local test run. Few reasons: - Scout custom reporting targets CI execution: events-based reporter was already disabled - Failed test reporter purpose is to provide html boilerplate to be annotated in pipeline build - When you run tests with IDE playwright plugin it provides its own reporter / history, should be enough. (cherry picked from commit 6635fe5)

@ess

…ally (elastic#209507) ## Summary This PR makes few changes to scout reporter: Recently I found out that Playwright load configuration file _multiple times_: - first time after you run `npx playwright test -c ...` - on every worker start log before: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 18f35f735a10155c Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 2633b4e4c20afa15 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` With our current logic unique `runId` will be generated on each configuration load, meaning for parallel run we will report failures in different directories instead of the same one. Playwright doesn't expose any unique identifier for the run, so we have do something similar described in microsoft/playwright#28941 (comment) log after fix: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` We also had a chat with @dolaru and agreed that Scout reporters to be disabled for local test run. Few reasons: - Scout custom reporting targets CI execution: events-based reporter was already disabled - Failed test reporter purpose is to provide html boilerplate to be annotated in pipeline build - When you run tests with IDE playwright plugin it provides its own reporter / history, should be enough. (cherry picked from commit 6635fe5)

kibanamachine · 2025-02-06T17:55:03Z

💔 Some backports could not be created

Status	Branch	Result
❌	8.16	Backport failed because of merge conflicts
❌	8.17	Backport failed because of merge conflicts You might need to backport the following PRs to 8.17: - [Detection Engine][Docs] Updating examples to meet old ascii docs (#207558)
✅	8.18
✅	8.x
❌	9.0	Cherrypick failed because the selected commit (`6635fe5`) is empty. It looks like the commit was already backported in #209808

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 209507

Questions ?

Please refer to the Backport tool documentation

@ess

…ter locally (#209507) (#210087) # Backport This will backport the following commits from `main` to `8.18`: - [[scout] unique runId for reporting, disabled failed test reporter locally (#209507)](#209507)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209507","number":209507,"mergeCommit":{"message":"[scout] unique runId for reporting, disabled failed test reporter locally (#209507)\n\n## Summary\r\n\r\nThis PR makes few changes to scout reporter:\r\n\r\nRecently I found out that Playwright load configuration file _multiple\r\ntimes_:\r\n- first time after you run `npx playwright test -c ...`\r\n- on every worker start\r\n\r\nlog before:\r\n\r\n```\r\n[main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts\r\n[createPlaywrightConfig] called with runId: 18f35f735a10155c\r\n\r\nRunning 1 test using 1 worker\r\n\r\n[createPlaywrightConfig] called with runId: 2633b4e4c20afa15\r\n[chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess\r\n```\r\n\r\nWith our current logic unique `runId` will be generated on each\r\nconfiguration load, meaning for parallel run we will report failures in\r\ndifferent directories instead of the same one.\r\n\r\nPlaywright doesn't expose any unique identifier for the run, so we have\r\ndo something similar described in\r\n\r\nhttps://github.com/microsoft/playwright/issues/28941#issuecomment-1888008102\r\n\r\nlog after fix:\r\n\r\n```\r\n[main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts\r\n[createPlaywrightConfig] called with runId: 310a576f32d3b8a5\r\n\r\nRunning 1 test using 1 worker\r\n\r\n[createPlaywrightConfig] called with runId: 310a576f32d3b8a5\r\n[chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess\r\n```\r\n\r\nWe also had a chat with @dolaru and agreed that Scout reporters to be\r\ndisabled for local test run. Few reasons:\r\n- Scout custom reporting targets CI execution: events-based reporter was\r\nalready disabled\r\n- Failed test reporter purpose is to provide html boilerplate to be\r\nannotated in pipeline build\r\n- When you run tests with IDE playwright plugin it provides its own\r\nreporter / history, should be enough.","sha":"6635fe501c307d567afa71a346fc91a7675e3cc5"}}]}] BACKPORT--> Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>

@ess

…ally (elastic#209507) ## Summary This PR makes few changes to scout reporter: Recently I found out that Playwright load configuration file _multiple times_: - first time after you run `npx playwright test -c ...` - on every worker start log before: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 18f35f735a10155c Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 2633b4e4c20afa15 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` With our current logic unique `runId` will be generated on each configuration load, meaning for parallel run we will report failures in different directories instead of the same one. Playwright doesn't expose any unique identifier for the run, so we have do something similar described in microsoft/playwright#28941 (comment) log after fix: ``` [main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 Running 1 test using 1 worker [createPlaywrightConfig] called with runId: 310a576f32d3b8a5 [chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess ``` We also had a chat with @dolaru and agreed that Scout reporters to be disabled for local test run. Few reasons: - Scout custom reporting targets CI execution: events-based reporter was already disabled - Failed test reporter purpose is to provide html boilerplate to be annotated in pipeline build - When you run tests with IDE playwright plugin it provides its own reporter / history, should be enough.

@ess

…er locally (#209507) (#210088) # Backport This will backport the following commits from `main` to `8.x`: - [[scout] unique runId for reporting, disabled failed test reporter locally (#209507)](#209507)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) \n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sqren/backport)\n\n\n\nCo-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>"}},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209507","number":209507,"mergeCommit":{"message":"[scout] unique runId for reporting, disabled failed test reporter locally (#209507)\n\n## Summary\r\n\r\nThis PR makes few changes to scout reporter:\r\n\r\nRecently I found out that Playwright load configuration file _multiple\r\ntimes_:\r\n- first time after you run `npx playwright test -c ...`\r\n- on every worker start\r\n\r\nlog before:\r\n\r\n```\r\n[main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts\r\n[createPlaywrightConfig] called with runId: 18f35f735a10155c\r\n\r\nRunning 1 test using 1 worker\r\n\r\n[createPlaywrightConfig] called with runId: 2633b4e4c20afa15\r\n[chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess\r\n```\r\n\r\nWith our current logic unique `runId` will be generated on each\r\nconfiguration load, meaning for parallel run we will report failures in\r\ndifferent directories instead of the same one.\r\n\r\nPlaywright doesn't expose any unique identifier for the run, so we have\r\ndo something similar described in\r\n\r\nhttps://github.com/microsoft/playwright/issues/28941#issuecomment-1888008102\r\n\r\nlog after fix:\r\n\r\n```\r\n[main][~/github/kibana]$ npx playwright test --config x-pack/platform/plugins/shared/maps/ui_tests/playwright.config.ts\r\n[createPlaywrightConfig] called with runId: 310a576f32d3b8a5\r\n\r\nRunning 1 test using 1 worker\r\n\r\n[createPlaywrightConfig] called with runId: 310a576f32d3b8a5\r\n[chromium] › full_screen_mode.spec.ts:28:9 › Maps › Full screen mode @svlSecurity @svlOblt @svlSearch @ess\r\n```\r\n\r\nWe also had a chat with @dolaru and agreed that Scout reporters to be\r\ndisabled for local test run. Few reasons:\r\n- Scout custom reporting targets CI execution: events-based reporter was\r\nalready disabled\r\n- Failed test reporter purpose is to provide html boilerplate to be\r\nannotated in pipeline build\r\n- When you run tests with IDE playwright plugin it provides its own\r\nreporter / history, should be enough.","sha":"6635fe501c307d567afa71a346fc91a7675e3cc5"}}]}] BACKPORT--> Co-authored-by: Dzmitry Lemechko <dzmitry.lemechko@elastic.co>

dmlemeshko added 2 commits February 4, 2025 11:21

[scout] unique runId for reporting, disabled failed test reporter for…

af92785

… local

update tests

d0495df

dmlemeshko self-assigned this Feb 4, 2025

dmlemeshko added v9.0.0 v8.18.0 release_note:skip Skip the PR/issue when compiling release notes backport:version Backport to applied version labels test:scout backport:prev-minor and removed backport:version Backport to applied version labels v8.18.0 labels Feb 4, 2025

dmlemeshko requested a review from dolaru February 4, 2025 11:59

dmlemeshko marked this pull request as ready for review February 4, 2025 12:12

dmlemeshko requested a review from a team as a code owner February 4, 2025 12:12

Merge branch 'main' into scout/unique-runId-and-disabled-failed-test-…

3931d60

…reporter-by-default

wayneseymour reviewed Feb 4, 2025

View reviewed changes

wayneseymour approved these changes Feb 4, 2025

View reviewed changes

dolaru approved these changes Feb 4, 2025

View reviewed changes

dmlemeshko merged commit 6635fe5 into elastic:main Feb 5, 2025
1 check passed

kibanamachine added the v9.1.0 label Feb 5, 2025

kibanamachine mentioned this pull request Feb 5, 2025

[9.0] [scout] unique runId for reporting, disabled failed test reporter locally (#209507) #209808

Merged

dmlemeshko added the backport:prev-major label Feb 6, 2025

kibanamachine mentioned this pull request Feb 6, 2025

[8.18] [scout] unique runId for reporting, disabled failed test reporter locally (#209507) #210087

Merged

kibanamachine mentioned this pull request Feb 6, 2025

[8.x] [scout] unique runId for reporting, disabled failed test reporter locally (#209507) #210088

Merged

kibanamachine added the v8.18.0 label Feb 6, 2025

dmlemeshko removed backport:prev-minor labels Feb 7, 2025

kibanamachine added the v8.19.0 label Feb 9, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[scout] unique runId for reporting, disabled failed test reporter locally#209507

[scout] unique runId for reporting, disabled failed test reporter locally#209507
dmlemeshko merged 3 commits intoelastic:mainfrom
dmlemeshko:scout/unique-runId-and-disabled-failed-test-reporter-by-default

dmlemeshko commented Feb 4, 2025 •

edited by kibanamachine

Loading

Uh oh!

wayneseymour Feb 4, 2025

Uh oh!

dmlemeshko Feb 4, 2025

Uh oh!

wayneseymour Feb 4, 2025

Uh oh!

wayneseymour left a comment

Uh oh!

wayneseymour Feb 4, 2025

Uh oh!

dmlemeshko Feb 4, 2025

Uh oh!

elasticmachine commented Feb 4, 2025

Uh oh!

Uh oh!

kibanamachine commented Feb 5, 2025

Uh oh!

kibanamachine commented Feb 5, 2025

Uh oh!

kibanamachine commented Feb 6, 2025

Uh oh!

kibanamachine commented Feb 6, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

dmlemeshko commented Feb 4, 2025 • edited by kibanamachine Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

wayneseymour Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

dmlemeshko Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

wayneseymour Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

wayneseymour left a comment

Choose a reason for hiding this comment

Uh oh!

wayneseymour Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

dmlemeshko Feb 4, 2025

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented Feb 4, 2025

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Uh oh!

Uh oh!

kibanamachine commented Feb 5, 2025

Uh oh!

kibanamachine commented Feb 5, 2025

💚 All backports created successfully

Questions ?

Uh oh!

kibanamachine commented Feb 6, 2025

Uh oh!

kibanamachine commented Feb 6, 2025

💔 Some backports could not be created

Manual backport

Questions ?

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

dmlemeshko commented Feb 4, 2025 •

edited by kibanamachine

Loading