feat: split superset-ui/query from superset-ui/chart

[kristw]

💔 Breaking Changes

A. Some functions and types are removed from @superset-ui/chart and moved to new package @superset-ui/query

• buildQueryContext
• buildQueryObject
• types related to QueryObject

There is no change to the functionalities.

Fix #176

B. ChartFormData is renamed to QueryFormData

This is to better reflect what the object actually is. Historically, formData in Superset stores all information necessary to reproduce a chart, which include

1. database query information
2. visual appearance

We have always considered formData to be a single type that contains both information in the context of Superset app (incubator-superset). However, after the development of embeddable charts, we see the following use cases:

1. Query data from Superset without using its chart. => only need the query part of formData.
2. Display Superset chart without query (User supplies data in their own way.) => only need the visual appearance part of formData.

It seems more logical to separate the two parts of formData into its own type.

1. QueryFormData, which is what @superset-ui/query handles. buildQueryObject converts QueryFormData to QueryObject.
2. ChartFormData, which varies chart by chart and can be defined in the @superset-ui/plugins packages.

type SupersetFormData = QueryFormData & ChartFormData

Currently, ChartFormData is referenced in plugin-chart-table which is still under development, and dataportal

Migration guide

• Change broken reference from @superset-ui/chart to @superset-ui/query
• For apps that has @superset-ui/chart as dependency, also add @superset-ui/query
• Rename ChartFormData to QueryFormData.

[codecov]

Codecov Report

Merging #178 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master     #178   +/-   ##
=======================================
  Coverage   99.91%   99.91%           
=======================================
  Files         102      102           
  Lines        1221     1221           
  Branches      293      293           
=======================================
  Hits         1220     1220           
  Partials        1        1

Impacted Files	Coverage Δ
...ckages/superset-ui-chart/src/models/ChartPlugin.ts	100% <ø> (ø)	⬆️
packages/superset-ui-query/src/convertMetric.ts	100% <ø> (ø)
packages/superset-ui-query/src/convertFilter.ts	100% <ø> (ø)
...src/registries/ChartBuildQueryRegistrySingleton.ts	100% <ø> (ø)	⬆️
packages/superset-ui-query/src/processMetrics.ts	100% <ø> (ø)
packages/superset-ui-query/src/processExtras.ts	100% <ø> (ø)
packages/superset-ui-query/src/types/Filter.ts	100% <ø> (ø)
...kages/superset-ui-query/src/types/QueryFormData.ts	100% <ø> (ø)
...rset-ui-chart/src/components/ChartDataProvider.tsx	100% <ø> (ø)	⬆️
packages/superset-ui-query/src/processFilters.ts	100% <ø> (ø)
... and 6 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f8d7042...8b528de. Read the comment docs.

[netlify]

Deploy preview for superset-ui ready!

Built with commit 0b8613e

https://deploy-preview-178--superset-ui.netlify.com

[netlify]

Deploy preview for superset-ui ready!

Built with commit 8b528de

https://deploy-preview-178--superset-ui.netlify.com

[etr2460]

one question

[etr2460]

Judging from the name, AnnotationLayerMetadata seems more related to charts than queries. why is it being pulled out here?

[kristw]

@etr2460 I have put the AnnotationLayerMetadata back

[etr2460]

lgtm then!