[Console] Enable monaco by default #184862

yuliacech · 2024-06-05T17:52:26Z

Summary

This PR enables the migration from Ace to Monaco in Dev Tools Console by default in the main branch. All serverless projects will still have the migration disabled by default. After 8.15 is branched, the migration will be disabled there as well. The intended release version for this migration is 8.16.

Functional tests

This PR creates a copy of functional tests for Monaco Console and keeps the tests for Ace in a separate folder. When the migration is released, we can remove the code for Ace together with tests.
The Monaco tests are not the exact copy of the Ace tests, since some functionality and autocomplete behaviour is slightly different in the migrated Console. For example, the auto-closing of brackets works in Monaco when typing something, but is not kicking in in the tests.

Flaky test runner

Checklist

Delete any items that are not applicable to this PR.

Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
Flaky Test Runner was used on any tests changed
Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)
Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)
If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list
This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)
This was checked for cross-browser compatibility

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk	Probability	Severity	Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space.	Low	High	Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks.	High	Low	Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled.	Medium	High	Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

This was checked for breaking API changes and was labeled appropriately

yuliacech · 2024-06-07T16:54:19Z

/ci

…fix'

yuliacech · 2024-06-10T17:55:18Z

/ci

yuliacech · 2024-06-11T10:09:03Z

/ci

yuliacech · 2024-06-11T11:56:10Z

/ci

yuliacech · 2024-06-11T12:29:25Z

/ci

yuliacech · 2024-06-11T13:22:53Z

/ci

yuliacech · 2024-06-18T13:10:56Z

/ci

elasticmachine · 2024-06-18T15:09:51Z

Pinging @elastic/kibana-management (Team:Kibana Management)

nreese

kibana-presentation team changes LGTM
code review only

jbudz

ftr_configs.yml

kibanamachine · 2024-06-18T17:38:03Z

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#6334

[❌] test/functional/apps/console/monaco/config.ts: 174/200 tests passed.

see run history

kibana-ci · 2024-06-19T12:12:21Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 142eb5d

Failed CI Steps

FTR Configs #1

Test Failures

[job] [logs] FTR Configs #1 / Cloud Security Posture Test adding Cloud Security Posture Integrations KSPM EKS KSPM EKS Direct Access KSPM EKS Direct Access Workflow

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/code-editor`	16	17	+1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`console`	456.6KB	456.8KB	+205.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/code-editor`	39	40	+1

History

💛 Build #216392 was flaky 08a3d3e
💔 Build #216194 failed 5553dc2
💔 Build #215835 failed 9be5798
💔 Build #215704 failed 6a2acb7
💔 Build #215492 failed 3ac4a6f
💔 Build #215452 failed d647cf9

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kibanamachine · 2024-06-19T12:17:25Z

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6351

[✅] test/functional/apps/console/monaco/config.ts: 200/200 tests passed.

see run history

jloleysens

Core changes LGTM, let me know if you need help rolling this out for serverless!

jloleysens · 2024-06-19T12:29:27Z

src/plugins/console/server/config.ts

@@ -31,7 +31,7 @@ const schemaLatest = schema.object(
        defaultValue: 'stack',
      }),
    }),
-    dev: schema.object({ enableMonaco: schema.boolean({ defaultValue: false }) }),
+    dev: schema.object({ enableMonaco: schema.boolean({ defaultValue: true }) }),


Huge, this has been a loong time coming! Great work @yuliacech !

Thank you, @jloleysens! We are super excited to get the new editor in front of real users!

Dosant

code lgtm!

ElenaStoeva

Great job @yuliacech! Tested locally and verified that Monaco Console is available in stateful and disabled in serverless. Code changes also LGTM!

## Summary Closes elastic#184025 This PR enables the migration from Ace to Monaco in Dev Tools Console by default in the main branch. All serverless projects will still have the migration disabled by default. After 8.15 is branched, the migration will be disabled there as well. The intended release version for this migration is 8.16. ### Functional tests This PR creates a copy of functional tests for Monaco Console and keeps the tests for Ace in a separate folder. When the migration is released, we can remove the code for Ace together with tests. The Monaco tests are not the exact copy of the Ace tests, since some functionality and autocomplete behaviour is slightly different in the migrated Console. For example, the auto-closing of brackets works in Monaco when typing something, but is not kicking in in the tests. Flaky test runner ### Checklist Delete any items that are not applicable to this PR. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>

