Copilot commented on code in PR #45908: URL: https://github.com/apache/superset/pull/45908#discussion_r4428581709
########## superset-frontend/plugins/plugin-chart-echarts/src/Sankey/crossFilter.ts: ########## @@ -0,0 +1,358 @@ +/** + * 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 { GenericDataType } from '@apache-superset/core/common'; +import { + DataRecordValue, + getColumnLabel, + getTimeFormatter, + QueryFormColumn, + QueryObjectFilterClause, +} from '@superset-ui/core'; +import { NULL_STRING } from '../constants'; +import { formatSeriesName } from '../utils/series'; + +/** + * Display text for an empty string. Matches `optionLabel` in + * `src/utils/common.ts`; this plugin cannot import that module. + */ +export const EMPTY_STRING = '<empty string>'; + +export type SankeyFilterColumn = 'source' | 'target'; + +/** Fields ECharts keeps on a node and returns from a click. */ +export type SankeyNodeDatum = { + name: string; + filterColumn: SankeyFilterColumn; + rawValue: DataRecordValue; +}; + +/** Fields ECharts keeps on a link and returns from a click. */ +export type SankeyLinkDatum = { + source: string; + target: string; + value: number; + sourceValue: DataRecordValue; + targetValue: DataRecordValue; +}; + +type NamedLink = { + source: string; + target: string; +}; + +type ParsedSelection = + | { kind: 'node'; column: SankeyFilterColumn; name: string } + | { kind: 'link'; source: string; target: string }; + +/** + * Label used as the ECharts node name. `null` and `''` stay distinct so a + * click can emit `IS NULL` or `IN ['']`. + */ +export function sankeyNodeName(value: DataRecordValue): string { + if (value == null) { + return NULL_STRING; + } + if (typeof value === 'bigint') { + return value.toString(); + } + const text = String(value); + return text === '' ? EMPTY_STRING : text; Review Comment: Node names and selection keys use display text, so null collides with the literal '<NULL>', an empty string with '<empty string>', and 42 with 42n. These collisions merge distinct nodes, can turn a valid flow into a self-link, and can make clicking a different link clear the previous filter instead of replacing it. Use typed, JSON-safe identities consistently for graph nodes, link endpoints, and selections, keeping display labels separate. ########## superset-frontend/plugins/plugin-chart-echarts/src/Sankey/crossFilter.ts: ########## @@ -0,0 +1,358 @@ +/** + * 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 { GenericDataType } from '@apache-superset/core/common'; +import { + DataRecordValue, + getColumnLabel, + getTimeFormatter, + QueryFormColumn, + QueryObjectFilterClause, +} from '@superset-ui/core'; +import { NULL_STRING } from '../constants'; +import { formatSeriesName } from '../utils/series'; + +/** + * Display text for an empty string. Matches `optionLabel` in + * `src/utils/common.ts`; this plugin cannot import that module. + */ +export const EMPTY_STRING = '<empty string>'; + +export type SankeyFilterColumn = 'source' | 'target'; + +/** Fields ECharts keeps on a node and returns from a click. */ +export type SankeyNodeDatum = { + name: string; + filterColumn: SankeyFilterColumn; + rawValue: DataRecordValue; +}; + +/** Fields ECharts keeps on a link and returns from a click. */ +export type SankeyLinkDatum = { + source: string; + target: string; + value: number; + sourceValue: DataRecordValue; + targetValue: DataRecordValue; +}; + +type NamedLink = { + source: string; + target: string; +}; + +type ParsedSelection = + | { kind: 'node'; column: SankeyFilterColumn; name: string } + | { kind: 'link'; source: string; target: string }; + +/** + * Label used as the ECharts node name. `null` and `''` stay distinct so a + * click can emit `IS NULL` or `IN ['']`. + */ +export function sankeyNodeName(value: DataRecordValue): string { + if (value == null) { + return NULL_STRING; + } + if (typeof value === 'bigint') { + return value.toString(); + } + const text = String(value); + return text === '' ? EMPTY_STRING : text; +} + +export function sankeyNodeKey( + column: SankeyFilterColumn, + name: string, +): string { + return JSON.stringify(['node', column, name]); +} + +export function sankeyLinkKey(source: string, target: string): string { + return JSON.stringify(['link', source, target]); +} + +export function isSankeyLinkDatum(data: unknown): data is SankeyLinkDatum { + return ( + typeof data === 'object' && + data !== null && + 'sourceValue' in data && + 'targetValue' in data + ); +} + +export function isSankeyNodeDatum(data: unknown): data is SankeyNodeDatum { + return ( + typeof data === 'object' && + data !== null && + 'filterColumn' in data && + 'rawValue' in data && + !isSankeyLinkDatum(data) + ); +} + +export function getSelectedSankeyKeys(selectedValues: unknown): string[] { + if (!selectedValues) { + return []; + } + if (Array.isArray(selectedValues)) { + return selectedValues.map(value => String(value)); + } + if (typeof selectedValues === 'object') { + return Object.values(selectedValues as Record<string, unknown>).map(value => + String(value), + ); + } + return []; +} + +function parseSelection(key: string): ParsedSelection | undefined { + try { + const parsed: unknown = JSON.parse(key); + if (!Array.isArray(parsed)) { + return undefined; + } + if ( + parsed[0] === 'node' && + (parsed[1] === 'source' || parsed[1] === 'target') && + typeof parsed[2] === 'string' + ) { + return { kind: 'node', column: parsed[1], name: parsed[2] }; + } + if ( + parsed[0] === 'link' && + typeof parsed[1] === 'string' && + typeof parsed[2] === 'string' + ) { + return { kind: 'link', source: parsed[1], target: parsed[2] }; + } + return undefined; + } catch { + return undefined; + } +} + +function nodeStaysBright( + name: string, + selection: ParsedSelection, + links: NamedLink[], +): boolean { + if (selection.kind === 'link') { + return name === selection.source || name === selection.target; + } + if (name === selection.name) { + return true; + } + // Keep the other end of each matching flow readable. + return links.some(link => + selection.column === 'source' + ? link.source === selection.name && link.target === name + : link.target === selection.name && link.source === name, + ); Review Comment: For a node selection, `transformProps` scans the links array for each other node, adding O(nodes × links) synchronous work to each update. A graph with 10,000 disjoint links can require roughly 200 million link checks per click. Precompute the selected node and matching links' endpoints once, then use set membership when assigning node opacity. ########## superset-frontend/plugins/plugin-chart-echarts/src/Sankey/transformProps.ts: ########## @@ -119,11 +159,20 @@ export default function transformProps( const echartOptions: EChartsOption = { series: { animation: false, + cursor: emitCrossFilters ? 'pointer' : 'default', data: seriesData, lineStyle: { color: 'source', }, Review Comment: `OpacityEnum.SemiTransparent` is 0.3, but matching links inherit ECharts' default Sankey link opacity of 0.2 because the series sets only `lineStyle.color`. Selecting a node or link therefore makes unrelated flows more opaque than the selected flows, reversing the intended highlighting. Explicitly give matching links a higher opacity while a selection is active, retaining the default appearance when nothing is selected. -- 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]
