-
Notifications
You must be signed in to change notification settings - Fork 16.7k
fix(ui-core): Invalid postTransform process #34874
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
Merged
justinpark
merged 6 commits into
apache:master
from
justinpark:hotfix--process-chart-props
Sep 3, 2025
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
95f9cd9
fix(ui-core): Invalid postTransform process
justinpark 4aeb98f
missing license and spec description
justinpark dd5fde2
restore processChartProps
justinpark 3d20635
lint fix
justinpark 1c3d955
update comments
justinpark 7f3db1e
replace describe/it by test
justinpark File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
90 changes: 90 additions & 0 deletions
90
superset-frontend/packages/superset-ui-core/src/chart/components/SuperChartCore.test.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| import { render, waitFor } from '@testing-library/react'; | ||
|
|
||
| import { | ||
| ChartPlugin, | ||
| ChartMetadata, | ||
| DatasourceType, | ||
| getChartComponentRegistry, | ||
| } from '@superset-ui/core'; | ||
|
|
||
| import SuperChartCore from './SuperChartCore'; | ||
|
|
||
| const props = { | ||
| chartType: 'line', | ||
| }; | ||
| const FakeChart = () => <span>test</span>; | ||
|
|
||
| beforeEach(() => { | ||
| const metadata = new ChartMetadata({ | ||
| name: 'test-chart', | ||
| thumbnail: '', | ||
| }); | ||
| const buildQuery = () => ({ | ||
| datasource: { id: 1, type: DatasourceType.Table }, | ||
| queries: [{ granularity: 'day' }], | ||
| force: false, | ||
| result_format: 'json', | ||
| result_type: 'full', | ||
| }); | ||
| const controlPanel = { abc: 1 }; | ||
| const plugin = new ChartPlugin({ | ||
| metadata, | ||
| Chart: FakeChart, | ||
| buildQuery, | ||
| controlPanel, | ||
| }); | ||
| plugin.configure({ key: props.chartType }).register(); | ||
| }); | ||
|
|
||
| test('should return the result from cache unless transformProps has changed', async () => { | ||
| const pre = jest.fn(x => x); | ||
| const transform = jest.fn(x => x); | ||
| const post = jest.fn(x => x); | ||
| expect(getChartComponentRegistry().get(props.chartType)).toBe(FakeChart); | ||
|
|
||
| expect(pre).toHaveBeenCalledTimes(0); | ||
| const { rerender } = render( | ||
| <SuperChartCore | ||
| {...props} | ||
| preTransformProps={pre} | ||
| overrideTransformProps={transform} | ||
| postTransformProps={post} | ||
| />, | ||
| ); | ||
|
|
||
| await waitFor(() => expect(pre).toHaveBeenCalledTimes(1)); | ||
| expect(transform).toHaveBeenCalledTimes(1); | ||
| expect(post).toHaveBeenCalledTimes(1); | ||
|
|
||
| const updatedPost = jest.fn(x => x); | ||
|
|
||
| rerender( | ||
| <SuperChartCore | ||
| {...props} | ||
| preTransformProps={pre} | ||
| overrideTransformProps={transform} | ||
| postTransformProps={updatedPost} | ||
| />, | ||
| ); | ||
| await waitFor(() => expect(updatedPost).toHaveBeenCalledTimes(1)); | ||
| expect(transform).toHaveBeenCalledTimes(1); | ||
| expect(pre).toHaveBeenCalledTimes(1); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,31 +85,74 @@ export default class SuperChartCore extends PureComponent<Props, {}> { | |
| container?: HTMLElement | null; | ||
|
|
||
| /** | ||
| * memoized function so it will not recompute | ||
| * and return previous value | ||
| * memoized function so it will not recompute and return previous value | ||
| * unless one of | ||
| * - preTransformProps | ||
| * - transformProps | ||
| * - postTransformProps | ||
| * - chartProps | ||
| * is changed. | ||
| */ | ||
| processChartProps = createSelector( | ||
| preSelector = createSelector( | ||
| [ | ||
| (input: { | ||
| chartProps: ChartProps; | ||
| preTransformProps?: PreTransformProps; | ||
| transformProps?: TransformProps; | ||
| postTransformProps?: PostTransformProps; | ||
| }) => input.chartProps, | ||
| input => input.preTransformProps, | ||
| ], | ||
| (chartProps, pre = IDENTITY) => pre(chartProps), | ||
| ); | ||
|
|
||
| /** | ||
| * memoized function so it will not recompute and return previous value | ||
| * unless one of the input arguments have changed. | ||
| */ | ||
| transformSelector = createSelector( | ||
| [ | ||
| (input: { chartProps: ChartProps; transformProps?: TransformProps }) => | ||
| input.chartProps, | ||
| input => input.transformProps, | ||
| ], | ||
| (preprocessedChartProps, transform = IDENTITY) => | ||
| transform(preprocessedChartProps), | ||
| ); | ||
|
|
||
| /** | ||
| * memoized function so it will not recompute and return previous value | ||
| * unless one of the input arguments have changed. | ||
| */ | ||
| postSelector = createSelector( | ||
| [ | ||
| (input: { | ||
| chartProps: ChartProps; | ||
| postTransformProps?: PostTransformProps; | ||
| }) => input.chartProps, | ||
| input => input.postTransformProps, | ||
| ], | ||
| (chartProps, pre = IDENTITY, transform = IDENTITY, post = IDENTITY) => | ||
| post(transform(pre(chartProps))), | ||
| (transformedChartProps, post = IDENTITY) => post(transformedChartProps), | ||
| ); | ||
|
|
||
| /** | ||
| * Using each memoized function to retrieve the computed chartProps | ||
| */ | ||
| processChartProps = ({ | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you add a docstring for this function? |
||
| chartProps, | ||
| preTransformProps, | ||
| transformProps, | ||
| postTransformProps, | ||
| }: { | ||
| chartProps: ChartProps; | ||
| preTransformProps?: PreTransformProps; | ||
| transformProps?: TransformProps; | ||
| postTransformProps?: PostTransformProps; | ||
| }) => | ||
| this.postSelector({ | ||
| chartProps: this.transformSelector({ | ||
| chartProps: this.preSelector({ chartProps, preTransformProps }), | ||
| transformProps, | ||
| }), | ||
| postTransformProps, | ||
| }); | ||
|
|
||
| /** | ||
| * memoized function so it will not recompute | ||
| * and return previous value | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you adjust the comments for
transformSelectorandpostSelectorto: