mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[Console Migration] Add styling for status codes in multiple response output (#183858)
Closes https://github.com/elastic/kibana/issues/179522 ## Summary This PR adds styling for the status codes in the multiple-response output in Console Monaco.1934cda7
-d6c1-41a0-9147-3f71885929c6 <img width="1574" alt="Screenshot 2024-05-21 at 16 38 55" src="59b28258
-5b41-4e66-8d1b-97b7d146d6e5"> In Ace editor: <img width="1918" alt="Screenshot 2024-05-16 at 18 01 42" src="da9d85e0
-0791-4631-84e7-139749ce4956"> Note: In the Ace editor, we use the [`badge.badge` css classes for token names](0f1139f302/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 https://github.com/microsoft/monaco-editor/issues/3868 and https://github.com/microsoft/monaco-editor/issues/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>
This commit is contained in:
parent
c60c363246
commit
c1d992d281
4 changed files with 51 additions and 3 deletions
|
@ -11,6 +11,7 @@ import {
|
|||
consoleSharedLexerRules,
|
||||
matchTokensWithEOL,
|
||||
matchToken,
|
||||
matchTokens,
|
||||
} from './shared';
|
||||
import { monaco } from '../../monaco_imports';
|
||||
|
||||
|
@ -31,6 +32,11 @@ export const lexerRules: monaco.languages.IMonarchLanguage = {
|
|||
// text
|
||||
matchToken('text', '.+?'),
|
||||
],
|
||||
comments: [
|
||||
// line comment indicated by #
|
||||
matchTokens(['comment.punctuation', 'comment.line'], /(#)(.*$)/),
|
||||
...consoleSharedLexerRules.tokenizer.comments,
|
||||
],
|
||||
method_sep: [
|
||||
// protocol host with slash
|
||||
matchTokensWithEOL(
|
||||
|
|
|
@ -6,7 +6,11 @@
|
|||
* Side Public License, v 1.
|
||||
*/
|
||||
|
||||
import { consoleSharedLanguageConfiguration, consoleSharedLexerRules } from './shared';
|
||||
import {
|
||||
consoleSharedLanguageConfiguration,
|
||||
consoleSharedLexerRules,
|
||||
matchTokensWithEOL,
|
||||
} from './shared';
|
||||
import { monaco } from '../../monaco_imports';
|
||||
|
||||
export const consoleOutputLanguageConfiguration: monaco.languages.LanguageConfiguration = {
|
||||
|
@ -15,4 +19,24 @@ export const consoleOutputLanguageConfiguration: monaco.languages.LanguageConfig
|
|||
|
||||
export const consoleOutputLexerRules: monaco.languages.IMonarchLanguage = {
|
||||
...consoleSharedLexerRules,
|
||||
tokenizer: {
|
||||
...consoleSharedLexerRules.tokenizer,
|
||||
comments: [
|
||||
// Line comment indicated by #
|
||||
// Everything after the # character is matched, stopping right before the status code and status text at the end if they are present
|
||||
matchTokensWithEOL('comment', /# .+?(?=\s+\d{3}(?: \w+)*$)/, 'root', 'status'),
|
||||
...consoleSharedLexerRules.tokenizer.comments,
|
||||
],
|
||||
status: [
|
||||
// Following HTTP response status codes conventions
|
||||
// Informational responses (status codes 100 – 199)
|
||||
matchTokensWithEOL('status.info', /\b1\d{2}(?: \w+)*$/, 'root'),
|
||||
// Successful responses (status codes 200 – 299)
|
||||
matchTokensWithEOL('status.success', /\b2\d{2}(?: \w+)*$/, 'root'),
|
||||
// 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'),
|
||||
],
|
||||
},
|
||||
};
|
||||
|
|
|
@ -112,8 +112,6 @@ export const consoleSharedLexerRules: monaco.languages.IMonarchLanguage = {
|
|||
matchToken('paren.lparen', '{', 'json_root'),
|
||||
],
|
||||
comments: [
|
||||
// line comment indicated by #
|
||||
matchTokens(['comment.punctuation', 'comment.line'], /(#)(.*$)/),
|
||||
// start a block comment indicated by /*
|
||||
matchToken('comment.punctuation', /\/\*/, 'block_comment'),
|
||||
// line comment indicated by //
|
||||
|
|
|
@ -37,6 +37,26 @@ export const buildConsoleTheme = (): monaco.editor.IStandaloneThemeData => {
|
|||
['constant.numeric'],
|
||||
makeHighContrastColor(euiThemeVars.euiColorAccentText)(background)
|
||||
),
|
||||
...buildRuleGroup(
|
||||
['status.info'],
|
||||
makeHighContrastColor(euiThemeVars.euiColorWarningText)(background),
|
||||
true
|
||||
),
|
||||
...buildRuleGroup(
|
||||
['status.success'],
|
||||
makeHighContrastColor(euiThemeVars.euiColorSuccessText)(background),
|
||||
true
|
||||
),
|
||||
...buildRuleGroup(
|
||||
['status.redirect'],
|
||||
makeHighContrastColor(euiThemeVars.euiColorWarningText)(background),
|
||||
true
|
||||
),
|
||||
...buildRuleGroup(
|
||||
['status.error'],
|
||||
makeHighContrastColor(euiThemeVars.euiColorDangerText)(background),
|
||||
true
|
||||
),
|
||||
...buildRuleGroup(['method'], makeHighContrastColor(methodTextColor)(background)),
|
||||
...buildRuleGroup(['url'], makeHighContrastColor(urlTextColor)(background)),
|
||||
],
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue