You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2026/09/07 02:29:49 UTC
(superset) 01/01: fix(chart): include echart_options in Matrixify render-trigger allowlist
This is an automated email from the ASF dual-hosted git repository.
rusackas pushed a commit to branch fix/issue-39008-implement-dosu-s-fix-verified-against-cu
in repository https://gitbox.apache.org/repos/asf/superset.git
commit 404cf1a287d57115a9b7cc0942fb683a461466aa
Author: rusackas <ev...@rusackas.com>
AuthorDate: Sun Sep 6 19:29:17 2026 -0700
fix(chart): include echart_options in Matrixify render-trigger allowlist
StatefulChart.tsx keeps a hardcoded allowlist of renderTrigger-only shared
controls (to avoid a circular import of chart-controls into core) that it
uses to decide whether a Matrixify grid cell should just re-render or issue
a full data refetch when formData changes. echart_options (and a few other
renderTrigger controls) were missing from that list, so editing the ECharts
Options field on a matrixified chart was treated as a data-affecting change
and forced an unnecessary per-cell requery instead of an instant re-render.
Fixes #39008
---
.../src/chart/components/StatefulChart.test.tsx | 50 ++++++++++++++++++++++
.../src/chart/components/StatefulChart.tsx | 8 ++++
2 files changed, 58 insertions(+)
diff --git a/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.test.tsx b/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.test.tsx
index 7d671f3ff5e..b35770243d4 100644
--- a/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.test.tsx
+++ b/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.test.tsx
@@ -566,6 +566,56 @@ test('should NOT refetch data when other string-based renderTrigger controls cha
});
});
+test('should NOT refetch data when echart_options (string-based renderTrigger control) changes', async () => {
+ // Matches how the Timeseries/MixedTimeseries control panels reference this
+ // shared control: a bare string, e.g. ['echart_options'].
+ const controlPanelConfig = {
+ controlPanelSections: [
+ {
+ controlSetRows: [['echart_options']],
+ },
+ ],
+ };
+
+ jest.mocked(getChartControlPanelRegistry).mockReturnValue({
+ get: jest.fn().mockReturnValue(controlPanelConfig),
+ } as unknown as ReturnType<typeof getChartControlPanelRegistry>);
+
+ const formDataWithEchartOptions = {
+ ...mockFormData,
+ echart_options: '{}',
+ };
+
+ const { rerender, getByTestId } = render(
+ <StatefulChart
+ formData={formDataWithEchartOptions}
+ chartType="test_chart"
+ />,
+ );
+
+ await waitFor(() => {
+ expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
+ });
+
+ // Edit the ECharts Options field (e.g. from the Customize tab while the
+ // chart is part of a Matrixify grid cell).
+ const updatedFormData = {
+ ...formDataWithEchartOptions,
+ echart_options: '{"title": {"text": "My Chart"}}',
+ };
+
+ rerender(<StatefulChart formData={updatedFormData} chartType="test_chart" />);
+
+ await waitFor(() => {
+ // Should NOT refetch data - echart_options is a renderTrigger control
+ expect(mockChartClient.client.post).toHaveBeenCalledTimes(1);
+ // But should re-render with the new formData
+ expect(getByTestId('super-chart')).toHaveTextContent(
+ JSON.stringify(updatedFormData),
+ );
+ });
+});
+
test('should refetch when string control is NOT in RENDER_TRIGGER_SHARED_CONTROLS', async () => {
// Control panel with a string control that is NOT in the renderTrigger set
const controlPanelConfig = {
diff --git a/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.tsx b/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.tsx
index e6c9103594b..eabd1b84d09 100644
--- a/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.tsx
+++ b/superset-frontend/packages/superset-ui-core/src/chart/components/StatefulChart.tsx
@@ -50,6 +50,9 @@ type LoadingState = 'uninitialized' | 'loading' | 'loaded' | 'error';
* This list is needed because string-based control references (e.g., ['zoomable'])
* cannot be introspected for their renderTrigger property without importing
* sharedControls, which would create a circular dependency.
+ *
+ * Keep this list in sync with the `renderTrigger: true` entries in
+ * @superset-ui/chart-controls's sharedControls.tsx.
*/
const RENDER_TRIGGER_SHARED_CONTROLS = new Set([
'zoomable',
@@ -57,6 +60,11 @@ const RENDER_TRIGGER_SHARED_CONTROLS = new Set([
'time_shift_color',
'y_axis_format',
'currency_format',
+ 'color_picker',
+ 'linear_color_scheme',
+ 'x_axis_time_format',
+ 'x_axis_number_format',
+ 'echart_options',
]);
/**