YousufFFFF commented on code in PR #36214: URL: https://github.com/apache/superset/pull/36214#discussion_r2567534683
########## superset-frontend/plugins/plugin-chart-echarts/spec/Timeseries/Scatter/transformProps.test.ts: ########## @@ -0,0 +1,183 @@ +/** + * 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 { ChartProps, SMART_DATE_ID } from '@superset-ui/core'; +import transformProps from '../../../src/Timeseries/transformProps'; +import { DEFAULT_FORM_DATA } from '../../../src/Timeseries/constants'; +import { + EchartsTimeseriesSeriesType, + EchartsTimeseriesFormData, + EchartsTimeseriesChartProps, +} from '../../../src/Timeseries/types'; +import { GenericDataType } from '@apache-superset/core/api/core'; +import { + D3_FORMAT_OPTIONS, + D3_TIME_FORMAT_OPTIONS, +} from '@superset-ui/chart-controls'; +import { supersetTheme } from '@apache-superset/core/ui'; + +describe('Scatter Chart X-axis Time Formatting', () => { + const baseFormData: EchartsTimeseriesFormData = { + ...DEFAULT_FORM_DATA, + colorScheme: 'supersetColors', + datasource: '1__table', + granularity_sqla: '__timestamp', + metric: ['column 1'], + groupby: [], + viz_type: 'echarts_timeseries_scatter', + seriesType: EchartsTimeseriesSeriesType.Scatter, + }; + + const timeseriesData = [ + { + data: [ + { column_1: 0.72099, __timestamp: 1609459200000 }, + { column_1: 0.77954, __timestamp: 1612137600000 }, + { column_1: 2.83434, __timestamp: 1614556800000 }, + ], + colnames: ['column_1', '__timestamp'], + coltypes: [GenericDataType.Numeric, GenericDataType.Temporal], + }, + ]; + + const baseChartPropsConfig = { + width: 800, + height: 600, + queriesData: timeseriesData, + theme: supersetTheme, + }; + + test('xAxisTimeFormat has no default formatter', () => { + const chartProps = new ChartProps({ + ...baseChartPropsConfig, + formData: baseFormData, + }); + + const transformedProps = transformProps( + // @ts-ignore + chartProps as EchartsTimeseriesChartProps, + ); + + expect(transformedProps.echartOptions.xAxis).toHaveProperty('axisLabel'); + const xAxis = transformedProps.echartOptions.xAxis as any; + expect(xAxis.axisLabel).toHaveProperty('formatter'); + expect(xAxis.axisLabel.formatter).toBeUndefined(); + }); + + test.each(D3_TIME_FORMAT_OPTIONS.map(([id]) => id))( + 'should handle %s format', + format => { + const chartProps = new ChartProps({ + ...baseChartPropsConfig, + formData: { + ...baseFormData, + xAxisTimeFormat: format, + }, + }); + + const transformedProps = transformProps( + // @ts-ignore + chartProps as EchartsTimeseriesChartProps, + ); + + const xAxis = transformedProps.echartOptions.xAxis as any; + expect(xAxis.axisLabel).toHaveProperty('formatter'); + if (format === SMART_DATE_ID) { + expect(xAxis.axisLabel.formatter).toBeUndefined(); + } else { + expect(typeof xAxis.axisLabel.formatter).toBe('function'); + expect(xAxis.axisLabel.formatter.id).toBe(format); + } + }, + ); +}); + +describe('Scatter Chart X-axis Number Formatting', () => { + const baseFormData: EchartsTimeseriesFormData = { + ...DEFAULT_FORM_DATA, + colorScheme: 'supersetColors', + datasource: '1__table', + metric: ['column_1'], + x_axis: 'column_2', + groupby: [], + viz_type: 'echarts_timeseries_scatter', + seriesType: EchartsTimeseriesSeriesType.Scatter, + }; + + const timeseriesData = [ + { + data: [ + { column_1: 0.72099, column_2: 3.01699 }, + { column_1: 0.77954, column_2: 3.44802 }, + { column_1: 2.83434, column_2: 3.58095 }, + ], + colnames: ['column_1', 'column_2'], + coltypes: [GenericDataType.Numeric, GenericDataType.Numeric], + }, + ]; + + const baseChartPropsConfig = { + width: 800, + height: 600, + queriesData: timeseriesData, + theme: supersetTheme, + }; + + test('should use SMART_NUMBER as default xAxisNumberFormat', () => { + const chartProps = new ChartProps({ + ...baseChartPropsConfig, + formData: baseFormData, + }); + + const transformedProps = transformProps( + // @ts-ignore + chartProps as EchartsTimeseriesChartProps, + ); + + expect(transformedProps.echartOptions.xAxis).toHaveProperty('axisLabel'); + const xAxis = transformedProps.echartOptions.xAxis as any; + expect(xAxis.axisLabel).toHaveProperty('formatter'); + expect(typeof xAxis.axisLabel.formatter).toBe('function'); + expect(xAxis.axisLabel.formatter.id).toBe('SMART_NUMBER'); + }); + + test.each(D3_FORMAT_OPTIONS.map(([id]) => id))( + 'should handle %s format', + format => { + const chartProps = new ChartProps({ + ...baseChartPropsConfig, + formData: { + ...baseFormData, + xAxisNumberFormat: format, + }, + }); + + const transformedProps = transformProps( + // @ts-ignore + chartProps as EchartsTimeseriesChartProps, + ); + + expect(transformedProps.echartOptions.xAxis).toHaveProperty('axisLabel'); + const xAxis = transformedProps.echartOptions.xAxis as any; + expect(xAxis.axisLabel).toHaveProperty('formatter'); + expect(typeof xAxis.axisLabel.formatter).toBe('function'); + expect(xAxis.axisLabel.formatter.id).toBe(format); + }, + ); +}); Review Comment: Thanks for pointing this out! I’ve removed the duplicate test file under `spec/Timeseries/Scatter` and kept the original test under the `test/` directory. The PR has been updated accordingly. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
