chore: add shared plugin controls utilities

[suddjian]

💔 Breaking Changes

🏆 Enhancements

This moves several files from incubator-superset into @superset-ui/chart. These will allow moving the plugin controls config out of Superset's setupPlugins.ts and into the individual plugins for all the plugins. This covers the dependencies for all plugin controls except the DeckGL plugins. Those will come later.

The new modules are not exported directly by @superset-ui/chart, and must be imported by their directory paths under @superset-ui/chart/controls/[...]. This is to keep things organized and to avoid bloating the package size.

📜 Documentation

Added a paragraph to the readme. It's not enough documentation really, but things are very much in flux and I'd prefer to write more comprehensive docs once the plugin situation is more locked down.

🐛 Bug Fix

🏠 Internal

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/superset/superset-ui/5nom0vq4d
✅ Preview: https://superset-ui-git-fork-suddjian-chart-config-deps.superset.now.sh

[rusackas]

I think this could be a part of @superset-ui/legacy-preset-chart-nvd3 since it's written for (and only used by) that one plugin.

Same applies to the DeckGL equivalent - those shared controls could live with that plugin.

[suddjian]

Oh thanks for the pointer, if it's only used there then that's way better.

[kristw]

Agree with @rusackas

[ktmud]

Maybe create a new pakage superset-ui/controls? It may also make sense to leave the NVD3 controls in incubator-superset for now. The way I see it, they are more like visualization-specific metadata that should go with the plugins.

[ktmud]

This has been updated to "~g". See: apache/superset#9608

[codecov]

Codecov Report

Merging #389 into master will increase coverage by 0.21%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #389      +/-   ##
==========================================
+ Coverage   26.31%   26.53%   +0.21%     
==========================================
  Files         192      196       +4     
  Lines        5293     5307      +14     
  Branches      475      475              
==========================================
+ Hits         1393     1408      +15     
  Misses       3864     3864              
+ Partials       36       35       -1     

Impacted Files	Coverage Δ
...ges/superset-ui-chart/src/controls/D3Formatting.ts	100.00% <100.00%> (ø)
packages/superset-ui-chart/src/controls/index.ts	100.00% <100.00%> (ø)
...ckages/superset-ui-chart/src/controls/sections.tsx	100.00% <100.00%> (ø)
...es/superset-ui-chart/src/controls/selectOptions.ts	100.00% <100.00%> (ø)
packages/superset-ui-query/src/buildQueryObject.ts	100.00% <0.00%> (+7.69%)	⬆️

---

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 b1c93da...d5e70aa. Read the comment docs.

[rusackas]

LGTM, but we may want to get this one in first: apache/superset#9578

[kristw]

Maybe create a new package superset-ui/controls

Agree with @ktmud.

[kristw]

These should be peerDependencies. (translation needs to be a singleton. validator not necessariliy, but I have been making all @superset-ui/xxx peerDependencies by convention to avoid having multiple copies of some singleton by mistake)

[rusackas]

@kristw @ktmud I'm inclined to say this is OK as-is, and push it through for now. We should sync up about the plan for remaining controls and their dependencies. If they need to be in a new package (I'm not sure, but I'm open to it), we can address that in a separate PR. I would just want to call it something like controlUtils rather than controls since the latter sounds exactly like what we're all trying to kill off :)

[ktmud]

I would just want to call it something like controlUtils rather than controls since the latter sounds exactly like what we're all trying to kill off :)

@rusackas , can you clarify on this statement?

I was creating a new control type today (a radio button, to be specific) and thought it'd be beneficial to create it as a shared control.

A @superset-ui/controls or @superset-ui/chart-controls package seems a great place to store these shared control components, as well as those currently reside in superset-frontend/src/explore/component/controls. What are our plans regarding those?