[Console Monaco Migration] Fix issue with different themes (#180321)

Fixes https://github.com/elastic/kibana/issues/180218

## Summary

This PR fixes the highlighting issue in the Monaco editor that is caused
when using a theme in the output panel that is different from the theme
in the editor. This fix is implemented by unifying the themes for both
editors into one.

The PR also fixes the issue with Console theme overwriting theme in
other code editors (e.g. embeddable Console in the index detail tabs) by
reusing the `euiTheme`.

Note: This solution changes some of the original highlighting colors in
Console (e.g. comments were green and now they are grey, background
color is also different now). We might be able to fix the text colors by
specifying unique token names in the Console language (e.g. using
`consoleComment` instead of `comment` token name). cc: @yuliacech


d77d4ea3-61b5-43fa-81ef-7e4ac239aadd



1dab2eca-08e5-421b-acd4-38e0b3d91a3e


<img width="1494" alt="Screenshot 2024-04-22 at 15 34 45"
src="a4241574-77ad-42db-8707-ae38761d52d0">




<!--
### 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&mdash;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&mdash;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: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>

packages/kbn-monaco/index.ts

@@ -36,7 +36,6 @@ export {
   CONSOLE_LANG_ID,
   CONSOLE_OUTPUT_LANG_ID,
   CONSOLE_THEME_ID,
-  CONSOLE_OUTPUT_THEME_ID,
   getParsedRequestsProvider,
   ConsoleParsedRequestsProvider,
 } from './src/console';

packages/kbn-monaco/src/console/constants.ts

@@ -9,5 +9,4 @@
 export const CONSOLE_LANG_ID = 'console';
 export const CONSOLE_THEME_ID = 'consoleTheme';
 export const CONSOLE_OUTPUT_LANG_ID = 'consoleOutput';
-export const CONSOLE_OUTPUT_THEME_ID = 'consoleOutputTheme';
 export const CONSOLE_POSTFIX = '.console';

packages/kbn-monaco/src/console/index.ts

@@ -20,14 +20,9 @@ import {
   consoleOutputLanguageConfiguration,
 } from './lexer_rules';
 
-export {
-  CONSOLE_LANG_ID,
-  CONSOLE_OUTPUT_LANG_ID,
-  CONSOLE_THEME_ID,
-  CONSOLE_OUTPUT_THEME_ID,
-} from './constants';
+export { CONSOLE_LANG_ID, CONSOLE_OUTPUT_LANG_ID, CONSOLE_THEME_ID } from './constants';
 
-export { buildConsoleTheme, buildConsoleOutputTheme } from './theme';
+export { buildConsoleTheme } from './theme';
 
 export const ConsoleLang: LangModuleType = {
   ID: CONSOLE_LANG_ID,

packages/kbn-monaco/src/console/theme.ts

@@ -0,0 +1,44 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+import { makeHighContrastColor } from '@elastic/eui';
+import { euiThemeVars } from '@kbn/ui-theme';
+import { darkMode } from '@kbn/ui-theme';
+import { buildLightTheme, buildDarkTheme } from '../code_editor';
+import { themeRuleGroupBuilderFactory } from '../common/theme';
+import { monaco } from '../monaco_imports';
+
+const buildRuleGroup = themeRuleGroupBuilderFactory();
+
+const background = euiThemeVars.euiFormBackgroundColor;
+const booleanTextColor = '#585CF6';
+const methodTextColor = '#DD0A73';
+const urlTextColor = '#00A69B';
+export const buildConsoleTheme = (): monaco.editor.IStandaloneThemeData => {
+  const euiTheme = darkMode ? buildDarkTheme() : buildLightTheme();
+  return {
+    ...euiTheme,
+    rules: [
+      ...euiTheme.rules,
+      ...buildRuleGroup(
+        ['string-literal', 'multi-string', 'punctuation.end-triple-quote'],
+        makeHighContrastColor(euiThemeVars.euiColorDangerText)(background)
+      ),
+      ...buildRuleGroup(
+        ['constant.language.boolean'],
+        makeHighContrastColor(booleanTextColor)(background)
+      ),
+      ...buildRuleGroup(
+        ['constant.numeric'],
+        makeHighContrastColor(euiThemeVars.euiColorAccentText)(background)
+      ),
+      ...buildRuleGroup(['method'], makeHighContrastColor(methodTextColor)(background)),
+      ...buildRuleGroup(['url'], makeHighContrastColor(urlTextColor)(background)),
+    ],
+  };
+};

packages/kbn-monaco/src/console/theme/editor_theme.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0 and the Server Side Public License, v 1; you may not use this file except
- * in compliance with, at your election, the Elastic License 2.0 or the Server
- * Side Public License, v 1.
- */
-
-import { makeHighContrastColor } from '@elastic/eui';
-import { euiThemeVars } from '@kbn/ui-theme';
-
-import { themeRuleGroupBuilderFactory } from '../../common/theme';
-import { monaco } from '../../monaco_imports';
-import { buildConsoleSharedTheme } from './shared';
-
-const buildRuleGroup = themeRuleGroupBuilderFactory();
-
-const background = euiThemeVars.euiColorLightestShade;
-const methodTextColor = '#DD0A73';
-const urlTextColor = '#00A69B';
-export const buildConsoleTheme = (): monaco.editor.IStandaloneThemeData => {
-  const sharedTheme = buildConsoleSharedTheme();
-  return {
-    ...sharedTheme,
-    rules: [
-      ...sharedTheme.rules,
-      ...buildRuleGroup(['method'], makeHighContrastColor(methodTextColor)(background)),
-      ...buildRuleGroup(['url'], makeHighContrastColor(urlTextColor)(background)),
-    ],
-  };
-};

packages/kbn-monaco/src/console/theme/index.ts

@@ -1,10 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0 and the Server Side Public License, v 1; you may not use this file except
- * in compliance with, at your election, the Elastic License 2.0 or the Server
- * Side Public License, v 1.
- */
-
-export { buildConsoleTheme } from './editor_theme';
-export { buildConsoleOutputTheme } from './output_theme';

packages/kbn-monaco/src/console/theme/output_theme.ts

@@ -1,17 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0 and the Server Side Public License, v 1; you may not use this file except
- * in compliance with, at your election, the Elastic License 2.0 or the Server
- * Side Public License, v 1.
- */
-
-import { monaco } from '../../monaco_imports';
-import { buildConsoleSharedTheme } from './shared';
-
-export const buildConsoleOutputTheme = (): monaco.editor.IStandaloneThemeData => {
-  const sharedTheme = buildConsoleSharedTheme();
-  return {
-    ...sharedTheme,
-  };
-};

packages/kbn-monaco/src/console/theme/shared.ts

@@ -1,50 +0,0 @@
-/*
- * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
- * or more contributor license agreements. Licensed under the Elastic License
- * 2.0 and the Server Side Public License, v 1; you may not use this file except
- * in compliance with, at your election, the Elastic License 2.0 or the Server
- * Side Public License, v 1.
- */
-
-import { makeHighContrastColor } from '@elastic/eui';
-import { darkMode, euiThemeVars } from '@kbn/ui-theme';
-
-import { themeRuleGroupBuilderFactory } from '../../common/theme';
-import { monaco } from '../../monaco_imports';
-
-const buildRuleGroup = themeRuleGroupBuilderFactory();
-
-const background = euiThemeVars.euiColorLightestShade;
-const stringTextColor = '#009926';
-const commentTextColor = '#4C886B';
-const variableTextColor = '#0079A5';
-const booleanTextColor = '#585CF6';
-const numericTextColor = variableTextColor;
-export const buildConsoleSharedTheme = (): monaco.editor.IStandaloneThemeData => {
-  return {
-    base: darkMode ? 'vs-dark' : 'vs',
-    inherit: true,
-    rules: [
-      ...buildRuleGroup(
-        ['string', 'string-literal', 'multi-string', 'punctuation.end-triple-quote'],
-        makeHighContrastColor(stringTextColor)(background)
-      ),
-      ...buildRuleGroup(['comment'], makeHighContrastColor(commentTextColor)(background)),
-      ...buildRuleGroup(['variable'], makeHighContrastColor(variableTextColor)(background)),
-      ...buildRuleGroup(
-        ['constant.language.boolean'],
-        makeHighContrastColor(booleanTextColor)(background)
-      ),
-      ...buildRuleGroup(['constant.numeric'], makeHighContrastColor(numericTextColor)(background)),
-    ],
-    colors: {
-      'editor.background': background,
-      // color of the line numbers
-      'editorLineNumber.foreground': euiThemeVars.euiColorDarkShade,
-      // color of the active line number
-      'editorLineNumber.activeForeground': euiThemeVars.euiColorDarkShade,
-      // background of the line numbers side panel
-      'editorGutter.background': euiThemeVars.euiColorEmptyShade,
-    },
-  };
-};

packages/kbn-monaco/src/register_globals.ts

@@ -13,14 +13,7 @@ import { monaco } from './monaco_imports';
 import { ESQL_THEME_ID, ESQLLang, buildESQlTheme } from './esql';
 import { YAML_LANG_ID } from './yaml';
 import { registerLanguage, registerTheme } from './helpers';
-import {
-  ConsoleLang,
-  ConsoleOutputLang,
-  CONSOLE_THEME_ID,
-  CONSOLE_OUTPUT_THEME_ID,
-  buildConsoleTheme,
-  buildConsoleOutputTheme,
-} from './console';
+import { ConsoleLang, ConsoleOutputLang, CONSOLE_THEME_ID, buildConsoleTheme } from './console';
 import {
   CODE_EDITOR_LIGHT_THEME_ID,
   CODE_EDITOR_DARK_THEME_ID,
@@ -58,7 +51,6 @@ registerLanguage(ConsoleOutputLang);
  */
 registerTheme(ESQL_THEME_ID, buildESQlTheme());
 registerTheme(CONSOLE_THEME_ID, buildConsoleTheme());
-registerTheme(CONSOLE_OUTPUT_THEME_ID, buildConsoleOutputTheme());
 registerTheme(CODE_EDITOR_LIGHT_THEME_ID, buildLightTheme());
 registerTheme(CODE_EDITOR_DARK_THEME_ID, buildDarkTheme());
 registerTheme(CODE_EDITOR_LIGHT_THEME_TRANSPARENT_ID, buildLightTransparentTheme());

packages/kbn-monaco/tsconfig.json

@@ -26,7 +26,7 @@
     "@kbn/repo-info",
     "@kbn/ui-theme",
     "@kbn/esql-ast",
-    "@kbn/esql-validation-autocomplete"
+    "@kbn/esql-validation-autocomplete",
   ],
   "exclude": [
     "target/**/*",

src/plugins/console/public/application/containers/editor/monaco/monaco_editor_output.tsx

@@ -13,7 +13,7 @@ import { VectorTile } from '@mapbox/vector-tile';
 import Protobuf from 'pbf';
 import { i18n } from '@kbn/i18n';
 import { EuiScreenReaderOnly } from '@elastic/eui';
-import { CONSOLE_OUTPUT_THEME_ID, CONSOLE_OUTPUT_LANG_ID, monaco } from '@kbn/monaco';
+import { CONSOLE_THEME_ID, CONSOLE_OUTPUT_LANG_ID, monaco } from '@kbn/monaco';
 import { useEditorReadContext, useRequestReadContext } from '../../../contexts';
 import { convertMapboxVectorTileToJson } from '../legacy/console_editor/mapbox_vector_tile';
 import {
@@ -99,9 +99,10 @@ export const MonacoEditorOutput: FunctionComponent = () => {
         editorDidMount={editorDidMountCallback}
         editorWillUnmount={editorWillUnmountCallback}
         options={{
+          readOnly: true,
           fontSize: readOnlySettings.fontSize,
           wordWrap: readOnlySettings.wrapMode === true ? 'on' : 'off',
-          theme: mode === CONSOLE_OUTPUT_LANG_ID ? CONSOLE_OUTPUT_THEME_ID : undefined,
+          theme: CONSOLE_THEME_ID,
           automaticLayout: true,
         }}
       />

src/plugins/console/public/styles/_app.scss

@@ -100,6 +100,7 @@
   @include kbnResizer;
   // Give the aria selection border priority when the divider is selected on IE11 and Chrome
   z-index: $euiZLevel1;
+  background-color: $euiColorLightestShade;
 }
 
 // SASSTODO: This component seems to not be used anymore?