SBIN2010 commented on code in PR #45680: URL: https://github.com/apache/superset/pull/45680#discussion_r4393899862
########## superset-frontend/plugins/plugin-chart-echarts/test/Waterfall/EchartsWaterfall.test.tsx: ########## @@ -0,0 +1,186 @@ +/** + * 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 { supersetTheme } from '@apache-superset/core/theme'; +import { ChartProps, SqlaFormData } from '@superset-ui/core'; +import { render } from '@testing-library/react'; +import EchartsWaterfall from '../../src/Waterfall/EchartsWaterfall'; +import transformProps from '../../src/Waterfall/transformProps'; +import { EchartsWaterfallChartProps } from '../../src/Waterfall/types'; +import Echart from '../../src/components/Echart'; +import { EventHandlers } from '../../src/types'; + +jest.mock('../../src/components/Echart', () => ({ + __esModule: true, + default: jest.fn(() => null), +})); + +const mockedEchart = jest.mocked(Echart); + +const rows = [ + { year: '2019', name: 'Sylvester', sum: 10 }, + { year: '2019', name: 'Arnold', sum: 3 }, + { year: '2020', name: 'Sylvester', sum: -10 }, + { year: '2020', name: 'Arnold', sum: 5 }, +]; + +const formData = { + colorScheme: 'bnbColors', + datasource: '3__table', + granularity_sqla: 'ds', + metric: 'sum', + x_axis: 'year', + groupby: 'name', + showTotal: true, +}; + +function renderChart( + overrides: Partial<ChartProps> & { emitCrossFilters?: boolean } = {}, +) { + const setDataMask = jest.fn(); + const onContextMenu = jest.fn(); + const chartProps = new ChartProps({ + formData: formData as unknown as SqlaFormData, + width: 800, + height: 600, + queriesData: [{ data: rows }], + hooks: { setDataMask, onContextMenu }, + theme: supersetTheme, + ...overrides, + }); + const props = transformProps( + chartProps as unknown as EchartsWaterfallChartProps, + ); + render(<EchartsWaterfall {...props} />); + const lastCall = mockedEchart.mock.calls[mockedEchart.mock.calls.length - 1]; + const { eventHandlers } = lastCall[0] as { eventHandlers: EventHandlers }; + return { eventHandlers, setDataMask, onContextMenu }; +} + +beforeEach(() => { + mockedEchart.mockClear(); +}); + +function pointerEvent(dataIndex: number) { + return { + dataIndex, + event: { + stop: jest.fn(), + event: { clientX: 12, clientY: 24 } as PointerEvent, + }, + }; +} + +test('clicking a breakdown bar filters the period and the breakdown', () => { + const { eventHandlers, setDataMask } = renderChart({ + emitCrossFilters: true, + }); + eventHandlers.click(pointerEvent(0)); + expect(setDataMask).toHaveBeenCalledWith( + expect.objectContaining({ + extraFormData: { + filters: [ + { col: 'year', op: 'IN', val: ['2019'] }, + { col: 'name', op: 'IN', val: ['Sylvester'] }, + ], + }, + }), + ); +}); + +test('clicking a period total filters the period only', () => { + const { eventHandlers, setDataMask } = renderChart({ + emitCrossFilters: true, + }); + eventHandlers.click(pointerEvent(2)); + expect(setDataMask).toHaveBeenCalledWith( + expect.objectContaining({ + extraFormData: { + filters: [{ col: 'year', op: 'IN', val: ['2019'] }], + }, + }), + ); +}); + +test('clicking the same bar again clears the filter', () => { + const { eventHandlers, setDataMask } = renderChart({ + emitCrossFilters: true, + filterState: { selectedValues: [JSON.stringify(['2019', 'Sylvester'])] }, + }); + eventHandlers.click(pointerEvent(0)); + expect(setDataMask).toHaveBeenCalledWith( + expect.objectContaining({ + extraFormData: { filters: [] }, + }), + ); +}); + +test('does not emit a filter when cross-filtering is disabled', () => { + const { eventHandlers, setDataMask } = renderChart({ + emitCrossFilters: false, + }); + eventHandlers.click(pointerEvent(0)); + expect(setDataMask).not.toHaveBeenCalled(); +}); + +test('clicking the grand total does not change the current filter', () => { + const { eventHandlers, setDataMask } = renderChart({ + emitCrossFilters: true, + formData: { ...formData, groupby: undefined } as unknown as SqlaFormData, + }); + eventHandlers.click(pointerEvent(2)); + expect(setDataMask).not.toHaveBeenCalled(); +}); + +test('a context menu carries the drill filters for the clicked bar', () => { + const { eventHandlers, onContextMenu } = renderChart({ + emitCrossFilters: true, + }); + const event = pointerEvent(0); + eventHandlers.contextmenu(event); + expect(event.event.stop).toHaveBeenCalled(); + expect(onContextMenu).toHaveBeenCalledWith( + 12, + 24, + expect.objectContaining({ Review Comment: Good catch; the test now checks `crossFilter.dataMask` and `isCurrentValueSelected` for both unselected columns and columns that are already selected—where a subsequent click removes the filter. -- 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]
