IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-11 16:15:42 -06:00
Code Issues Packages Projects Releases Wiki Activity

Variables: Fix so queryparam option works for scoped variables (#42742)

Browse Source 
* Variables: Fix so queryparam option work for scoped variables

* Chore: update after PR comments
This commit is contained in:
Hugo Häggmark 2021-12-06 12:44:28 +01:00 committed by GitHub
parent 0a4cc54a3b
commit 73b7485630
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 42 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
public/app/features/templating/formatRegistry.ts
View File

@ -3,8 +3,6 @@ import { dateTime, Registry, RegistryItem, textUtil, VariableModel } from '@graf
import { isArray, map, replace } from 'lodash';
import { formatVariableLabel } from '../variables/shared/formatVariable';
import { ALL_VARIABLE_TEXT, ALL_VARIABLE_VALUE } from '../variables/state/types';
import { variableAdapters } from '../variables/adapters';
import { VariableModel as ExtendedVariableModel } from '../variables/types';
export interface FormatOptions {
value: any;
@ -244,15 +242,14 @@ export const formatRegistry = new Registry<FormatRegistryItem>(() => {
description:
'Format variables as URL parameters. Example in multi-variable scenario A + B + C => var-foo=A&var-foo=B&var-foo=C.',
formatter: (options, variable) => {
const { name, type } = variable;
const adapter = variableAdapters.get(type);
const valueForUrl = adapter.getValueForUrl(variable as ExtendedVariableModel);
const { value } = options;
const { name } = variable;
if (Array.isArray(valueForUrl)) {
return valueForUrl.map((v) => formatQueryParameter(name, v)).join('&');
if (Array.isArray(value)) {
return value.map((v) => formatQueryParameter(name, v)).join('&');
}
return formatQueryParameter(name, valueForUrl);
return formatQueryParameter(name, value);
},
},
];

32
public/app/features/templating/template_srv.test.ts
View File

@ -752,29 +752,59 @@ describe('templateSrv', () => {
expect(target).toBe('var-single=value1');
});
it('query variable with single value with queryparam format and scoped vars should return correct queryparam', () => {
const target = _templateSrv.replace(`\${single:queryparam}`, { single: { value: 'value1', text: 'value1' } });
expect(target).toBe('var-single=value1');
});
it('query variable with single value and queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace('${single}', {}, 'queryparam');
expect(target).toBe('var-single=value1');
});
it('query variable with single value and queryparam format and scoped vars should return correct queryparam', () => {
const target = _templateSrv.replace('${single}', { single: { value: 'value1', text: 'value1' } }, 'queryparam');
expect(target).toBe('var-single=value1');
});
it('query variable with multi value with queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace(`\${multi:queryparam}`, {});
expect(target).toBe('var-multi=value1&var-multi=value2');
});
it('query variable with multi value with queryparam format and scoped vars should return correct queryparam', () => {
const target = _templateSrv.replace(`\${multi:queryparam}`, { multi: { value: 'value2', text: 'value2' } });
expect(target).toBe('var-multi=value2');
});
it('query variable with multi value and queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace('${multi}', {}, 'queryparam');
expect(target).toBe('var-multi=value1&var-multi=value2');
});
it('query variable with multi value and queryparam format and scoped vars should return correct queryparam', () => {
const target = _templateSrv.replace('${multi}', { multi: { value: 'value2', text: 'value2' } }, 'queryparam');
expect(target).toBe('var-multi=value2');
});
it('query variable with adhoc value with queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace(`\${adhoc:queryparam}`, {});
expect(target).toBe('var-adhoc=alertstate%7C%3D%7Cfiring&var-adhoc=alertname%7C%3D%7CExampleAlertAlwaysFiring');
});
it('query variable with multi value and queryparam format should return correct queryparam', () => {
it('query variable with adhoc value with queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace(`\${adhoc:queryparam}`, { adhoc: { value: 'value2', text: 'value2' } });
expect(target).toBe('var-adhoc=value2');
});
it('query variable with adhoc value and queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace('${adhoc}', {}, 'queryparam');
expect(target).toBe('var-adhoc=alertstate%7C%3D%7Cfiring&var-adhoc=alertname%7C%3D%7CExampleAlertAlwaysFiring');
});
it('query variable with adhoc value and queryparam format should return correct queryparam', () => {
const target = _templateSrv.replace('${adhoc}', { adhoc: { value: 'value2', text: 'value2' } }, 'queryparam');
expect(target).toBe('var-adhoc=value2');
});
});
});

12
public/app/features/templating/template_srv.ts
View File

@ -7,7 +7,7 @@ import { AdHocVariableFilter, AdHocVariableModel, VariableModel } from '../varia
import { getDataSourceSrv, setTemplateSrv, TemplateSrv as BaseTemplateSrv } from '@grafana/runtime';
import { FormatOptions, formatRegistry, FormatRegistryID } from './formatRegistry';
import { ALL_VARIABLE_TEXT, ALL_VARIABLE_VALUE } from '../variables/state/types';
import { safeStringifyValue } from '../../core/utils/explore';
import { variableAdapters } from '../variables/adapters';
interface FieldAccessorCache {
[key: string]: (obj: any) => any;
@ -115,7 +115,7 @@ export class TemplateSrv implements BaseTemplateSrv {
return filters;
}
formatValue(value: any, format: any, variable: any, text?: string) {
formatValue(value: any, format: any, variable: any, text?: string): string {
// for some scopedVars there is no variable
variable = variable || {};
@ -282,9 +282,9 @@ export class TemplateSrv implements BaseTemplateSrv {
return match;
}
if (isAdHoc(variable)) {
const value = safeStringifyValue(variable.filters);
const text = variable.id;
if (fmt === FormatRegistryID.queryParam || isAdHoc(variable)) {
const value = variableAdapters.get(variable.type).getValueForUrl(variable);
const text = isAdHoc(variable) ? variable.id : variable.current.text;
return this.formatValue(value, fmt, variable, text);
}
@ -301,7 +301,7 @@ export class TemplateSrv implements BaseTemplateSrv {
value = this.getAllValue(variable);
text = ALL_VARIABLE_TEXT;
// skip formatting of custom all values
if (variable.allValue && fmt !== FormatRegistryID.text && fmt !== FormatRegistryID.queryParam) {
if (variable.allValue && fmt !== FormatRegistryID.text) {
return this.replace(value);
}
}