DataPanel.tsx 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  1. // Library
  2. import React, { Component } from 'react';
  3. // Services
  4. import { DatasourceSrv, getDatasourceSrv } from 'app/features/plugins/datasource_srv';
  5. // Utils
  6. import kbn from 'app/core/utils/kbn';
  7. // Types
  8. import {
  9. DataQueryOptions,
  10. DataQueryResponse,
  11. DataQueryError,
  12. LoadingState,
  13. PanelData,
  14. TableData,
  15. TimeRange,
  16. TimeSeries,
  17. ScopedVars,
  18. } from '@grafana/ui';
  19. interface RenderProps {
  20. loading: LoadingState;
  21. panelData: PanelData;
  22. }
  23. export interface Props {
  24. datasource: string | null;
  25. queries: any[];
  26. panelId: number;
  27. dashboardId?: number;
  28. isVisible?: boolean;
  29. timeRange?: TimeRange;
  30. widthPixels: number;
  31. refreshCounter: number;
  32. minInterval?: string;
  33. maxDataPoints?: number;
  34. scopedVars?: ScopedVars;
  35. children: (r: RenderProps) => JSX.Element;
  36. onDataResponse?: (data: DataQueryResponse) => void;
  37. onError: (message: string, error: DataQueryError) => void;
  38. }
  39. export interface State {
  40. isFirstLoad: boolean;
  41. loading: LoadingState;
  42. response: DataQueryResponse;
  43. }
  44. export class DataPanel extends Component<Props, State> {
  45. static defaultProps = {
  46. isVisible: true,
  47. dashboardId: 1,
  48. };
  49. dataSourceSrv: DatasourceSrv = getDatasourceSrv();
  50. isUnmounted = false;
  51. constructor(props: Props) {
  52. super(props);
  53. this.state = {
  54. loading: LoadingState.NotStarted,
  55. response: {
  56. data: [],
  57. },
  58. isFirstLoad: true,
  59. };
  60. }
  61. componentDidMount() {
  62. this.issueQueries();
  63. }
  64. componentWillUnmount() {
  65. this.isUnmounted = true;
  66. }
  67. async componentDidUpdate(prevProps: Props) {
  68. if (!this.hasPropsChanged(prevProps)) {
  69. return;
  70. }
  71. this.issueQueries();
  72. }
  73. hasPropsChanged(prevProps: Props) {
  74. return this.props.refreshCounter !== prevProps.refreshCounter;
  75. }
  76. private issueQueries = async () => {
  77. const {
  78. isVisible,
  79. queries,
  80. datasource,
  81. panelId,
  82. dashboardId,
  83. timeRange,
  84. widthPixels,
  85. maxDataPoints,
  86. scopedVars,
  87. onDataResponse,
  88. onError,
  89. } = this.props;
  90. if (!isVisible) {
  91. return;
  92. }
  93. if (!queries.length) {
  94. this.setState({ loading: LoadingState.Done });
  95. return;
  96. }
  97. this.setState({ loading: LoadingState.Loading });
  98. try {
  99. const ds = await this.dataSourceSrv.get(datasource);
  100. // TODO interpolate variables
  101. const minInterval = this.props.minInterval || ds.interval;
  102. const intervalRes = kbn.calculateInterval(timeRange, widthPixels, minInterval);
  103. const queryOptions: DataQueryOptions = {
  104. timezone: 'browser',
  105. panelId: panelId,
  106. dashboardId: dashboardId,
  107. range: timeRange,
  108. rangeRaw: timeRange.raw,
  109. interval: intervalRes.interval,
  110. intervalMs: intervalRes.intervalMs,
  111. targets: queries,
  112. maxDataPoints: maxDataPoints || widthPixels,
  113. scopedVars: scopedVars || {},
  114. cacheTimeout: null,
  115. };
  116. const resp = await ds.query(queryOptions);
  117. if (this.isUnmounted) {
  118. return;
  119. }
  120. if (onDataResponse) {
  121. onDataResponse(resp);
  122. }
  123. this.setState({
  124. loading: LoadingState.Done,
  125. response: resp,
  126. isFirstLoad: false,
  127. });
  128. } catch (err) {
  129. console.log('DataPanel error', err);
  130. let message = 'Query error';
  131. if (err.message) {
  132. message = err.message;
  133. } else if (err.data && err.data.message) {
  134. message = err.data.message;
  135. } else if (err.data && err.data.error) {
  136. message = err.data.error;
  137. } else if (err.status) {
  138. message = `Query error: ${err.status} ${err.statusText}`;
  139. }
  140. onError(message, err);
  141. this.setState({ isFirstLoad: false, loading: LoadingState.Error });
  142. }
  143. };
  144. getPanelData = () => {
  145. const { response } = this.state;
  146. if (response.data.length > 0 && (response.data[0] as TableData).type === 'table') {
  147. return {
  148. tableData: response.data[0] as TableData,
  149. timeSeries: null,
  150. };
  151. }
  152. return {
  153. timeSeries: response.data as TimeSeries[],
  154. tableData: null,
  155. };
  156. };
  157. render() {
  158. const { queries } = this.props;
  159. const { loading, isFirstLoad } = this.state;
  160. const panelData = this.getPanelData();
  161. // do not render component until we have first data
  162. if (isFirstLoad && (loading === LoadingState.Loading || loading === LoadingState.NotStarted)) {
  163. return this.renderLoadingState();
  164. }
  165. if (!queries.length) {
  166. return (
  167. <div className="panel-empty">
  168. <p>Add a query to get some data!</p>
  169. </div>
  170. );
  171. }
  172. return (
  173. <>
  174. {loading === LoadingState.Loading && this.renderLoadingState()}
  175. {this.props.children({ loading, panelData })}
  176. </>
  177. );
  178. }
  179. private renderLoadingState(): JSX.Element {
  180. return (
  181. <div className="panel-loading">
  182. <i className="fa fa-spinner fa-spin" />
  183. </div>
  184. );
  185. }
  186. }