// Libraries import React, { PureComponent } from 'react'; import { AutoSizer } from 'react-virtualized'; // Services import { getTimeSrv, TimeSrv } from '../services/TimeSrv'; // Components import { PanelHeader } from './PanelHeader/PanelHeader'; import { DataPanel } from './DataPanel'; import ErrorBoundary from '../../../core/components/ErrorBoundary/ErrorBoundary'; // Utils import { applyPanelTimeOverrides } from 'app/features/dashboard/utils/panel'; import { PANEL_HEADER_HEIGHT } from 'app/core/constants'; import { profiler } from 'app/core/profiler'; import config from 'app/core/config'; // Types import { DashboardModel, PanelModel } from '../state'; import { PanelPlugin } from 'app/types'; import { TimeRange, LoadingState, DataQueryError, SeriesData, toLegacyResponseData } from '@grafana/ui'; import { ScopedVars } from '@grafana/ui'; import templateSrv from 'app/features/templating/template_srv'; import { getProcessedSeriesData } from './DataPanel'; const DEFAULT_PLUGIN_ERROR = 'Error in plugin'; export interface Props { panel: PanelModel; dashboard: DashboardModel; plugin: PanelPlugin; isFullscreen: boolean; isEditing: boolean; } export interface State { refreshCounter: number; renderCounter: number; timeInfo?: string; timeRange?: TimeRange; errorMessage: string | null; } export class PanelChrome extends PureComponent { timeSrv: TimeSrv = getTimeSrv(); constructor(props) { super(props); this.state = { refreshCounter: 0, renderCounter: 0, errorMessage: null, }; } componentDidMount() { this.props.panel.events.on('refresh', this.onRefresh); this.props.panel.events.on('render', this.onRender); this.props.dashboard.panelInitialized(this.props.panel); } componentWillUnmount() { this.props.panel.events.off('refresh', this.onRefresh); } onRefresh = () => { console.log('onRefresh'); if (!this.isVisible) { return; } const { panel } = this.props; const timeData = applyPanelTimeOverrides(panel, this.timeSrv.timeRange()); this.setState({ refreshCounter: this.state.refreshCounter + 1, timeRange: timeData.timeRange, timeInfo: timeData.timeInfo, }); }; onRender = () => { this.setState({ renderCounter: this.state.renderCounter + 1, }); }; replaceVariables = (value: string, extraVars?: ScopedVars, format?: string) => { let vars = this.props.panel.scopedVars; if (extraVars) { vars = vars ? { ...vars, ...extraVars } : extraVars; } return templateSrv.replace(value, vars, format); }; onDataResponse = (data?: SeriesData[]) => { if (this.props.dashboard.isSnapshot()) { this.props.panel.snapshotData = data; } // clear error state (if any) this.clearErrorState(); if (this.props.isEditing) { const events = this.props.panel.events; if (!data) { data = []; } // Angular query editors expect TimeSeries|TableData events.emit('data-received', data.map(v => toLegacyResponseData(v))); // Notify react query editors events.emit('series-data-received', data); } }; onDataError = (message: string, error: DataQueryError) => { if (this.state.errorMessage !== message) { this.setState({ errorMessage: message }); } // this event is used by old query editors this.props.panel.events.emit('data-error', error); }; onPanelError = (message: string) => { if (this.state.errorMessage !== message) { this.setState({ errorMessage: message }); } }; clearErrorState() { if (this.state.errorMessage) { this.setState({ errorMessage: null }); } } get isVisible() { return !this.props.dashboard.otherPanelInFullscreen(this.props.panel); } get hasPanelSnapshot() { const { panel } = this.props; return panel.snapshotData && panel.snapshotData.length; } get needsQueryExecution() { return this.hasPanelSnapshot || this.props.plugin.dataFormats.length > 0; } get getDataForPanel() { return this.hasPanelSnapshot ? getProcessedSeriesData(this.props.panel.snapshotData) : null; } renderPanelPlugin(loading: LoadingState, data: SeriesData[], width: number, height: number): JSX.Element { const { panel, plugin } = this.props; const { timeRange, renderCounter } = this.state; const PanelComponent = plugin.exports.reactPanel.panel; // This is only done to increase a counter that is used by backend // image rendering (phantomjs/headless chrome) to know when to capture image if (loading === LoadingState.Done) { profiler.renderingCompleted(panel.id); } return (
); } renderPanelBody = (width: number, height: number): JSX.Element => { const { panel } = this.props; const { refreshCounter, timeRange } = this.state; const { datasource, targets } = panel; return ( <> {this.needsQueryExecution ? ( {({ loading, data }) => { return this.renderPanelPlugin(loading, data, width, height); }} ) : ( this.renderPanelPlugin(LoadingState.Done, this.getDataForPanel, width, height) )} ); }; render() { const { dashboard, panel, isFullscreen } = this.props; const { errorMessage, timeInfo } = this.state; const { transparent } = panel; const containerClassNames = `panel-container panel-container--absolute ${transparent ? 'panel-transparent' : ''}`; return ( {({ width, height }) => { if (width === 0) { return null; } return (
{({ error, errorInfo }) => { if (errorInfo) { this.onPanelError(error.message || DEFAULT_PLUGIN_ERROR); return null; } return this.renderPanelBody(width, height); }}
); }}
); } }