DataPanel.tsx 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253
  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. DataQueryError,
  10. LoadingState,
  11. SeriesData,
  12. TimeRange,
  13. ScopedVars,
  14. toSeriesData,
  15. guessFieldTypes,
  16. DataQuery,
  17. PanelData,
  18. DataRequestInfo,
  19. } from '@grafana/ui';
  20. interface RenderProps {
  21. data: PanelData;
  22. }
  23. export interface Props {
  24. datasource: string | null;
  25. queries: DataQuery[];
  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?: SeriesData[]) => void;
  37. onError: (message: string, error: DataQueryError) => void;
  38. }
  39. export interface State {
  40. isFirstLoad: boolean;
  41. data: PanelData;
  42. }
  43. /**
  44. * All panels will be passed tables that have our best guess at colum type set
  45. *
  46. * This is also used by PanelChrome for snapshot support
  47. */
  48. export function getProcessedSeriesData(results?: any[]): SeriesData[] {
  49. if (!results) {
  50. return [];
  51. }
  52. const series: SeriesData[] = [];
  53. for (const r of results) {
  54. if (r) {
  55. series.push(guessFieldTypes(toSeriesData(r)));
  56. }
  57. }
  58. return series;
  59. }
  60. export class DataPanel extends Component<Props, State> {
  61. static defaultProps = {
  62. isVisible: true,
  63. dashboardId: 1,
  64. };
  65. dataSourceSrv: DatasourceSrv = getDatasourceSrv();
  66. isUnmounted = false;
  67. constructor(props: Props) {
  68. super(props);
  69. this.state = {
  70. isFirstLoad: true,
  71. data: {
  72. state: LoadingState.NotStarted,
  73. series: [],
  74. },
  75. };
  76. }
  77. componentDidMount() {
  78. this.issueQueries();
  79. }
  80. componentWillUnmount() {
  81. this.isUnmounted = true;
  82. }
  83. async componentDidUpdate(prevProps: Props) {
  84. if (!this.hasPropsChanged(prevProps)) {
  85. return;
  86. }
  87. this.issueQueries();
  88. }
  89. hasPropsChanged(prevProps: Props) {
  90. return this.props.refreshCounter !== prevProps.refreshCounter;
  91. }
  92. private issueQueries = async () => {
  93. const {
  94. isVisible,
  95. queries,
  96. datasource,
  97. panelId,
  98. dashboardId,
  99. timeRange,
  100. widthPixels,
  101. maxDataPoints,
  102. scopedVars,
  103. onDataResponse,
  104. onError,
  105. } = this.props;
  106. if (!isVisible) {
  107. return;
  108. }
  109. if (!queries.length) {
  110. this.setState({
  111. data: {
  112. state: LoadingState.Done,
  113. series: [],
  114. },
  115. });
  116. return;
  117. }
  118. this.setState({
  119. data: {
  120. ...this.state.data,
  121. loading: LoadingState.Loading,
  122. },
  123. });
  124. try {
  125. const ds = await this.dataSourceSrv.get(datasource, scopedVars);
  126. const minInterval = this.props.minInterval || ds.interval;
  127. const intervalRes = kbn.calculateInterval(timeRange, widthPixels, minInterval);
  128. // make shallow copy of scoped vars,
  129. // and add built in variables interval and interval_ms
  130. const scopedVarsWithInterval = Object.assign({}, scopedVars, {
  131. __interval: { text: intervalRes.interval, value: intervalRes.interval },
  132. __interval_ms: { text: intervalRes.intervalMs.toString(), value: intervalRes.intervalMs },
  133. });
  134. const request: DataRequestInfo = {
  135. timezone: 'browser',
  136. panelId: panelId,
  137. dashboardId: dashboardId,
  138. range: timeRange,
  139. rangeRaw: timeRange.raw,
  140. interval: intervalRes.interval,
  141. intervalMs: intervalRes.intervalMs,
  142. targets: queries,
  143. maxDataPoints: maxDataPoints || widthPixels,
  144. scopedVars: scopedVarsWithInterval,
  145. cacheTimeout: null,
  146. startTime: Date.now(),
  147. };
  148. const resp = await ds.query(request);
  149. request.endTime = Date.now();
  150. if (this.isUnmounted) {
  151. return;
  152. }
  153. // Make sure the data is SeriesData[]
  154. const series = getProcessedSeriesData(resp.data);
  155. if (onDataResponse) {
  156. onDataResponse(series);
  157. }
  158. this.setState({
  159. isFirstLoad: false,
  160. data: {
  161. state: LoadingState.Done,
  162. series,
  163. request,
  164. },
  165. });
  166. } catch (err) {
  167. console.log('DataPanel error', err);
  168. let message = 'Query error';
  169. if (err.message) {
  170. message = err.message;
  171. } else if (err.data && err.data.message) {
  172. message = err.data.message;
  173. } else if (err.data && err.data.error) {
  174. message = err.data.error;
  175. } else if (err.status) {
  176. message = `Query error: ${err.status} ${err.statusText}`;
  177. }
  178. onError(message, err);
  179. this.setState({
  180. isFirstLoad: false,
  181. data: {
  182. ...this.state.data,
  183. loading: LoadingState.Error,
  184. },
  185. });
  186. }
  187. };
  188. render() {
  189. const { queries } = this.props;
  190. const { isFirstLoad, data } = this.state;
  191. const { state } = data;
  192. // do not render component until we have first data
  193. if (isFirstLoad && (state === LoadingState.Loading || state === LoadingState.NotStarted)) {
  194. return this.renderLoadingState();
  195. }
  196. if (!queries.length) {
  197. return (
  198. <div className="panel-empty">
  199. <p>Add a query to get some data!</p>
  200. </div>
  201. );
  202. }
  203. return (
  204. <>
  205. {state === LoadingState.Loading && this.renderLoadingState()}
  206. {this.props.children({ data })}
  207. </>
  208. );
  209. }
  210. private renderLoadingState(): JSX.Element {
  211. return (
  212. <div className="panel-loading">
  213. <i className="fa fa-spinner fa-spin" />
  214. </div>
  215. );
  216. }
  217. }