Skip to content

Fix and improve suggestion experience in Formula#19

Merged
wylieconlon merged 2 commits intowylieconlon:lens/formula-error-handlingfrom
dej611:lens/formula-kql
May 24, 2021
Merged

Fix and improve suggestion experience in Formula#19
wylieconlon merged 2 commits intowylieconlon:lens/formula-error-handlingfrom
dej611:lens/formula-kql

Conversation

@dej611
Copy link
Copy Markdown

@dej611 dej611 commented May 20, 2021 •
edited
Loading

Summary

  • Remove formula and math functions from the suggestion list
  • Remove duplicate examples
  • Use EUI markdown component on all renderings
    • revisit markdown format for snippets
  • sync signatures across different places
  • refactor the kql/lucene extra args for all arguments
  • reduced the info in the suggestion help popover (I've tried only with signature, but it was basically a clone of the regular suggestion)
    • moving_average is the longest (see the pic below). Others are in the order of 1/2 lines
  • memoized a couple things for doc
  • Added few doc bits for counter_rate

Screenshot 2021-05-20 at 18 37 34

Screenshot 2021-05-20 at 18 38 10

Screenshot 2021-05-20 at 18 38 23

Hover still shows the whole doc for the function:
Screenshot 2021-05-20 at 18 41 00

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

For maintainers

wylieconlon
wylieconlon reviewed May 20, 2021
View reviewed changes
Copy link
Copy Markdown
Owner

@wylieconlon wylieconlon left a comment

Choose a reason for hiding this comment

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

@dej611 A few comments left, but I tested out the PR and it's mostly looking good. Just one more round of updates before I merge.

Comment thread ...s/lens/public/indexpattern_datasource/operations/definitions/formula/editor/formula_help.tsx Outdated
let extraArgs = '';
if (def.filterable) {
extraArgs += hasFunctionFieldArgument(name) || 'operationParams' in def ? ',' : '';
extraArgs += '[kql]?: string, [lucene]?: string';
Copy link
Copy Markdown
Owner

@wylieconlon wylieconlon May 20, 2021

Choose a reason for hiding this comment

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

@dej611 We probably don't need i18n on the words kql/lucene, but we probably do need it for the word string.

Comment thread ...lens/public/indexpattern_datasource/operations/definitions/formula/editor/math_completion.ts Outdated
Comment on lines +284 to +285
o.operationType !== 'formula' &&
o.operationType !== 'math'
Copy link
Copy Markdown
Owner

@wylieconlon wylieconlon May 20, 2021

Choose a reason for hiding this comment

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

We already have o.hidden as a filterable parameter here, please use that instead @dej611

Comment thread x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/cardinality.tsx Outdated
\`\`\`
unique_count(product.name, kql="product.group=clothes")
\`\`\`
${'`unique_count(product.name, kql="product.group=clothes")`'}
Copy link
Copy Markdown
Owner

@wylieconlon wylieconlon May 20, 2021

Choose a reason for hiding this comment

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

Since you're making a change to kql here, can you also ensure that KQL uses single quotes in every example?

@wylieconlon wylieconlon merged commit c97f6f6 into wylieconlon:lens/formula-error-handling May 24, 2021
wylieconlon pushed a commit that referenced this pull request Jun 10, 2021
@dej611 @kibanamachine
@flash1293 @MichaelMarcialis
[Lens] Formula editor (elastic#99297)
b35cde5 
* 💄 Hack to fix suggestion box

* 🐛 Fix validation messages

* 🐛 Relax operations check for managedReferences

* Change completion params

* 🏷️ Fix missing arg issue

* ✨ Add more tinymath fns

* 🐛 Improved validation around math operations + multiple named arguments

* 🐛 Use new onError feature in math expression

* ♻️ Refactor namedArguments validation

* 🐛 Fix circular dependency issue in tests + minor fixes

* Move formula into a tab

* 🔥 Leftovers from previous merge

* ✨ Move over namedArgs from previous function

* ✅ Add tests for transferable scenarios

* ✅ Fixed broken test

* ✨ Use custom label for axis

* Allow switching back and forth to formula tab

* Add a section for the function reference

* Add modal editor and markdown docs

* Change the way math nodes are validated

* Use custom portal to fix monaco positioning

* Fix model sharing issues

* Provide signature help

* 🐛 Fix small test issue

* 🐛 Mark pow arguments as required

* 🐛 validate on first render only if a formula is present

* 🔥 Remove log10 fn for now

* ✨ Improved math validation + add tests for math functions

* Fix mount/unmount issues with Monaco

* [Lens] Fully unmount React when flyout closes

* Fix bug with editor frame unmounting

* Fix type

* Add tests for monaco providers, add hover provider

* Add test for last_value

* Usability improvements

* Add KQL and Lucene named parameters

* Add kql, lucene completion and validation

* Fix autocomplete on weird characters and properly connect KQL

* Highlight functions that have additional requirements after validating

* Fix type error and move help text to popover

* Fix escape characters inside KQL

* 🐛 Fix dataType issue when moving over to Formula

* Automatically insert single quotes on every named param

* Only insert single quotes when typing kql= or lucene=

* Reorganize help popover

* Fix merge issues

* Update grammar for formulas

* Fix bad merge

* Rough fullscreen mode

* Type updates

* Pass through fullscreen state

* Remove more chrome from full screen mode

* Fix minor bugs in formula typing

* 🐛 Decouple column order of references and output

* 🔧 Fix tests and types

* ✅ Add first functional test

* Fix copying formulas and empty formula

* Trigger suggestion prompt when hitting enter on function or typing kql=

* 🐛 Prevent flyout from closing while interacting with monaco

* refactoring

* move main column generation into parse module

* fix tests

* refactor small formula styles and markup

* documentation

* adjustments in formula footer

* Formula refactoring (#12)

* refactoring

* move main column generation into parse module

* fix tests

* more style and markup tweak for custom formula

* Fix tests

* [Expressions] Use table column ID instead of name when set

* [Lens] Create managedReference type for formulas

* Fix test failures

* Fix i18n types

* fix fullscreen flex issues

* Delete managedReference when replacing

* refactor css and markup; add button placeholders

* [Lens] Formulas

* Tests for formula

Co-authored-by: Marco Liberati <marco.liberati@elastic.co>

* added error count placeholder

* Add tooltips

* Refactoring from code review

* Fix some editor issues

* Update ID matching to match by name sometimes

* Improve performance of Monaco, fix formulas with 0, update labels

* Improve performance of full screen toggle

* Fix formula tests

* fix stuff

* Add an extra case to prevent insertion of duplicate column

* Simplify logic and add test for output ID

* add telemetry for Lens formula (#15)

* Respond to review comments

* ✨ Improve the signatures with better documentation and examples

* adjust border styles to account for docs collapse

* refactor docs markup; restructure docs obj; styles

* Fix formula auto reordering (#18)

* fix formula auto reordering

* add unit test

* Fix and improve suggestion experience in Formula (#19)

* ✨ Revisit documentation and suggestions

* 👌 Integrated feedback

* ✨ Add query validation for quotes

* Usability updates & type fixes

* add search to formula

* fix form styles to match designs

* fix text styles; revert to Markdown for control

* 👌 Integrated more feedback

* improve search

* improve suggestions

* improve suggestions even more

* 🐛 Fix i18n issues (#22)

* Persist formula on leave, fix fullscreen and popovers

* Fix documentation tests

* 🏷️ fix type issue

* 🐛 Remove hidden operations from valid functions list

* 🐛 Fix empty string query edge case

* 🐛 Enable more suggestions + extends validation

* Fix tests that depended on setState being called without function

* Error state and text wrapping updates

* ✨ Add new module to CodeEditor for brackets matching (#25)

* Fix type

* show warning

* keep current quick function

* ✨ Improve suggestions within kql query

* 📷 Fix snapshot editor test

* 🐛 Improved suggestion for single quote and refactored debounce

* Fix lodash usage

* Fix tests

* Revert "keep current quick function"

This reverts commit ed47705.

* Improve performance of dispatch by using timeout

* Improve memoization of datapanel

* Fix escape characters

* fix reduced suggestions

* fix responsiveness

* fix unit test

* Fix autocomplete on nested math

* Show errors and warnings on first render

* fix transposing column crash

* Update comment

* 🐛 Fix field error message

* fix test types

* 📝 Fix i18n name

* 💄 Manage wordwrap via react component

* Fix selector for palettes that interferes with quick functions

* Use word wrapping by default

* Errors for managed references are handled at the top level

* 🐛 Move the cursor just next to new inserted text

* ⚗️ First pass for performance

* 🐛 Fix unwanted change

* ⚡ Memoize as many combobox props as possible

* ⚡ More memoization

* Show errors in hover

* Use temporary invalid state when moving away from formula

* Remove setActiveDimension and shouldClose, fixed by async setters

* Fix test dependency

* do not show quick functions tab

* increase documentation popover width

* fix functional test

* Call setActiveDimension when updating visualization

* Simplify handling of flyout with incomplete columns

* Fix test issues

* add description to formula telemetry

* fix schema

* Update from design feedback

* More review comments

* Hide callout border from v7 theme

Co-authored-by: dej611 <dej611@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Joe Reuter <johannes.reuter@elastic.co>
Co-authored-by: Michael Marcialis <michael.marcialis@elastic.co>
Co-authored-by: Joe Reuter <email@johannes-reuter.de>
Co-authored-by: Marco Liberati <marco.liberati@elastic.co>
Co-authored-by: Marco Liberati <dej611@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wylieconlon wylieconlon wylieconlon left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dej611 @wylieconlon