[Console] Enable monaco by default

0e593e8

yuliacech added Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes labels Jun 5, 2024

yuliacech added 4 commits June 7, 2024 14:49

[Console] Revert changes to console page helpers

851a23e

[Console] Fix functional tests

32db829

[Console] Revert changes to ace tests

cdcdab0

[Console] Revert changes to ace tests

f10182a

kibanamachine and others added 5 commits June 7, 2024 17:09

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

0dd528d

…fix'

Merge branch 'main' into console/enable_migration

a16b929

Merge branch 'main' into console/enable_migration

ae25dda

[Console] Add a link for the comma related issue for monaco

fc63ccb

[Console] Fix more tests

f4ba975

[Console] Fix ace tests

3567320

yuliacech added 2 commits June 11, 2024 13:54

[Console] Monaco autocomplete tests

286f1b1

[Console] Fix default request test

cd661b0

[Console] Fix monaco tests

8420598

yuliacech added 2 commits June 11, 2024 14:32

[Console] Fix monaco tests

b9f6ffd

[Console] Fix monaco tests (comments)

4b979ca

yuliacech added 5 commits June 11, 2024 15:30

[Console] Fix monaco tests

82d0bb0

[Console] Fix monaco tests

3b30ecd

[Console] Fix monaco tests

215203d

[Console] Fix monaco tests

29e20e9

[Console] Fix monaco tests

5b2e025

[Console] Fix tests

08a3d3e

yuliacech marked this pull request as ready for review June 18, 2024 15:09

yuliacech requested review from a team as code owners June 18, 2024 15:09

SiddharthMantri approved these changes Jun 18, 2024

View reviewed changes

nreese approved these changes Jun 18, 2024

View reviewed changes

jbudz approved these changes Jun 18, 2024

View reviewed changes

[Console] Skip flaky tests

142eb5d

jloleysens approved these changes Jun 19, 2024

View reviewed changes

Dosant approved these changes Jun 19, 2024

View reviewed changes

ElenaStoeva self-requested a review June 19, 2024 13:47

ElenaStoeva approved these changes Jun 19, 2024

View reviewed changes

yuliacech merged commit 5e346b2 into elastic:main Jun 19, 2024
25 checks passed

kibanamachine added v8.15.0 backport:skip This commit does not require backporting labels Jun 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Console] Enable monaco by default #184862

[Console] Enable monaco by default #184862

yuliacech commented Jun 5, 2024 •

edited

Loading

yuliacech commented Jun 7, 2024

yuliacech commented Jun 10, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 18, 2024

elasticmachine commented Jun 18, 2024

nreese left a comment

jbudz left a comment

kibanamachine commented Jun 18, 2024

kibana-ci commented Jun 19, 2024

API count

kibanamachine commented Jun 19, 2024

jloleysens left a comment

jloleysens Jun 19, 2024

yuliacech Jun 19, 2024

Dosant left a comment

ElenaStoeva left a comment •

edited

Loading

[Console] Enable monaco by default #184862

[Console] Enable monaco by default #184862

Conversation

yuliacech commented Jun 5, 2024 • edited Loading

Summary

Functional tests

Checklist

Risk Matrix

For maintainers

yuliacech commented Jun 7, 2024

yuliacech commented Jun 10, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 11, 2024

yuliacech commented Jun 18, 2024

elasticmachine commented Jun 18, 2024

nreese left a comment

Choose a reason for hiding this comment

jbudz left a comment

Choose a reason for hiding this comment

kibanamachine commented Jun 18, 2024

Flaky Test Runner Stats

🟠 Some tests failed. - kibana-flaky-test-suite-runner#6334

kibana-ci commented Jun 19, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Public APIs missing comments

Async chunks

API count

History

kibanamachine commented Jun 19, 2024

Flaky Test Runner Stats

🎉 All tests passed! - kibana-flaky-test-suite-runner#6351

jloleysens left a comment

Choose a reason for hiding this comment

jloleysens Jun 19, 2024

Choose a reason for hiding this comment

yuliacech Jun 19, 2024

Choose a reason for hiding this comment

Dosant left a comment

Choose a reason for hiding this comment

ElenaStoeva left a comment • edited Loading

Choose a reason for hiding this comment

yuliacech commented Jun 5, 2024 •

edited

Loading

ElenaStoeva left a comment •

edited

Loading