EnxDev commented on code in PR #43938: URL: https://github.com/apache/superset/pull/43938#discussion_r4076942283
########## superset-frontend/packages/superset-ui-chart-controls/src/utils/headerGroups.ts: ########## @@ -0,0 +1,868 @@ +/** + * 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 { t } from '@apache-superset/core/translation'; +import { + ComparisonType, + ensureIsArray, + getColumnLabel, + getMetricLabel, + QueryFormColumn, + QueryFormMetric, + QueryMode, + SqlaFormData, +} from '@superset-ui/core'; +import { isEmpty, last } from 'lodash-es'; +import { + isPercentMetric, + isRegularMetric, + shouldSkipMetricColumn, +} from './metricColumnFilter'; + +export type HeaderGroupLabelAlign = 'left' | 'center' | 'right'; + +export type HeaderGroupPlacement = 'left' | 'right'; + +export type HeaderGroupConfig = { + id: string; + label: string; + columns: string[]; + labelAlign?: HeaderGroupLabelAlign; + placement?: HeaderGroupPlacement; + source?: 'time_compare'; + children?: HeaderGroupConfig[]; +}; + +export type HeaderGroupCell = { + key: string; + label: string; + colSpan: number; + rowSpan: number; + columnIndex: number; + labelAlign?: HeaderGroupLabelAlign; + isLastColumn: boolean; +}; + +export const TIME_COMPARE_MAIN_KEY = 'Main'; + +const TIME_COMPARE_SYMBOL_PREFIXES = ['#', '△', '%'] as const; + +type TimeCompareSlot = { + metric: string; + isMain: boolean; + prefix: string; +}; + +function getMainComparisonPrefixes(): string[] { + return [...new Set([t('Main'), TIME_COMPARE_MAIN_KEY])]; +} + +function isTimeCompareSymbolPrefix( + prefix: string, +): prefix is (typeof TIME_COMPARE_SYMBOL_PREFIXES)[number] { + return (TIME_COMPARE_SYMBOL_PREFIXES as readonly string[]).includes(prefix); +} + +function parseTimeComparisonSlot(column: string): TimeCompareSlot | null { + for (const prefix of TIME_COMPARE_SYMBOL_PREFIXES) { + if (column.startsWith(`${prefix} `)) { + return { metric: column.slice(prefix.length + 1), isMain: false, prefix }; + } + } + for (const prefix of getMainComparisonPrefixes()) { + if (column.startsWith(`${prefix} `)) { + return { + metric: column.slice(prefix.length + 1), + isMain: true, + prefix: TIME_COMPARE_MAIN_KEY, + }; + } + } + return null; +} + +function inferMainSlotFromSiblings( + column: string, + visibleKeys: string[], +): TimeCompareSlot | null { + const space = column.indexOf(' '); + if (space <= 0) { + return null; + } + const metric = column.slice(space + 1); + if ( + !metric || + !TIME_COMPARE_SYMBOL_PREFIXES.some(symbol => + visibleKeys.includes(`${symbol} ${metric}`), + ) + ) { + return null; + } + return { metric, isMain: true, prefix: TIME_COMPARE_MAIN_KEY }; +} + +function resolveTimeComparisonSlotKeys( + slot: TimeCompareSlot, + visibleKeys: string[], +): string[] { + if (!slot.isMain) { + const key = `${slot.prefix} ${slot.metric}`; + return visibleKeys.filter(item => item === key); + } + const wanted = new Set( + getMainComparisonPrefixes().map(prefix => `${prefix} ${slot.metric}`), + ); + const matches = visibleKeys.filter(key => wanted.has(key)); + if (matches.length > 0) { + return matches; + } + const alternatives = visibleKeys.filter(key => { + const space = key.indexOf(' '); + if (space <= 0) { + return false; + } + const prefix = key.slice(0, space); + return ( + !isTimeCompareSymbolPrefix(prefix) && key.slice(space + 1) === slot.metric + ); + }); + return alternatives.length === 1 ? alternatives : []; +} + +/** + * Locale-independent comparison column keys. `Main` is a stored slot id. + * Chart headers display `t('Main')` and may use a translated data key. + */ +export function getTimeComparisonColumnKeys(colname: string): string[] { + return [ + `${TIME_COMPARE_MAIN_KEY} ${colname}`, + `# ${colname}`, + `△ ${colname}`, + `% ${colname}`, + ]; +} + +export function toStoredTimeComparisonColumnKey( + column: string, + visibleKeys: string[] = [], +): string { + const slot = + parseTimeComparisonSlot(column) ?? + inferMainSlotFromSiblings(column, visibleKeys); + if (!slot) { + return column; + } + if ( + visibleKeys.length > 0 && + resolveTimeComparisonSlotKeys(slot, visibleKeys).length === 0 + ) { + return column; + } + return slot.isMain + ? `${TIME_COMPARE_MAIN_KEY} ${slot.metric}` + : `${slot.prefix} ${slot.metric}`; +} + +export function expandGroupColumnKey( + identifier: string, + visibleKeys: string[], +): string[] { + const visible = new Set(visibleKeys); + if (visible.has(identifier)) { + return [identifier]; + } + const slot = + parseTimeComparisonSlot(identifier) ?? + inferMainSlotFromSiblings(identifier, visibleKeys); + if (slot) { + return resolveTimeComparisonSlotKeys(slot, visibleKeys); + } + const candidates = [ + `%${identifier}`, + ...getTimeComparisonColumnKeys(identifier), + `${t('Main')} ${identifier}`, + ]; + const matchSet = new Set(candidates.filter(key => visible.has(key))); + return visibleKeys.filter(key => matchSet.has(key)); +} + +export function buildTimeComparisonHeaderGroups( + metricKeys: string[], + labelFor: (key: string) => string = key => key, +): HeaderGroupConfig[] { + return metricKeys.map(key => ({ + id: `time-compare-${key}`, + label: labelFor(key), + columns: getTimeComparisonColumnKeys(key), + labelAlign: 'left', + placement: 'right', + source: 'time_compare', + })); +} + +function isTimeComparisonSlotKey(column: string, prefix: string): boolean { + return column.startsWith(`${prefix} `); +} + +function remapTimeComparisonColumns( + columns: string[], + currentKeys: string[], +): string[] { + const currentSet = new Set(currentKeys); + if (columns.every(column => currentSet.has(column))) { + return columns; + } + const mainKey = currentKeys.find( + key => + !isTimeComparisonSlotKey(key, '#') && + !isTimeComparisonSlotKey(key, '△') && + !isTimeComparisonSlotKey(key, '%'), + ); + const hashKey = currentKeys.find(key => isTimeComparisonSlotKey(key, '#')); + const deltaKey = currentKeys.find(key => isTimeComparisonSlotKey(key, '△')); + const percentKey = currentKeys.find(key => isTimeComparisonSlotKey(key, '%')); + const remapped = columns + .map(column => { + if (currentSet.has(column)) { + return column; + } + if (isTimeComparisonSlotKey(column, '#')) { + return hashKey; + } + if (isTimeComparisonSlotKey(column, '△')) { + return deltaKey; + } + if (isTimeComparisonSlotKey(column, '%')) { + return percentKey; + } + return mainKey; + }) + .filter((column): column is string => Boolean(column)); + return remapped.length > 0 ? [...new Set(remapped)] : currentKeys; +} + +function refreshTimeComparisonGroup( + group: HeaderGroupConfig, + currentKeys: string[], + replaceColumns: boolean, +): HeaderGroupConfig { + return { + ...group, Review Comment: This spread keeps `label` from the stored group, and the caller only hands down `fresh.columns` — so an auto group's header text is frozen at whatever the metric's verbose name was when the group first got written to form_data. Rename the metric in the dataset and the Main/#/△/% header keeps showing the old name, and since these groups aren't editable there's no way to correct it. Could the caller pass `fresh.label` through too, with a test that changes a `verbose_map` entry and asserts the header follows? <!-- enxdev-human:ba72da1 --> ########## superset-frontend/src/explore/components/ControlPanelsContainer.tsx: ########## @@ -325,6 +329,70 @@ export const ControlPanelsContainer = (props: ControlPanelsContainerProps) => { const previousXAxis = usePrevious(x_axis); + const hasHeaderGroupsControl = Boolean(props.controls.header_groups); + const headerGroupsValue = props.controls.header_groups?.value; + const exploreDatasource = props.exploreState.datasource; + const exploreFormData = props.exploreState.form_data; + const exploreControls = props.exploreState.controls; + const timeCompareValue = exploreControls?.time_compare?.value; + const queryModeValue = exploreControls?.query_mode?.value; + const comparisonTypeValue = exploreControls?.comparison_type?.value; + const queryColnames = props.chart.queriesResponse?.[0]?.colnames; + + // HeaderGroupsControl is on the Customize tab and is not mounted until that + // tab is opened. Sync time-comparison auto-groups into form_data here so + // enabling Time Comparison updates the chart without visiting Customize. + useEffect(() => { Review Comment: This is table-only logic living in the container every viz type renders through, and it's the third copy of the `time_compare` + aggregate + `Values` condition — the two plugins' `transformProps` hold the others. The `header_groups` guard keeps it cheap so this is a design question rather than a bug, but is there a reason it can't sit in the control's `mapStateToProps`, which already calls `getHeaderGroupsControlProps`? <!-- enxdev-human:ba72da1 --> ########## superset-frontend/src/explore/components/controls/HeaderGroupsControl/HeaderGroupEditor.tsx: ########## @@ -0,0 +1,535 @@ +/** + * 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 { useState, type ReactNode } from 'react'; +import { t } from '@apache-superset/core/translation'; +import { css, styled } from '@apache-superset/core/theme'; +import { Button, Input, Popover, Select } from '@superset-ui/core/components'; +import { Radio } from '@superset-ui/core/components/Radio'; +import { Icons } from '@superset-ui/core/components/Icons'; +import { + HeaderGroupColumnOption, + HeaderGroupConfig, + HeaderGroupLabelAlign, + HeaderGroupPlacement, + MAX_HEADER_GROUP_DEPTH, +} from './types'; +import { + canSaveHeaderGroup, + createHeaderGroup, + normalizeSelectedColumns, + moveHeaderGroupAt, + removeHeaderGroupAt, + updateHeaderGroupAt, +} from './utils'; + +export type HeaderGroupEditorProps = { + group?: HeaderGroupConfig; + path: number[]; + columnOptions: HeaderGroupColumnOption[]; + usedColumns: Set<string>; + onChange?: (path: number[], next: HeaderGroupConfig) => void; + onAddChild?: (path: number[]) => void; + onRemove?: (path: number[]) => void; + onSave?: (group: HeaderGroupConfig) => void; + mode?: 'add' | 'edit'; + children?: ReactNode; +}; + +const FormStack = styled.div` + ${({ theme }) => css` + display: flex; + flex-direction: column; + gap: ${theme.sizeUnit * 3}px; + min-width: ${theme.sizeUnit * 92}px; + `} +`; + +const FieldRow = styled.div` + ${({ theme }) => css` + display: flex; + flex-direction: column; + gap: ${theme.sizeUnit}px; + `} +`; + +const InlineFields = styled.div` + ${({ theme }) => css` + display: flex; + flex-wrap: nowrap; + align-items: flex-start; + gap: ${theme.sizeUnit * 3}px; + + & > *:first-of-type { + flex: 1.4 1 auto; + } + + & > *:last-of-type { + flex: 1 1 auto; + } + `} +`; + +const CompactRadioGroup = styled.div` + ${({ theme }) => css` + .ant-radio-group { + display: flex; + flex-wrap: nowrap; + width: 100%; + } + + .ant-radio-button-wrapper { + flex: 1 1 auto; + height: ${theme.sizeUnit * 6}px; + line-height: ${theme.sizeUnit * 6 - 2}px; + padding-inline: ${theme.sizeUnit}px; + font-size: ${theme.fontSizeSM}px; + text-align: center; + } + `} +`; + +const FieldLabel = styled.span` + ${({ theme }) => css` + color: ${theme.colorTextSecondary}; + font-size: ${theme.fontSizeSM}px; + `} +`; + +const NestedCard = styled.div` + ${({ theme }) => css` + display: flex; + flex-direction: column; + gap: ${theme.sizeUnit * 2}px; + padding: ${theme.sizeUnit * 2}px; + border: 1px solid ${theme.colorBorder}; + border-radius: ${theme.borderRadius}px; + `} +`; + +const NestedHeader = styled.div` + ${({ theme }) => css` + display: flex; + align-items: center; + justify-content: space-between; + gap: ${theme.sizeUnit}px; + font-weight: ${theme.fontWeightStrong}; + `} +`; + +const NestedHeaderActions = styled.div` + display: inline-flex; + align-items: center; +`; + +const PopoverTitleRow = styled.div` + display: flex; + align-items: center; + justify-content: space-between; + gap: ${({ theme }) => theme.sizeUnit}px; +`; + +const ApplyRow = styled.div` + display: flex; + justify-content: flex-end; +`; + +function SettingsToggle({ + collapsed, + onToggle, +}: { + collapsed: boolean; + onToggle: () => void; +}) { + return ( + <Button + buttonStyle="link" + buttonSize="small" + aria-label={collapsed ? t('Expand settings') : t('Collapse settings')} + onClick={event => { + event.preventDefault(); + event.stopPropagation(); + onToggle(); + }} + icon={ + collapsed ? ( + <Icons.DownOutlined iconSize="s" /> + ) : ( + <Icons.UpOutlined iconSize="s" /> + ) + } + /> + ); +} + +const LABEL_ALIGN_OPTIONS: { label: string; value: HeaderGroupLabelAlign }[] = [ + { label: t('Left'), value: 'left' }, + { label: t('Center'), value: 'center' }, + { label: t('Right'), value: 'right' }, +]; + +const PLACEMENT_OPTIONS: { label: string; value: HeaderGroupPlacement }[] = [ + { label: t('Left'), value: 'left' }, + { label: t('Right'), value: 'right' }, +]; + +export function getGroupTitle(path: number[]): string { + const numberedPath = path.map(index => index + 1).join('.'); + return path.length === 1 + ? t('Group %s', numberedPath) + : t('Subgroup %s', numberedPath); +} + +function HeaderGroupForm({ + group, + path, + columnOptions, + usedColumns, + onChange, + onAddChild, + onRemove, + onMove, + onApply, + showRemove = false, + siblingCount = 1, + settingsCollapsed: settingsCollapsedProp, + onToggleSettings, +}: { + group: HeaderGroupConfig; + path: number[]; + columnOptions: HeaderGroupColumnOption[]; + usedColumns: Set<string>; + onChange: (path: number[], next: HeaderGroupConfig) => void; + onAddChild: (path: number[]) => void; + onRemove: (path: number[]) => void; + onMove: (path: number[], toIndex: number) => void; + onApply?: () => void; + showRemove?: boolean; + siblingCount?: number; + settingsCollapsed?: boolean; + onToggleSettings?: () => void; +}) { + const availableOptions = columnOptions.filter( + option => + (group.columns ?? []).includes(option.value) || + !usedColumns.has(option.value), + ); + const [localCollapsed, setLocalCollapsed] = useState(false); + const canSave = canSaveHeaderGroup(group); + const isTimeCompareGroup = group.source === 'time_compare'; + const isTopLevel = path.length === 1; + const hasSubgroups = (group.children ?? []).length > 0; + const canCollapse = showRemove || hasSubgroups; + const isCollapseControlled = settingsCollapsedProp !== undefined; + const settingsCollapsed = isCollapseControlled + ? Boolean(settingsCollapsedProp) + : localCollapsed; + const showSettings = !canCollapse || !settingsCollapsed; + const toggleSettings = + onToggleSettings ?? (() => setLocalCollapsed(collapsed => !collapsed)); + + return ( + <FormStack data-test="header-group-editor"> + {showRemove && ( + <NestedHeader> + <span>{getGroupTitle(path)}</span> + <NestedHeaderActions> + {canCollapse && ( + <SettingsToggle + collapsed={settingsCollapsed} + onToggle={toggleSettings} + /> + )} + <Button + buttonStyle="link" + buttonSize="small" + aria-label={t('Move group left')} + disabled={path[path.length - 1] === 0} + onClick={() => onMove(path, path[path.length - 1] - 1)} + icon={<Icons.LeftOutlined iconSize="s" />} + /> + <Button + buttonStyle="link" + buttonSize="small" + aria-label={t('Move group right')} + disabled={path[path.length - 1] >= siblingCount - 1} + onClick={() => onMove(path, path[path.length - 1] + 1)} + icon={<Icons.RightOutlined iconSize="s" />} + /> + <Button + buttonStyle="link" + buttonSize="small" + aria-label={t('Remove group')} + onClick={() => onRemove(path)} + icon={<Icons.DeleteOutlined iconSize="s" />} + /> + </NestedHeaderActions> + </NestedHeader> + )} + {showSettings && ( + <> + <FieldRow> + <FieldLabel>{t('Name')}</FieldLabel> + <Input + aria-label={t('Group name')} + value={group.label} + placeholder={t('Enter group name')} + onChange={event => + onChange(path, { ...group, label: event.target.value }) + } + /> + </FieldRow> + <FieldRow> + <FieldLabel>{t('Columns')}</FieldLabel> + <Select + ariaLabel={t('Group columns')} + mode="multiple" + allowClear={!isTimeCompareGroup} + showSearch={!isTimeCompareGroup} + disabled={isTimeCompareGroup} + value={group.columns ?? []} + options={availableOptions} + placeholder={t('Select columns')} + maxTagCount={3} + onChange={columns => { + onChange(path, { + ...group, + columns: normalizeSelectedColumns(columns), + }); + }} + /> + </FieldRow> + <InlineFields> + <FieldRow> + <FieldLabel>{t('Label position')}</FieldLabel> + <CompactRadioGroup> + <Radio.Group + size="small" + optionType="button" + value={group.labelAlign ?? 'center'} + onChange={event => + onChange(path, { + ...group, + labelAlign: event.target.value as HeaderGroupLabelAlign, + }) + } + > + {LABEL_ALIGN_OPTIONS.map(option => ( + <Radio.Button key={option.value} value={option.value}> + {option.label} + </Radio.Button> + ))} + </Radio.Group> + </CompactRadioGroup> + </FieldRow> + <FieldRow> + <FieldLabel> + {isTopLevel ? t('Table side') : t('Position')} + </FieldLabel> + <CompactRadioGroup> + <Radio.Group + size="small" + optionType="button" + value={group.placement ?? 'right'} + onChange={event => + onChange(path, { + ...group, + placement: event.target.value as HeaderGroupPlacement, + }) + } + > + {PLACEMENT_OPTIONS.map(option => ( + <Radio.Button key={option.value} value={option.value}> + {option.label} + </Radio.Button> + ))} + </Radio.Group> + </CompactRadioGroup> + </FieldRow> + </InlineFields> + </> + )} + {(group.children ?? []).length > 0 && ( + <FieldRow> + {(group.children ?? []).map((child, index) => ( + <NestedCard key={child.id}> + <HeaderGroupForm + group={child} + path={[...path, index]} + columnOptions={columnOptions} + usedColumns={usedColumns} + onChange={onChange} + onAddChild={onAddChild} + onRemove={onRemove} + onMove={onMove} + showRemove + siblingCount={(group.children ?? []).length} + /> + </NestedCard> + ))} + </FieldRow> + )} + {path.length < MAX_HEADER_GROUP_DEPTH && !isTimeCompareGroup && ( + <Button + buttonStyle="dashed" + buttonSize="small" + disabled={!canSave} + icon={<Icons.PlusOutlined iconSize="s" />} + onClick={() => { + if (canSave) { + onAddChild(path); + } + }} + > + {t('Add subgroup')} + </Button> + )} + {onApply && ( + <ApplyRow> + <Button buttonStyle="primary" disabled={!canSave} onClick={onApply}> + {t('Apply')} + </Button> + </ApplyRow> + )} + </FormStack> + ); +} + +export default function HeaderGroupEditor({ + children, + group, + path, + columnOptions, + usedColumns, + onChange, + onSave, + mode = 'edit', +}: HeaderGroupEditorProps) { + const [visible, setVisible] = useState(false); + const [settingsCollapsed, setSettingsCollapsed] = useState(false); + const [draft, setDraft] = useState<HeaderGroupConfig>( + group ?? createHeaderGroup(), + ); + + const isAddMode = mode === 'add'; + const currentGroup = draft; + const canCollapseRoot = (currentGroup.children ?? []).length > 0; + + const toDraftPath = (nextPath: number[]) => + isAddMode ? nextPath : [0, ...nextPath.slice(path.length)]; + + const handleOpenChange = (open: boolean) => { + setVisible(open); + if (open) { + setDraft( + isAddMode ? createHeaderGroup() : (group ?? createHeaderGroup()), + ); + setSettingsCollapsed(false); + } + }; + + const persistDraftIfValid = (nextDraft: HeaderGroupConfig) => { + if (!isAddMode && canSaveHeaderGroup(nextDraft)) { Review Comment: Edit mode has no Apply button, so this guard is the only thing writing to form_data — clear the group name and nothing persists, the popover closes, and reopening silently restores the old name. The user gets no signal their edit was discarded. Could we surface the validation the way add mode does, so at least the Name field shows an error instead of quietly reverting? <!-- enxdev-human:ba72da1 --> -- 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]
