Skip to content

[ES|QL] Show policy metadata on hover#171940

Merged
dej611 merged 3 commits intoelastic:feature/esql-validationfrom
dej611:fix/esql-more-hover
Nov 27, 2023
Merged

[ES|QL] Show policy metadata on hover#171940
dej611 merged 3 commits intoelastic:feature/esql-validationfrom
dej611:fix/esql-more-hover

Conversation

@dej611
Copy link
Contributor

@dej611 dej611 commented Nov 24, 2023 •
edited
Loading

Summary

This PR adds some more hover feature on policies hovering, showing some useful details:

Screenshot 2023-11-24 at 18 02 18

Initially I thought about adding also the signature for command and option on hover, but there's enough space there for examples, which are kind of important together with the signature.
I'd wait for #171720 to be merged, and then leverage the HTML support in markdown together with some additional nice features in the editor with the newer version.

Checklist

@dej611 dej611 added Team:Visualizations Team label for Lens, elastic-charts, Graph, legacy editors (TSVB, Visualize, Timelion) t// release_note:skip Skip the PR/issue when compiling release notes Feature:ES|QL ES|QL related features in Kibana v8.12.0 labels Nov 24, 2023
@kibana-ci
Copy link

kibana-ci commented Nov 27, 2023

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/monaco 94 95 +1

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
textBasedLanguages 151.0KB 151.0KB +6.0B

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 2.7MB 2.7MB +908.0B
Unknown metric groups

API count

id before after diff
@kbn/monaco 96 97 +1

History

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

@dej611 dej611 marked this pull request as ready for review November 27, 2023 09:58
@dej611 dej611 requested review from a team as code owners November 27, 2023 09:58
@elasticmachine
Copy link
Contributor

elasticmachine commented Nov 27, 2023

Pinging @elastic/kibana-visualizations (Team:Visualizations)

@dej611 dej611 mentioned this pull request Nov 27, 2023
Merged
23 tasks
stratoula
stratoula approved these changes Nov 27, 2023
View reviewed changes
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.

Me gusta! LGTM

@dej611 dej611 merged commit d7a101e into elastic:feature/esql-validation Nov 27, 2023
dej611 added a commit that referenced this pull request Dec 7, 2023
@dej611 @kibanamachine
@stratoula @abdonpijpelink
[ES|QL] Advanced validation and autocomplete (#170071)
ff49526 
## Summary

Fixes #166242 , #166876, #166173
, part of #166092, #166084

List of tasks:

* [x] AST work ( #166185 )
* [x] Basic validate work ( #166185 )
* [x] Hover feature ( #166185 )
* [x] Initial autocomplete work with new AST ( #166185 )
* Complete validation feature for MVP
  * [x] wildcards support ( #170014 )
  * [x] remote index validation support ( #171996 )
  * [x] wildcard support as `count` argument  ( #172054 )
  * [x] Aggressive caching for field queries:
* cache as much as possible the `FROM` queries - possible clear the
cache every 10/15 minutes?
    * do not fire a query when code == submitted code
* cache as much as possible the custom `FROM` built from `ENRICH`
policies - same clear policy as above
  * [x] Add unsupported fields warning messages
  * [x] Notify usage of `project` command with deprecation `warning`
* Complete autocomplete work ( #171664 )
  * [x] `stats`
  * [x] `where`
  * [x] `eval`
    * `math syntax`
  * [x] Aggressive cache for fields queries? ( #171866 )
  * [x] Fix when cursor is not at the end position ( #172060 ) 
* [x] Revisit copy messages
  * Label Kibana-only messages
* [x] Extend hover feature ( #171940 )
* [x] Disable editor query highlight for warnings ( #171968 )
* Fix editor highlight with new grammar
  * [x] on multi-line ( #172080 )
  * [x] for functions ( #172287 )

## Release notes

Enhance ES|QL query editing experience with client side validation.
Enhance ES|QL suggestions experience with more in context suggestions
leveraging field and variable types.
Show meta informations on ES|QL query hover on policy names.
Show function signature on ES|QL query hover on function text.


### Checklist

Delete any items that are not applicable to this PR.

- [x] 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)
- [x] [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
- [x] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Stratoula Kalafateli <efstratia.kalafateli@elastic.co>
Co-authored-by: Abdon Pijpelink <abdon.pijpelink@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stratoula stratoula stratoula approved these changes

Assignees

No one assigned

Labels

Feature:ES|QL ES|QL related features in Kibana release_note:skip Skip the PR/issue when compiling release notes Team:Visualizations Team label for Lens, elastic-charts, Graph, legacy editors (TSVB, Visualize, Timelion) t// v8.12.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dej611 @kibana-ci @elasticmachine @stratoula