[ES|QL] Implements wrapping pretty-printer

[vadimkibana]

Summary

Partially addresses #182257

• Improves the basic "one-line" printer BasicPrettyPrinter, notable changes:
  • It is now possible better specify if query keywords should be uppercased
  • Better formatting columns names, adds backquotes when escaping needed: `name👍`
  • Wraps cast expressions into brackets, where needed: (1 + 2)::string instead of 1 + 2::string
• Adds initial implementations of the more complex WrappingPrettyPrinter.
  • "Initial implementation" because it probably covers 80-90% of the cases, some follow up will be needed.
  • The WrappingPrettyPrinter formats the query like Prettier, it tries to format AST nodes horizontally as lists, but based on various conditions breaks the lines and indents them.

Cases handled by the WrappingPrettyPrinter

Below are examples of some of the cases handled by the WrappingPrettyPrinter. (See test files for many more cases.)

Short queries

Queries with less than 4 commands and if they do not require wrapping are formatted to a single line.

Source:

FROM index | WHERE a == 123

Result:

FROM index | WHERE a == 123

Argument wrapping

Command arguments are wrapped (at wrapping threshold, defaults to 80).

Source:

FROM index, another_index, yet_another_index, on-more-index, last_index, very_last_index, ok_this_is_the_last_index

Result:

FROM index, another_index, yet_another_index, on-more-index, last_index,
     very_last_index, ok_this_is_the_last_index

Argument breaking

Command argument combinations which result into a single argument occupying a whole line (due to that argument being long, or because the surrounding argument combination results into such a case), except the last argument, results into the argument list being broken by line.

Source:

FROM xxxxxxxxxx, yyyyyyyyyyy, zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,  // <------------ this one
  bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb, ccccccc, ggggggggg

Result:

FROM
  xxxxxxxxxx,
  yyyyyyyyyyy,
  zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz,
  aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,
  bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,
  ccccccc,
  ggggggggg

Binary expression chain vertical flattening

Binary expressions of the same precedence are vertically flattened, if wrapping is required. Same as it is done by Prettier, where there is an indentation after the first line to allow for different precedence expressions.

All expressions have the same precedence

Source:

FROM index
| STATS super_function_name(11111111111111.111 + 11111111111111.111 + 11111111111111.111 + 11111111111111.111 + 11111111111111.111))

Result:

FROM index
  | STATS
      SUPER_FUNCTION_NAME(
        11111111111111.111 +
          11111111111111.111 +
          11111111111111.111 +
          11111111111111.111 +
          11111111111111.111)

Expressions with additive and multiplicative precedence mixed

Source:

FROM index
| STATS super_function_name(11111111111111.111 + 3333333333333.3333 * 3333333333333.3333 * 3333333333333.3333 * 3333333333333.3333 + 11111111111111.111 + 11111111111111.111 + 11111111111111.111 + 11111111111111.111))

Result:

FROM index
  | STATS
      SUPER_FUNCTION_NAME(
        11111111111111.111 +
          3333333333333.3335 *
            3333333333333.3335 *
            3333333333333.3335 *
            3333333333333.3335 +
          11111111111111.111 +
          11111111111111.111 +
          11111111111111.111 +
          11111111111111.111)

Checklist

Delete any items that are not applicable to this PR.

• Unit or functional tests were updated or added to match the most common scenarios

For maintainers

• This was checked for breaking API changes and was labeled appropriately

[elasticmachine]

Pinging @elastic/kibana-esql (Team:ESQL)

[elasticmachine]

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

[vadimkibana]

@elasticmachine merge upstream

[kibana-ci]

💛 Build succeeded, but was flaky

• Buildkite Build
• Commit: 0c545a2

Failed CI Steps

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
@kbn/esql-ast	1	2	+1

Total ESLint disabled count

id	before	after	diff
@kbn/esql-ast	2	3	+1

History

• 💚 Build #228126 succeeded 57f7a71
• 💔 Build #227863 failed f71385e

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

[drewdaemon]

Beautiful work