IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Prometheus: Bug fix to check default expr is empty string to set legend format as auto (#69255)

Browse Source 
* check default query.expr is empty string to set default legend format

* fix tests with default base query

* fix tests
This commit is contained in:
Brendan O'Handley 2023-05-30 12:25:53 -04:00 committed by GitHub
parent 345b7fadc9
commit 27c18b8c0c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
public/app/plugins/datasource/prometheus/datasource.tsx
View File

@ -1265,12 +1265,7 @@ export class PrometheusDatasource
} }
getDefaultQuery(app: CoreApp): PromQuery { getDefaultQuery(app: CoreApp): PromQuery {
const defaults = { const defaults = promDefaultBaseQuery();
refId: 'A',
expr: '',
range: true,
instant: false,
};
if (app === CoreApp.UnifiedAlerting) { if (app === CoreApp.UnifiedAlerting) {
return { return {
@ -1340,3 +1335,12 @@ export function prometheusRegularEscape(value: any) {
export function prometheusSpecialRegexEscape(value: any) { export function prometheusSpecialRegexEscape(value: any) {
return typeof value === 'string' ? value.replace(/\\/g, '\\\\\\\\').replace(/[$^*{}\[\]\'+?.()|]/g, '\\\\$&') : value; return typeof value === 'string' ? value.replace(/\\/g, '\\\\\\\\').replace(/[$^*{}\[\]\'+?.()|]/g, '\\\\$&') : value;
} }
export function promDefaultBaseQuery(): PromQuery {
return {
refId: 'A',
expr: '',
range: true,
instant: false,
};
}

3
public/app/plugins/datasource/prometheus/querybuilder/components/PromQueryBuilderOptions.test.tsx
View File

@ -5,6 +5,7 @@ import { selectOptionInTest } from 'test/helpers/selectOptionInTest';
import { CoreApp } from '@grafana/data'; import { CoreApp } from '@grafana/data';
import { promDefaultBaseQuery } from '../../datasource';
import { PromQuery } from '../../types'; import { PromQuery } from '../../types';
import { getQueryWithDefaults } from '../state'; import { getQueryWithDefaults } from '../state';
@ -106,7 +107,7 @@ function setup(queryOverrides: Partial<PromQuery> = {}, app: CoreApp = CoreApp.P
const props = { const props = {
app, app,
query: { query: {
...getQueryWithDefaults({ refId: 'A' } as PromQuery, CoreApp.PanelEditor), ...getQueryWithDefaults(promDefaultBaseQuery(), CoreApp.PanelEditor),
...queryOverrides, ...queryOverrides,
}, },
onRunQuery: jest.fn(), onRunQuery: jest.fn(),

12
public/app/plugins/datasource/prometheus/querybuilder/state.test.ts
View File

@ -7,7 +7,7 @@ import { changeEditorMode, getQueryWithDefaults } from './state';
describe('getQueryWithDefaults(', () => { describe('getQueryWithDefaults(', () => {
it('should set defaults', () => { it('should set defaults', () => {
expect(getQueryWithDefaults({ refId: 'A' } as PromQuery, CoreApp.Dashboard)).toEqual({ expect(getQueryWithDefaults({ expr: '', refId: 'A' } as PromQuery, CoreApp.Dashboard)).toEqual({
editorMode: 'builder', editorMode: 'builder',
expr: '', expr: '',
legendFormat: '__auto', legendFormat: '__auto',
@ -17,7 +17,7 @@ describe('getQueryWithDefaults(', () => {
}); });
it('should set both range and instant to true when in Explore', () => { it('should set both range and instant to true when in Explore', () => {
expect(getQueryWithDefaults({ refId: 'A' } as PromQuery, CoreApp.Explore)).toEqual({ expect(getQueryWithDefaults({ expr: '', refId: 'A' } as PromQuery, CoreApp.Explore)).toEqual({
editorMode: 'builder', editorMode: 'builder',
expr: '', expr: '',
legendFormat: '__auto', legendFormat: '__auto',
@ -29,7 +29,7 @@ describe('getQueryWithDefaults(', () => {
it('should not set both instant and range for Prometheus queries in Alert Creation', () => { it('should not set both instant and range for Prometheus queries in Alert Creation', () => {
expect( expect(
getQueryWithDefaults({ refId: 'A', range: true, instant: true } as PromQuery, CoreApp.UnifiedAlerting) getQueryWithDefaults({ expr: '', refId: 'A', range: true, instant: true } as PromQuery, CoreApp.UnifiedAlerting)
).toEqual({ ).toEqual({
editorMode: 'builder', editorMode: 'builder',
expr: '', expr: '',
@ -45,13 +45,15 @@ describe('getQueryWithDefaults(', () => {
expect(query.editorMode).toBe(QueryEditorMode.Code); expect(query.editorMode).toBe(QueryEditorMode.Code);
}); });
expect(getQueryWithDefaults({ refId: 'A' } as PromQuery, CoreApp.Dashboard).editorMode).toEqual( expect(getQueryWithDefaults({ expr: '', refId: 'A' } as PromQuery, CoreApp.Dashboard).editorMode).toEqual(
QueryEditorMode.Code QueryEditorMode.Code
); );
}); });
it('should return default editor mode when it is provided', () => { it('should return default editor mode when it is provided', () => {
expect(getQueryWithDefaults({ refId: 'A' } as PromQuery, CoreApp.Dashboard, QueryEditorMode.Code)).toEqual({ expect(
getQueryWithDefaults({ expr: '', refId: 'A' } as PromQuery, CoreApp.Dashboard, QueryEditorMode.Code)
).toEqual({
editorMode: 'code', editorMode: 'code',
expr: '', expr: '',
legendFormat: '__auto', legendFormat: '__auto',

3
public/app/plugins/datasource/prometheus/querybuilder/state.ts
View File

@ -46,7 +46,8 @@ export function getQueryWithDefaults(
result = { ...query, editorMode: getDefaultEditorMode(query.expr, defaultEditor) }; result = { ...query, editorMode: getDefaultEditorMode(query.expr, defaultEditor) };
} }
if (query.expr == null) { // default query expr is now empty string, set in getDefaultQuery
if (query.expr === '') {
result = { ...result, expr: '', legendFormat: LegendFormatMode.Auto }; result = { ...result, expr: '', legendFormat: LegendFormatMode.Auto };
} }