fix: Ensures form data required properties exist at runtime (echarts-timeseries) #25419
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
This PR fixes many potential problems related to missing required properties in form data objects. The form data object is a JSON representation of a chart's configuration and it evolves over time as new features are added. Unfortunately, these objects are not versioned and their Typescript definitions refer to their latest version. This causes some problems because we may have legacy versions of a form data type that don't obey to its Typescript definition. As an example, a required property might be
null
or don't exist in a legacy version. This leads to runtime exceptions and developers adding checks fornull
values when the type definition clearly states that it shouldn't be the case. To remedy this issue, this PR adds a generic solution to make sure Typescript required fields exist during runtime.This PR adds the generic
parseFormData
function and focus on timeseries charts. The intention of this PR is to create the pattern to handle this problem and allow subsequent PRs for the other chart types.Fixes #25354
BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF
TESTING INSTRUCTIONS
TODO
ADDITIONAL INFORMATION