[Console Monaco] Invalid requests are incorrectly selected and actions on them are broken #189366
Assignees
Labels
bug
Fixes for quality problems that affect the customer experience
Feature:Console
Dev Tools Console Feature
Team:Kibana Management
Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Comments
ElenaStoeva
added
bug
|
Pinging @elastic/kibana-management (Team:Kibana Management) |
This was referenced Aug 1, 2024
yuliacech
added a commit
that referenced
this issue
Aug 20, 2024
## Summary Fixes #189366 Fixes #186773 This PR refactors how the request body is being extracted from the editor to use for "sendRequest" and "copyAsCurl" functions. Previously the editor actions provider would rely on the parser to get a JSON object or several for request body. The downside of this implementation was when the parser would not be able to fully process the json object. That could lead to potential text loss and the editor would process the requests in a way that was not always obvious to the user. For example, the editor would highlight the request with the json object, but when sending it to ES the request body would be completely ignored. Instead this PR suggests to use the "raw" text from the editor for actions and give the user more transparency and control over the requests. We also don't need to keep the information about requests in the parser, which might affect browser performance for longer texts. ### 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)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The Monaco Console allows selecting and highlighting invalid requests and performing actions on them. This results on erroneous actions performed. For example:
Auto-indenting an invalid request followed by a valid request deletes the whole valid request:
indent_8.16-SNAPSHOT.mov
Sending a request that follows an invalid requests sends broken payload to ES:
incomplete_syntax.mov
We should probably improve the logic for selecting the right range.
The text was updated successfully, but these errors were encountered: