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

[XY] Add xExtent validation within expression #134546

Merged
merged 3 commits into from
Jun 17, 2022

Conversation

dej611
Copy link
Contributor

@dej611 dej611 commented Jun 16, 2022

Summary

Fixes partially #129308

This PR adds some validation for the new xExtent arg to improve Canvas users experience.

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

@dej611 dej611 added release_note:enhancement Feature:XYAxis XY-Axis charts (bar, area, line) Team:Visualizations Visualization editors, elastic-charts and infrastructure backport:skip This commit does not require backporting v8.4.0 labels Jun 16, 2022
@dej611 dej611 marked this pull request as ready for review June 16, 2022 09:52
@dej611 dej611 requested a review from a team as a code owner June 16, 2022 09:52
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-vis-editors @elastic/kibana-vis-editors-external (Team:VisEditors)

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

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

id before after diff
expressionXY 96.7KB 98.5KB +1.8KB

History

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

Copy link
Contributor

@flash1293 flash1293 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@VladLasitsa VladLasitsa left a comment

Choose a reason for hiding this comment

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

LGTM, just one small nit

@@ -136,6 +144,20 @@ export const validateExtentForDataBounds = (
}
};

export const validateXExtent = (
extent: AxisExtentConfigResult | undefined,
Copy link
Contributor

@VladLasitsa VladLasitsa Jun 17, 2022

Choose a reason for hiding this comment

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

nit: extent?: AxisExtentConfigResult

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have to invert the arguments order to set the optional argument

export const validateXExtent = (
  dataLayers: Array<DataLayerConfigResult | CommonXYDataLayerConfig>,
  extent?: AxisExtentConfigResult
) => {
...

Usually I prefer to have as first argument what it needs to be validate, and as subsequent arguments supporting utilities/objects.

@dej611 dej611 merged commit 2dc48ff into elastic:main Jun 17, 2022
@flash1293 flash1293 added release_note:skip Skip the PR/issue when compiling release notes and removed release_note:enhancement labels Aug 17, 2022
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:XYAxis XY-Axis charts (bar, area, line) release_note:skip Skip the PR/issue when compiling release notes Team:Visualizations Visualization editors, elastic-charts and infrastructure v8.4.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants