Skip to content

[8.19] [ES|QL] Stop ANTLR token monkey-patching in parser (#225629) #226010

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

Merged
kibanamachine merged 1 commit into from
Jul 1, 2025
Merged

[8.19] [ES|QL] Stop ANTLR token monkey-patching in parser (#225629) #226010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 1 addition & 27 deletions src/platform/packages/shared/kbn-esql-ast/src/parser/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,10 @@ import { ESQLErrorListener } from './esql_error_listener';
import { ESQLAstBuilderListener } from './esql_ast_builder_listener';
import { GRAMMAR_ROOT_RULE } from './constants';
import { attachDecorations, collectDecorations } from './formatting';
import type { ESQLAst, ESQLAstQueryExpression, EditorError } from '../types';
import { Builder } from '../builder';
import { default as ESQLLexer } from '../antlr/esql_lexer';
import { default as ESQLParser } from '../antlr/esql_parser';

/**
* Some changes to the grammar deleted the literal names for some tokens.
* This is a workaround to restore the literals that were lost.
*
* See https://github.com/elastic/elasticsearch/pull/124177 for context.
*/
const replaceSymbolsWithLiterals = (
symbolicNames: Array<string | null>,
literalNames: Array<string | null>
) => {
const symbolReplacements: Map<string, string> = new Map([
['LP', '('],
['OPENING_BRACKET', '['],
]);

for (let i = 0; i < symbolicNames.length; i++) {
const name = symbolicNames[i];
if (name && symbolReplacements.has(name)) {
literalNames[i] = `'${symbolReplacements.get(name)!}'`;
}
}
};
import type { ESQLAst, ESQLAstQueryExpression, EditorError } from '../types';

export interface ParseOptions {
/**
Expand Down Expand Up @@ -100,9 +77,6 @@ export class Parser {
const tokens = (this.tokens = new CommonTokenStream(lexer));
const parser = (this.parser = new ESQLParser(tokens));

replaceSymbolsWithLiterals(lexer.symbolicNames, lexer.literalNames);
replaceSymbolsWithLiterals(parser.symbolicNames, parser.literalNames);

lexer.removeErrorListeners();
lexer.addErrorListener(this.errors);

Expand Down
9 changes: 8 additions & 1 deletion src/platform/packages/shared/kbn-esql-validation-autocomplete/src/validation/validation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,15 @@ async function validateAst(
messages.push(...commandMessages);
}

const parserErrors = parsingResult.errors;

for (const error of parserErrors) {
error.message = error.message.replace(/\bLP\b/, "'('");
error.message = error.message.replace(/\bOPENING_BRACKET\b/, "'['");
}

return {
errors: [...parsingResult.errors, ...messages.filter(({ type }) => type === 'error')],
errors: [...parserErrors, ...messages.filter(({ type }) => type === 'error')],
warnings: messages.filter(({ type }) => type === 'warning'),
};
}
Expand Down