forked from apache/superset
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add superchart and convert to ts * fix compilation error * fix build issue * unit test working * Add default width and height to ChartProps * export SuperChart * Add null check and update unit tests * update unit tests * complete test coverage * Add generic * reduce timeout
- Loading branch information
Showing
9 changed files
with
458 additions
and
32 deletions.
There are no files selected for viewing
222 changes: 222 additions & 0 deletions
222
packages/superset-ui-chart/src/components/SuperChart.tsx
This file contains 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,222 @@ | ||
| import * as React from 'react'; | ||
| import { createSelector } from 'reselect'; | ||
| import getChartComponentRegistry from '../registries/ChartComponentRegistrySingleton'; | ||
| import getChartTransformPropsRegistry from '../registries/ChartTransformPropsRegistrySingleton'; | ||
| import ChartProps from '../models/ChartProps'; | ||
| import createLoadableRenderer, { LoadableRenderer } from './createLoadableRenderer'; | ||
|
|
||
| const IDENTITY = (x: any) => x; | ||
|
|
||
| const EMPTY = () => null; | ||
|
|
||
| /* eslint-disable sort-keys */ | ||
| const defaultProps = { | ||
| id: '', | ||
| className: '', | ||
| preTransformProps: IDENTITY, | ||
| overrideTransformProps: undefined, | ||
| postTransformProps: IDENTITY, | ||
| onRenderSuccess() {}, | ||
| onRenderFailure() {}, | ||
| }; | ||
| /* eslint-enable sort-keys */ | ||
|
|
||
| type TransformFunction<Input = PlainProps, Output = PlainProps> = (x: Input) => Output; | ||
| type HandlerFunction = (...args: any[]) => void; | ||
|
|
||
| interface LoadingProps { | ||
| error: any; | ||
| } | ||
|
|
||
| interface PlainProps { | ||
| [key: string]: any; | ||
| } | ||
|
|
||
| interface LoadedModules { | ||
| Chart: React.Component | { default: React.Component }; | ||
| transformProps: TransformFunction | { default: TransformFunction }; | ||
| } | ||
|
|
||
| interface RenderProps { | ||
| chartProps: ChartProps; | ||
| preTransformProps?: TransformFunction<ChartProps>; | ||
| postTransformProps?: TransformFunction; | ||
| } | ||
|
|
||
| const BLANK_CHART_PROPS = new ChartProps(); | ||
|
|
||
| export interface SuperChartProps { | ||
| id?: string; | ||
| className?: string; | ||
| chartProps?: ChartProps | null; | ||
| chartType: string; | ||
| preTransformProps?: TransformFunction<ChartProps>; | ||
| overrideTransformProps?: TransformFunction; | ||
| postTransformProps?: TransformFunction; | ||
| onRenderSuccess?: HandlerFunction; | ||
| onRenderFailure?: HandlerFunction; | ||
| } | ||
|
|
||
| function getModule<T>(value: any): T { | ||
| return (value.default ? value.default : value) as T; | ||
| } | ||
|
|
||
| export default class SuperChart extends React.PureComponent<SuperChartProps, {}> { | ||
| static defaultProps = defaultProps; | ||
|
|
||
| constructor(props: SuperChartProps) { | ||
| super(props); | ||
|
|
||
| this.renderChart = this.renderChart.bind(this); | ||
| this.renderLoading = this.renderLoading.bind(this); | ||
|
|
||
| // memoized function so it will not recompute | ||
| // and return previous value | ||
| // unless one of | ||
| // - preTransformProps | ||
| // - transformProps | ||
| // - postTransformProps | ||
| // - chartProps | ||
| // is changed. | ||
| this.processChartProps = createSelector( | ||
| input => input.preTransformProps, | ||
| input => input.transformProps, | ||
| input => input.postTransformProps, | ||
| input => input.chartProps, | ||
| (pre = IDENTITY, transform = IDENTITY, post = IDENTITY, chartProps) => | ||
| post(transform(pre(chartProps))), | ||
| ); | ||
|
|
||
| const componentRegistry = getChartComponentRegistry(); | ||
| const transformPropsRegistry = getChartTransformPropsRegistry(); | ||
|
|
||
| // memoized function so it will not recompute | ||
| // and return previous value | ||
| // unless one of | ||
| // - chartType | ||
| // - overrideTransformProps | ||
| // is changed. | ||
| this.createLoadableRenderer = createSelector( | ||
| input => input.chartType, | ||
| input => input.overrideTransformProps, | ||
| (chartType, overrideTransformProps) => { | ||
| if (chartType) { | ||
| const Renderer = createLoadableRenderer({ | ||
| loader: { | ||
| Chart: () => componentRegistry.getAsPromise(chartType), | ||
| transformProps: overrideTransformProps | ||
| ? () => Promise.resolve(overrideTransformProps) | ||
| : () => transformPropsRegistry.getAsPromise(chartType), | ||
| }, | ||
| loading: (loadingProps: LoadingProps) => this.renderLoading(loadingProps, chartType), | ||
| render: this.renderChart, | ||
| }); | ||
|
|
||
| // Trigger preloading. | ||
| Renderer.preload(); | ||
|
|
||
| return Renderer; | ||
| } | ||
|
|
||
| return EMPTY; | ||
| }, | ||
| ); | ||
| } | ||
|
|
||
| processChartProps: ( | ||
| input: { | ||
| chartProps: ChartProps; | ||
| preTransformProps?: TransformFunction<ChartProps>; | ||
| transformProps?: TransformFunction; | ||
| postTransformProps?: TransformFunction; | ||
| }, | ||
| ) => any; | ||
|
|
||
| createLoadableRenderer: ( | ||
| input: { | ||
| chartType: string; | ||
| overrideTransformProps?: TransformFunction; | ||
| }, | ||
| ) => LoadableRenderer<RenderProps, LoadedModules> | (() => null); | ||
|
|
||
| renderChart(loaded: LoadedModules, props: RenderProps) { | ||
| const Chart = getModule<typeof React.Component>(loaded.Chart); | ||
| const transformProps = getModule<TransformFunction>(loaded.transformProps); | ||
| const { chartProps, preTransformProps, postTransformProps } = props; | ||
|
|
||
| return ( | ||
| <Chart | ||
| {...this.processChartProps({ | ||
| /* eslint-disable sort-keys */ | ||
| chartProps, | ||
| preTransformProps, | ||
| transformProps, | ||
| postTransformProps, | ||
| /* eslint-enable sort-keys */ | ||
| })} | ||
| /> | ||
| ); | ||
| } | ||
|
|
||
| renderLoading(loadingProps: LoadingProps, chartType: string) { | ||
| const { error } = loadingProps; | ||
|
|
||
| if (error) { | ||
| return ( | ||
| <div className="alert alert-warning" role="alert"> | ||
| <strong>ERROR</strong> | ||
| <code>chartType="{chartType}"</code> — | ||
| {error.toString()} | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| render() { | ||
| const { | ||
| id, | ||
| className, | ||
| preTransformProps, | ||
| postTransformProps, | ||
| chartProps = BLANK_CHART_PROPS, | ||
| onRenderSuccess, | ||
| onRenderFailure, | ||
| } = this.props; | ||
|
|
||
| // Create LoadableRenderer and start preloading | ||
| // the lazy-loaded Chart components | ||
| const Renderer = this.createLoadableRenderer(this.props); | ||
|
|
||
| // Do not render if chartProps is set to null. | ||
| // but the pre-loading has been started in this.createLoadableRenderer | ||
| // to prepare for rendering once chartProps becomes available. | ||
| if (chartProps === null) { | ||
| return null; | ||
| } | ||
|
|
||
| const containerProps: { | ||
| id?: string; | ||
| className?: string; | ||
| } = {}; | ||
| if (id) { | ||
| containerProps.id = id; | ||
| } | ||
| if (className) { | ||
| containerProps.className = className; | ||
| } | ||
|
|
||
| return ( | ||
| <div {...containerProps}> | ||
| <Renderer | ||
| preTransformProps={preTransformProps} | ||
| postTransformProps={postTransformProps} | ||
| chartProps={chartProps} | ||
| onRenderSuccess={onRenderSuccess} | ||
| onRenderFailure={onRenderFailure} | ||
| /> | ||
| </div> | ||
| ); | ||
| } | ||
| } |
This file contains 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 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 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 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
13 changes: 13 additions & 0 deletions
13
packages/superset-ui-chart/test/components/SuperChart.test.jsx
This file contains 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,13 @@ | ||
| import React from 'react'; | ||
| import { shallow } from 'enzyme'; | ||
| import { SuperChart } from '../../src'; | ||
|
|
||
| describe('SuperChart', () => { | ||
| it('does not render if chartType is not set', done => { | ||
| const wrapper = shallow(<SuperChart />); | ||
| setTimeout(() => { | ||
| expect(wrapper.render().children()).toHaveLength(0); | ||
| done(); | ||
| }, 5); | ||
| }); | ||
| }); |
Oops, something went wrong.