QueryEditor: move QueryEditorRows to its own component (#19756)

This commit is contained in:
Ryan McKinley
2019-10-18 13:09:55 +02:00
committed by GitHub
parent c9b11bfc7a
commit 060fab8f1c
3 changed files with 148 additions and 54 deletions

View File

@@ -10,3 +10,9 @@ export const getNextRefIdChar = (queries: DataQuery[]): string => {
}); });
}); });
}; };
export function addQuery(queries: DataQuery[], query?: Partial<DataQuery>): DataQuery[] {
const q = query || {};
q.refId = getNextRefIdChar(queries);
return [...queries, q as DataQuery];
}

View File

@@ -16,7 +16,7 @@ import {
AlphaNotice, AlphaNotice,
PluginState, PluginState,
} from '@grafana/ui'; } from '@grafana/ui';
import { QueryEditorRow } from './QueryEditorRow'; import { QueryEditorRows } from './QueryEditorRows';
// Services // Services
import { getDatasourceSrv } from 'app/features/plugins/datasource_srv'; import { getDatasourceSrv } from 'app/features/plugins/datasource_srv';
import { getBackendSrv } from 'app/core/services/backend_srv'; import { getBackendSrv } from 'app/core/services/backend_srv';
@@ -26,6 +26,7 @@ import { PanelModel } from '../state/PanelModel';
import { DashboardModel } from '../state/DashboardModel'; import { DashboardModel } from '../state/DashboardModel';
import { LoadingState, DataTransformerConfig, DefaultTimeRange } from '@grafana/data'; import { LoadingState, DataTransformerConfig, DefaultTimeRange } from '@grafana/data';
import { PluginHelp } from 'app/core/components/PluginHelp/PluginHelp'; import { PluginHelp } from 'app/core/components/PluginHelp/PluginHelp';
import { addQuery } from 'app/core/utils/query';
import { Unsubscribable } from 'rxjs'; import { Unsubscribable } from 'rxjs';
import { isSharedDashboardQuery, DashboardQueryEditor } from 'app/plugins/datasource/dashboard'; import { isSharedDashboardQuery, DashboardQueryEditor } from 'app/plugins/datasource/dashboard';
@@ -88,12 +89,13 @@ export class QueriesTab extends PureComponent<Props, State> {
return this.datasources.find(datasource => datasource.value === panel.datasource) || this.datasources[0]; return this.datasources.find(datasource => datasource.value === panel.datasource) || this.datasources[0];
} }
onChangeDataSource = (datasource: any) => { onChangeDataSource = (datasource: DataSourceSelectItem) => {
const { panel } = this.props; const { panel } = this.props;
const { currentDS } = this.state; const { currentDS } = this.state;
// switching to mixed // switching to mixed
if (datasource.meta.mixed) { if (datasource.meta.mixed) {
// Set the datasource on all targets
panel.targets.forEach(target => { panel.targets.forEach(target => {
target.datasource = panel.datasource; target.datasource = panel.datasource;
if (!target.datasource) { if (!target.datasource) {
@@ -103,6 +105,7 @@ export class QueriesTab extends PureComponent<Props, State> {
} else if (currentDS) { } else if (currentDS) {
// if switching from mixed // if switching from mixed
if (currentDS.meta.mixed) { if (currentDS.meta.mixed) {
// Remove the explicit datasource
for (const target of panel.targets) { for (const target of panel.targets) {
delete target.datasource; delete target.datasource;
} }
@@ -129,9 +132,12 @@ export class QueriesTab extends PureComponent<Props, State> {
return <PluginHelp plugin={this.state.currentDS.meta} type="query_help" />; return <PluginHelp plugin={this.state.currentDS.meta} type="query_help" />;
}; };
onAddQuery = (query?: Partial<DataQuery>) => { /**
this.props.panel.addQuery(query); * Sets the queries for the panel
this.setState({ scrollTop: this.state.scrollTop + 100000 }); */
onUpdateQueries = (queries: DataQuery[]) => {
this.props.panel.targets = queries;
this.forceUpdate();
}; };
onAddQueryClick = () => { onAddQueryClick = () => {
@@ -140,27 +146,12 @@ export class QueriesTab extends PureComponent<Props, State> {
return; return;
} }
this.onAddQuery(); this.onUpdateQueries(addQuery(this.props.panel.targets));
this.onScrollBottom();
}; };
onRemoveQuery = (query: DataQuery) => { onScrollBottom = () => {
const { panel } = this.props; this.setState({ scrollTop: this.state.scrollTop + 10000 });
const index = _.indexOf(panel.targets, query);
panel.targets.splice(index, 1);
panel.refresh();
this.forceUpdate();
};
onMoveQuery = (query: DataQuery, direction: number) => {
const { panel } = this.props;
const index = _.indexOf(panel.targets, query);
// @ts-ignore
_.move(panel.targets, index, index + direction);
this.forceUpdate();
}; };
renderToolbar = () => { renderToolbar = () => {
@@ -184,7 +175,7 @@ export class QueriesTab extends PureComponent<Props, State> {
renderMixedPicker = () => { renderMixedPicker = () => {
return ( return (
<DataSourcePicker <DataSourcePicker
datasources={this.datasources} datasources={this.datasources.filter(ds => !ds.meta.mixed)}
onChange={this.onAddMixedQuery} onChange={this.onAddMixedQuery}
current={null} current={null}
autoFocus={true} autoFocus={true}
@@ -195,8 +186,9 @@ export class QueriesTab extends PureComponent<Props, State> {
}; };
onAddMixedQuery = (datasource: any) => { onAddMixedQuery = (datasource: any) => {
this.onAddQuery({ datasource: datasource.name }); this.props.panel.targets = addQuery(this.props.panel.targets, { datasource: datasource.name });
this.setState({ isAddingMixed: false, scrollTop: this.state.scrollTop + 10000 }); this.setState({ isAddingMixed: false, scrollTop: this.state.scrollTop + 10000 });
this.forceUpdate();
}; };
onMixedPickerBlur = () => { onMixedPickerBlur = () => {
@@ -218,9 +210,34 @@ export class QueriesTab extends PureComponent<Props, State> {
this.setState({ scrollTop: target.scrollTop }); this.setState({ scrollTop: target.scrollTop });
}; };
render() { renderQueryBody = () => {
const { panel, dashboard } = this.props; const { panel, dashboard } = this.props;
const { currentDS, scrollTop, data } = this.state; const { currentDS, data } = this.state;
if (isSharedDashboardQuery(currentDS.name)) {
return <DashboardQueryEditor panel={panel} panelData={data} onChange={query => this.onUpdateQueries([query])} />;
}
return (
<>
<QueryEditorRows
queries={panel.targets}
datasource={currentDS}
onChangeQueries={this.onUpdateQueries}
onScrollBottom={this.onScrollBottom}
panel={panel}
dashboard={dashboard}
data={data}
/>
<PanelOptionsGroup>
<QueryOptions panel={panel} datasource={currentDS} />
</PanelOptionsGroup>
</>
);
};
render() {
const { scrollTop, data } = this.state;
const queryInspector: EditorToolbarView = { const queryInspector: EditorToolbarView = {
title: 'Query Inspector', title: 'Query Inspector',
render: this.renderQueryInspector, render: this.renderQueryInspector,
@@ -243,32 +260,7 @@ export class QueriesTab extends PureComponent<Props, State> {
scrollTop={scrollTop} scrollTop={scrollTop}
> >
<> <>
{isSharedDashboardQuery(currentDS.name) ? ( {this.renderQueryBody()}
<DashboardQueryEditor panel={panel} panelData={data} onChange={query => this.onQueryChange(query, 0)} />
) : (
<>
<div className="query-editor-rows">
{panel.targets.map((query, index) => (
<QueryEditorRow
dataSourceValue={query.datasource || panel.datasource}
key={query.refId}
panel={panel}
dashboard={dashboard}
data={data}
query={query}
onChange={query => this.onQueryChange(query, index)}
onRemoveQuery={this.onRemoveQuery}
onAddQuery={this.onAddQuery}
onMoveQuery={this.onMoveQuery}
inMixedMode={currentDS.meta.mixed}
/>
))}
</div>
<PanelOptionsGroup>
<QueryOptions panel={panel} datasource={currentDS} />
</PanelOptionsGroup>
</>
)}
{enableTransformations && ( {enableTransformations && (
<PanelOptionsGroup <PanelOptionsGroup

View File

@@ -0,0 +1,96 @@
// Libraries
import React, { PureComponent } from 'react';
// @ts-ignore ignoring this for now, otherwise we would have to extend _ interface with move
import _ from 'lodash';
// Types
import { PanelModel } from '../state/PanelModel';
import { DataQuery, PanelData, DataSourceSelectItem } from '@grafana/ui';
import { DashboardModel } from '../state/DashboardModel';
import { QueryEditorRow } from './QueryEditorRow';
import { addQuery } from 'app/core/utils/query';
interface Props {
// The query configuration
queries: DataQuery[];
datasource: DataSourceSelectItem;
// Query editing
onChangeQueries: (queries: DataQuery[]) => void;
onScrollBottom: () => void;
// Dashboard Configs
panel: PanelModel;
dashboard: DashboardModel;
// Query Response Data
data: PanelData;
}
export class QueryEditorRows extends PureComponent<Props> {
onAddQuery = (query?: Partial<DataQuery>) => {
const { queries, onChangeQueries } = this.props;
onChangeQueries(addQuery(queries, query));
this.props.onScrollBottom();
};
onRemoveQuery = (query: DataQuery) => {
const { queries, onChangeQueries, panel } = this.props;
const removed = queries.filter(q => {
return q !== query;
});
onChangeQueries(removed);
panel.refresh();
};
onMoveQuery = (query: DataQuery, direction: number) => {
const { queries, onChangeQueries, panel } = this.props;
const index = _.indexOf(queries, query);
// @ts-ignore
_.move(queries, index, index + direction);
onChangeQueries(queries);
panel.refresh();
};
onChangeQuery(query: DataQuery, index: number) {
const { queries, onChangeQueries } = this.props;
// ensure refId is maintained
query.refId = queries[index].refId;
// update query in array
onChangeQueries(
queries.map((item, itemIndex) => {
if (itemIndex === index) {
return query;
}
return item;
})
);
}
render() {
const { props } = this;
return (
<div className="query-editor-rows">
{props.queries.map((query, index) => (
<QueryEditorRow
dataSourceValue={query.datasource || props.datasource.value}
key={query.refId}
panel={props.panel}
dashboard={props.dashboard}
data={props.data}
query={query}
onChange={query => this.onChangeQuery(query, index)}
onRemoveQuery={this.onRemoveQuery}
onAddQuery={this.onAddQuery}
onMoveQuery={this.onMoveQuery}
inMixedMode={props.datasource.meta.mixed}
/>
))}
</div>
);
}
}