Skip to content
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.

Sign up for GitHub

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

feat: Implement breadcrumbs in Drill By modal #23664

Merged
merged 5 commits into from
Apr 13, 2023
Merged

feat: Implement breadcrumbs in Drill By modal #23664

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
61c2be2
feat: Implement breadcrumbs in drill by modal
kgabryje Apr 7, 2023
52d7f4b
Remove console log
kgabryje Apr 12, 2023
b226125
Refactor currentColumn logic
kgabryje Apr 13, 2023
6910d27
Add ut
kgabryje Apr 13, 2023
44c8073
Remove console log
kgabryje Apr 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions superset-frontend/src/components/Chart/ChartContextMenu/ChartContextMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ const ChartContextMenu = (
<DrillByMenuItems
filters={filters?.drillBy?.filters}
groupbyFieldName={filters?.drillBy?.groupbyFieldName}
adhocFilterFieldName={filters?.drillBy?.adhocFilterFieldName}
onSelection={onSelection}
formData={formData}
contextMenuY={clientY}
Expand Down
30 changes: 20 additions & 10 deletions superset-frontend/src/components/Chart/DrillBy/DrillByMenuItems.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ export interface DrillByMenuItemsProps {
contextMenuY?: number;
submenuIndex?: number;
groupbyFieldName?: string;
adhocFilterFieldName?: string;
onSelection?: (...args: any) => void;
onClick?: (event: MouseEvent) => void;
openNewModal?: boolean;
Expand All @@ -68,6 +69,7 @@ export interface DrillByMenuItemsProps {
export const DrillByMenuItems = ({
filters,
groupbyFieldName,
adhocFilterFieldName,
formData,
contextMenuY = 0,
submenuIndex = 0,
Expand Down Expand Up @@ -130,6 +132,11 @@ export const DrillByMenuItems = ({
column =>
!ensureIsArray(formData[groupbyFieldName]).includes(
column.column_name,
) &&
column.column_name !== formData.x_axis &&
ensureIsArray(excludedColumns)?.every(
excludedCol =>
excludedCol.column_name !== column.column_name,
),
),
);
Expand All @@ -138,7 +145,13 @@ export const DrillByMenuItems = ({
supersetGetCache.delete(`/api/v1/dataset/${datasetId}`);
});
}
}, [formData, groupbyFieldName, handlesDimensionContextMenu, hasDrillBy]);
}, [
excludedColumns,
formData,
groupbyFieldName,
handlesDimensionContextMenu,
hasDrillBy,
]);

