Skip to content

[ES|QL] PromQL pretty-printing support #247399

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
vadimkibana merged 5 commits into from
Jan 5, 2026
Merged

[ES|QL] PromQL pretty-printing support #247399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
92df1a9
add promql pretty printing
vadimkibana Dec 23, 2025
6ff341f
Merge branch 'main' into promql-printer-2
vadimkibana Dec 29, 2025
52a6724
Merge branch 'main' into promql-printer-2
vadimkibana Jan 5, 2026
f34b95b
create separate builder test file
vadimkibana Jan 5, 2026
2c461bd
Merge remote-tracking branch 'origin/promql-printer-2' into promql-pr…
vadimkibana Jan 5, 2026
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
14 changes: 11 additions & 3 deletions src/platform/packages/shared/kbn-esql-language/src/promql/builder/builder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,17 +236,25 @@ export namespace PromQLBuilder {
};
};

/**
* Create a string literal.
*
* @param valueUnquoted - The unquoted string value (e.g., 'hello' not '"hello"')
* @param rawValue - Optional raw value as it appeared in source (used by parser).
* If not provided, the printer will handle quoting/escaping.
* @param fromParser - Optional parser fields
*/
export const string = (
value: string,
valueUnquoted: string,
rawValue?: string,
fromParser?: Partial<AstNodeParserFields>
): PromQLStringLiteral => {
return {
dialect: 'promql',
type: 'literal',
literalType: 'string',
name: value,
value,
name: rawValue ?? valueUnquoted,
value: rawValue ?? valueUnquoted,
valueUnquoted,
...PromQLBuilder.parserFields(fromParser),
};
Expand Down
5 changes: 3 additions & 2 deletions src/platform/packages/shared/kbn-esql-language/src/promql/parser/cst_to_ast_converter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,16 +596,17 @@ export class PromQLCstToAstConverter {
return this.fromStringToken(token.symbol);
}

return PromQLBuilder.expression.literal.string(ctx.getText(), '', this.getParserFields(ctx));
const text = ctx.getText();
return PromQLBuilder.expression.literal.string('', text, this.getParserFields(ctx));
Copy link
Contributor

@sddonne sddonne Dec 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for the value unquoted to be empty string?

Copy link
Contributor Author

@vadimkibana vadimkibana Jan 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because PromQLBuilder can construct the AST node from two patterns: (1) parsed from source text; (2) created programmatically without the source text. In the first case the second argument text is passed and the "unquoted" version is figured out by the builder. In the second case, the actual string (the unquoted version) is passed and the pretty-printer later figures out how to quote it, if at all.

}

private fromStringToken(token: antlr.Token): ast.PromQLStringLiteral {
const text = token.text ?? '';
const valueUnquoted = this.unquoteString(text);

return PromQLBuilder.expression.literal.string(
text,
valueUnquoted,
text,
this.createParserFieldsFromToken(token)
);
}
Expand Down
Loading