[Console Migration] Add styling for status codes in multiple response output #183858
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
ElenaStoeva
added
Feature:Console
|
/ci |
ElenaStoeva
commented
May 20, 2024
| // Redirection messages (status codes 300 – 399) | ||
| matchTokensWithEOL('status.redirect', /\b3\d{2}(?: \w+)*$/, 'root'), | ||
| // Client and server error responses (status codes 400 – 599) | ||
| matchTokensWithEOL('status.error', /\b[4-5]\d{2}(?: \w+)*$/, 'root'), |
There was a problem hiding this comment.
Grouped the status codes as per the HTTP status code groups. As far as I know, Es currently only uses 2**, 4**, and 5** status codes (200 OK, 201 Created, 202 Accepted, 204 No Content, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 429 Too Many Requests, 500 Internal Server Error, 503 Service Unavailable). Practically only the status.success and status.error tokens will be used, but added the rest in case these status codes are added in Es.
|
Pinging @elastic/kibana-management (Team:Kibana Management) |
|
Opened #184010 for the color badges issue that can't be resolved at the moment. |
yuliacech
approved these changes
May 22, 2024
💚 Build Succeeded
Metrics [docs]Page load bundle
History
To update your PR or re-run it, just comment with: |
kibanamachine
added
v8.15.0
backport:skip
kaanyalti
pushed a commit
to kaanyalti/kibana
that referenced
this pull request
May 28, 2024
… output (elastic#183858) Closes elastic#179522 ## Summary This PR adds styling for the status codes in the multiple-response output in Console Monaco. https://github.com/elastic/kibana/assets/59341489/1934cda7-d6c1-41a0-9147-3f71885929c6 <img width="1574" alt="Screenshot 2024-05-21 at 16 38 55" src="https://github.com/elastic/kibana/assets/59341489/59b28258-5b41-4e66-8d1b-97b7d146d6e5"> In Ace editor: <img width="1918" alt="Screenshot 2024-05-16 at 18 01 42" src="https://github.com/elastic/kibana/assets/59341489/da9d85e0-0791-4631-84e7-139749ce4956"> Note: In the Ace editor, we use the [`badge.badge` css classes for token names](https://github.com/elastic/kibana/blob/0f1139f302db4a2a673193346978fa9a3e62ccd9/src/plugins/console/public/application/models/legacy_core_editor/mode/output_highlight_rules.ts#L15), but unfortunately Monaco theme rules don't support class names. I tried setting the [background color property](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.ITokenThemeRule.html#background) in the rules for the status code tokens but this doesn't work because of a bug from Monaco's side, see microsoft/monaco-editor#3868 and microsoft/monaco-editor#586). Therefore, in this PR we only set the text colors. <!-- ### 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: Yulia Čech <6585477+yuliacech@users.noreply.github.com>
rshen91
pushed a commit
to rshen91/kibana
that referenced
this pull request
May 30, 2024
… output (elastic#183858) Closes elastic#179522 ## Summary This PR adds styling for the status codes in the multiple-response output in Console Monaco. https://github.com/elastic/kibana/assets/59341489/1934cda7-d6c1-41a0-9147-3f71885929c6 <img width="1574" alt="Screenshot 2024-05-21 at 16 38 55" src="https://github.com/elastic/kibana/assets/59341489/59b28258-5b41-4e66-8d1b-97b7d146d6e5"> In Ace editor: <img width="1918" alt="Screenshot 2024-05-16 at 18 01 42" src="https://github.com/elastic/kibana/assets/59341489/da9d85e0-0791-4631-84e7-139749ce4956"> Note: In the Ace editor, we use the [`badge.badge` css classes for token names](https://github.com/elastic/kibana/blob/0f1139f302db4a2a673193346978fa9a3e62ccd9/src/plugins/console/public/application/models/legacy_core_editor/mode/output_highlight_rules.ts#L15), but unfortunately Monaco theme rules don't support class names. I tried setting the [background color property](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.ITokenThemeRule.html#background) in the rules for the status code tokens but this doesn't work because of a bug from Monaco's side, see microsoft/monaco-editor#3868 and microsoft/monaco-editor#586). Therefore, in this PR we only set the text colors. <!-- ### 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: Yulia Čech <6585477+yuliacech@users.noreply.github.com>
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.
Closes #179522
Summary
This PR adds styling for the status codes in the multiple-response output in Console Monaco.
Screen.Recording.2024-05-21.at.16.39.08.mov
In Ace editor:
Note: In the Ace editor, we use the
badge.badgecss classes for token names, but unfortunately Monaco theme rules don't support class names. I tried setting the background color property in the rules for the status code tokens but this doesn't work because of a bug from Monaco's side, see microsoft/monaco-editor#3868 and microsoft/monaco-editor#586). Therefore, in this PR we only set the text colors.