const handleInput = useCallback((e: ChangeEvent<HTMLInputElement>) => {
e.stopPropagation();
Expand All @@ -148,16 +161,12 @@ export const DrillByMenuItems = ({

const filteredColumns = useMemo(
() =>
columns.filter(
column =>
(column.verbose_name || column.column_name)
.toLowerCase()
.includes(searchInput.toLowerCase()) &&
!ensureIsArray(excludedColumns)?.some(
col => col.column_name === column.column_name,
),
columns.filter(column =>
(column.verbose_name || column.column_name)
.toLowerCase()
.includes(searchInput.toLowerCase()),
),
[columns, excludedColumns, searchInput],
[columns, searchInput],
);

const submenuYOffset = useMemo(
Expand Down Expand Up @@ -260,6 +269,7 @@ export const DrillByMenuItems = ({
filters={filters}
formData={formData}
groupbyFieldName={groupbyFieldName}
adhocFilterFieldName={adhocFilterFieldName}
onHideModal={closeModal}
dataset={dataset!}
/>
Expand Down
172 changes: 112 additions & 60 deletions superset-frontend/src/components/Chart/DrillBy/DrillByModal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ import {
QueryData,
css,
ensureIsArray,
isDefined,
t,
useTheme,
} from '@superset-ui/core';
Expand All @@ -39,7 +40,6 @@ import { Link } from 'react-router-dom';
import Modal from 'src/components/Modal';
import Loading from 'src/components/Loading';
import Button from 'src/components/Button';
import { Radio } from 'src/components/Radio';
import { RootState } from 'src/dashboard/types';
import { DashboardPageIdContext } from 'src/dashboard/containers/DashboardPage';
import { postFormData } from 'src/explore/exploreUtils/formData';
Expand All @@ -52,6 +52,11 @@ import DrillByChart from './DrillByChart';
import { ContextMenuItem } from '../ChartContextMenu/ChartContextMenu';
import { useContextMenu } from '../ChartContextMenu/useContextMenu';
import { getChartDataRequest } from '../chartAction';
import { useDisplayModeToggle } from './useDisplayModeToggle';
import {
DrillByBreadcrumb,
useDrillByBreadcrumbs,
} from './useDrillByBreadcrumbs';

const DATA_SIZE = 15;
interface ModalFooterProps {
Expand Down Expand Up @@ -107,6 +112,7 @@ interface DrillByModalProps {
filters?: BinaryQueryObjectFilterClause[];
formData: BaseFormData & { [key: string]: any };
groupbyFieldName?: string;
adhocFilterFieldName?: string;
onHideModal: () => void;
}

Expand All @@ -116,36 +122,87 @@ export default function DrillByModal({
filters,
formData,
groupbyFieldName = 'groupby',
adhocFilterFieldName = 'adhoc_filters',
onHideModal,
}: DrillByModalProps) {
const theme = useTheme();
const [chartDataResult, setChartDataResult] = useState<QueryData[]>();
const [drillByDisplayMode, setDrillByDisplayMode] = useState<DrillByType>(
DrillByType.Chart,

const initialGroupbyColumns = useMemo(
() =>
ensureIsArray(formData[groupbyFieldName])
.map(colName =>
dataset.columns?.find(col => col.column_name === colName),
)
.filter(isDefined),
[dataset.columns, formData, groupbyFieldName],
);

const { displayModeToggle, drillByDisplayMode } = useDisplayModeToggle();
const [chartDataResult, setChartDataResult] = useState<QueryData[]>();
const [datasourceId] = useMemo(
() => formData.datasource.split('__'),
[formData.datasource],
);

const [currentColumn, setCurrentColumn] = useState(column);
// currentColumn can be an array when the original chart is grouped by multiple
// columns and user navigates back to the original chart by clicking the first
// breadcrumb
const [currentColumn, setCurrentColumn] = useState<
Column | Column[] | undefined
>(column);
Copy link
Member

@villebro villebro Apr 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a thought - would it potentially simplify the code, if we'd do something like this (we'd also do something similar in those other similar code blocks):

  const [currentColumns, setCurrentColumns] = useState(ensureIsArray(column));

Then we wouldn't have to jump between currentColumn and currentColumns or worry about it potentially being undefined.

const [currentFormData, setCurrentFormData] = useState(formData);
const [currentFilters, setCurrentFilters] = useState(filters);
const [usedGroupbyColumns, setUsedGroupbyColumns] = useState([
...ensureIsArray(formData[groupbyFieldName]).map(colName =>
dataset.columns?.find(col => col.column_name === colName),
),
column,
const [currentFilters, setCurrentFilters] = useState(filters || []);
const [usedGroupbyColumns, setUsedGroupbyColumns] = useState<Column[]>(
[...initialGroupbyColumns, column].filter(isDefined),
);
const [breadcrumbsData, setBreadcrumbsData] = useState<DrillByBreadcrumb[]>([
{ groupby: initialGroupbyColumns, filters },
{ groupby: column || [] },
]);

const updatedFormData = useMemo(() => {
let updatedFormData = { ...currentFormData };
const getNewGroupby = useCallback(
(groupbyCol: Column | Column[]) => {
const columnNames = ensureIsArray(groupbyCol).map(col => col.column_name);
return Array.isArray(formData[groupbyFieldName])
? columnNames
: columnNames[0];
},
[formData, groupbyFieldName],
);

const onBreadcrumbClick = useCallback(
(breadcrumb: DrillByBreadcrumb, index: number) => {
setCurrentColumn(breadcrumb.groupby);
setCurrentFilters(filters => filters.slice(0, index));
setBreadcrumbsData(prevBreadcrumbs => {
const newBreadcrumbs = prevBreadcrumbs.slice(0, index + 1);
delete newBreadcrumbs[newBreadcrumbs.length - 1].filters;
return newBreadcrumbs;
});
setUsedGroupbyColumns(prevUsedGroupbyColumns =>
prevUsedGroupbyColumns.slice(0, index),
);
setCurrentFormData(prevFormData => ({
...prevFormData,
[groupbyFieldName]: getNewGroupby(breadcrumb.groupby),
[adhocFilterFieldName]: [
...formData[adhocFilterFieldName],
...prevFormData[adhocFilterFieldName].slice(
formData[adhocFilterFieldName].length,
formData[adhocFilterFieldName].length + index,
),
],
}));
},
[adhocFilterFieldName, formData, getNewGroupby, groupbyFieldName],
);

const breadcrumbs = useDrillByBreadcrumbs(breadcrumbsData, onBreadcrumbClick);

const drilledFormData = useMemo(() => {
let updatedFormData = { ...formData };
if (currentColumn) {
updatedFormData[groupbyFieldName] = Array.isArray(
currentFormData[groupbyFieldName],
)
? [currentColumn.column_name]
: currentColumn.column_name;
updatedFormData[groupbyFieldName] = getNewGroupby(currentColumn);
}

if (currentFilters) {
Expand All @@ -154,8 +211,8 @@ export default function DrillByModal({
);
updatedFormData = {
...updatedFormData,
adhoc_filters: [
...ensureIsArray(currentFormData.adhoc_filters),
[adhocFilterFieldName]: [
...ensureIsArray(formData[adhocFilterFieldName]),
...adhocFilters,
],
};
Expand All @@ -164,21 +221,41 @@ export default function DrillByModal({
delete updatedFormData.slice_name;
delete updatedFormData.dashboards;
return updatedFormData;
}, [currentColumn, currentFormData, currentFilters, groupbyFieldName]);
}, [
formData,
currentColumn,
currentFilters,
groupbyFieldName,
getNewGroupby,
adhocFilterFieldName,
]);

useEffect(() => {
setUsedGroupbyColumns(cols =>
cols.includes(currentColumn) ? cols : [...cols, currentColumn],
);
setUsedGroupbyColumns(usedCols => {
const currentColumns = ensureIsArray(currentColumn);
return !currentColumn ||
usedCols.some(usedCol =>
currentColumns.some(
currentCol => currentCol?.column_name === usedCol.column_name,
),
)
? usedCols
: [...usedCols, ...currentColumns];
});
}, [currentColumn]);

const onSelection = useCallback(
(newColumn: Column, filters: BinaryQueryObjectFilterClause[]) => {
setCurrentColumn(newColumn);
setCurrentFormData(updatedFormData);
setCurrentFilters(filters);
setCurrentFormData(drilledFormData);
setCurrentFilters(prevFilters => [...prevFilters, ...filters]);
setBreadcrumbsData(prevBreadcrumbs => {
const newBreadcrumbs = [...prevBreadcrumbs, { groupby: newColumn }];
newBreadcrumbs[newBreadcrumbs.length - 2].filters = filters;
return newBreadcrumbs;
});
},
[updatedFormData],
[drilledFormData],
);

const additionalConfig = useMemo(
Expand Down Expand Up @@ -206,14 +283,15 @@ export default function DrillByModal({
});

useEffect(() => {
if (updatedFormData) {
if (drilledFormData) {
setChartDataResult(undefined);
getChartDataRequest({
formData: updatedFormData,
formData: drilledFormData,
}).then(({ json }) => {
setChartDataResult(json.result);
});
}
}, [updatedFormData]);
}, [drilledFormData]);
const { metadataBar } = useDatasetMetadataBar({ dataset });

return (
Expand All @@ -226,7 +304,7 @@ export default function DrillByModal({
show
onHide={onHideModal ?? (() => null)}
title={t('Drill by: %s', chartName)}
footer={<ModalFooter formData={updatedFormData} />}
footer={<ModalFooter formData={drilledFormData} />}
responsive
resizable
resizableConfig={{
Expand All @@ -249,38 +327,12 @@ export default function DrillByModal({
`}
>
{metadataBar}
<div
css={css`
margin-bottom: ${theme.gridUnit * 6}px;
.ant-radio-button-wrapper-checked:not(.ant-radio-button-wrapper-disabled):focus-within {
box-shadow: none;
}
`}
>
<Radio.Group
onChange={({ target: { value } }) => {
setDrillByDisplayMode(value);
}}
defaultValue={DrillByType.Chart}
>
<Radio.Button
value={DrillByType.Chart}
data-test="drill-by-chart-radio"
>
{t('Chart')}
</Radio.Button>
<Radio.Button
value={DrillByType.Table}
data-test="drill-by-table-radio"
>
{t('Table')}
</Radio.Button>
</Radio.Group>
</div>
{breadcrumbs}
{displayModeToggle}
{!chartDataResult && <Loading />}
{drillByDisplayMode === DrillByType.Chart && chartDataResult && (
<DrillByChart
formData={updatedFormData}
formData={drilledFormData}
result={chartDataResult}
onContextMenu={onContextMenu}
inContextMenu={inContextMenu}
Expand Down
Loading