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

[Canvas] Filter is not using the type property correctly; fix in 8.0 #37422

Closed
clintandrewhall opened this issue May 29, 2019 · 2 comments · Fixed by #64215
Closed

[Canvas] Filter is not using the type property correctly; fix in 8.0 #37422

clintandrewhall opened this issue May 29, 2019 · 2 comments · Fixed by #64215
Assignees
Labels
bug Fixes for quality problems that affect the customer experience Feature:Canvas impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort release_note:breaking Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas v8.0.0

Comments

@clintandrewhall
Copy link
Contributor

In Canvas, all types used and returned by the Interpreter include a type property, a string, which indicates what the JSON shape represents, (e.g. Datatable has type: 'datatable', etc).

As we were moving the Canvas Function Typescript to the Interpreter package (#36960), we noticed that Filter does not honor this contract. Instead, Filter uses type to indicate what type of filter it is, and is missing the type string.

The fix for this would be to rename the existing type property to something like filterType, and add type: 'filter' to the shape, (and TS type). This would constitute a breaking change for Canvas plugin authors.

We're tracking the need for this change in this issue, as something to ship in v8.0.

cc: @w33ble, @lukeelmers

@clintandrewhall clintandrewhall added bug Fixes for quality problems that affect the customer experience Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas loe:small Small Level of Effort v8.0.0 impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. labels May 29, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-canvas

@lukeelmers
Copy link
Member

cc @elastic/kibana-app-arch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Feature:Canvas impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort release_note:breaking Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas v8.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants