Skip to content

Commit

Permalink
[Console] Add Console parser to kbn/monaco (#177194)
Browse files Browse the repository at this point in the history
## Summary

Related meta [issue](#176926) 

This PR adds the parser used by Ace in Console to the Console language
definition in `kbn/monaco`.
Changes introduced by this PR: 
- Copy the code for `'sense_editor/mode/worker_parser'` from the file
`src/plugins/console/public/application/models/legacy_core_editor/mode/worker/worker.js`
into the `kbn/monaco` package
- Move the code for the webworker from the `xjson` folder in
`kbn/monaco` to a shared folder `ace_migration`
- Register the parser worker for the Console language in `kbn/monaco`

### How to test
#### Test the parser in Console
1. Add `console.dev.enableMonaco: true` to kibana.dev.yml
2. Open Dev Tools Console and try to type a valid request, check that
there are no red markers in the editor
3. Type an invalid request and check that there are red markers in the
editor

#### Test that `xjson` language parser still works
1. Navigate to Ingest pipelines and click the "create from csv" button
2. Load a valid csv file, for example this
[one](https://github.com/kgeller/ecs-mapper/blob/master/example/mapping.csv)
3. In the editor that now display a valid json, try changing the value
and check that red markers appear for invalid json

### Screenshots
#### Invalid request (red markers in the editor)
<img width="786" alt="Screenshot 2024-02-19 at 18 06 13"
src="https://github.com/elastic/kibana/assets/6585477/bac1bdfd-c402-45f1-9b9b-a9cc29ccb123">


#### Valid request
<img width="795" alt="Screenshot 2024-02-19 at 18 06 23"
src="https://github.com/elastic/kibana/assets/6585477/c06b1163-1077-43c6-bddc-1d86d0116266">


### 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)
  • Loading branch information
yuliacech authored Feb 22, 2024
1 parent 03a7372 commit 1d4057f
Show file tree
Hide file tree
Showing 15 changed files with 706 additions and 126 deletions.
63 changes: 63 additions & 0 deletions packages/kbn-monaco/src/ace_migration/setup_worker.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
/*
* 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 { ParserWorker } from './types';
import { monaco } from '../monaco_imports';
import { WorkerProxyService } from './worker_proxy';

export const setupWorker = (
langId: string,
owner: string,
worker: WorkerProxyService<ParserWorker>
) => {
worker.setup(langId);

const updateAnnotations = async (model: monaco.editor.IModel): Promise<void> => {
if (model.isDisposed()) {
return;
}
const parseResult = await worker.getAnnos(model.uri);
if (!parseResult) {
return;
}
const { annotations } = parseResult;
monaco.editor.setModelMarkers(
model,
owner,
annotations.map(({ at, text, type }) => {
const { column, lineNumber } = model.getPositionAt(at);
return {
startLineNumber: lineNumber,
startColumn: column,
endLineNumber: lineNumber,
endColumn: column,
message: text,
severity: type === 'error' ? monaco.MarkerSeverity.Error : monaco.MarkerSeverity.Warning,
};
})
);
};

const onModelAdd = (model: monaco.editor.IModel) => {
if (model.getLanguageId() !== langId) {
return;
}

const { dispose } = model.onDidChangeContent(async () => {
updateAnnotations(model);
});

model.onWillDispose(() => {
dispose();
});

updateAnnotations(model);
};

monaco.editor.onDidCreateModel(onModelAdd);
};
29 changes: 29 additions & 0 deletions packages/kbn-monaco/src/ace_migration/types.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* 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 enum AnnoTypes {
error = 'error',
warning = 'warning',
}

export interface Annotation {
name?: string;
type: AnnoTypes;
text: string;
at: number;
}

export interface ParseResult {
annotations: Annotation[];
}

export type Parser = (source: string) => ParseResult;

export interface ParserWorker {
parse: (model: string) => Promise<ParseResult | undefined>;
}
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@
* Side Public License, v 1.
*/

import { ParseResult } from './grammar';
import { monaco } from '../monaco_imports';
import { XJsonWorker } from './worker';
import { ID } from './constants';
import { ParserWorker, ParseResult } from './types';

export class WorkerProxyService {
private worker: monaco.editor.MonacoWebWorker<XJsonWorker> | undefined;
export class WorkerProxyService<IWorker extends ParserWorker> {
private worker: monaco.editor.MonacoWebWorker<IWorker> | undefined;

public async getAnnos(modelUri: monaco.Uri): Promise<ParseResult | undefined> {
if (!this.worker) {
Expand All @@ -23,8 +21,8 @@ export class WorkerProxyService {
return proxy.parse(modelUri.toString());
}

public setup() {
this.worker = monaco.editor.createWebWorker({ label: ID, moduleId: '' });
public setup(langId: string) {
this.worker = monaco.editor.createWebWorker({ label: langId, moduleId: '' });
}

public stop() {
Expand Down
16 changes: 15 additions & 1 deletion packages/kbn-monaco/src/console/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,19 @@
* Side Public License, v 1.
*/

/**
* This import registers the Console monaco language contribution
*/
import './language';

import type { LangModuleType } from '../types';
import { CONSOLE_LANG_ID } from './constants';
import { lexerRules, languageConfiguration } from './lexer_rules';

export { CONSOLE_LANG_ID } from './constants';
export { ConsoleLang } from './language';

export const ConsoleLang: LangModuleType = {
ID: CONSOLE_LANG_ID,
lexerRules,
languageConfiguration,
};
59 changes: 9 additions & 50 deletions packages/kbn-monaco/src/console/language.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,55 +6,14 @@
* Side Public License, v 1.
*/

import { LangModuleType } from '../types';
import { CONSOLE_LANG_ID } from './constants';
import { ConsoleWorker } from './worker';
import { WorkerProxyService } from '../ace_migration/worker_proxy';
import { monaco } from '../monaco_imports';
import { CONSOLE_LANG_ID } from './constants';
import { setupWorker } from '../ace_migration/setup_worker';

export const languageConfiguration: monaco.languages.LanguageConfiguration = {};

export const lexerRules: monaco.languages.IMonarchLanguage = {
defaultToken: 'invalid',
regex_method: /get|post|put|patch|delete/,
regex_url: /.*$/,
// C# style strings
escapes: /\\(?:[abfnrtv\\"']|x[0-9A-Fa-f]{1,4}|u[0-9A-Fa-f]{4}|U[0-9A-Fa-f]{8})/,
ignoreCase: true,
tokenizer: {
root: [
// whitespace
{ include: '@rule_whitespace' },
// start a multi-line comment
{ include: '@rule_start_multi_comment' },
// a one-line comment
[/\/\/.*$/, 'comment'],
// method
[/@regex_method/, 'keyword'],
// url
[/@regex_url/, 'identifier'],
],
rule_whitespace: [[/[ \t\r\n]+/, 'WHITESPACE']],
rule_start_multi_comment: [[/\/\*/, 'comment', '@rule_multi_comment']],
rule_multi_comment: [
// match everything on a single line inside the comment except for chars / and *
[/[^\/*]+/, 'comment'],
// start a nested comment by going 1 level down
[/\/\*/, 'comment', '@push'],
// match the closing of the comment and return 1 level up
['\\*/', 'comment', '@pop'],
// match individual chars inside a multi-line comment
[/[\/*]/, 'comment'],
],
string: [
[/[^\\"]+/, 'string'],
[/@escapes/, 'string.escape'],
[/\\./, 'string.escape.invalid'],
[/"/, { token: 'string.quote', bracket: '@close', next: '@pop' }],
],
},
};

export const ConsoleLang: LangModuleType = {
ID: CONSOLE_LANG_ID,
lexerRules,
languageConfiguration,
};
const OWNER = 'CONSOLE_GRAMMAR_CHECKER';
const wps = new WorkerProxyService<ConsoleWorker>();
monaco.languages.onLanguage(CONSOLE_LANG_ID, async () => {
setupWorker(CONSOLE_LANG_ID, OWNER, wps);
});
52 changes: 52 additions & 0 deletions packages/kbn-monaco/src/console/lexer_rules/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
/*
* 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';

export const languageConfiguration: monaco.languages.LanguageConfiguration = {};

export const lexerRules: monaco.languages.IMonarchLanguage = {
defaultToken: 'invalid',
regex_method: /get|post|put|patch|delete/,
regex_url: /.*$/,
// C# style strings
escapes: /\\(?:[abfnrtv\\"']|x[0-9A-Fa-f]{1,4}|u[0-9A-Fa-f]{4}|U[0-9A-Fa-f]{8})/,
ignoreCase: true,
tokenizer: {
root: [
// whitespace
{ include: '@rule_whitespace' },
// start a multi-line comment
{ include: '@rule_start_multi_comment' },
// a one-line comment
[/\/\/.*$/, 'comment'],
// method
[/@regex_method/, 'keyword'],
// url
[/@regex_url/, 'identifier'],
],
rule_whitespace: [[/[ \t\r\n]+/, 'WHITESPACE']],
rule_start_multi_comment: [[/\/\*/, 'comment', '@rule_multi_comment']],
rule_multi_comment: [
// match everything on a single line inside the comment except for chars / and *
[/[^\/*]+/, 'comment'],
// start a nested comment by going 1 level down
[/\/\*/, 'comment', '@push'],
// match the closing of the comment and return 1 level up
['\\*/', 'comment', '@pop'],
// match individual chars inside a multi-line comment
[/[\/*]/, 'comment'],
],
string: [
[/[^\\"]+/, 'string'],
[/@escapes/, 'string.escape'],
[/\\./, 'string.escape.invalid'],
[/"/, { token: 'string.quote', bracket: '@close', next: '@pop' }],
],
},
};
Loading

0 comments on commit 1d4057f

Please sign in to comment.