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.

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

[ES|QL] Improve ES|QL autocomplete suggestions for case() expressions #192135

Merged
merged 10 commits into from
Sep 9, 2024

Conversation

qn895
Copy link
Member

@qn895 qn895 commented Sep 4, 2024

Summary

This PR addresses #177258 and improves autocomplete support for case() expressions

After:

  • case( / ) suggest any field/to boolean function in this position as first argument
  • case( field /) suggest comparison operators at this point to converge to a boolean
  • case( field > / ) suggest field/function of the same type of the right hand side to complete the boolean expression
  • case( field > 0, / ) suggest normal fields and functions
Screen.Recording.2024-09-04.at.15.59.06.mov
Screen.Recording.2024-09-05.at.12.44.02.mov

Checklist

Delete any items that are not applicable to this PR.

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—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—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

For maintainers

@qn895 qn895 requested a review from a team as a code owner September 4, 2024 21:12
@qn895 qn895 self-assigned this Sep 4, 2024
@qn895 qn895 added release_note:enhancement Feature:ES|QL ES|QL related features in Kibana Team:ESQL ES|QL related features in Kibana v8.16.0 labels Sep 4, 2024
@elasticmachine
Copy link
Contributor

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

Copy link
Contributor

@stratoula stratoula left a comment

Choose a reason for hiding this comment

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

Very very nice! I tested it locally and works great, LGTM!

@qn895
Copy link
Member Author

qn895 commented Sep 5, 2024

@elasticmachine merge upstream

@qn895 qn895 enabled auto-merge (squash) September 5, 2024 15:46
@drewdaemon
Copy link
Contributor

This improves the basic case nicely.

I'm not sure how far we want to take this. Worth pointing out, though, that CASE can be far more complex than this with an unlimited number of predicates and branches (basically nested ternaries).

case(predicate, value, predicate, value, predicate, value, value)

FROM employees
| EVAL type = CASE(
    languages <= 1, "monolingual",
    languages <= 2, "bilingual",
     "polyglot")

WDYT about these cases @qn895 @stratoula

@qn895 qn895 disabled auto-merge September 5, 2024 16:40
@stratoula
Copy link
Contributor

Yes yes we know that. I am fine with what Quynh has done so far and I don't want to complicate things at this point. I think it gives the idea. I want to add a more complicated cases example in the recommended queries task. I think we are good for now

Copy link
Contributor

@drewdaemon drewdaemon left a comment

Choose a reason for hiding this comment

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

Looking good! I suggested a couple test cases to add.

@qn895 qn895 enabled auto-merge (squash) September 5, 2024 18:07
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
kbnUiSharedDeps-srcJs 3.3MB 3.3MB +285.0B

History

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

cc @qn895

@qn895 qn895 merged commit 1919efa into elastic:main Sep 9, 2024
22 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Sep 9, 2024
gergoabraham pushed a commit to gergoabraham/kibana that referenced this pull request Sep 13, 2024
…elastic#192135)

## Summary

This PR addresses elastic#177258 and
improves autocomplete support for `case()` expressions

After:

- `case( / )` suggest any field/to boolean function in this position as
first argument
- `case( field /)` suggest comparison operators at this point to
converge to a boolean
- `case( field > / )` suggest field/function of the same type of the
right hand side to complete the boolean expression
- `case( field > 0, / )` suggest normal fields and functions



https://github.com/user-attachments/assets/64c87441-0e55-439b-8e84-697cbefe06f4


https://github.com/user-attachments/assets/79544f76-12ae-47c9-8e1a-82476b646ae7


### 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: Elastic Machine <elasticmachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:ES|QL ES|QL related features in Kibana release_note:enhancement Team:ESQL ES|QL related features in Kibana v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants