Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Console Monaco migration] Fix highlighting bug #180218

Closed
yuliacech opened this issue Apr 5, 2024 · 5 comments · Fixed by #180321
Closed

[Console Monaco migration] Fix highlighting bug #180218

yuliacech opened this issue Apr 5, 2024 · 5 comments · Fixed by #180321
Assignees
@ElenaStoeva
Labels
Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@yuliacech
Copy link
Contributor

The highlighting in the input editor is not working on component load and while the requests are being sent (tested with changes from #179808). This might have to do with the editor being not in focus, since the highlighting works again after changes in the input. Might be a regression after #178696. Looks like the text is being parsed as json, so maybe the order of lexer rules affects that.

Screenshot 2024-04-05 at 20 19 39
@yuliacech yuliacech added Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more labels Apr 5, 2024
@elasticmachine
Copy link
Contributor

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

@yuliacech yuliacech mentioned this issue Apr 5, 2024
Closed
@ElenaStoeva
Copy link
Contributor

ElenaStoeva commented Apr 8, 2024 •
edited
Loading

This seems to be caused when a theme is assigned to the Monaco output panel. When a request is sent, this sends json data to the output panel and sets its theme to the console output theme (the theme is set to undefined when no request is sent). I will investigate further why setting a theme in the output panel breaks the highlighting in the editor.

Edit: this issue is also observed in #180080 where we add the text theme by default in the output panel. Then even without sending a request, the highlighting in the editor is broken.

@ElenaStoeva ElenaStoeva mentioned this issue Apr 8, 2024
Merged
@ElenaStoeva
Copy link
Contributor

ElenaStoeva commented Apr 8, 2024 •
edited
Loading

After further investigation, I found that this behavior is probably caused by the Monaco editor itself. It turns out that we cannot have two Monaco editors with different themes and there is an open issue for this. The problem is that when we assign a theme in the output panel, it messes up the theme in the editor. The simplest solution might be to use one theme for both editors (draft PR: #180321) but this might create complications by adding unnecessary highlighting for some modes in the output panel. There are also proposed solutions in the Monaco issue but most of them seem to be too complicated.

@ElenaStoeva ElenaStoeva mentioned this issue Apr 8, 2024
Closed
@ElenaStoeva
Copy link
Contributor

ElenaStoeva commented Apr 16, 2024 •
edited
Loading

@elastic/appex-sharedux, could you assist with resolving this issue from the CodeEditor side? Not being able to have two or more CodeEditor components with different themes on one page might cause issues in other places in Kibana as well.

In Console, we've found a workaround by using a single theme for both the editor and the output panel. However, this is likely just a temporary fix, as it might cause complications in the future—especially if Console is embedded on a page with another code editor using a different theme. The workaround that we considered for Console would not work as the Console theme affects the code editor in the Settings tab as @yuliacech shows in the next comment.

We came across a proposed solution in the public Monaco issue. It suggests isolating each theme by wrapping each editor with a component that has a unique class name. Do you think this approach would be feasible to implement for CodeEditor?

@yuliacech
Copy link
Contributor Author

Here is a screen recording of the json editor changing the theme on the index page when embeddable console is opened

Screen.Recording.2024-04-16.at.18.19.00.mov

@ElenaStoeva ElenaStoeva self-assigned this Apr 17, 2024
ElenaStoeva added a commit that referenced this issue Apr 30, 2024
@ElenaStoeva @kibanamachine
[Console Monaco Migration] Fix issue with different themes (#180321)
b8d8c73 
Fixes #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


https://github.com/elastic/kibana/assets/59341489/d77d4ea3-61b5-43fa-81ef-7e4ac239aadd



https://github.com/elastic/kibana/assets/59341489/1dab2eca-08e5-421b-acd4-38e0b3d91a3e


<img width="1494" alt="Screenshot 2024-04-22 at 15 34 45"
src="https://github.com/elastic/kibana/assets/59341489/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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ElenaStoeva ElenaStoeva

Labels
Feature:Console Dev Tools Console Feature Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Console Monaco Migration] Fix issue with different themes ElenaStoeva/kibana
3 participants
@yuliacech @elasticmachine @ElenaStoeva