Chore: Remove angular dependency from data sources (#27735)

* Chore: Remove angular dependency from data sources

* Removes default export for time and template srvs
Also uses @grafana/runtime versions of the interfaces where possible

* Replace usage of internal templateSrv where possible

* Use runtime templateSrv in a couple more places
This commit is contained in:
kay delaney
2020-10-01 18:51:23 +01:00
committed by GitHub
parent 8a5fc00330
commit 185442115c
60 changed files with 302 additions and 334 deletions

View File

@@ -1,7 +1,7 @@
import _ from 'lodash'; import _ from 'lodash';
import angular from 'angular'; import angular from 'angular';
import coreModule from '../core_module'; import coreModule from '../core_module';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { dateTime } from '@grafana/data'; import { dateTime } from '@grafana/data';
coreModule.filter('stringSort', () => { coreModule.filter('stringSort', () => {
@@ -39,8 +39,7 @@ coreModule.filter('moment', () => {
}; };
}); });
/** @ngInject */ function interpolateTemplateVars(templateSrv: TemplateSrv = getTemplateSrv()) {
function interpolateTemplateVars(templateSrv: TemplateSrv) {
const filterFunc: any = (text: string, scope: any) => { const filterFunc: any = (text: string, scope: any) => {
let scopedVars; let scopedVars;
if (scope.ctrl) { if (scope.ctrl) {

View File

@@ -3,10 +3,10 @@ import classNames from 'classnames';
import { Icon } from '@grafana/ui'; import { Icon } from '@grafana/ui';
import { PanelModel } from '../../state/PanelModel'; import { PanelModel } from '../../state/PanelModel';
import { DashboardModel } from '../../state/DashboardModel'; import { DashboardModel } from '../../state/DashboardModel';
import templateSrv from 'app/features/templating/template_srv';
import appEvents from 'app/core/app_events'; import appEvents from 'app/core/app_events';
import { CoreEvents } from 'app/types'; import { CoreEvents } from 'app/types';
import { RowOptionsButton } from '../RowOptions/RowOptionsButton'; import { RowOptionsButton } from '../RowOptions/RowOptionsButton';
import { getTemplateSrv } from '@grafana/runtime';
export interface DashboardRowProps { export interface DashboardRowProps {
panel: PanelModel; panel: PanelModel;
@@ -69,7 +69,7 @@ export class DashboardRow extends React.Component<DashboardRowProps, any> {
'dashboard-row--collapsed': this.state.collapsed, 'dashboard-row--collapsed': this.state.collapsed,
}); });
const title = templateSrv.replace(this.props.panel.title, this.props.panel.scopedVars, 'text'); const title = getTemplateSrv().replace(this.props.panel.title, this.props.panel.scopedVars, 'text');
const count = this.props.panel.panels ? this.props.panel.panels.length : 0; const count = this.props.panel.panels ? this.props.panel.panels.length : 0;
const panels = count === 1 ? 'panel' : 'panels'; const panels = count === 1 ? 'panel' : 'panels';
const canEdit = this.props.dashboard.meta.canEdit === true; const canEdit = this.props.dashboard.meta.canEdit === true;

View File

@@ -14,9 +14,11 @@ jest.mock('app/features/dashboard/services/TimeSrv', () => ({
let fillVariableValuesForUrlMock = (params: any) => {}; let fillVariableValuesForUrlMock = (params: any) => {};
jest.mock('app/features/templating/template_srv', () => ({ jest.mock('app/features/templating/template_srv', () => ({
fillVariableValuesForUrl: (params: any) => { getTemplateSrv: () => ({
fillVariableValuesForUrlMock(params); fillVariableValuesForUrl: (params: any) => {
}, fillVariableValuesForUrlMock(params);
},
}),
})); }));
function mockLocationHref(href: string) { function mockLocationHref(href: string) {

View File

@@ -1,6 +1,6 @@
import { config } from '@grafana/runtime'; import { config } from '@grafana/runtime';
import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv';
import templateSrv from 'app/features/templating/template_srv'; import { getTemplateSrv } from 'app/features/templating/template_srv';
import { PanelModel, dateTime, urlUtil } from '@grafana/data'; import { PanelModel, dateTime, urlUtil } from '@grafana/data';
export function buildParams( export function buildParams(
@@ -22,7 +22,7 @@ export function buildParams(
} }
if (includeTemplateVars) { if (includeTemplateVars) {
templateSrv.fillVariableValuesForUrl(params); getTemplateSrv().fillVariableValuesForUrl(params);
} }
if (selectedTheme !== 'current') { if (selectedTheme !== 'current') {

View File

@@ -2,13 +2,12 @@ import React, { Component } from 'react';
import classNames from 'classnames'; import classNames from 'classnames';
import { isEqual } from 'lodash'; import { isEqual } from 'lodash';
import { DataLink, LoadingState, PanelData, PanelMenuItem, QueryResultMetaNotice, ScopedVars } from '@grafana/data'; import { DataLink, LoadingState, PanelData, PanelMenuItem, QueryResultMetaNotice, ScopedVars } from '@grafana/data';
import { AngularComponent } from '@grafana/runtime'; import { AngularComponent, getTemplateSrv } from '@grafana/runtime';
import { ClickOutsideWrapper, Icon, IconName, Tooltip } from '@grafana/ui'; import { ClickOutsideWrapper, Icon, IconName, Tooltip } from '@grafana/ui';
import { selectors } from '@grafana/e2e-selectors'; import { selectors } from '@grafana/e2e-selectors';
import PanelHeaderCorner from './PanelHeaderCorner'; import PanelHeaderCorner from './PanelHeaderCorner';
import { PanelHeaderMenu } from './PanelHeaderMenu'; import { PanelHeaderMenu } from './PanelHeaderMenu';
import templateSrv from 'app/features/templating/template_srv';
import { DashboardModel } from 'app/features/dashboard/state/DashboardModel'; import { DashboardModel } from 'app/features/dashboard/state/DashboardModel';
import { PanelModel } from 'app/features/dashboard/state/PanelModel'; import { PanelModel } from 'app/features/dashboard/state/PanelModel';
@@ -137,7 +136,7 @@ export class PanelHeader extends Component<Props, State> {
render() { render() {
const { panel, scopedVars, error, isViewing, isEditing, data, alertState } = this.props; const { panel, scopedVars, error, isViewing, isEditing, data, alertState } = this.props;
const { menuItems } = this.state; const { menuItems } = this.state;
const title = templateSrv.replace(panel.title, scopedVars, 'text'); const title = getTemplateSrv().replace(panel.title, scopedVars, 'text');
const panelHeaderClass = classNames({ const panelHeaderClass = classNames({
'panel-header': true, 'panel-header': true,

View File

@@ -2,10 +2,9 @@ import React, { Component } from 'react';
import { renderMarkdown, LinkModelSupplier, ScopedVars } from '@grafana/data'; import { renderMarkdown, LinkModelSupplier, ScopedVars } from '@grafana/data';
import { Tooltip, PopoverContent } from '@grafana/ui'; import { Tooltip, PopoverContent } from '@grafana/ui';
import { getLocationSrv } from '@grafana/runtime'; import { getLocationSrv, getTemplateSrv } from '@grafana/runtime';
import { PanelModel } from 'app/features/dashboard/state/PanelModel'; import { PanelModel } from 'app/features/dashboard/state/PanelModel';
import templateSrv from 'app/features/templating/template_srv';
import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { InspectTab } from '../../components/Inspector/types'; import { InspectTab } from '../../components/Inspector/types';
@@ -45,7 +44,7 @@ export class PanelHeaderCorner extends Component<Props> {
getInfoContent = (): JSX.Element => { getInfoContent = (): JSX.Element => {
const { panel } = this.props; const { panel } = this.props;
const markdown = panel.description || ''; const markdown = panel.description || '';
const interpolatedMarkdown = templateSrv.replace(markdown, panel.scopedVars); const interpolatedMarkdown = getTemplateSrv().replace(markdown, panel.scopedVars);
const markedInterpolatedMarkdown = renderMarkdown(interpolatedMarkdown); const markedInterpolatedMarkdown = renderMarkdown(interpolatedMarkdown);
const links = this.props.links && this.props.links.getLinks(panel); const links = this.props.links && this.props.links.getLinks(panel);

View File

@@ -1,9 +1,9 @@
// Libraries // Libraries
import _ from 'lodash'; import _ from 'lodash';
// Utils // Utils
import { getTemplateSrv } from '@grafana/runtime';
import { Emitter } from 'app/core/utils/emitter'; import { Emitter } from 'app/core/utils/emitter';
import { getNextRefIdChar } from 'app/core/utils/query'; import { getNextRefIdChar } from 'app/core/utils/query';
import templateSrv from 'app/features/templating/template_srv';
// Types // Types
import { import {
AppEvent, AppEvent,
@@ -478,7 +478,7 @@ export class PanelModel implements DataConfigSource {
if (extraVars) { if (extraVars) {
vars = vars ? { ...vars, ...extraVars } : extraVars; vars = vars ? { ...vars, ...extraVars } : extraVars;
} }
return templateSrv.replace(value, vars, format); return getTemplateSrv().replace(value, vars, format);
} }
resendLastResult() { resendLastResult() {

View File

@@ -4,8 +4,8 @@ import { ReplaySubject, Unsubscribable, Observable } from 'rxjs';
import { map } from 'rxjs/operators'; import { map } from 'rxjs/operators';
// Services & Utils // Services & Utils
import { getTemplateSrv } from '@grafana/runtime';
import { getDatasourceSrv } from 'app/features/plugins/datasource_srv'; import { getDatasourceSrv } from 'app/features/plugins/datasource_srv';
import templateSrv from 'app/features/templating/template_srv';
import { runRequest, preProcessPanelData } from './runRequest'; import { runRequest, preProcessPanelData } from './runRequest';
import { runSharedRequest, isSharedDashboardQuery } from '../../../plugins/datasource/dashboard'; import { runSharedRequest, isSharedDashboardQuery } from '../../../plugins/datasource/dashboard';
@@ -164,7 +164,7 @@ export class PanelQueryRunner {
return query; return query;
}); });
const lowerIntervalLimit = minInterval ? templateSrv.replace(minInterval, request.scopedVars) : ds.interval; const lowerIntervalLimit = minInterval ? getTemplateSrv().replace(minInterval, request.scopedVars) : ds.interval;
const norm = rangeUtil.calculateInterval(timeRange, maxDataPoints, lowerIntervalLimit); const norm = rangeUtil.calculateInterval(timeRange, maxDataPoints, lowerIntervalLimit);
// make shallow copy of scoped vars, // make shallow copy of scoped vars,

View File

@@ -14,7 +14,7 @@ import appEvents from 'app/core/app_events';
import config from 'app/core/config'; import config from 'app/core/config';
// Services // Services
import templateSrv from 'app/features/templating/template_srv'; import { getTemplateSrv } from '@grafana/runtime';
// Constants // Constants
import { LS_PANEL_COPY_KEY, PANEL_BORDER } from 'app/core/constants'; import { LS_PANEL_COPY_KEY, PANEL_BORDER } from 'app/core/constants';
@@ -84,7 +84,7 @@ export function applyPanelTimeOverrides(panel: PanelModel, timeRange: TimeRange)
}; };
if (panel.timeFrom) { if (panel.timeFrom) {
const timeFromInterpolated = templateSrv.replace(panel.timeFrom, panel.scopedVars); const timeFromInterpolated = getTemplateSrv().replace(panel.timeFrom, panel.scopedVars);
const timeFromInfo = rangeUtil.describeTextRange(timeFromInterpolated); const timeFromInfo = rangeUtil.describeTextRange(timeFromInterpolated);
if (timeFromInfo.invalid) { if (timeFromInfo.invalid) {
newTimeData.timeInfo = 'invalid time override'; newTimeData.timeInfo = 'invalid time override';
@@ -106,7 +106,7 @@ export function applyPanelTimeOverrides(panel: PanelModel, timeRange: TimeRange)
} }
if (panel.timeShift) { if (panel.timeShift) {
const timeShiftInterpolated = templateSrv.replace(panel.timeShift, panel.scopedVars); const timeShiftInterpolated = getTemplateSrv().replace(panel.timeShift, panel.scopedVars);
const timeShiftInfo = rangeUtil.describeTextRange(timeShiftInterpolated); const timeShiftInfo = rangeUtil.describeTextRange(timeShiftInterpolated);
if (timeShiftInfo.invalid) { if (timeShiftInfo.invalid) {
newTimeData.timeInfo = 'invalid timeshift'; newTimeData.timeInfo = 'invalid timeshift';

View File

@@ -1,6 +1,6 @@
import _ from 'lodash'; import _ from 'lodash';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import templateSrv, { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import coreModule from 'app/core/core_module'; import coreModule from 'app/core/core_module';
import { getConfig } from 'app/core/config'; import { getConfig } from 'app/core/config';
import { import {
@@ -80,11 +80,13 @@ const buildLabelPath = (label: string) => {
}; };
export const getPanelLinksVariableSuggestions = (): VariableSuggestion[] => [ export const getPanelLinksVariableSuggestions = (): VariableSuggestion[] => [
...templateSrv.getVariables().map(variable => ({ ...getTemplateSrv()
value: variable.name as string, .getVariables()
label: variable.name, .map(variable => ({
origin: VariableOrigin.Template, value: variable.name as string,
})), label: variable.name,
origin: VariableOrigin.Template,
})),
{ {
value: `${DataLinkBuiltInVars.includeVars}`, value: `${DataLinkBuiltInVars.includeVars}`,
label: 'All variables', label: 'All variables',
@@ -240,11 +242,13 @@ export const getPanelOptionsVariableSuggestions = (plugin: PanelPlugin, data?: D
const dataVariables = plugin.meta.skipDataQuery ? [] : getDataFrameVars(data || []); const dataVariables = plugin.meta.skipDataQuery ? [] : getDataFrameVars(data || []);
return [ return [
...dataVariables, // field values ...dataVariables, // field values
...templateSrv.getVariables().map(variable => ({ ...getTemplateSrv()
value: variable.name as string, .getVariables()
label: variable.name, .map(variable => ({
origin: VariableOrigin.Template, value: variable.name as string,
})), label: variable.name,
origin: VariableOrigin.Template,
})),
]; ];
}; };

View File

@@ -4,11 +4,14 @@ import coreModule from 'app/core/core_module';
// Services & Utils // Services & Utils
import config from 'app/core/config'; import config from 'app/core/config';
import { importDataSourcePlugin } from './plugin_loader'; import { importDataSourcePlugin } from './plugin_loader';
import { DataSourceSrv as DataSourceService, getDataSourceSrv as getDataSourceService } from '@grafana/runtime'; import {
DataSourceSrv as DataSourceService,
getDataSourceSrv as getDataSourceService,
TemplateSrv,
} from '@grafana/runtime';
// Types // Types
import { AppEvents, DataSourceApi, DataSourceInstanceSettings, DataSourceSelectItem, ScopedVars } from '@grafana/data'; import { AppEvents, DataSourceApi, DataSourceInstanceSettings, DataSourceSelectItem, ScopedVars } from '@grafana/data';
import { auto } from 'angular'; import { auto } from 'angular';
import { TemplateSrv } from '../templating/template_srv';
import { GrafanaRootScope } from 'app/routes/GrafanaCtrl'; import { GrafanaRootScope } from 'app/routes/GrafanaCtrl';
// Pretend Datasource // Pretend Datasource
import { expressionDatasource } from 'app/features/expressions/ExpressionDatasource'; import { expressionDatasource } from 'app/features/expressions/ExpressionDatasource';

View File

@@ -4,7 +4,7 @@ import React from 'react';
import ReactDOM from 'react-dom'; import ReactDOM from 'react-dom';
import DefaultVariableQueryEditor from '../variables/editor/DefaultVariableQueryEditor'; import DefaultVariableQueryEditor from '../variables/editor/DefaultVariableQueryEditor';
import { DataSourcePluginMeta } from '@grafana/data'; import { DataSourcePluginMeta } from '@grafana/data';
import { TemplateSrv } from '../templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
async function loadComponent(meta: DataSourcePluginMeta) { async function loadComponent(meta: DataSourcePluginMeta) {
const dsPlugin = await importDataSourcePlugin(meta); const dsPlugin = await importDataSourcePlugin(meta);

View File

@@ -1,4 +1,4 @@
import coreModule from 'app/core/core_module'; import coreModule from 'app/core/core_module';
import templateSrv from './template_srv'; import { getTemplateSrv } from './template_srv';
coreModule.factory('templateSrv', () => templateSrv); coreModule.factory('templateSrv', () => getTemplateSrv());

View File

@@ -336,4 +336,4 @@ export class TemplateSrv implements BaseTemplateSrv {
// Expose the template srv // Expose the template srv
const srv = new TemplateSrv(); const srv = new TemplateSrv();
setTemplateSrv(srv); setTemplateSrv(srv);
export default srv; export const getTemplateSrv = () => srv;

View File

@@ -6,7 +6,7 @@ import { DataSourceSelectItem, stringToJsRegex } from '@grafana/data';
import { getDatasourceSrv } from '../../plugins/datasource_srv'; import { getDatasourceSrv } from '../../plugins/datasource_srv';
import { getVariable } from '../state/selectors'; import { getVariable } from '../state/selectors';
import { DataSourceVariableModel } from '../types'; import { DataSourceVariableModel } from '../types';
import templateSrv from '../../templating/template_srv'; import { getTemplateSrv } from '@grafana/runtime';
import _ from 'lodash'; import _ from 'lodash';
import { changeVariableEditorExtended } from '../editor/reducer'; import { changeVariableEditorExtended } from '../editor/reducer';
@@ -23,7 +23,7 @@ export const updateDataSourceVariableOptions = (
let regex; let regex;
if (variableInState.regex) { if (variableInState.regex) {
regex = templateSrv.replace(variableInState.regex, undefined, 'regex'); regex = getTemplateSrv().replace(variableInState.regex, undefined, 'regex');
regex = stringToJsRegex(regex); regex = stringToJsRegex(regex);
} }

View File

@@ -7,7 +7,7 @@ import { validateVariableSelectionState } from '../state/actions';
import { getVariable } from '../state/selectors'; import { getVariable } from '../state/selectors';
import { IntervalVariableModel } from '../types'; import { IntervalVariableModel } from '../types';
import { getTimeSrv } from '../../dashboard/services/TimeSrv'; import { getTimeSrv } from '../../dashboard/services/TimeSrv';
import templateSrv from '../../templating/template_srv'; import { getTemplateSrv, TemplateSrv } from '../../templating/template_srv';
import appEvents from '../../../core/app_events'; import appEvents from '../../../core/app_events';
export interface UpdateIntervalVariableOptionsDependencies { export interface UpdateIntervalVariableOptionsDependencies {
@@ -30,7 +30,7 @@ export const updateIntervalVariableOptions = (
export interface UpdateAutoValueDependencies { export interface UpdateAutoValueDependencies {
calculateInterval: typeof rangeUtil.calculateInterval; calculateInterval: typeof rangeUtil.calculateInterval;
getTimeSrv: typeof getTimeSrv; getTimeSrv: typeof getTimeSrv;
templateSrv: typeof templateSrv; templateSrv: TemplateSrv;
} }
export const updateAutoValue = ( export const updateAutoValue = (
@@ -38,7 +38,7 @@ export const updateAutoValue = (
dependencies: UpdateAutoValueDependencies = { dependencies: UpdateAutoValueDependencies = {
calculateInterval: rangeUtil.calculateInterval, calculateInterval: rangeUtil.calculateInterval,
getTimeSrv: getTimeSrv, getTimeSrv: getTimeSrv,
templateSrv: templateSrv, templateSrv: getTemplateSrv(),
} }
): ThunkResult<void> => (dispatch, getState) => { ): ThunkResult<void> => (dispatch, getState) => {
const variableInState = getVariable<IntervalVariableModel>(identifier.id, getState()); const variableInState = getVariable<IntervalVariableModel>(identifier.id, getState());

View File

@@ -2,7 +2,7 @@ import React, { ChangeEvent, PureComponent } from 'react';
import { InlineFormLabel, LegacyForms } from '@grafana/ui'; import { InlineFormLabel, LegacyForms } from '@grafana/ui';
import { selectors } from '@grafana/e2e-selectors'; import { selectors } from '@grafana/e2e-selectors';
import templateSrv from '../../templating/template_srv'; import { getTemplateSrv } from '@grafana/runtime';
import { SelectionOptionsEditor } from '../editor/SelectionOptionsEditor'; import { SelectionOptionsEditor } from '../editor/SelectionOptionsEditor';
import { QueryVariableModel, VariableRefresh, VariableSort, VariableWithMultiSupport } from '../types'; import { QueryVariableModel, VariableRefresh, VariableSort, VariableWithMultiSupport } from '../types';
import { QueryVariableEditorState } from './reducer'; import { QueryVariableEditorState } from './reducer';
@@ -185,7 +185,7 @@ export class QueryVariableEditorUnConnected extends PureComponent<Props, State>
<VariableQueryEditor <VariableQueryEditor
datasource={this.props.editor.extended?.dataSource} datasource={this.props.editor.extended?.dataSource}
query={this.props.variable.query} query={this.props.variable.query}
templateSrv={templateSrv} templateSrv={getTemplateSrv()}
onChange={this.onQueryChange} onChange={this.onQueryChange}
/> />
)} )}

View File

@@ -1,9 +1,9 @@
import { AppEvents, DataSourcePluginMeta, DataSourceSelectItem } from '@grafana/data'; import { AppEvents, DataSourcePluginMeta, DataSourceSelectItem } from '@grafana/data';
import { getTemplateSrv } from '@grafana/runtime';
import { validateVariableSelectionState } from '../state/actions'; import { validateVariableSelectionState } from '../state/actions';
import { QueryVariableModel, VariableRefresh } from '../types'; import { QueryVariableModel, VariableRefresh } from '../types';
import { ThunkResult } from '../../../types'; import { ThunkResult } from '../../../types';
import { getDatasourceSrv } from '../../plugins/datasource_srv'; import { getDatasourceSrv } from '../../plugins/datasource_srv';
import templateSrv from '../../templating/template_srv';
import { getTimeSrv } from '../../dashboard/services/TimeSrv'; import { getTimeSrv } from '../../dashboard/services/TimeSrv';
import appEvents from '../../../core/app_events'; import appEvents from '../../../core/app_events';
import { importDataSourcePlugin } from '../../plugins/plugin_loader'; import { importDataSourcePlugin } from '../../plugins/plugin_loader';
@@ -138,5 +138,5 @@ const getTemplatedRegex = (variable: QueryVariableModel): string => {
return ''; return '';
} }
return templateSrv.replace(variable.regex, {}, 'regex'); return getTemplateSrv().replace(variable.regex, {}, 'regex');
}; };

View File

@@ -30,7 +30,7 @@ import {
import { toVariableIdentifier, toVariablePayload, VariableIdentifier } from './types'; import { toVariableIdentifier, toVariablePayload, VariableIdentifier } from './types';
import { appEvents } from 'app/core/core'; import { appEvents } from 'app/core/core';
import { contextSrv } from 'app/core/services/context_srv'; import { contextSrv } from 'app/core/services/context_srv';
import templateSrv from '../../templating/template_srv'; import { getTemplateSrv, TemplateSrv } from '../../templating/template_srv';
import { alignCurrentWithMulti } from '../shared/multiOptions'; import { alignCurrentWithMulti } from '../shared/multiOptions';
import { isMulti } from '../guard'; import { isMulti } from '../guard';
import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv';
@@ -89,7 +89,7 @@ export const initDashboardTemplating = (list: VariableModel[]): ThunkResult<void
dispatch(addVariable(toVariablePayload(model, { global: false, index: orderIndex++, model }))); dispatch(addVariable(toVariablePayload(model, { global: false, index: orderIndex++, model })));
} }
templateSrv.updateTimeRange(getTimeSrv().timeRange()); getTemplateSrv().updateTimeRange(getTimeSrv().timeRange());
for (let index = 0; index < getVariables(getState()).length; index++) { for (let index = 0; index < getVariables(getState()).length; index++) {
dispatch(addInitLock(toVariablePayload(getVariables(getState())[index]))); dispatch(addInitLock(toVariablePayload(getVariables(getState())[index])));
@@ -458,13 +458,13 @@ export const variableUpdated = (
}; };
export interface OnTimeRangeUpdatedDependencies { export interface OnTimeRangeUpdatedDependencies {
templateSrv: typeof templateSrv; templateSrv: TemplateSrv;
appEvents: typeof appEvents; appEvents: typeof appEvents;
} }
export const onTimeRangeUpdated = ( export const onTimeRangeUpdated = (
timeRange: TimeRange, timeRange: TimeRange,
dependencies: OnTimeRangeUpdatedDependencies = { templateSrv: templateSrv, appEvents: appEvents } dependencies: OnTimeRangeUpdatedDependencies = { templateSrv: getTemplateSrv(), appEvents: appEvents }
): ThunkResult<Promise<void>> => async (dispatch, getState) => { ): ThunkResult<Promise<void>> => async (dispatch, getState) => {
dependencies.templateSrv.updateTimeRange(timeRange); dependencies.templateSrv.updateTimeRange(timeRange);
const variablesThatNeedRefresh = getVariables(getState()).filter(variable => { const variablesThatNeedRefresh = getVariables(getState()).filter(variable => {

View File

@@ -1,12 +1,9 @@
import { TemplateSrv } from 'app/features/templating/template_srv';
import { AnnotationTarget } from './types'; import { AnnotationTarget } from './types';
export class CloudMonitoringAnnotationsQueryCtrl { export class CloudMonitoringAnnotationsQueryCtrl {
static templateUrl = 'partials/annotations.editor.html'; static templateUrl = 'partials/annotations.editor.html';
annotation: any; annotation: any;
templateSrv: TemplateSrv;
/** @ngInject */
constructor() { constructor() {
this.annotation.target = this.annotation.target || {}; this.annotation.target = this.annotation.target || {};
this.onQueryChange = this.onQueryChange.bind(this); this.onQueryChange = this.onQueryChange.bind(this);

View File

@@ -1,7 +1,7 @@
import React, { FC } from 'react'; import React, { FC } from 'react';
import _ from 'lodash'; import _ from 'lodash';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { SelectableValue, rangeUtil } from '@grafana/data'; import { SelectableValue, rangeUtil } from '@grafana/data';
import { Segment } from '@grafana/ui'; import { Segment } from '@grafana/ui';
import { alignmentPeriods, alignOptions } from '../constants'; import { alignmentPeriods, alignOptions } from '../constants';

View File

@@ -2,7 +2,7 @@ import React from 'react';
import { LegacyForms } from '@grafana/ui'; import { LegacyForms } from '@grafana/ui';
const { Input } = LegacyForms; const { Input } = LegacyForms;
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { SelectableValue } from '@grafana/data'; import { SelectableValue } from '@grafana/data';
import CloudMonitoringDatasource from '../datasource'; import CloudMonitoringDatasource from '../datasource';

View File

@@ -1,7 +1,7 @@
import React, { useEffect, useState } from 'react'; import React, { useEffect, useState } from 'react';
import _ from 'lodash'; import _ from 'lodash';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { SelectableValue } from '@grafana/data'; import { SelectableValue } from '@grafana/data';
import CloudMonitoringDatasource from '../datasource'; import CloudMonitoringDatasource from '../datasource';
import { Segment } from '@grafana/ui'; import { Segment } from '@grafana/ui';

View File

@@ -9,8 +9,8 @@ import {
SelectableValue, SelectableValue,
toDataFrame, toDataFrame,
} from '@grafana/data'; } from '@grafana/data';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { import {
CloudMonitoringQuery, CloudMonitoringQuery,
@@ -28,11 +28,10 @@ export default class CloudMonitoringDatasource extends DataSourceApi<CloudMonito
api: API; api: API;
authenticationType: string; authenticationType: string;
/** @ngInject */
constructor( constructor(
private instanceSettings: DataSourceInstanceSettings<CloudMonitoringOptions>, private instanceSettings: DataSourceInstanceSettings<CloudMonitoringOptions>,
public templateSrv: TemplateSrv, public templateSrv: TemplateSrv = getTemplateSrv(),
private timeSrv: TimeSrv private readonly timeSrv: TimeSrv = getTimeSrv()
) { ) {
super(instanceSettings); super(instanceSettings);
this.authenticationType = instanceSettings.jsonData.authenticationType || 'jwt'; this.authenticationType = instanceSettings.jsonData.authenticationType || 'jwt';

View File

@@ -2,7 +2,7 @@ import _ from 'lodash';
import { alignOptions, aggOptions, ValueTypes, MetricKind, systemLabels } from './constants'; import { alignOptions, aggOptions, ValueTypes, MetricKind, systemLabels } from './constants';
import { SelectableValue } from '@grafana/data'; import { SelectableValue } from '@grafana/data';
import CloudMonitoringDatasource from './datasource'; import CloudMonitoringDatasource from './datasource';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { MetricDescriptor, Filter, MetricQuery } from './types'; import { MetricDescriptor, Filter, MetricQuery } from './types';
export const extractServicesFromMetricDescriptors = (metricDescriptors: MetricDescriptor[]) => export const extractServicesFromMetricDescriptors = (metricDescriptors: MetricDescriptor[]) =>

View File

@@ -21,8 +21,8 @@ import {
DataQueryErrorType, DataQueryErrorType,
} from '@grafana/data'; } from '@grafana/data';
import { getBackendSrv, toDataQueryResponse } from '@grafana/runtime'; import { getBackendSrv, toDataQueryResponse } from '@grafana/runtime';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { ThrottlingErrorMessage } from './components/ThrottlingErrorMessage'; import { ThrottlingErrorMessage } from './components/ThrottlingErrorMessage';
import memoizedDebounce from './memoizedDebounce'; import memoizedDebounce from './memoizedDebounce';
import { import {
@@ -83,11 +83,10 @@ export class CloudWatchDatasource extends DataSourceApi<CloudWatchQuery, CloudWa
logQueries: Record<string, { id: string; region: string; statsQuery: boolean }>; logQueries: Record<string, { id: string; region: string; statsQuery: boolean }>;
languageProvider: CloudWatchLanguageProvider; languageProvider: CloudWatchLanguageProvider;
/** @ngInject */
constructor( constructor(
instanceSettings: DataSourceInstanceSettings<CloudWatchJsonData>, instanceSettings: DataSourceInstanceSettings<CloudWatchJsonData>,
private templateSrv: TemplateSrv, private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private timeSrv: TimeSrv private readonly timeSrv: TimeSrv = getTimeSrv()
) { ) {
super(instanceSettings); super(instanceSettings);
this.type = 'cloudwatch'; this.type = 'cloudwatch';

View File

@@ -1,12 +1,11 @@
import angular from 'angular'; import angular from 'angular';
import coreModule from 'app/core/core_module'; import coreModule from 'app/core/core_module';
import _ from 'lodash'; import _ from 'lodash';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import DatasourceSrv from 'app/features/plugins/datasource_srv';
export class CloudWatchQueryParameterCtrl { export class CloudWatchQueryParameterCtrl {
/** @ngInject */ /** @ngInject */
constructor($scope: any, templateSrv: TemplateSrv, uiSegmentSrv: any, datasourceSrv: DatasourceSrv) { constructor($scope: any, templateSrv: TemplateSrv, uiSegmentSrv: any) {
$scope.init = () => { $scope.init = () => {
const target = $scope.target; const target = $scope.target;
target.namespace = target.namespace || ''; target.namespace = target.namespace || '';

View File

@@ -18,8 +18,8 @@ import { ElasticQueryBuilder } from './query_builder';
import { toUtc } from '@grafana/data'; import { toUtc } from '@grafana/data';
import * as queryDef from './query_def'; import * as queryDef from './query_def';
import { getBackendSrv } from '@grafana/runtime'; import { getBackendSrv } from '@grafana/runtime';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { DataLinkConfig, ElasticsearchOptions, ElasticsearchQuery } from './types'; import { DataLinkConfig, ElasticsearchOptions, ElasticsearchQuery } from './types';
// Those are metadata fields as defined in https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html#_identity_metadata_fields. // Those are metadata fields as defined in https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-fields.html#_identity_metadata_fields.
@@ -53,11 +53,10 @@ export class ElasticDatasource extends DataSourceApi<ElasticsearchQuery, Elastic
dataLinks: DataLinkConfig[]; dataLinks: DataLinkConfig[];
languageProvider: LanguageProvider; languageProvider: LanguageProvider;
/** @ngInject */
constructor( constructor(
instanceSettings: DataSourceInstanceSettings<ElasticsearchOptions>, instanceSettings: DataSourceInstanceSettings<ElasticsearchOptions>,
private templateSrv: TemplateSrv, private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private timeSrv: TimeSrv private readonly timeSrv: TimeSrv = getTimeSrv()
) { ) {
super(instanceSettings); super(instanceSettings);
this.basicAuth = instanceSettings.basicAuth; this.basicAuth = instanceSettings.basicAuth;

View File

@@ -4,27 +4,21 @@ import { ElasticDatasource } from './datasource';
import { DataSourceInstanceSettings, dateTime } from '@grafana/data'; import { DataSourceInstanceSettings, dateTime } from '@grafana/data';
import { ElasticsearchOptions } from './types'; import { ElasticsearchOptions } from './types';
import { TemplateSrv } from '../../../features/templating/template_srv'; import { TemplateSrv } from '../../../features/templating/template_srv';
import { getTimeSrv, TimeSrv } from '../../../features/dashboard/services/TimeSrv'; import { TimeSrv } from '../../../features/dashboard/services/TimeSrv';
import { getTemplateSrv } from '@grafana/runtime';
jest.mock('app/features/templating/template_srv', () => { const templateSrvStub = {
return { getAdhocFilters: jest.fn(() => [] as any[]),
getAdhocFilters: jest.fn(() => [] as any[]), replace: jest.fn((a: string) => a),
replace: jest.fn((a: string) => a), } as any;
};
});
jest.mock('app/features/dashboard/services/TimeSrv', () => ({ const timeSrvStub = {
__esModule: true, timeRange(): any {
getTimeSrv: jest.fn().mockReturnValue({ return {
timeRange(): any { from: dateTime(1531468681),
return { to: dateTime(1531489712),
from: dateTime(1531468681), };
to: dateTime(1531489712), },
}; } as any;
},
}),
}));
const dataSource = new ElasticDatasource( const dataSource = new ElasticDatasource(
{ {
@@ -36,8 +30,8 @@ const dataSource = new ElasticDatasource(
timeField: '@time', timeField: '@time',
}, },
} as DataSourceInstanceSettings<ElasticsearchOptions>, } as DataSourceInstanceSettings<ElasticsearchOptions>,
getTemplateSrv() as TemplateSrv, templateSrvStub as TemplateSrv,
getTimeSrv() as TimeSrv timeSrvStub as TimeSrv
); );
describe('transform prometheus query to elasticsearch query', () => { describe('transform prometheus query to elasticsearch query', () => {
it('Prometheus query with exact equals labels ( 2 labels ) and metric __name__', () => { it('Prometheus query with exact equals labels ( 2 labels ) and metric __name__', () => {

View File

@@ -1,4 +1,4 @@
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from '@grafana/runtime';
export class AzureMonitorAnnotationsQueryCtrl { export class AzureMonitorAnnotationsQueryCtrl {
static templateUrl = 'partials/annotations.editor.html'; static templateUrl = 'partials/annotations.editor.html';
@@ -10,8 +10,7 @@ export class AzureMonitorAnnotationsQueryCtrl {
defaultQuery = defaultQuery =
'<your table>\n| where $__timeFilter() \n| project TimeGenerated, Text=YourTitleColumn, Tags="tag1,tag2"'; '<your table>\n| where $__timeFilter() \n| project TimeGenerated, Text=YourTitleColumn, Tags="tag1,tag2"';
/** @ngInject */ constructor(private templateSrv: TemplateSrv = getTemplateSrv()) {
constructor(private templateSrv: TemplateSrv) {
this.annotation.queryType = this.annotation.queryType || 'Azure Log Analytics'; this.annotation.queryType = this.annotation.queryType || 'Azure Log Analytics';
this.annotation.rawQuery = this.annotation.rawQuery || this.defaultQuery; this.annotation.rawQuery = this.annotation.rawQuery || this.defaultQuery;
this.initDropdowns(); this.initDropdowns();

View File

@@ -4,7 +4,7 @@ import { QueryCtrl } from 'app/plugins/sdk';
import TimegrainConverter from './time_grain_converter'; import TimegrainConverter from './time_grain_converter';
import './editor/editor_component'; import './editor/editor_component';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { auto, IPromise } from 'angular'; import { auto, IPromise } from 'angular';
import { DataFrame, PanelEvents, rangeUtil } from '@grafana/data'; import { DataFrame, PanelEvents, rangeUtil } from '@grafana/data';
import { AzureQueryType, AzureMetricQuery } from './types'; import { AzureQueryType, AzureMetricQuery } from './types';

View File

@@ -7,11 +7,6 @@ import { GrafanaQuery, GrafanaAnnotationQuery, GrafanaAnnotationType } from './t
jest.mock('@grafana/runtime', () => ({ jest.mock('@grafana/runtime', () => ({
...((jest.requireActual('@grafana/runtime') as unknown) as object), ...((jest.requireActual('@grafana/runtime') as unknown) as object),
getBackendSrv: () => backendSrv, getBackendSrv: () => backendSrv,
getTemplateSrv: () => ({
replace: (val: string) => {
return val.replace('$var2', 'replaced__delimiter__replaced2').replace('$var', 'replaced');
},
}),
})); }));
describe('grafana data source', () => { describe('grafana data source', () => {
@@ -30,7 +25,13 @@ describe('grafana data source', () => {
return Promise.resolve([]); return Promise.resolve([]);
}); });
ds = new GrafanaDatasource({} as DataSourceInstanceSettings); const templateSrvStub = {
replace: (val: string) => {
return val.replace('$var2', 'replaced__delimiter__replaced2').replace('$var', 'replaced');
},
};
ds = new GrafanaDatasource({} as DataSourceInstanceSettings, templateSrvStub as any);
}); });
describe('with tags that have template variables', () => { describe('with tags that have template variables', () => {

View File

@@ -1,3 +1,4 @@
import _ from 'lodash';
import { import {
AnnotationEvent, AnnotationEvent,
AnnotationQueryRequest, AnnotationQueryRequest,
@@ -8,12 +9,15 @@ import {
} from '@grafana/data'; } from '@grafana/data';
import { GrafanaQuery, GrafanaAnnotationQuery, GrafanaAnnotationType } from './types'; import { GrafanaQuery, GrafanaAnnotationQuery, GrafanaAnnotationType } from './types';
import { getBackendSrv, getTemplateSrv, toDataQueryResponse } from '@grafana/runtime'; import { getBackendSrv, getTemplateSrv, TemplateSrv, toDataQueryResponse } from '@grafana/runtime';
import { Observable, of } from 'rxjs'; import { Observable, of } from 'rxjs';
import { map, catchError } from 'rxjs/operators'; import { map, catchError } from 'rxjs/operators';
export class GrafanaDatasource extends DataSourceApi<GrafanaQuery> { export class GrafanaDatasource extends DataSourceApi<GrafanaQuery> {
constructor(instanceSettings: DataSourceInstanceSettings) { constructor(
instanceSettings: DataSourceInstanceSettings,
private readonly templateSrv: TemplateSrv = getTemplateSrv()
) {
super(instanceSettings); super(instanceSettings);
} }
@@ -50,7 +54,6 @@ export class GrafanaDatasource extends DataSourceApi<GrafanaQuery> {
} }
annotationQuery(options: AnnotationQueryRequest<GrafanaQuery>): Promise<AnnotationEvent[]> { annotationQuery(options: AnnotationQueryRequest<GrafanaQuery>): Promise<AnnotationEvent[]> {
const templateSrv = getTemplateSrv();
const annotation = (options.annotation as unknown) as GrafanaAnnotationQuery; const annotation = (options.annotation as unknown) as GrafanaAnnotationQuery;
const params: any = { const params: any = {
from: options.range.from.valueOf(), from: options.range.from.valueOf(),
@@ -77,7 +80,7 @@ export class GrafanaDatasource extends DataSourceApi<GrafanaQuery> {
const delimiter = '__delimiter__'; const delimiter = '__delimiter__';
const tags = []; const tags = [];
for (const t of params.tags) { for (const t of params.tags) {
const renderedValues = templateSrv.replace(t, {}, (value: any) => { const renderedValues = this.templateSrv.replace(t, {}, (value: any) => {
if (typeof value === 'string') { if (typeof value === 'string') {
return value; return value;
} }

View File

@@ -13,7 +13,7 @@ import {
import { isVersionGtOrEq, SemVersion } from 'app/core/utils/version'; import { isVersionGtOrEq, SemVersion } from 'app/core/utils/version';
import gfunc from './gfunc'; import gfunc from './gfunc';
import { getBackendSrv } from '@grafana/runtime'; import { getBackendSrv } from '@grafana/runtime';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
// Types // Types
import { GraphiteOptions, GraphiteQuery, GraphiteType, MetricTankRequestMeta } from './types'; import { GraphiteOptions, GraphiteQuery, GraphiteType, MetricTankRequestMeta } from './types';
import { getRollupNotice, getRuntimeConsolidationNotice } from 'app/plugins/datasource/graphite/meta'; import { getRollupNotice, getRuntimeConsolidationNotice } from 'app/plugins/datasource/graphite/meta';
@@ -33,8 +33,7 @@ export class GraphiteDatasource extends DataSourceApi<GraphiteQuery, GraphiteOpt
funcDefsPromise: Promise<any> | null = null; funcDefsPromise: Promise<any> | null = null;
_seriesRefLetters: string; _seriesRefLetters: string;
/** @ngInject */ constructor(instanceSettings: any, private readonly templateSrv: TemplateSrv = getTemplateSrv()) {
constructor(instanceSettings: any, private templateSrv: TemplateSrv) {
super(instanceSettings); super(instanceSettings);
this.basicAuth = instanceSettings.basicAuth; this.basicAuth = instanceSettings.basicAuth;
this.url = instanceSettings.url; this.url = instanceSettings.url;

View File

@@ -1,6 +1,6 @@
import _ from 'lodash'; import _ from 'lodash';
import { Parser } from './parser'; import { Parser } from './parser';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { ScopedVars } from '@grafana/data'; import { ScopedVars } from '@grafana/data';
export default class GraphiteQuery { export default class GraphiteQuery {

View File

@@ -7,7 +7,7 @@ import { QueryCtrl } from 'app/plugins/sdk';
import appEvents from 'app/core/app_events'; import appEvents from 'app/core/app_events';
import { promiseToDigest } from 'app/core/utils/promiseToDigest'; import { promiseToDigest } from 'app/core/utils/promiseToDigest';
import { auto } from 'angular'; import { auto } from 'angular';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { AppEvents } from '@grafana/data'; import { AppEvents } from '@grafana/data';
const GRAPHITE_TAG_OPERATORS = ['=', '!=', '=~', '!=~']; const GRAPHITE_TAG_OPERATORS = ['=', '!=', '=~', '!=~'];

View File

@@ -4,7 +4,7 @@ import { ButtonCascader, CascaderOption } from '@grafana/ui';
import InfluxQueryModel from '../influx_query_model'; import InfluxQueryModel from '../influx_query_model';
import { AdHocFilterField, KeyValuePair } from 'app/features/explore/AdHocFilterField'; import { AdHocFilterField, KeyValuePair } from 'app/features/explore/AdHocFilterField';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from '@grafana/runtime';
import InfluxDatasource from '../datasource'; import InfluxDatasource from '../datasource';
import { InfluxQueryBuilder } from '../query_builder'; import { InfluxQueryBuilder } from '../query_builder';
import { InfluxOptions, InfluxQuery } from '../types'; import { InfluxOptions, InfluxQuery } from '../types';
@@ -48,7 +48,7 @@ function getChooserText({ measurement, field, error }: ChooserOptions): string {
} }
export class InfluxLogsQueryField extends React.PureComponent<Props, State> { export class InfluxLogsQueryField extends React.PureComponent<Props, State> {
templateSrv: TemplateSrv = new TemplateSrv(); templateSrv: TemplateSrv = getTemplateSrv();
state: State = { state: State = {
measurements: [], measurements: [],
measurement: null, measurement: null,

View File

@@ -19,7 +19,8 @@ import InfluxQueryModel from './influx_query_model';
import ResponseParser from './response_parser'; import ResponseParser from './response_parser';
import { InfluxQueryBuilder } from './query_builder'; import { InfluxQueryBuilder } from './query_builder';
import { InfluxQuery, InfluxOptions, InfluxVersion } from './types'; import { InfluxQuery, InfluxOptions, InfluxVersion } from './types';
import { getBackendSrv, getTemplateSrv, DataSourceWithBackend, frameToMetricFindValue } from '@grafana/runtime'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { getBackendSrv, DataSourceWithBackend, frameToMetricFindValue } from '@grafana/runtime';
import { Observable, from } from 'rxjs'; import { Observable, from } from 'rxjs';
import { FluxQueryEditor } from './components/FluxQueryEditor'; import { FluxQueryEditor } from './components/FluxQueryEditor';
@@ -37,7 +38,10 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
httpMode: string; httpMode: string;
isFlux: boolean; isFlux: boolean;
constructor(instanceSettings: DataSourceInstanceSettings<InfluxOptions>) { constructor(
instanceSettings: DataSourceInstanceSettings<InfluxOptions>,
private readonly templateSrv: TemplateSrv = getTemplateSrv()
) {
super(instanceSettings); super(instanceSettings);
this.type = 'influxdb'; this.type = 'influxdb';
@@ -97,7 +101,7 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
applyTemplateVariables(query: InfluxQuery, scopedVars: ScopedVars): Record<string, any> { applyTemplateVariables(query: InfluxQuery, scopedVars: ScopedVars): Record<string, any> {
return { return {
...query, ...query,
query: getTemplateSrv().replace(query.query ?? '', scopedVars), // The raw query text query: this.templateSrv.replace(query.query ?? '', scopedVars), // The raw query text
}; };
} }
@@ -111,7 +115,6 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
const queryTargets: any[] = []; const queryTargets: any[] = [];
let i, y; let i, y;
const templateSrv = getTemplateSrv();
let allQueries = _.map(targets, target => { let allQueries = _.map(targets, target => {
if (target.hide) { if (target.hide) {
@@ -123,7 +126,7 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
// backward compatibility // backward compatibility
scopedVars.interval = scopedVars.__interval; scopedVars.interval = scopedVars.__interval;
return new InfluxQueryModel(target, templateSrv, scopedVars).render(true); return new InfluxQueryModel(target, this.templateSrv, scopedVars).render(true);
}).reduce((acc, current) => { }).reduce((acc, current) => {
if (current !== '') { if (current !== '') {
acc += ';' + current; acc += ';' + current;
@@ -136,9 +139,9 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
} }
// add global adhoc filters to timeFilter // add global adhoc filters to timeFilter
const adhocFilters = (templateSrv as any).getAdhocFilters(this.name); const adhocFilters = this.templateSrv.getAdhocFilters(this.name);
if (adhocFilters.length > 0) { if (adhocFilters.length > 0) {
const tmpQuery = new InfluxQueryModel({ refId: 'A' }, templateSrv, scopedVars); const tmpQuery = new InfluxQueryModel({ refId: 'A' }, this.templateSrv, scopedVars);
timeFilter += ' AND ' + tmpQuery.renderAdhocFilters(adhocFilters); timeFilter += ' AND ' + tmpQuery.renderAdhocFilters(adhocFilters);
} }
@@ -146,7 +149,7 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
scopedVars.timeFilter = { value: timeFilter }; scopedVars.timeFilter = { value: timeFilter };
// replace templated variables // replace templated variables
allQueries = templateSrv.replace(allQueries, scopedVars); allQueries = this.templateSrv.replace(allQueries, scopedVars);
return this._seriesQuery(allQueries, options).then((data: any): any => { return this._seriesQuery(allQueries, options).then((data: any): any => {
if (!data || !data.results) { if (!data || !data.results) {
@@ -163,7 +166,7 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
const target = queryTargets[i]; const target = queryTargets[i];
let alias = target.alias; let alias = target.alias;
if (alias) { if (alias) {
alias = templateSrv.replace(target.alias, options.scopedVars); alias = this.templateSrv.replace(target.alias, options.scopedVars);
} }
const meta: QueryResultMeta = { const meta: QueryResultMeta = {
@@ -214,7 +217,7 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
const timeFilter = this.getTimeFilter({ rangeRaw: options.rangeRaw, timezone: options.dashboard.timezone }); const timeFilter = this.getTimeFilter({ rangeRaw: options.rangeRaw, timezone: options.dashboard.timezone });
let query = options.annotation.query.replace('$timeFilter', timeFilter); let query = options.annotation.query.replace('$timeFilter', timeFilter);
query = getTemplateSrv().replace(query, undefined, 'regex'); query = this.templateSrv.replace(query, undefined, 'regex');
return this._seriesQuery(query, options).then((data: any) => { return this._seriesQuery(query, options).then((data: any) => {
if (!data || !data.results || !data.results[0]) { if (!data || !data.results || !data.results[0]) {
@@ -228,18 +231,16 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
} }
targetContainsTemplate(target: any) { targetContainsTemplate(target: any) {
const templateSrv = getTemplateSrv() as any; // :(
for (const group of target.groupBy) { for (const group of target.groupBy) {
for (const param of group.params) { for (const param of group.params) {
if (templateSrv.variableExists(param)) { if (this.templateSrv.variableExists(param)) {
return true; return true;
} }
} }
} }
for (const i in target.tags) { for (const i in target.tags) {
if (templateSrv.variableExists(target.tags[i].value)) { if (this.templateSrv.variableExists(target.tags[i].value)) {
return true; return true;
} }
} }
@@ -254,25 +255,23 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
let expandedQueries = queries; let expandedQueries = queries;
if (queries && queries.length > 0) { if (queries && queries.length > 0) {
const templateSrv = getTemplateSrv();
expandedQueries = queries.map(query => { expandedQueries = queries.map(query => {
const expandedQuery = { const expandedQuery = {
...query, ...query,
datasource: this.name, datasource: this.name,
measurement: templateSrv.replace(query.measurement ?? '', scopedVars, 'regex'), measurement: this.templateSrv.replace(query.measurement ?? '', scopedVars, 'regex'),
policy: templateSrv.replace(query.policy ?? '', scopedVars, 'regex'), policy: this.templateSrv.replace(query.policy ?? '', scopedVars, 'regex'),
}; };
if (query.rawQuery) { if (query.rawQuery) {
expandedQuery.query = templateSrv.replace(query.query ?? '', scopedVars, 'regex'); expandedQuery.query = this.templateSrv.replace(query.query ?? '', scopedVars, 'regex');
} }
if (query.tags) { if (query.tags) {
const expandedTags = query.tags.map(tag => { const expandedTags = query.tags.map(tag => {
const expandedTag = { const expandedTag = {
...tag, ...tag,
value: templateSrv.replace(tag.value, undefined, 'regex'), value: this.templateSrv.replace(tag.value, undefined, 'regex'),
}; };
return expandedTag; return expandedTag;
}); });
@@ -304,7 +303,7 @@ export default class InfluxDatasource extends DataSourceWithBackend<InfluxQuery,
}); });
} }
const interpolated = getTemplateSrv().replace(query, undefined, 'regex'); const interpolated = this.templateSrv.replace(query, undefined, 'regex');
return this._seriesQuery(interpolated, options).then(resp => { return this._seriesQuery(interpolated, options).then(resp => {
return this.responseParser.parse(query, resp); return this.responseParser.parse(query, resp);

View File

@@ -4,7 +4,7 @@ import { InfluxQueryBuilder } from './query_builder';
import InfluxQueryModel from './influx_query_model'; import InfluxQueryModel from './influx_query_model';
import queryPart from './query_part'; import queryPart from './query_part';
import { QueryCtrl } from 'app/plugins/sdk'; import { QueryCtrl } from 'app/plugins/sdk';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { InfluxQuery } from './types'; import { InfluxQuery } from './types';
import InfluxDatasource from './datasource'; import InfluxDatasource from './datasource';

View File

@@ -9,7 +9,6 @@ const templateSrv = new TemplateSrvStub();
jest.mock('@grafana/runtime', () => ({ jest.mock('@grafana/runtime', () => ({
...((jest.requireActual('@grafana/runtime') as unknown) as object), ...((jest.requireActual('@grafana/runtime') as unknown) as object),
getBackendSrv: () => backendSrv, getBackendSrv: () => backendSrv,
getTemplateSrv: () => templateSrv,
})); }));
describe('InfluxDataSource', () => { describe('InfluxDataSource', () => {
@@ -22,7 +21,7 @@ describe('InfluxDataSource', () => {
beforeEach(() => { beforeEach(() => {
jest.clearAllMocks(); jest.clearAllMocks();
ctx.instanceSettings.url = '/api/datasources/proxy/1'; ctx.instanceSettings.url = '/api/datasources/proxy/1';
ctx.ds = new InfluxDatasource(ctx.instanceSettings); ctx.ds = new InfluxDatasource(ctx.instanceSettings, templateSrv);
}); });
describe('When issuing metricFindQuery', () => { describe('When issuing metricFindQuery', () => {
@@ -124,7 +123,7 @@ describe('InfluxDataSource', () => {
beforeEach(() => { beforeEach(() => {
ctx.instanceSettings.url = '/api/datasources/proxy/1'; ctx.instanceSettings.url = '/api/datasources/proxy/1';
ctx.ds = new InfluxDatasource(ctx.instanceSettings); ctx.ds = new InfluxDatasource(ctx.instanceSettings, templateSrv);
}); });
describe('When issuing metricFindQuery', () => { describe('When issuing metricFindQuery', () => {

View File

@@ -13,7 +13,7 @@ import { getBackendSrv, BackendSrvRequest } from '@grafana/runtime';
import { Observable, from, of } from 'rxjs'; import { Observable, from, of } from 'rxjs';
import { map } from 'rxjs/operators'; import { map } from 'rxjs/operators';
import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { serializeParams } from 'app/core/utils/fetch'; import { serializeParams } from 'app/core/utils/fetch';
export type JaegerQuery = { export type JaegerQuery = {
@@ -21,7 +21,7 @@ export type JaegerQuery = {
} & DataQuery; } & DataQuery;
export class JaegerDatasource extends DataSourceApi<JaegerQuery> { export class JaegerDatasource extends DataSourceApi<JaegerQuery> {
constructor(private instanceSettings: DataSourceInstanceSettings) { constructor(private instanceSettings: DataSourceInstanceSettings, private readonly timeSrv: TimeSrv = getTimeSrv()) {
super(instanceSettings); super(instanceSettings);
} }
@@ -81,7 +81,7 @@ export class JaegerDatasource extends DataSourceApi<JaegerQuery> {
} }
getTimeRange(): { start: number; end: number } { getTimeRange(): { start: number; end: number } {
const range = getTimeSrv().timeRange(); const range = this.timeSrv.timeRange();
return { return {
start: getTime(range.from, false), start: getTime(range.from, false),
end: getTime(range.to, true), end: getTime(range.to, true),

View File

@@ -21,16 +21,12 @@ jest.mock('@grafana/runtime', () => ({
getBackendSrv: () => backendSrv, getBackendSrv: () => backendSrv,
})); }));
jest.mock('app/features/dashboard/services/TimeSrv', () => { const timeSrvStub = {
return { timeRange: () => ({
getTimeSrv: () => ({ from: new Date(0),
timeRange: () => ({ to: new Date(1),
from: new Date(0), }),
to: new Date(1), };
}),
}),
};
});
describe('LokiDatasource', () => { describe('LokiDatasource', () => {
let fetchStream: Subject<FetchResponse>; let fetchStream: Subject<FetchResponse>;
@@ -120,7 +116,7 @@ describe('LokiDatasource', () => {
replace: (a: string) => a, replace: (a: string) => a,
} as unknown) as TemplateSrv; } as unknown) as TemplateSrv;
const ds = new LokiDatasource(settings, templateSrvMock); const ds = new LokiDatasource(settings, templateSrvMock, timeSrvStub as any);
const options = getQueryOptions<LokiQuery>({ targets: [{ expr: 'foo', refId: 'B', maxLines: maxDataPoints }] }); const options = getQueryOptions<LokiQuery>({ targets: [{ expr: 'foo', refId: 'B', maxLines: maxDataPoints }] });
@@ -515,7 +511,7 @@ function createLokiDSForTests(
const customData = { ...(instanceSettings.jsonData || {}), maxLines: 20 }; const customData = { ...(instanceSettings.jsonData || {}), maxLines: 20 };
const customSettings = { ...instanceSettings, jsonData: customData }; const customSettings = { ...instanceSettings, jsonData: customData };
return new LokiDatasource(customSettings, templateSrvMock); return new LokiDatasource(customSettings, templateSrvMock, timeSrvStub as any);
} }
function makeAnnotationQueryRequest(): AnnotationQueryRequest<LokiQuery> { function makeAnnotationQueryRequest(): AnnotationQueryRequest<LokiQuery> {

View File

@@ -24,13 +24,12 @@ import {
ScopedVars, ScopedVars,
TimeRange, TimeRange,
} from '@grafana/data'; } from '@grafana/data';
import { BackendSrvRequest, FetchError, getBackendSrv } from '@grafana/runtime'; import { getTemplateSrv, TemplateSrv, BackendSrvRequest, FetchError, getBackendSrv } from '@grafana/runtime';
import { addLabelToQuery } from 'app/plugins/datasource/prometheus/add_label_to_query'; import { addLabelToQuery } from 'app/plugins/datasource/prometheus/add_label_to_query';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { convertToWebSocketUrl } from 'app/core/utils/explore'; import { convertToWebSocketUrl } from 'app/core/utils/explore';
import { lokiResultsToTableModel, lokiStreamResultToDataFrame, processRangeQueryResponse } from './result_transformer'; import { lokiResultsToTableModel, lokiStreamResultToDataFrame, processRangeQueryResponse } from './result_transformer';
import { getHighlighterExpressionsFromQuery } from './query_utils'; import { getHighlighterExpressionsFromQuery } from './query_utils';
import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { import {
LokiOptions, LokiOptions,
@@ -63,8 +62,11 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> {
languageProvider: LanguageProvider; languageProvider: LanguageProvider;
maxLines: number; maxLines: number;
/** @ngInject */ constructor(
constructor(private instanceSettings: DataSourceInstanceSettings<LokiOptions>, private templateSrv: TemplateSrv) { private instanceSettings: DataSourceInstanceSettings<LokiOptions>,
private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private readonly timeSrv: TimeSrv = getTimeSrv()
) {
super(instanceSettings); super(instanceSettings);
this.languageProvider = new LanguageProvider(this); this.languageProvider = new LanguageProvider(this);
@@ -294,7 +296,7 @@ export class LokiDatasource extends DataSourceApi<LokiQuery, LokiOptions> {
const labelNamesRegex = /^label_names\(\)\s*$/; const labelNamesRegex = /^label_names\(\)\s*$/;
const labelValuesRegex = /^label_values\((?:(.+),\s*)?([a-zA-Z_][a-zA-Z0-9_]*)\)\s*$/; const labelValuesRegex = /^label_values\((?:(.+),\s*)?([a-zA-Z_][a-zA-Z0-9_]*)\)\s*$/;
const timeRange = range || getTimeSrv().timeRange(); const timeRange = range || this.timeSrv.timeRange();
const params = rangeToParams({ from: timeRange.from.valueOf(), to: timeRange.to.valueOf() }); const params = rangeToParams({ from: timeRange.from.valueOf(), to: timeRange.to.valueOf() });
const labelNames = query.match(labelNamesRegex); const labelNames = query.match(labelNamesRegex);

View File

@@ -2,6 +2,8 @@ import { CircularDataFrame, FieldCache, FieldType, MutableDataFrame } from '@gra
import { LokiStreamResult, LokiTailResponse, LokiStreamResponse, LokiResultType, TransformerOptions } from './types'; import { LokiStreamResult, LokiTailResponse, LokiStreamResponse, LokiResultType, TransformerOptions } from './types';
import * as ResultTransformer from './result_transformer'; import * as ResultTransformer from './result_transformer';
import { enhanceDataFrame } from './result_transformer'; import { enhanceDataFrame } from './result_transformer';
import { setTemplateSrv } from '@grafana/runtime';
import { TemplateSrv } from 'app/features/templating/template_srv';
const streamResult: LokiStreamResult[] = [ const streamResult: LokiStreamResult[] = [
{ {
@@ -32,6 +34,10 @@ const lokiResponse: LokiStreamResponse = {
}; };
describe('loki result transformer', () => { describe('loki result transformer', () => {
beforeAll(() => {
setTemplateSrv(new TemplateSrv());
});
afterAll(() => { afterAll(() => {
jest.restoreAllMocks(); jest.restoreAllMocks();
}); });

View File

@@ -19,7 +19,7 @@ import {
ScopedVars, ScopedVars,
} from '@grafana/data'; } from '@grafana/data';
import templateSrv from 'app/features/templating/template_srv'; import { getTemplateSrv } from '@grafana/runtime';
import TableModel from 'app/core/table_model'; import TableModel from 'app/core/table_model';
import { formatQuery, getHighlighterExpressionsFromQuery } from './query_utils'; import { formatQuery, getHighlighterExpressionsFromQuery } from './query_utils';
import { import {
@@ -245,7 +245,7 @@ export function createMetricLabel(labelData: { [key: string]: string }, options?
let label = let label =
options === undefined || _.isEmpty(options.legendFormat) options === undefined || _.isEmpty(options.legendFormat)
? getOriginalMetricName(labelData) ? getOriginalMetricName(labelData)
: renderTemplate(templateSrv.replace(options.legendFormat ?? '', options.scopedVars), labelData); : renderTemplate(getTemplateSrv().replace(options.legendFormat ?? '', options.scopedVars), labelData);
if (!label && options) { if (!label && options) {
label = options.query; label = options.query;

View File

@@ -2,8 +2,8 @@ import _ from 'lodash';
import ResponseParser from './response_parser'; import ResponseParser from './response_parser';
import { getBackendSrv } from '@grafana/runtime'; import { getBackendSrv } from '@grafana/runtime';
import { ScopedVars } from '@grafana/data'; import { ScopedVars } from '@grafana/data';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
//Types //Types
import { MssqlQueryForInterpolation } from './types'; import { MssqlQueryForInterpolation } from './types';
@@ -13,8 +13,11 @@ export class MssqlDatasource {
responseParser: ResponseParser; responseParser: ResponseParser;
interval: string; interval: string;
/** @ngInject */ constructor(
constructor(instanceSettings: any, private templateSrv: TemplateSrv, private timeSrv: TimeSrv) { instanceSettings: any,
private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private readonly timeSrv: TimeSrv = getTimeSrv()
) {
this.name = instanceSettings.name; this.name = instanceSettings.name;
this.id = instanceSettings.id; this.id = instanceSettings.id;
this.responseParser = new ResponseParser(); this.responseParser = new ResponseParser();

View File

@@ -3,12 +3,11 @@ import { Observable, of } from 'rxjs';
import { catchError, map, mapTo } from 'rxjs/operators'; import { catchError, map, mapTo } from 'rxjs/operators';
import { getBackendSrv } from '@grafana/runtime'; import { getBackendSrv } from '@grafana/runtime';
import { ScopedVars } from '@grafana/data'; import { ScopedVars } from '@grafana/data';
import { TemplateSrv } from 'app/features/templating/template_srv';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import MysqlQuery from 'app/plugins/datasource/mysql/mysql_query'; import MysqlQuery from 'app/plugins/datasource/mysql/mysql_query';
import ResponseParser, { MysqlResponse } from './response_parser'; import ResponseParser, { MysqlResponse } from './response_parser';
import { MysqlMetricFindValue, MysqlQueryForInterpolation } from './types'; import { MysqlMetricFindValue, MysqlQueryForInterpolation } from './types';
import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { getSearchFilterScopedVar } from '../../../features/variables/utils'; import { getSearchFilterScopedVar } from '../../../features/variables/utils';
export class MysqlDatasource { export class MysqlDatasource {
@@ -18,8 +17,11 @@ export class MysqlDatasource {
queryModel: MysqlQuery; queryModel: MysqlQuery;
interval: string; interval: string;
/** @ngInject */ constructor(
constructor(instanceSettings: any, private templateSrv: TemplateSrv, private timeSrv: TimeSrv) { instanceSettings: any,
private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private readonly timeSrv: TimeSrv = getTimeSrv()
) {
this.name = instanceSettings.name; this.name = instanceSettings.name;
this.id = instanceSettings.id; this.id = instanceSettings.id;
this.responseParser = new ResponseParser(); this.responseParser = new ResponseParser();

View File

@@ -1,5 +1,5 @@
import _ from 'lodash'; import _ from 'lodash';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { ScopedVars } from '@grafana/data'; import { ScopedVars } from '@grafana/data';
export default class MysqlQuery { export default class MysqlQuery {

View File

@@ -6,11 +6,10 @@ import { SqlPart } from 'app/core/components/sql_part/sql_part';
import MysqlQuery from './mysql_query'; import MysqlQuery from './mysql_query';
import sqlPart from './sql_part'; import sqlPart from './sql_part';
import { auto } from 'angular'; import { auto } from 'angular';
import { TemplateSrv } from 'app/features/templating/template_srv';
import { CoreEvents } from 'app/types'; import { CoreEvents } from 'app/types';
import { PanelEvents } from '@grafana/data'; import { PanelEvents } from '@grafana/data';
import { VariableWithMultiSupport } from 'app/features/variables/types'; import { VariableWithMultiSupport } from 'app/features/variables/types';
import { getLocationSrv } from '@grafana/runtime'; import { getLocationSrv, TemplateSrv } from '@grafana/runtime';
export interface QueryMeta { export interface QueryMeta {
sql: string; sql: string;

View File

@@ -2,7 +2,7 @@ import angular from 'angular';
import _ from 'lodash'; import _ from 'lodash';
import { dateMath, DataQueryRequest, DataSourceApi, ScopedVars } from '@grafana/data'; import { dateMath, DataQueryRequest, DataSourceApi, ScopedVars } from '@grafana/data';
import { getBackendSrv } from '@grafana/runtime'; import { getBackendSrv } from '@grafana/runtime';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { OpenTsdbOptions, OpenTsdbQuery } from './types'; import { OpenTsdbOptions, OpenTsdbQuery } from './types';
export default class OpenTsDatasource extends DataSourceApi<OpenTsdbQuery, OpenTsdbOptions> { export default class OpenTsDatasource extends DataSourceApi<OpenTsdbQuery, OpenTsdbOptions> {
@@ -19,8 +19,7 @@ export default class OpenTsDatasource extends DataSourceApi<OpenTsdbQuery, OpenT
aggregatorsPromise: any; aggregatorsPromise: any;
filterTypesPromise: any; filterTypesPromise: any;
/** @ngInject */ constructor(instanceSettings: any, private readonly templateSrv: TemplateSrv = getTemplateSrv()) {
constructor(instanceSettings: any, private templateSrv: TemplateSrv) {
super(instanceSettings); super(instanceSettings);
this.type = 'opentsdb'; this.type = 'opentsdb';
this.url = instanceSettings.url; this.url = instanceSettings.url;

View File

@@ -6,8 +6,8 @@ import { DataQueryResponse, ScopedVars } from '@grafana/data';
import ResponseParser from './response_parser'; import ResponseParser from './response_parser';
import PostgresQuery from 'app/plugins/datasource/postgres/postgres_query'; import PostgresQuery from 'app/plugins/datasource/postgres/postgres_query';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import { TimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
//Types //Types
import { PostgresMetricFindValue, PostgresQueryForInterpolation } from './types'; import { PostgresMetricFindValue, PostgresQueryForInterpolation } from './types';
import { getSearchFilterScopedVar } from '../../../features/variables/utils'; import { getSearchFilterScopedVar } from '../../../features/variables/utils';
@@ -20,11 +20,10 @@ export class PostgresDatasource {
queryModel: PostgresQuery; queryModel: PostgresQuery;
interval: string; interval: string;
/** @ngInject */
constructor( constructor(
instanceSettings: { name: any; id?: any; jsonData?: any }, instanceSettings: { name: any; id?: any; jsonData?: any },
private templateSrv: TemplateSrv, private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private timeSrv: TimeSrv private readonly timeSrv: TimeSrv = getTimeSrv()
) { ) {
this.name = instanceSettings.name; this.name = instanceSettings.name;
this.id = instanceSettings.id; this.id = instanceSettings.id;

View File

@@ -1,5 +1,5 @@
import _ from 'lodash'; import _ from 'lodash';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { TemplateSrv } from '@grafana/runtime';
import { ScopedVars } from '@grafana/data'; import { ScopedVars } from '@grafana/data';
export default class PostgresQuery { export default class PostgresQuery {

View File

@@ -6,11 +6,10 @@ import { SqlPart } from 'app/core/components/sql_part/sql_part';
import PostgresQuery from './postgres_query'; import PostgresQuery from './postgres_query';
import sqlPart from './sql_part'; import sqlPart from './sql_part';
import { auto } from 'angular'; import { auto } from 'angular';
import { TemplateSrv } from 'app/features/templating/template_srv';
import { CoreEvents } from 'app/types'; import { CoreEvents } from 'app/types';
import { PanelEvents } from '@grafana/data'; import { PanelEvents } from '@grafana/data';
import { VariableWithMultiSupport } from 'app/features/variables/types'; import { VariableWithMultiSupport } from 'app/features/variables/types';
import { getLocationSrv } from '@grafana/runtime'; import { getLocationSrv, TemplateSrv } from '@grafana/runtime';
export interface QueryMeta { export interface QueryMeta {
sql: string; sql: string;

View File

@@ -1,11 +1,5 @@
import _ from 'lodash'; import _ from 'lodash';
import { import { of, throwError } from 'rxjs';
alignRange,
extractRuleMappingFromGroups,
PrometheusDatasource,
prometheusRegularEscape,
prometheusSpecialRegexEscape,
} from './datasource';
import { import {
CoreApp, CoreApp,
DataQueryRequest, DataQueryRequest,
@@ -16,51 +10,46 @@ import {
LoadingState, LoadingState,
toDataFrame, toDataFrame,
} from '@grafana/data'; } from '@grafana/data';
import {
alignRange,
extractRuleMappingFromGroups,
PrometheusDatasource,
prometheusRegularEscape,
prometheusSpecialRegexEscape,
} from './datasource';
import { PromOptions, PromQuery } from './types'; import { PromOptions, PromQuery } from './types';
import templateSrv from 'app/features/templating/template_srv';
import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import { VariableHide } from '../../../features/variables/types'; import { VariableHide } from '../../../features/variables/types';
import { describe } from '../../../../test/lib/common'; import { describe } from '../../../../test/lib/common';
import { QueryOptions } from 'app/types'; import { QueryOptions } from 'app/types';
import { of, throwError } from 'rxjs';
const fetchMock = jest.fn().mockReturnValue(of(createDefaultPromResponse())); const fetchMock = jest.fn().mockReturnValue(of(createDefaultPromResponse()));
jest.mock('./metric_find_query'); jest.mock('./metric_find_query');
jest.mock('@grafana/runtime', () => ({ jest.mock('@grafana/runtime', () => ({
// @ts-ignore
...jest.requireActual('@grafana/runtime'),
getBackendSrv: () => ({ getBackendSrv: () => ({
fetch: fetchMock, fetch: fetchMock,
}), }),
})); }));
jest.mock('app/features/templating/template_srv', () => { const templateSrvStub = {
return { getAdhocFilters: jest.fn(() => [] as any[]),
getAdhocFilters: jest.fn(() => [] as any[]), replace: jest.fn((a: string, ...rest: any) => a),
replace: jest.fn((a: string) => a), };
};
});
jest.mock('app/features/dashboard/services/TimeSrv', () => ({ const timeSrvStub = {
__esModule: true, timeRange(): any {
getTimeSrv: jest.fn().mockReturnValue({ return {
timeRange(): any { from: dateTime(1531468681),
return { to: dateTime(1531489712),
from: dateTime(1531468681), };
to: dateTime(1531489712), },
}; };
},
}),
}));
const getAdhocFiltersMock = (templateSrv.getAdhocFilters as any) as jest.Mock<any>;
const replaceMock = (templateSrv.replace as any) as jest.Mock<any>;
const getTimeSrvMock = (getTimeSrv as any) as jest.Mock<TimeSrv>;
beforeEach(() => { beforeEach(() => {
fetchMock.mockClear(); jest.clearAllMocks();
getAdhocFiltersMock.mockClear();
replaceMock.mockClear();
getTimeSrvMock.mockClear();
}); });
describe('PrometheusDatasource', () => { describe('PrometheusDatasource', () => {
@@ -74,7 +63,7 @@ describe('PrometheusDatasource', () => {
} as unknown) as DataSourceInstanceSettings<PromOptions>; } as unknown) as DataSourceInstanceSettings<PromOptions>;
beforeEach(() => { beforeEach(() => {
ds = new PrometheusDatasource(instanceSettings); ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
}); });
describe('Query', () => { describe('Query', () => {
@@ -145,7 +134,7 @@ describe('PrometheusDatasource', () => {
it('should still perform a GET request with the DS HTTP method set to POST', () => { it('should still perform a GET request with the DS HTTP method set to POST', () => {
const postSettings = _.cloneDeep(instanceSettings); const postSettings = _.cloneDeep(instanceSettings);
postSettings.jsonData.httpMethod = 'POST'; postSettings.jsonData.httpMethod = 'POST';
const promDs = new PrometheusDatasource(postSettings); const promDs = new PrometheusDatasource(postSettings, templateSrvStub as any, timeSrvStub as any);
promDs.metadataRequest('/foo'); promDs.metadataRequest('/foo');
expect(fetchMock.mock.calls.length).toBe(1); expect(fetchMock.mock.calls.length).toBe(1);
expect(fetchMock.mock.calls[0][0].method).toBe('GET'); expect(fetchMock.mock.calls[0][0].method).toBe('GET');
@@ -155,10 +144,10 @@ describe('PrometheusDatasource', () => {
describe('When using adhoc filters', () => { describe('When using adhoc filters', () => {
const DEFAULT_QUERY_EXPRESSION = 'metric{job="foo"} - metric'; const DEFAULT_QUERY_EXPRESSION = 'metric{job="foo"} - metric';
const target = { expr: DEFAULT_QUERY_EXPRESSION }; const target = { expr: DEFAULT_QUERY_EXPRESSION };
const originalAdhocFiltersMock = getAdhocFiltersMock(); const originalAdhocFiltersMock = templateSrvStub.getAdhocFilters();
afterAll(() => { afterAll(() => {
getAdhocFiltersMock.mockReturnValue(originalAdhocFiltersMock); templateSrvStub.getAdhocFilters.mockReturnValue(originalAdhocFiltersMock);
}); });
it('should not modify expression with no filters', () => { it('should not modify expression with no filters', () => {
@@ -167,7 +156,7 @@ describe('PrometheusDatasource', () => {
}); });
it('should add filters to expression', () => { it('should add filters to expression', () => {
getAdhocFiltersMock.mockReturnValue([ templateSrvStub.getAdhocFilters.mockReturnValue([
{ {
key: 'k1', key: 'k1',
operator: '=', operator: '=',
@@ -184,7 +173,7 @@ describe('PrometheusDatasource', () => {
}); });
it('should add escaping if needed to regex filter expressions', () => { it('should add escaping if needed to regex filter expressions', () => {
getAdhocFiltersMock.mockReturnValue([ templateSrvStub.getAdhocFilters.mockReturnValue([
{ {
key: 'k1', key: 'k1',
operator: '=~', operator: '=~',
@@ -511,30 +500,30 @@ describe('PrometheusDatasource', () => {
describe('metricFindQuery', () => { describe('metricFindQuery', () => {
beforeEach(() => { beforeEach(() => {
const query = 'query_result(topk(5,rate(http_request_duration_microseconds_count[$__interval])))'; const query = 'query_result(topk(5,rate(http_request_duration_microseconds_count[$__interval])))';
replaceMock.mockImplementation(jest.fn); templateSrvStub.replace = jest.fn();
ds.metricFindQuery(query); ds.metricFindQuery(query);
}); });
afterAll(() => { afterAll(() => {
replaceMock.mockImplementation((a: string) => a); templateSrvStub.replace = jest.fn((a: string) => a);
}); });
it('should call templateSrv.replace with scopedVars', () => { it('should call templateSrv.replace with scopedVars', () => {
expect(replaceMock.mock.calls[0][1]).toBeDefined(); expect(templateSrvStub.replace.mock.calls[0][1]).toBeDefined();
}); });
it('should have the correct range and range_ms', () => { it('should have the correct range and range_ms', () => {
const range = replaceMock.mock.calls[0][1].__range; const range = templateSrvStub.replace.mock.calls[0][1].__range;
const rangeMs = replaceMock.mock.calls[0][1].__range_ms; const rangeMs = templateSrvStub.replace.mock.calls[0][1].__range_ms;
const rangeS = replaceMock.mock.calls[0][1].__range_s; const rangeS = templateSrvStub.replace.mock.calls[0][1].__range_s;
expect(range).toEqual({ text: '21s', value: '21s' }); expect(range).toEqual({ text: '21s', value: '21s' });
expect(rangeMs).toEqual({ text: 21031, value: 21031 }); expect(rangeMs).toEqual({ text: 21031, value: 21031 });
expect(rangeS).toEqual({ text: 21, value: 21 }); expect(rangeS).toEqual({ text: 21, value: 21 });
}); });
it('should pass the default interval value', () => { it('should pass the default interval value', () => {
const interval = replaceMock.mock.calls[0][1].__interval; const interval = templateSrvStub.replace.mock.calls[0][1].__interval;
const intervalMs = replaceMock.mock.calls[0][1].__interval_ms; const intervalMs = templateSrvStub.replace.mock.calls[0][1].__interval_ms;
expect(interval).toEqual({ text: '15s', value: '15s' }); expect(interval).toEqual({ text: '15s', value: '15s' });
expect(intervalMs).toEqual({ text: 15000, value: 15000 }); expect(intervalMs).toEqual({ text: 15000, value: 15000 });
}); });
@@ -558,7 +547,7 @@ describe('PrometheusDatasource', () => {
let ds: PrometheusDatasource; let ds: PrometheusDatasource;
beforeEach(() => { beforeEach(() => {
ds = new PrometheusDatasource(instanceSettings); ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
}); });
describe('When querying prometheus with one target using query editor target spec', () => { describe('When querying prometheus with one target using query editor target spec', () => {
@@ -1242,14 +1231,7 @@ describe('PrometheusDatasource', () => {
end -= end % 55; end -= end % 55;
const start = 0; const start = 0;
const step = 55; const step = 55;
const adjusted = alignRange( const adjusted = alignRange(start, end, step, timeSrvStub.timeRange().to.utcOffset() * 60);
start,
end,
step,
getTimeSrv()
.timeRange()
.to.utcOffset() * 60
);
const urlExpected = const urlExpected =
'proxied/api/v1/query_range?query=test' + '&start=' + adjusted.start + '&end=' + adjusted.end + '&step=' + step; 'proxied/api/v1/query_range?query=test' + '&start=' + adjusted.start + '&end=' + adjusted.end + '&step=' + step;
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
@@ -1293,15 +1275,14 @@ describe('PrometheusDatasource', () => {
encodeURIComponent('rate(test[$__interval])') + encodeURIComponent('rate(test[$__interval])') +
'&start=60&end=420&step=10'; '&start=60&end=420&step=10';
templateSrv.replace = jest.fn(str => str) as any; templateSrvStub.replace = jest.fn(str => str) as any;
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
ds.query(query as any); ds.query(query as any);
const res = fetchMock.mock.calls[0][0]; const res = fetchMock.mock.calls[0][0];
expect(res.method).toBe('GET'); expect(res.method).toBe('GET');
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[0][1]).toEqual({
expect(templateSrv.replace.mock.calls[0][1]).toEqual({
__interval: { __interval: {
text: '10s', text: '10s',
value: '10s', value: '10s',
@@ -1334,14 +1315,13 @@ describe('PrometheusDatasource', () => {
encodeURIComponent('rate(test[$__interval])') + encodeURIComponent('rate(test[$__interval])') +
'&start=60&end=420&step=10'; '&start=60&end=420&step=10';
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
templateSrv.replace = jest.fn(str => str) as any; templateSrvStub.replace = jest.fn(str => str) as any;
ds.query(query as any); ds.query(query as any);
const res = fetchMock.mock.calls[0][0]; const res = fetchMock.mock.calls[0][0];
expect(res.method).toBe('GET'); expect(res.method).toBe('GET');
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[0][1]).toEqual({
expect(templateSrv.replace.mock.calls[0][1]).toEqual({
__interval: { __interval: {
text: '5s', text: '5s',
value: '5s', value: '5s',
@@ -1375,14 +1355,13 @@ describe('PrometheusDatasource', () => {
encodeURIComponent('rate(test[$__interval])') + encodeURIComponent('rate(test[$__interval])') +
'&start=0&end=400&step=100'; '&start=0&end=400&step=100';
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
templateSrv.replace = jest.fn(str => str) as any; templateSrvStub.replace = jest.fn(str => str) as any;
ds.query(query as any); ds.query(query as any);
const res = fetchMock.mock.calls[0][0]; const res = fetchMock.mock.calls[0][0];
expect(res.method).toBe('GET'); expect(res.method).toBe('GET');
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[0][1]).toEqual({
expect(templateSrv.replace.mock.calls[0][1]).toEqual({
__interval: { __interval: {
text: '10s', text: '10s',
value: '10s', value: '10s',
@@ -1421,15 +1400,14 @@ describe('PrometheusDatasource', () => {
encodeURIComponent('rate(test[$__interval])') + encodeURIComponent('rate(test[$__interval])') +
'&start=50&end=400&step=50'; '&start=50&end=400&step=50';
templateSrv.replace = jest.fn(str => str) as any; templateSrvStub.replace = jest.fn(str => str) as any;
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
ds.query(query as any); ds.query(query as any);
const res = fetchMock.mock.calls[0][0]; const res = fetchMock.mock.calls[0][0];
expect(res.method).toBe('GET'); expect(res.method).toBe('GET');
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[0][1]).toEqual({
expect(templateSrv.replace.mock.calls[0][1]).toEqual({
__interval: { __interval: {
text: '5s', text: '5s',
value: '5s', value: '5s',
@@ -1469,8 +1447,7 @@ describe('PrometheusDatasource', () => {
expect(res.method).toBe('GET'); expect(res.method).toBe('GET');
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[0][1]).toEqual({
expect(templateSrv.replace.mock.calls[0][1]).toEqual({
__interval: { __interval: {
text: '5s', text: '5s',
value: '5s', value: '5s',
@@ -1502,14 +1479,7 @@ describe('PrometheusDatasource', () => {
end -= end % 55; end -= end % 55;
const start = 0; const start = 0;
const step = 55; const step = 55;
const adjusted = alignRange( const adjusted = alignRange(start, end, step, timeSrvStub.timeRange().to.utcOffset() * 60);
start,
end,
step,
getTimeSrv()
.timeRange()
.to.utcOffset() * 60
);
const urlExpected = const urlExpected =
'proxied/api/v1/query_range?query=' + 'proxied/api/v1/query_range?query=' +
encodeURIComponent('rate(test[$__interval])') + encodeURIComponent('rate(test[$__interval])') +
@@ -1520,14 +1490,13 @@ describe('PrometheusDatasource', () => {
'&step=' + '&step=' +
step; step;
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
templateSrv.replace = jest.fn(str => str) as any; templateSrvStub.replace = jest.fn(str => str) as any;
ds.query(query as any); ds.query(query as any);
const res = fetchMock.mock.calls[0][0]; const res = fetchMock.mock.calls[0][0];
expect(res.method).toBe('GET'); expect(res.method).toBe('GET');
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[0][1]).toEqual({
expect(templateSrv.replace.mock.calls[0][1]).toEqual({
__interval: { __interval: {
text: '5s', text: '5s',
value: '5s', value: '5s',
@@ -1570,14 +1539,13 @@ describe('PrometheusDatasource', () => {
query.targets[0].expr query.targets[0].expr
)}&start=0&end=3600&step=60`; )}&start=0&end=3600&step=60`;
templateSrv.replace = jest.fn(str => str) as any; templateSrvStub.replace = jest.fn(str => str) as any;
fetchMock.mockImplementation(() => of(response)); fetchMock.mockImplementation(() => of(response));
ds.query(query as any); ds.query(query as any);
const res = fetchMock.mock.calls[0][0]; const res = fetchMock.mock.calls[0][0];
expect(res.url).toBe(urlExpected); expect(res.url).toBe(urlExpected);
// @ts-ignore expect(templateSrvStub.replace.mock.calls[1][1]).toEqual({
expect(templateSrv.replace.mock.calls[1][1]).toEqual({
__range_s: { __range_s: {
text: expectedRangeSecond, text: expectedRangeSecond,
value: expectedRangeSecond, value: expectedRangeSecond,
@@ -1602,46 +1570,46 @@ describe('PrometheusDatasource', () => {
const target = { expr: 'rate(process_cpu_seconds_total[$__rate_interval])', refId: 'A' }; const target = { expr: 'rate(process_cpu_seconds_total[$__rate_interval])', refId: 'A' };
beforeEach(() => { beforeEach(() => {
(templateSrv.replace as any).mockClear(); templateSrvStub.replace.mockClear();
}); });
it('should be 4 times the scrape interval if interval + scrape interval is lower', () => { it('should be 4 times the scrape interval if interval + scrape interval is lower', () => {
ds.createQuery(target, { interval: '15s' } as any, 0, 300); ds.createQuery(target, { interval: '15s' } as any, 0, 300);
expect((templateSrv.replace as any).mock.calls[1][1]['__rate_interval'].value).toBe('60s'); expect(templateSrvStub.replace.mock.calls[1][1]['__rate_interval'].value).toBe('60s');
}); });
it('should be interval + scrape interval if 4 times the scrape interval is lower', () => { it('should be interval + scrape interval if 4 times the scrape interval is lower', () => {
ds.createQuery(target, { interval: '5m' } as any, 0, 10080); ds.createQuery(target, { interval: '5m' } as any, 0, 10080);
expect((templateSrv.replace as any).mock.calls[1][1]['__rate_interval'].value).toBe('315s'); expect(templateSrvStub.replace.mock.calls[1][1]['__rate_interval'].value).toBe('315s');
}); });
it('should fall back to a scrape interval of 15s if min step is set to 0, resulting in 4*15s = 60s', () => { it('should fall back to a scrape interval of 15s if min step is set to 0, resulting in 4*15s = 60s', () => {
ds.createQuery({ ...target, interval: '' }, { interval: '15s' } as any, 0, 300); ds.createQuery({ ...target, interval: '' }, { interval: '15s' } as any, 0, 300);
expect((templateSrv.replace as any).mock.calls[1][1]['__rate_interval'].value).toBe('60s'); expect(templateSrvStub.replace.mock.calls[1][1]['__rate_interval'].value).toBe('60s');
}); });
it('should be 4 times the scrape interval if min step set to 1m and interval is 15s', () => { it('should be 4 times the scrape interval if min step set to 1m and interval is 15s', () => {
// For a 5m graph, $__interval is 15s // For a 5m graph, $__interval is 15s
ds.createQuery({ ...target, interval: '1m' }, { interval: '15s' } as any, 0, 300); ds.createQuery({ ...target, interval: '1m' }, { interval: '15s' } as any, 0, 300);
expect((templateSrv.replace as any).mock.calls[2][1]['__rate_interval'].value).toBe('240s'); expect(templateSrvStub.replace.mock.calls[2][1]['__rate_interval'].value).toBe('240s');
}); });
it('should be interval + scrape interval if min step set to 1m and interval is 5m', () => { it('should be interval + scrape interval if min step set to 1m and interval is 5m', () => {
// For a 7d graph, $__interval is 5m // For a 7d graph, $__interval is 5m
ds.createQuery({ ...target, interval: '1m' }, { interval: '5m' } as any, 0, 10080); ds.createQuery({ ...target, interval: '1m' }, { interval: '5m' } as any, 0, 10080);
expect((templateSrv.replace as any).mock.calls[2][1]['__rate_interval'].value).toBe('360s'); expect(templateSrvStub.replace.mock.calls[2][1]['__rate_interval'].value).toBe('360s');
}); });
it('should be interval + scrape interval if resolution is set to 1/2 and interval is 10m', () => { it('should be interval + scrape interval if resolution is set to 1/2 and interval is 10m', () => {
// For a 7d graph, $__interval is 10m // For a 7d graph, $__interval is 10m
ds.createQuery({ ...target, intervalFactor: 2 }, { interval: '10m' } as any, 0, 10080); ds.createQuery({ ...target, intervalFactor: 2 }, { interval: '10m' } as any, 0, 10080);
expect((templateSrv.replace as any).mock.calls[1][1]['__rate_interval'].value).toBe('1215s'); expect(templateSrvStub.replace.mock.calls[1][1]['__rate_interval'].value).toBe('1215s');
}); });
it('should be 4 times the scrape interval if resolution is set to 1/2 and interval is 15s', () => { it('should be 4 times the scrape interval if resolution is set to 1/2 and interval is 15s', () => {
// For a 5m graph, $__interval is 15s // For a 5m graph, $__interval is 15s
ds.createQuery({ ...target, intervalFactor: 2 }, { interval: '15s' } as any, 0, 300); ds.createQuery({ ...target, intervalFactor: 2 }, { interval: '15s' } as any, 0, 300);
expect((templateSrv.replace as any).mock.calls[1][1]['__rate_interval'].value).toBe('60s'); expect(templateSrvStub.replace.mock.calls[1][1]['__rate_interval'].value).toBe('60s');
}); });
it('should interpolate min step if set', () => { it('should interpolate min step if set', () => {
templateSrv.replace = jest.fn(() => '15s'); templateSrvStub.replace = jest.fn((_: string) => '15s');
ds.createQuery({ ...target, interval: '$int' }, { interval: '15s' } as any, 0, 300); ds.createQuery({ ...target, interval: '$int' }, { interval: '15s' } as any, 0, 300);
expect((templateSrv.replace as any).mock.calls).toHaveLength(3); expect(templateSrvStub.replace.mock.calls).toHaveLength(3);
templateSrv.replace = jest.fn((a: string) => a); templateSrvStub.replace = jest.fn((a: string) => a);
}); });
}); });
}); });
@@ -1658,7 +1626,7 @@ describe('PrometheusDatasource for POST', () => {
let ds: PrometheusDatasource; let ds: PrometheusDatasource;
beforeEach(() => { beforeEach(() => {
ds = new PrometheusDatasource(instanceSettings); ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
}); });
describe('When querying prometheus with one target using query editor target spec', () => { describe('When querying prometheus with one target using query editor target spec', () => {
@@ -1724,7 +1692,11 @@ describe('PrometheusDatasource for POST', () => {
}); });
it('with direct access tracing headers should not be added', () => { it('with direct access tracing headers should not be added', () => {
const mockDs = new PrometheusDatasource({ ...instanceSettings, url: 'http://127.0.0.1:8000' }); const mockDs = new PrometheusDatasource(
{ ...instanceSettings, url: 'http://127.0.0.1:8000' },
templateSrvStub as any,
timeSrvStub as any
);
mockDs._addTracingHeaders(httpOptions as any, options as any); mockDs._addTracingHeaders(httpOptions as any, options as any);
expect(httpOptions.headers['X-Dashboard-Id']).toBe(undefined); expect(httpOptions.headers['X-Dashboard-Id']).toBe(undefined);
expect(httpOptions.headers['X-Panel-Id']).toBe(undefined); expect(httpOptions.headers['X-Panel-Id']).toBe(undefined);
@@ -1747,7 +1719,7 @@ const getPrepareTargetsContext = (target: PromQuery, app?: CoreApp, queryOptions
PromQuery PromQuery
>; >;
const ds = new PrometheusDatasource(instanceSettings); const ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
const { queries, activeTargets } = ds.prepareTargets(options, start, end); const { queries, activeTargets } = ds.prepareTargets(options, start, end);
return { return {
@@ -1918,7 +1890,7 @@ describe('modifyQuery', () => {
const query: PromQuery = { refId: 'A', expr: 'go_goroutines' }; const query: PromQuery = { refId: 'A', expr: 'go_goroutines' };
const action = { key: 'cluster', value: 'us-cluster', type: 'ADD_FILTER' }; const action = { key: 'cluster', value: 'us-cluster', type: 'ADD_FILTER' };
const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>; const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>;
const ds = new PrometheusDatasource(instanceSettings); const ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
const result = ds.modifyQuery(query, action); const result = ds.modifyQuery(query, action);
@@ -1932,7 +1904,7 @@ describe('modifyQuery', () => {
const query: PromQuery = { refId: 'A', expr: 'go_goroutines{cluster="us-cluster"}' }; const query: PromQuery = { refId: 'A', expr: 'go_goroutines{cluster="us-cluster"}' };
const action = { key: 'pod', value: 'pod-123', type: 'ADD_FILTER' }; const action = { key: 'pod', value: 'pod-123', type: 'ADD_FILTER' };
const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>; const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>;
const ds = new PrometheusDatasource(instanceSettings); const ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
const result = ds.modifyQuery(query, action); const result = ds.modifyQuery(query, action);
@@ -1948,7 +1920,7 @@ describe('modifyQuery', () => {
const query: PromQuery = { refId: 'A', expr: 'go_goroutines' }; const query: PromQuery = { refId: 'A', expr: 'go_goroutines' };
const action = { key: 'cluster', value: 'us-cluster', type: 'ADD_FILTER_OUT' }; const action = { key: 'cluster', value: 'us-cluster', type: 'ADD_FILTER_OUT' };
const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>; const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>;
const ds = new PrometheusDatasource(instanceSettings); const ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
const result = ds.modifyQuery(query, action); const result = ds.modifyQuery(query, action);
@@ -1962,7 +1934,7 @@ describe('modifyQuery', () => {
const query: PromQuery = { refId: 'A', expr: 'go_goroutines{cluster="us-cluster"}' }; const query: PromQuery = { refId: 'A', expr: 'go_goroutines{cluster="us-cluster"}' };
const action = { key: 'pod', value: 'pod-123', type: 'ADD_FILTER_OUT' }; const action = { key: 'pod', value: 'pod-123', type: 'ADD_FILTER_OUT' };
const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>; const instanceSettings = ({ jsonData: {} } as unknown) as DataSourceInstanceSettings<PromOptions>;
const ds = new PrometheusDatasource(instanceSettings); const ds = new PrometheusDatasource(instanceSettings, templateSrvStub as any, timeSrvStub as any);
const result = ds.modifyQuery(query, action); const result = ds.modifyQuery(query, action);

View File

@@ -15,8 +15,8 @@ import {
} from '@grafana/data'; } from '@grafana/data';
import { BackendSrvRequest, FetchError, getBackendSrv } from '@grafana/runtime'; import { BackendSrvRequest, FetchError, getBackendSrv } from '@grafana/runtime';
import { safeStringifyValue } from 'app/core/utils/explore'; import { safeStringifyValue } from 'app/core/utils/explore';
import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv'; import { getTimeSrv, TimeSrv } from 'app/features/dashboard/services/TimeSrv';
import templateSrv from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from 'app/features/templating/template_srv';
import cloneDeep from 'lodash/cloneDeep'; import cloneDeep from 'lodash/cloneDeep';
import defaults from 'lodash/defaults'; import defaults from 'lodash/defaults';
import LRU from 'lru-cache'; import LRU from 'lru-cache';
@@ -58,7 +58,11 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
lookupsDisabled: boolean; lookupsDisabled: boolean;
customQueryParameters: any; customQueryParameters: any;
constructor(instanceSettings: DataSourceInstanceSettings<PromOptions>) { constructor(
instanceSettings: DataSourceInstanceSettings<PromOptions>,
private readonly templateSrv: TemplateSrv = getTemplateSrv(),
private readonly timeSrv: TimeSrv = getTimeSrv()
) {
super(instanceSettings); super(instanceSettings);
this.type = 'prometheus'; this.type = 'prometheus';
@@ -150,7 +154,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
} }
targetContainsTemplate(target: PromQuery) { targetContainsTemplate(target: PromQuery) {
return templateSrv.variableExists(target.expr); return this.templateSrv.variableExists(target.expr);
} }
prepareTargets = (options: DataQueryRequest<PromQuery>, start: number, end: number) => { prepareTargets = (options: DataQueryRequest<PromQuery>, start: number, end: number) => {
@@ -313,12 +317,12 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
let interval: number = rangeUtil.intervalToSeconds(options.interval); let interval: number = rangeUtil.intervalToSeconds(options.interval);
// Minimum interval ("Min step"), if specified for the query, or same as interval otherwise. // Minimum interval ("Min step"), if specified for the query, or same as interval otherwise.
const minInterval = rangeUtil.intervalToSeconds( const minInterval = rangeUtil.intervalToSeconds(
templateSrv.replace(target.interval || options.interval, options.scopedVars) this.templateSrv.replace(target.interval || options.interval, options.scopedVars)
); );
// Scrape interval as specified for the query ("Min step") or otherwise taken from the datasource. // Scrape interval as specified for the query ("Min step") or otherwise taken from the datasource.
// Min step field can have template variables in it, make sure to replace it. // Min step field can have template variables in it, make sure to replace it.
const scrapeInterval = target.interval const scrapeInterval = target.interval
? rangeUtil.intervalToSeconds(templateSrv.replace(target.interval, options.scopedVars)) ? rangeUtil.intervalToSeconds(this.templateSrv.replace(target.interval, options.scopedVars))
: rangeUtil.intervalToSeconds(this.interval); : rangeUtil.intervalToSeconds(this.interval);
const intervalFactor = target.intervalFactor || 1; const intervalFactor = target.intervalFactor || 1;
@@ -344,7 +348,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
let expr = target.expr; let expr = target.expr;
// Apply adhoc filters // Apply adhoc filters
const adhocFilters = templateSrv.getAdhocFilters(this.name); const adhocFilters = this.templateSrv.getAdhocFilters(this.name);
expr = adhocFilters.reduce((acc: string, filter: { key?: any; operator?: any; value?: any }) => { expr = adhocFilters.reduce((acc: string, filter: { key?: any; operator?: any; value?: any }) => {
const { key, operator } = filter; const { key, operator } = filter;
let { value } = filter; let { value } = filter;
@@ -355,18 +359,11 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
}, expr); }, expr);
// Only replace vars in expression after having (possibly) updated interval vars // Only replace vars in expression after having (possibly) updated interval vars
query.expr = templateSrv.replace(expr, scopedVars, this.interpolateQueryExpr); query.expr = this.templateSrv.replace(expr, scopedVars, this.interpolateQueryExpr);
// Align query interval with step to allow query caching and to ensure // Align query interval with step to allow query caching and to ensure
// that about-same-time query results look the same. // that about-same-time query results look the same.
const adjusted = alignRange( const adjusted = alignRange(start, end, query.step, this.timeSrv.timeRange().to.utcOffset() * 60);
start,
end,
query.step,
getTimeSrv()
.timeRange()
.to.utcOffset() * 60
);
query.start = adjusted.start; query.start = adjusted.start;
query.end = adjusted.end; query.end = adjusted.end;
this._addTracingHeaders(query, options); this._addTracingHeaders(query, options);
@@ -495,14 +492,14 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
const scopedVars = { const scopedVars = {
__interval: { text: this.interval, value: this.interval }, __interval: { text: this.interval, value: this.interval },
__interval_ms: { text: rangeUtil.intervalToMs(this.interval), value: rangeUtil.intervalToMs(this.interval) }, __interval_ms: { text: rangeUtil.intervalToMs(this.interval), value: rangeUtil.intervalToMs(this.interval) },
...this.getRangeScopedVars(getTimeSrv().timeRange()), ...this.getRangeScopedVars(this.timeSrv.timeRange()),
}; };
const interpolated = templateSrv.replace(query, scopedVars, this.interpolateQueryExpr); const interpolated = this.templateSrv.replace(query, scopedVars, this.interpolateQueryExpr);
const metricFindQuery = new PrometheusMetricFindQuery(this, interpolated); const metricFindQuery = new PrometheusMetricFindQuery(this, interpolated);
return metricFindQuery.process(); return metricFindQuery.process();
} }
getRangeScopedVars(range: TimeRange = getTimeSrv().timeRange()) { getRangeScopedVars(range: TimeRange = this.timeSrv.timeRange()) {
const msRange = range.to.diff(range.from); const msRange = range.to.diff(range.from);
const sRange = Math.round(msRange / 1000); const sRange = Math.round(msRange / 1000);
return { return {
@@ -639,7 +636,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
const expandedQuery = { const expandedQuery = {
...query, ...query,
datasource: this.name, datasource: this.name,
expr: templateSrv.replace(query.expr, scopedVars, this.interpolateQueryExpr), expr: this.templateSrv.replace(query.expr, scopedVars, this.interpolateQueryExpr),
}; };
return expandedQuery; return expandedQuery;
}); });
@@ -709,7 +706,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
} }
getTimeRange(): { start: number; end: number } { getTimeRange(): { start: number; end: number } {
const range = getTimeSrv().timeRange(); const range = this.timeSrv.timeRange();
return { return {
start: this.getPrometheusTime(range.from, false), start: this.getPrometheusTime(range.from, false),
end: this.getPrometheusTime(range.to, true), end: this.getPrometheusTime(range.to, true),

View File

@@ -8,13 +8,6 @@ import { backendSrv } from 'app/core/services/backend_srv'; // will use the vers
import { PromOptions } from './types'; import { PromOptions } from './types';
import { FetchResponse } from '@grafana/runtime'; import { FetchResponse } from '@grafana/runtime';
jest.mock('app/features/templating/template_srv', () => {
return {
getAdhocFilters: jest.fn(() => [] as any[]),
replace: jest.fn((a: string) => a),
};
});
jest.mock('@grafana/runtime', () => ({ jest.mock('@grafana/runtime', () => ({
...((jest.requireActual('@grafana/runtime') as unknown) as object), ...((jest.requireActual('@grafana/runtime') as unknown) as object),
getBackendSrv: () => backendSrv, getBackendSrv: () => backendSrv,
@@ -47,6 +40,11 @@ jest.mock('app/features/dashboard/services/TimeSrv', () => ({
}), }),
})); }));
const templateSrvStub = {
getAdhocFilters: jest.fn(() => [] as any[]),
replace: jest.fn((a: string) => a),
} as any;
beforeEach(() => { beforeEach(() => {
jest.clearAllMocks(); jest.clearAllMocks();
}); });
@@ -54,7 +52,7 @@ beforeEach(() => {
describe('PrometheusMetricFindQuery', () => { describe('PrometheusMetricFindQuery', () => {
let ds: PrometheusDatasource; let ds: PrometheusDatasource;
beforeEach(() => { beforeEach(() => {
ds = new PrometheusDatasource(instanceSettings); ds = new PrometheusDatasource(instanceSettings, templateSrvStub);
}); });
const setupMetricFindQuery = (data: any) => { const setupMetricFindQuery = (data: any) => {

View File

@@ -10,7 +10,7 @@ import {
TIME_SERIES_VALUE_FIELD_NAME, TIME_SERIES_VALUE_FIELD_NAME,
} from '@grafana/data'; } from '@grafana/data';
import { FetchResponse } from '@grafana/runtime'; import { FetchResponse } from '@grafana/runtime';
import templateSrv from 'app/features/templating/template_srv'; import { getTemplateSrv } from 'app/features/templating/template_srv';
import { import {
isMatrixData, isMatrixData,
MatrixOrVectorResult, MatrixOrVectorResult,
@@ -231,7 +231,7 @@ function getValueField(
function createLabelInfo(labels: { [key: string]: string }, options: TransformOptions) { function createLabelInfo(labels: { [key: string]: string }, options: TransformOptions) {
if (options?.legendFormat) { if (options?.legendFormat) {
const title = renderTemplate(templateSrv.replace(options.legendFormat, options?.scopedVars), labels); const title = renderTemplate(getTemplateSrv().replace(options.legendFormat, options?.scopedVars), labels);
return { name: title, labels }; return { name: title, labels };
} }

View File

@@ -19,18 +19,20 @@ import {
AnnotationEvent, AnnotationEvent,
} from '@grafana/data'; } from '@grafana/data';
import { Scenario, TestDataQuery } from './types'; import { Scenario, TestDataQuery } from './types';
import { getBackendSrv, toDataQueryError } from '@grafana/runtime'; import { getBackendSrv, toDataQueryError, getTemplateSrv, TemplateSrv } from '@grafana/runtime';
import { queryMetricTree } from './metricTree'; import { queryMetricTree } from './metricTree';
import { from, merge, Observable, of } from 'rxjs'; import { from, merge, Observable, of } from 'rxjs';
import { map } from 'rxjs/operators'; import { map } from 'rxjs/operators';
import { runStream } from './runStreams'; import { runStream } from './runStreams';
import templateSrv from 'app/features/templating/template_srv';
import { getSearchFilterScopedVar } from 'app/features/variables/utils'; import { getSearchFilterScopedVar } from 'app/features/variables/utils';
type TestData = TimeSeries | TableData; type TestData = TimeSeries | TableData;
export class TestDataDataSource extends DataSourceApi<TestDataQuery> { export class TestDataDataSource extends DataSourceApi<TestDataQuery> {
constructor(instanceSettings: DataSourceInstanceSettings) { constructor(
instanceSettings: DataSourceInstanceSettings,
private readonly templateSrv: TemplateSrv = getTemplateSrv()
) {
super(instanceSettings); super(instanceSettings);
} }
@@ -63,7 +65,7 @@ export class TestDataDataSource extends DataSourceApi<TestDataQuery> {
intervalMs: options.intervalMs, intervalMs: options.intervalMs,
maxDataPoints: options.maxDataPoints, maxDataPoints: options.maxDataPoints,
datasourceId: this.id, datasourceId: this.id,
alias: templateSrv.replace(target.alias || '', options.scopedVars), alias: this.templateSrv.replace(target.alias || '', options.scopedVars),
}); });
} }
} }
@@ -173,7 +175,7 @@ export class TestDataDataSource extends DataSourceApi<TestDataQuery> {
metricFindQuery(query: string, options: any) { metricFindQuery(query: string, options: any) {
return new Promise<MetricFindValue[]>((resolve, reject) => { return new Promise<MetricFindValue[]>((resolve, reject) => {
setTimeout(() => { setTimeout(() => {
const interpolatedQuery = templateSrv.replace( const interpolatedQuery = this.templateSrv.replace(
query, query,
getSearchFilterScopedVar({ query, wildcardChar: '*', options }) getSearchFilterScopedVar({ query, wildcardChar: '*', options })
); );

View File

@@ -14,7 +14,7 @@ import {
dateTimeFormatISO, dateTimeFormatISO,
dateTimeFormat, dateTimeFormat,
} from '@grafana/data'; } from '@grafana/data';
import { TemplateSrv } from 'app/features/templating/template_srv'; import { getTemplateSrv, TemplateSrv } from '@grafana/runtime';
import { ColumnRender, TableRenderModel, ColumnStyle } from './types'; import { ColumnRender, TableRenderModel, ColumnStyle } from './types';
import { ColumnOptionsCtrl } from './column_options'; import { ColumnOptionsCtrl } from './column_options';
@@ -27,7 +27,7 @@ export class TableRenderer {
private table: TableRenderModel, private table: TableRenderModel,
private timeZone: TimeZone, private timeZone: TimeZone,
private sanitize: (v: any) => any, private sanitize: (v: any) => any,
private templateSrv: TemplateSrv, private templateSrv: TemplateSrv = getTemplateSrv(),
private theme?: GrafanaThemeType private theme?: GrafanaThemeType
) { ) {
this.initColumns(); this.initColumns();

View File

@@ -1,5 +1,6 @@
import { PluginMeta } from '@grafana/data'; import { PluginMeta } from '@grafana/data';
import { PanelPlugin } from '@grafana/data'; import { PanelPlugin } from '@grafana/data';
import { TemplateSrv } from '@grafana/runtime';
export interface PluginDashboard { export interface PluginDashboard {
dashboardId: number; dashboardId: number;
@@ -34,5 +35,5 @@ export interface VariableQueryProps {
query: any; query: any;
onChange: (query: any, definition: string) => void; onChange: (query: any, definition: string) => void;
datasource: any; datasource: any;
templateSrv: any; templateSrv: TemplateSrv;
} }