rusackas commented on code in PR #40912: URL: https://github.com/apache/superset/pull/40912#discussion_r3494042488
########## superset-frontend/src/features/lineage/LineageView.tsx: ########## @@ -0,0 +1,744 @@ +/** + * 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 { FC, useMemo, useState, useCallback } from 'react'; +import { useResizeDetector } from 'react-resize-detector'; +import { t } from '@apache-superset/core/translation'; +import { styled, useTheme } from '@apache-superset/core/theme'; +import { Empty, Loading } from '@superset-ui/core/components'; +import { Button } from '@superset-ui/core/components'; +import { ResourceStatus } from 'src/hooks/apiResources/apiResources'; +import type { Resource } from 'src/hooks/apiResources/apiResources'; +import type { + DatasetLineage, + ChartLineage, + DashboardLineage, + ChartEntity, + DashboardEntity, + DatasetEntity, + DatabaseEntity, +} from 'src/hooks/apiResources/lineage'; +import Echart from '../../../plugins/plugin-chart-echarts/src/components/Echart'; +import type { EChartsCoreOption } from 'echarts/core'; + +const LineageContainer = styled.div` + display: flex; + flex-direction: column; + width: 100%; + height: 100%; +`; + +const Legend = styled.div` + ${({ theme }) => ` + display: flex; + justify-content: center; + align-items: center; + gap: ${theme.sizeUnit * 4}px; + padding: ${theme.sizeUnit * 3}px; + background-color: ${theme.colorBgLayout}; + border-bottom: 1px solid ${theme.colorBorder}; + `} +`; + +const LegendItem = styled.div<{ color: string }>` + ${({ theme, color }) => ` + display: flex; + align-items: center; + gap: ${theme.sizeUnit * 2}px; + font-size: ${theme.fontSizeSM}px; + color: ${theme.colorText}; + + &::before { + content: ''; + width: 12px; + height: 12px; + border-radius: 2px; + background-color: ${color}; + } + `} +`; + +const DetailsPanel = styled.div` + ${({ theme }) => ` + padding: ${theme.sizeUnit * 4}px; + background-color: ${theme.colorBgLayout}; + border-top: 1px solid ${theme.colorBorder}; + min-height: 120px; + `} +`; + +const DetailsPanelHeader = styled.div` + ${({ theme }) => ` + display: flex; + justify-content: space-between; + align-items: center; + margin-bottom: ${theme.sizeUnit * 3}px; + `} +`; + +const DetailsPanelActions = styled.div` + ${({ theme }) => ` + display: flex; + gap: ${theme.sizeUnit * 2}px; + `} +`; + +const DetailsPanelTitle = styled.h4` + ${({ theme }) => ` + margin: 0; + font-size: ${theme.fontSizeLG}px; + font-weight: ${theme.fontWeightStrong}; + color: ${theme.colorText}; + `} +`; + +const DetailsPanelContent = styled.div` + ${({ theme }) => ` + display: flex; + flex-direction: column; + gap: ${theme.sizeUnit * 2}px; + `} +`; + +const DetailRow = styled.div` + ${({ theme }) => ` + display: flex; + gap: ${theme.sizeUnit * 2}px; + font-size: ${theme.fontSizeSM}px; + color: ${theme.colorText}; + `} +`; + +const DetailLabel = styled.span` + ${({ theme }) => ` + font-weight: ${theme.fontWeightStrong}; + min-width: 100px; + `} +`; + +const DetailValue = styled.span` + ${({ theme }) => ` + color: ${theme.colorTextSecondary}; + `} +`; + +type NodeType = 'database' | 'dataset' | 'chart' | 'dashboard'; + +type NodeDetails = { + name: string; + type: NodeType; + id?: number; + additionalInfo?: Record<string, string | number | null | undefined>; +}; + +// Build a stable, unique graph identity for a node so that entities sharing the +// same display name (e.g. two charts with identical titles) never collapse into +// a single Sankey node. The human-readable name is kept separately as the label. +const nodeKey = (type: NodeType, id?: number, name?: string): string => + id != null ? `${type}:${id}` : `${type}:${name ?? ''}`; + +type LineageViewProps = { + lineageResource: + | Resource<DatasetLineage> + | Resource<ChartLineage> + | Resource<DashboardLineage>; + entityType: 'dataset' | 'chart' | 'dashboard'; +}; + +const LineageView: FC<LineageViewProps> = ({ lineageResource, entityType }) => { + const theme = useTheme(); + const [selectedNode, setSelectedNode] = useState<NodeDetails | null>(null); + const { width: chartWidth = 800, ref: chartContainerRef } = + useResizeDetector(); + + // Create a mapping of node names to their details + const nodeDetailsMap = useMemo(() => { + if ( + lineageResource.status !== ResourceStatus.Complete || + !lineageResource.result + ) { + return new Map<string, NodeDetails>(); + } + + const data = lineageResource.result; + const map = new Map<string, NodeDetails>(); + + if (entityType === 'dataset' && 'dataset' in data) { + const { dataset, upstream, downstream } = data as DatasetLineage; + + // Add current dataset + map.set(nodeKey('dataset', dataset.id, dataset.name), { + name: dataset.name, + type: 'dataset', + id: dataset.id, + additionalInfo: { + schema: dataset.schema, + table_name: dataset.table_name, + database_name: dataset.database_name, + }, + }); + + // Add upstream database + if (upstream?.database) { + map.set( + nodeKey( + 'database', + upstream.database.id, + upstream.database.database_name, + ), + { + name: upstream.database.database_name, + type: 'database', + id: upstream.database.id, + }, + ); + } + + // Add downstream charts + if (downstream?.charts?.result) { + downstream.charts.result.forEach((chart: ChartEntity) => { + map.set(nodeKey('chart', chart.id, chart.slice_name), { + name: chart.slice_name, + type: 'chart', + id: chart.id, + additionalInfo: { + viz_type: chart.viz_type, + }, + }); + }); + } + + // Add downstream dashboards + if (downstream?.dashboards?.result) { + downstream.dashboards.result.forEach((dashboard: DashboardEntity) => { + map.set(nodeKey('dashboard', dashboard.id, dashboard.title), { + name: dashboard.title, + type: 'dashboard', + id: dashboard.id, + additionalInfo: { + slug: dashboard.slug, + }, + }); + }); + } + } else if (entityType === 'chart' && 'chart' in data) { + const { chart, upstream, downstream } = data as ChartLineage; + + // Add current chart + map.set(nodeKey('chart', chart.id, chart.slice_name), { + name: chart.slice_name, + type: 'chart', + id: chart.id, + additionalInfo: { + viz_type: chart.viz_type, + }, + }); + + // Add upstream dataset + if (upstream?.dataset) { + map.set( + nodeKey('dataset', upstream.dataset.id, upstream.dataset.name), + { + name: upstream.dataset.name, + type: 'dataset', + id: upstream.dataset.id, + additionalInfo: { + schema: upstream.dataset.schema, + table_name: upstream.dataset.table_name, + }, + }, + ); + } + + // Add upstream database + if (upstream?.database) { + map.set( + nodeKey( + 'database', + upstream.database.id, + upstream.database.database_name, + ), + { + name: upstream.database.database_name, + type: 'database', + id: upstream.database.id, + }, + ); + } + + // Add downstream dashboards + if (downstream?.dashboards?.result) { + downstream.dashboards.result.forEach((dashboard: DashboardEntity) => { + map.set(nodeKey('dashboard', dashboard.id, dashboard.title), { + name: dashboard.title, + type: 'dashboard', + id: dashboard.id, + additionalInfo: { + slug: dashboard.slug, + }, + }); + }); + } + } else if (entityType === 'dashboard' && 'dashboard' in data) { + const { dashboard, upstream } = data as DashboardLineage; + + // Add current dashboard + map.set(nodeKey('dashboard', dashboard.id, dashboard.title), { + name: dashboard.title, + type: 'dashboard', + id: dashboard.id, + additionalInfo: { + slug: dashboard.slug, + }, + }); + + // Add upstream charts + if (upstream?.charts?.result) { + upstream.charts.result.forEach((chart: ChartEntity) => { + map.set(nodeKey('chart', chart.id, chart.slice_name), { + name: chart.slice_name, + type: 'chart', + id: chart.id, + additionalInfo: { + viz_type: chart.viz_type, + }, + }); + }); + } + + // Add upstream datasets + if (upstream?.datasets?.result) { + upstream.datasets.result.forEach((dataset: DatasetEntity) => { + map.set(nodeKey('dataset', dataset.id, dataset.name), { + name: dataset.name, + type: 'dataset', + id: dataset.id, + additionalInfo: { + schema: dataset.schema, + table_name: dataset.table_name, + }, + }); + }); + } + + // Add upstream databases + if (upstream?.databases?.result) { + upstream.databases.result.forEach((database: DatabaseEntity) => { + map.set(nodeKey('database', database.id, database.database_name), { + name: database.database_name, + type: 'database', + id: database.id, + }); + }); + } + } + + return map; + }, [lineageResource, entityType]); + + // Handle node click + const handleNodeClick = useCallback( + (params: { + dataType?: string; + name?: string; + event?: { stop: () => void }; + }) => { + if (params.dataType === 'node' && params.name) { + const nodeDetails = nodeDetailsMap.get(params.name); + if (nodeDetails) { + setSelectedNode(nodeDetails); + } + } + // Always stop event propagation to prevent tooltip issues + if (params.event) { + params.event.stop(); + } + }, + [nodeDetailsMap], + ); + + const echartOptions: EChartsCoreOption | null = useMemo(() => { + if ( + lineageResource.status !== ResourceStatus.Complete || + !lineageResource.result + ) { + return null; + } + + const data = lineageResource.result; + const nodes: { + name: string; + label?: { position?: string; formatter?: string }; + itemStyle?: { color: string }; + }[] = []; + const links: { source: string; target: string; value: number }[] = []; + const nodeSet = new Set<string>(); + + // Helper to add a node. `key` is the stable unique identity used for graph + // links and detail lookups; `label` is the human-readable text shown. + const addNode = ( + key: string, + label: string, + color: string, + labelPosition: 'left' | 'right' | 'inside', + ) => { + if (!nodeSet.has(key)) { + nodeSet.add(key); + nodes.push({ + name: key, + itemStyle: { color }, + label: { + position: labelPosition, + formatter: label, + }, + }); + } + }; + + // Helper to add a link between two node keys + const addLink = (source: string, target: string) => { + links.push({ source, target, value: 1 }); + }; + + // Build nodes and links based on entity type + if (entityType === 'dataset' && 'dataset' in data) { + const { dataset, upstream, downstream } = data as DatasetLineage; + + const datasetKey = nodeKey('dataset', dataset.id, dataset.name); + // Add current dataset node (center) - label inside + addNode(datasetKey, dataset.name, theme.colorPrimary, 'inside'); + + // Add upstream database - label on left + if (upstream?.database) { + const dbKey = nodeKey( + 'database', + upstream.database.id, + upstream.database.database_name, + ); + addNode( + dbKey, + upstream.database.database_name, + theme.colorInfo, + 'left', + ); + addLink(dbKey, datasetKey); + } + + // Add downstream charts - label on right + const chartKeys = new Map<number, string>(); + if (downstream?.charts?.result) { + downstream.charts.result.forEach((chart: ChartEntity) => { + const chartKey = nodeKey('chart', chart.id, chart.slice_name); + chartKeys.set(chart.id, chartKey); + addNode(chartKey, chart.slice_name, theme.colorSuccess, 'right'); + addLink(datasetKey, chartKey); + }); + } + + // Add downstream dashboards - label on right + if (downstream?.dashboards?.result) { + downstream.dashboards.result.forEach((dashboard: DashboardEntity) => { + const dashKey = nodeKey('dashboard', dashboard.id, dashboard.title); + addNode(dashKey, dashboard.title, theme.colorWarning, 'right'); + + // Link from charts to dashboards using chart_ids + let linked = false; + if (dashboard.chart_ids && dashboard.chart_ids.length > 0) { + dashboard.chart_ids.forEach(chartId => { + const chartKey = chartKeys.get(chartId); + if (chartKey) { + addLink(chartKey, dashKey); + linked = true; + } + }); + } + // Fall back to a direct dataset -> dashboard edge so the dashboard + // still renders when none of its charts resolve to visible nodes + // (e.g. after permission filtering); Sankey omits orphaned nodes. + if (!linked) { + addLink(datasetKey, dashKey); + } + }); + } + } else if (entityType === 'chart' && 'chart' in data) { + const { chart, upstream, downstream } = data as ChartLineage; + + const chartKey = nodeKey('chart', chart.id, chart.slice_name); + // Add current chart node (center) - label inside + addNode(chartKey, chart.slice_name, theme.colorPrimary, 'inside'); + + // Add upstream dataset - label on left + if (upstream?.dataset) { + const datasetKey = nodeKey( + 'dataset', + upstream.dataset.id, + upstream.dataset.name, + ); + addNode(datasetKey, upstream.dataset.name, theme.colorInfo, 'left'); + addLink(datasetKey, chartKey); + + // Add upstream database - label on left + if (upstream.database) { + const dbKey = nodeKey( + 'database', + upstream.database.id, + upstream.database.database_name, + ); + addNode( + dbKey, + upstream.database.database_name, + theme.colorWarning, + 'left', + ); + addLink(dbKey, datasetKey); + } + } + + // Add downstream dashboards - label on right + if (downstream?.dashboards?.result) { + downstream.dashboards.result.forEach((dashboard: DashboardEntity) => { + const dashKey = nodeKey('dashboard', dashboard.id, dashboard.title); + addNode(dashKey, dashboard.title, theme.colorSuccess, 'right'); + addLink(chartKey, dashKey); + }); + } + } else if (entityType === 'dashboard' && 'dashboard' in data) { + const { dashboard, upstream } = data as DashboardLineage; + + const dashKey = nodeKey('dashboard', dashboard.id, dashboard.title); + // Add current dashboard node (right) - label inside + addNode(dashKey, dashboard.title, theme.colorPrimary, 'inside'); + + // Add upstream charts - label on left + const chartKeys = new Map<number, string>(); + if (upstream?.charts?.result) { + upstream.charts.result.forEach((chart: ChartEntity) => { + const chartKey = nodeKey('chart', chart.id, chart.slice_name); + chartKeys.set(chart.id, chartKey); + addNode(chartKey, chart.slice_name, theme.colorInfo, 'left'); + addLink(chartKey, dashKey); + }); + } + + // Add upstream datasets - label on left + const datasetKeys = new Map<number, string>(); + if (upstream?.datasets?.result) { + upstream.datasets.result.forEach(dataset => { + const datasetKey = nodeKey('dataset', dataset.id, dataset.name); + datasetKeys.set(dataset.id, datasetKey); + addNode(datasetKey, dataset.name, theme.colorSuccess, 'left'); + }); + } + + // Link charts to their specific datasets using dataset_id from each chart + if (upstream?.charts?.result) { + upstream.charts.result.forEach((chart: ChartEntity) => { + if (chart.dataset_id) { + const datasetKey = datasetKeys.get(chart.dataset_id); + const chartKey = chartKeys.get(chart.id); + if (datasetKey && chartKey) { + addLink(datasetKey, chartKey); + } + } + }); + } + + // Add upstream databases and link to their specific datasets + if (upstream?.databases?.result) { + upstream.databases.result.forEach(database => { + const dbKey = nodeKey( + 'database', + database.id, + database.database_name, + ); + addNode(dbKey, database.database_name, theme.colorWarning, 'left'); + + // Link databases to datasets that belong to them using database_id + if (upstream.datasets?.result) { + upstream.datasets.result.forEach(dataset => { + if (dataset.database_id === database.id) { + const datasetKey = datasetKeys.get(dataset.id); + if (datasetKey) { + addLink(dbKey, datasetKey); + } + } + }); + } + }); + } + } + + return { + series: { + animation: false, + data: nodes, + lineStyle: { + color: 'source', + }, + links, + type: 'sankey', + }, + tooltip: { + show: false, + }, + }; + }, [lineageResource, entityType, theme]); + + // Build legend data based on entity type + const legendItems: { label: string; color: string }[] = useMemo(() => { + if (entityType === 'dataset') { + return [ + { label: t('Database (Upstream)'), color: theme.colorInfo }, + { label: t('Dataset (Current)'), color: theme.colorPrimary }, + { label: t('Chart (Downstream)'), color: theme.colorSuccess }, + { label: t('Dashboard (Downstream)'), color: theme.colorWarning }, + ]; + } else if (entityType === 'chart') { + return [ + { label: t('Database (Upstream)'), color: theme.colorWarning }, + { label: t('Dataset (Upstream)'), color: theme.colorInfo }, + { label: t('Chart (Current)'), color: theme.colorPrimary }, + { label: t('Dashboard (Downstream)'), color: theme.colorSuccess }, + ]; + } else if (entityType === 'dashboard') { + return [ + { label: t('Database (Upstream)'), color: theme.colorWarning }, + { label: t('Dataset (Upstream)'), color: theme.colorSuccess }, + { label: t('Chart (Upstream)'), color: theme.colorInfo }, + { label: t('Dashboard (Current)'), color: theme.colorPrimary }, + ]; + } + return []; + }, [entityType, theme]); + + if (lineageResource.status === ResourceStatus.Loading) { + return <Loading />; + } + + if ( + lineageResource.status === ResourceStatus.Error || + !lineageResource.result + ) { + return <Empty description={t('Failed to load lineage data')} />; + } + + if (!echartOptions) { + return <Empty description={t('No lineage data available')} />; + } + + // Helper function to get the URL for an entity + const getEntityUrl = (nodeDetails: NodeDetails): string => { + switch (nodeDetails.type) { + case 'dashboard': + return `/superset/dashboard/${nodeDetails.id}/`; + case 'chart': + return `/explore/?slice_id=${nodeDetails.id}`; + case 'dataset': + return `/dataset/${nodeDetails.id}`; + default: + return '#'; + } + }; + + return ( + <LineageContainer> + <Legend> + {legendItems.map(item => ( + <LegendItem key={item.label} color={item.color}> + {item.label} + </LegendItem> + ))} + </Legend> + <div ref={chartContainerRef} style={{ width: '100%' }}> + <Echart + refs={{}} + height={selectedNode ? 450 : 600} + width={chartWidth} + echartOptions={echartOptions} + vizType="sankey" + eventHandlers={{ + click: handleNodeClick, + }} + /> + </div> + {selectedNode && ( + <DetailsPanel> + <DetailsPanelHeader> + <DetailsPanelTitle> + {t( + '%s Details', + selectedNode.type.charAt(0).toUpperCase() + + selectedNode.type.slice(1), + )} + </DetailsPanelTitle> + <DetailsPanelActions> + {(selectedNode.type === 'dashboard' || + selectedNode.type === 'chart') && ( + <Button + buttonStyle="primary" + buttonSize="small" + onClick={() => { + window.location.href = getEntityUrl(selectedNode); + }} + > + {t('Open')}{' '} + {selectedNode.type.charAt(0).toUpperCase() + + selectedNode.type.slice(1)} + </Button> + )} Review Comment: There's no standalone dataset page to open, so I dropped the dead `dataset` branch in `getEntityUrl` rather than wiring up navigation that would 404. ########## superset/datasets/api.py: ########## @@ -855,6 +858,130 @@ def related_objects(self, id_or_uuid: str) -> Response: dashboards={"count": len(dashboards), "result": dashboards}, ) + @expose("/<id_or_uuid>/lineage", methods=("GET",)) + @protect() + @safe + @statsd_metrics + @event_logger.log_this_with_context( + action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.lineage", + log_to_statsd=False, + ) + def lineage(self, id_or_uuid: str) -> Response: + """Get lineage information for a dataset. + --- + get: + summary: Get lineage information for a dataset + description: >- + Returns upstream (database) and downstream (charts, dashboards) lineage + information for a dataset + parameters: + - in: path + name: id_or_uuid + schema: + type: string + description: Either the id of the dataset, or its uuid + responses: + 200: + description: Lineage information + content: + application/json: + schema: + $ref: "#/components/schemas/DatasetLineageResponseSchema" + 401: + $ref: '#/components/responses/401' + 404: + $ref: '#/components/responses/404' + 500: + $ref: '#/components/responses/500' + """ + dataset = DatasetDAO.find_by_id_or_uuid(id_or_uuid) + if not dataset: + return self.response_404() + + dataset_info = { + "id": dataset.id, + "name": dataset.name, + "database_id": dataset.database_id, + "database_name": ( + dataset.database.database_name if dataset.database else None + ), + "schema": dataset.schema, + "table_name": dataset.table_name, + } + + # Get upstream (database) information + upstream: dict[str, Any] = {} + if dataset.database: + upstream["database"] = { + "id": dataset.database.id, + "database_name": dataset.database.database_name, + "backend": dataset.database.backend, + } + else: + upstream["database"] = None + + # Get downstream (charts and dashboards) information + related_data = DatasetDAO.get_related_objects(dataset.id) + + # Build chart information with dashboard IDs, filtering both the charts + # and their linked dashboards by the current user's permissions so + # lineage never exposes assets the user cannot access. + charts: list[dict[str, Any]] = [] + for chart in related_data["charts"]: + if not security_manager.can_access_chart(chart): + continue + dashboard_ids = [ + d.id + for d in chart.dashboards + if security_manager.can_access_dashboard(d) + ] Review Comment: `get_related_objects` now `selectinload`s `Slice.dashboards`, so the lineage loop no longer queries per chart. ########## superset/datasets/api.py: ########## @@ -855,6 +858,130 @@ def related_objects(self, id_or_uuid: str) -> Response: dashboards={"count": len(dashboards), "result": dashboards}, ) + @expose("/<id_or_uuid>/lineage", methods=("GET",)) + @protect() + @safe + @statsd_metrics + @event_logger.log_this_with_context( + action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.lineage", + log_to_statsd=False, + ) + def lineage(self, id_or_uuid: str) -> Response: + """Get lineage information for a dataset. + --- + get: + summary: Get lineage information for a dataset + description: >- + Returns upstream (database) and downstream (charts, dashboards) lineage + information for a dataset + parameters: + - in: path + name: id_or_uuid + schema: + type: string + description: Either the id of the dataset, or its uuid + responses: + 200: + description: Lineage information + content: + application/json: + schema: + $ref: "#/components/schemas/DatasetLineageResponseSchema" + 401: + $ref: '#/components/responses/401' + 404: + $ref: '#/components/responses/404' + 500: + $ref: '#/components/responses/500' + """ + dataset = DatasetDAO.find_by_id_or_uuid(id_or_uuid) + if not dataset: + return self.response_404() + + dataset_info = { + "id": dataset.id, + "name": dataset.name, + "database_id": dataset.database_id, + "database_name": ( + dataset.database.database_name if dataset.database else None + ), + "schema": dataset.schema, + "table_name": dataset.table_name, + } + + # Get upstream (database) information + upstream: dict[str, Any] = {} + if dataset.database: + upstream["database"] = { + "id": dataset.database.id, + "database_name": dataset.database.database_name, + "backend": dataset.database.backend, + } + else: + upstream["database"] = None + + # Get downstream (charts and dashboards) information + related_data = DatasetDAO.get_related_objects(dataset.id) + + # Build chart information with dashboard IDs, filtering both the charts + # and their linked dashboards by the current user's permissions so + # lineage never exposes assets the user cannot access. + charts: list[dict[str, Any]] = [] + for chart in related_data["charts"]: + if not security_manager.can_access_chart(chart): + continue + dashboard_ids = [ + d.id + for d in chart.dashboards + if security_manager.can_access_dashboard(d) + ] + charts.append( + { + "id": chart.id, + "slice_name": chart.slice_name, + "viz_type": chart.viz_type, + "dashboard_ids": dashboard_ids, + } + ) + + # Build dashboard information with chart IDs + dashboards: list[dict[str, Any]] = [] + for dashboard in related_data["dashboards"]: + if not security_manager.can_access_dashboard(dashboard): + continue + chart_ids = [ + chart.id + for chart in dashboard.slices + if chart.datasource_id == dataset.id + and security_manager.can_access_chart(chart) + ] Review Comment: Same fix — `get_related_objects` now `selectinload`s `Dashboard.slices` so the loop doesn't query per dashboard. ########## superset/dashboards/api.py: ########## @@ -528,6 +531,126 @@ def get( ) return self.response(200, result=result) + @expose("/<id_or_slug>/lineage", methods=("GET",)) + @protect() + @safe + @statsd_metrics + @with_dashboard + @event_logger.log_this_with_context( + action=lambda self, *args, **kwargs: f"{self.__class__.__name__}.lineage", + log_to_statsd=False, + ) + # pylint: disable=arguments-differ,arguments-renamed + def lineage(self, dash: Dashboard) -> Response: + """Get lineage information for a dashboard. + --- + get: + summary: Get lineage information for a dashboard + description: >- + Returns upstream (charts, datasets, databases) lineage information + for a dashboard + parameters: + - in: path + name: id_or_slug + schema: + type: string + description: Either the id of the dashboard, or its slug + responses: + 200: + description: Lineage information + content: + application/json: + schema: + $ref: "#/components/schemas/DashboardLineageResponseSchema" + 401: + $ref: '#/components/responses/401' + 404: + $ref: '#/components/responses/404' + 500: + $ref: '#/components/responses/500' + """ + dashboard_info = { + "id": dash.id, + "title": dash.dashboard_title, + "slug": dash.slug, + "published": dash.published, + } + + # Get upstream (charts, datasets, databases) information + charts = [] + dataset_map = {} + database_map = {} + + for chart in dash.slices: + charts.append( + { + "id": chart.id, + "slice_name": chart.slice_name, + "viz_type": chart.viz_type, + "dataset_id": chart.datasource_id, + } + ) + + # Collect dataset information. Schema/table/database details are + # only exposed to users who can access the underlying datasource; + # otherwise they are redacted so lineage never leaks datasource + # internals (the dataset id/name are kept so the graph still + # renders). + dataset = chart.datasource Review Comment: This loop is bounded to a single dashboard's slices, and `chart.datasource` is a polymorphic property rather than a plain relationship, so there's no clean eager-load here. Leaving it as-is. ########## superset/datasets/schemas.py: ########## @@ -250,6 +250,60 @@ class DatasetRelatedObjectsResponse(Schema): dashboards = fields.Nested(DatasetRelatedDashboards) +class DatasetLineageDatasetSchema(Schema): + id = fields.Integer() + name = fields.String() + database_id = fields.Integer() + database_name = fields.String() Review Comment: Right — `database_name` is null when the dataset has no database, so I marked it `allow_none`. ########## superset/datasets/schemas.py: ########## @@ -250,6 +250,60 @@ class DatasetRelatedObjectsResponse(Schema): dashboards = fields.Nested(DatasetRelatedDashboards) +class DatasetLineageDatasetSchema(Schema): + id = fields.Integer() + name = fields.String() + database_id = fields.Integer() + database_name = fields.String() + schema = fields.String(allow_none=True) + table_name = fields.String() + + +class DatasetLineageDatabaseSchema(Schema): + id = fields.Integer() + database_name = fields.String() + backend = fields.String() + + +class DatasetLineageChartSchema(Schema): + id = fields.Integer() + slice_name = fields.String() + viz_type = fields.String() + dashboard_ids = fields.List(fields.Integer()) + + +class DatasetLineageDashboardSchema(Schema): + id = fields.Integer() + title = fields.String() + slug = fields.String() Review Comment: Yep, `slug` is nullable on the model. Marked it `allow_none` here and in the chart/dashboard lineage schemas too. ########## superset-frontend/src/dashboard/components/Header/useHeaderActionsDropdownMenu.tsx: ########## @@ -234,6 +235,23 @@ export const useHeaderActionsMenu = ({ }); } + // View lineage (available in both view and edit mode; lineage is + // read-only information about the dashboard's upstream assets) + if (dashboardId) { + menuItems.push( + createModalMenuItem( + MenuKeys.ViewLineage, + <LineageModal + entityType="dashboard" + entityId={dashboardId} + triggerNode={ + <div data-test="view-lineage-menu-item">{t('View lineage')}</div> + } + />, + ), + ); Review Comment: `LineageModal` now defers the fetch until `beforeOpen` via the hooks' `skip` flag, so opening the actions menu no longer hits the endpoint. ########## superset-frontend/src/explore/components/useExploreAdditionalActionsMenu/index.tsx: ########## @@ -1077,6 +1079,23 @@ export const useExploreAdditionalActionsMenu = ( onClick: () => setIsDropdownVisible(false), }); + // View lineage + if (slice?.slice_id) { + menuItems.push({ + key: MENU_KEYS.VIEW_LINEAGE, + label: ( + <LineageModal + entityType="chart" + entityId={slice.slice_id} + triggerNode={ + <div data-test="view-lineage-menu-item">{t('View lineage')}</div> + } + /> + ), + onClick: () => setIsDropdownVisible(false), + }); Review Comment: Same — `LineageModal` defers the chart lineage fetch until the modal actually opens, so the dropdown no longer triggers it. -- 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]
