mirror of https://github.com/grafana/grafana
Query History: Implement RemoteStorage methods: get all, add new (#48330)
* Load Rich History when the container is opened * Store rich history for each pane separately * Do not update currently opened query history when an item is added It's impossible to figure out if the item should be added or not, because filters are applied in the backend. We don't want to replicate that filtering logic in frontend. One way to make it work could be by refreshing both panes. * Test starring and deleting query history items when both panes are open * Remove e2e dependency on ExploreId * Fix unit test * Assert exact queries * Simplify test * Fix e2e tests * Fix toolbar a11y * Reload the history after an item is added * Fix unit test * Remove references to Explore from generic PageToolbar component * Update test name * Fix test assertion * Add issue item to TODO * Improve test assertion * Simplify test setup * Move query history settings to persistence layer * Fix test import * Fix unit test * Fix unit test * Test local storage settings API * Code formatting * Fix linting errors * Add an integration test * Add missing aria role * Fix a11y issues * Fix a11y issues * Use divs instead of ul/li Otherwis,e pa11y-ci reports the error below claiming there are no children with role=tab: Certain ARIA roles must contain particular children (https://dequeuniversity.com/rules/axe/4.3/aria-required-children?application=axeAPI) (#reactRoot > div > main > div:nth-child(3) > div > div:nth-child(1) > div > div:nth-child(1) > div > div > nav > div:nth-child(2) > ul) <ul class="css-af3vye" role="tablist"><li class="css-1ciwanz"><a href...</ul> * Clean up settings tab * Remove redundant aria label * Remove redundant container * Clean up test assertions * Move filtering to persistence layer * Move filtering to persistence layer * Simplify applying filters * Split applying filters and reloading the history * Debounce updating filters * Update tests * Fix waiting for debounced results * Clear results when switching tabs * Improve test coverage * Update docs * Revert extra handling for uid (will be added when we introduce remote storage) * Create basic plan * Rename query history toggle * Add list of supported features and add ds name to RichHistoryQuery object * Clean up Removed planned items will be addressed in upcoming prs (filtering and pagination) * Handle data source filters * Simplify DTO conversion * Clean up * Fix betterer conflicts * Fix imports * Fix imports * Post-merge fixes * Use config instead of a feature flag * Use config instead of a feature flag * Update converter tests * Add tests for RichHistoryRemoteStorage * Simplify test setup * Simplify assertion * Add e2e test for query history * Remove duplicated entry * Fix unit tests * Improve readability * Remove unnecessary casting * Mock backend in integration tests * Remove unnecessary casting * Fix integration test * Update betterer results * Fix unit tests * Simplify testing with DataSourceSrv * Fix sorting and add to/from filtering * Simplify testing DataSourceSettings * Update betterer results * Ensure previous request is canceled when getting search results * Add loading message when results are being loaded * Show info message only if local storage is enabled * Fix unit test * Reuse sort order options * Reuse sort order options * Fix footer spacingpull/49071/head
Piotr Jamróz
3 years ago
committed by
GitHub
parent
9a0f2ec449
commit
f252e89339
@ -0,0 +1,84 @@ |
|||||||
|
import { of } from 'rxjs'; |
||||||
|
|
||||||
|
import { DatasourceSrv } from '../../features/plugins/datasource_srv'; |
||||||
|
import { RichHistoryQuery } from '../../types'; |
||||||
|
import { SortOrder } from '../utils/richHistoryTypes'; |
||||||
|
|
||||||
|
import RichHistoryRemoteStorage, { RichHistoryRemoteStorageDTO } from './RichHistoryRemoteStorage'; |
||||||
|
|
||||||
|
const dsMock = new DatasourceSrv(); |
||||||
|
dsMock.init( |
||||||
|
{ |
||||||
|
// @ts-ignore
|
||||||
|
'name-of-ds1': { uid: 'ds1', name: 'name-of-ds1' }, |
||||||
|
// @ts-ignore
|
||||||
|
'name-of-ds2': { uid: 'ds2', name: 'name-of-ds2' }, |
||||||
|
}, |
||||||
|
'' |
||||||
|
); |
||||||
|
|
||||||
|
const fetchMock = jest.fn(); |
||||||
|
jest.mock('@grafana/runtime', () => ({ |
||||||
|
...jest.requireActual('@grafana/runtime'), |
||||||
|
getBackendSrv: () => ({ |
||||||
|
fetch: fetchMock, |
||||||
|
}), |
||||||
|
getDataSourceSrv: () => dsMock, |
||||||
|
})); |
||||||
|
|
||||||
|
describe('RichHistoryRemoteStorage', () => { |
||||||
|
let storage: RichHistoryRemoteStorage; |
||||||
|
|
||||||
|
beforeEach(() => { |
||||||
|
fetchMock.mockReset(); |
||||||
|
storage = new RichHistoryRemoteStorage(); |
||||||
|
}); |
||||||
|
|
||||||
|
it('returns list of query history items', async () => { |
||||||
|
const expectedViewModel: RichHistoryQuery<any> = { |
||||||
|
id: '123', |
||||||
|
createdAt: 200 * 1000, |
||||||
|
datasourceUid: 'ds1', |
||||||
|
datasourceName: 'name-of-ds1', |
||||||
|
starred: true, |
||||||
|
comment: 'comment', |
||||||
|
queries: [{ foo: 'bar ' }], |
||||||
|
}; |
||||||
|
const returnedDTOs: RichHistoryRemoteStorageDTO[] = [ |
||||||
|
{ |
||||||
|
uid: expectedViewModel.id, |
||||||
|
createdAt: expectedViewModel.createdAt / 1000, |
||||||
|
datasourceUid: expectedViewModel.datasourceUid, |
||||||
|
starred: expectedViewModel.starred, |
||||||
|
comment: expectedViewModel.comment, |
||||||
|
queries: expectedViewModel.queries, |
||||||
|
}, |
||||||
|
]; |
||||||
|
fetchMock.mockReturnValue( |
||||||
|
of({ |
||||||
|
data: { |
||||||
|
result: { |
||||||
|
queryHistory: returnedDTOs, |
||||||
|
}, |
||||||
|
}, |
||||||
|
}) |
||||||
|
); |
||||||
|
const search = 'foo'; |
||||||
|
const datasourceFilters = ['name-of-ds1', 'name-of-ds2']; |
||||||
|
const sortOrder = SortOrder.Descending; |
||||||
|
const starred = true; |
||||||
|
const from = 100; |
||||||
|
const to = 200; |
||||||
|
const expectedLimit = 100; |
||||||
|
const expectedPage = 1; |
||||||
|
|
||||||
|
const items = await storage.getRichHistory({ search, datasourceFilters, sortOrder, starred, to, from }); |
||||||
|
|
||||||
|
expect(fetchMock).toBeCalledWith({ |
||||||
|
method: 'GET', |
||||||
|
url: `/api/query-history?datasourceUid=ds1&datasourceUid=ds2&searchString=${search}&sort=time-desc&to=now-${from}d&from=now-${to}d&limit=${expectedLimit}&page=${expectedPage}&onlyStarred=${starred}`, |
||||||
|
requestId: 'query-history-get-all', |
||||||
|
}); |
||||||
|
expect(items).toMatchObject([expectedViewModel]); |
||||||
|
}); |
||||||
|
}); |
||||||
@ -0,0 +1,107 @@ |
|||||||
|
import { lastValueFrom } from 'rxjs'; |
||||||
|
|
||||||
|
import { getBackendSrv, getDataSourceSrv } from '@grafana/runtime'; |
||||||
|
import { RichHistoryQuery } from 'app/types/explore'; |
||||||
|
|
||||||
|
import { DataQuery } from '../../../../packages/grafana-data'; |
||||||
|
import { RichHistorySearchFilters, RichHistorySettings, SortOrder } from '../utils/richHistoryTypes'; |
||||||
|
|
||||||
|
import RichHistoryStorage, { RichHistoryStorageWarningDetails } from './RichHistoryStorage'; |
||||||
|
import { fromDTO } from './remoteStorageConverter'; |
||||||
|
|
||||||
|
export type RichHistoryRemoteStorageDTO = { |
||||||
|
uid: string; |
||||||
|
createdAt: number; |
||||||
|
datasourceUid: string; |
||||||
|
starred: boolean; |
||||||
|
comment: string; |
||||||
|
queries: DataQuery[]; |
||||||
|
}; |
||||||
|
|
||||||
|
type RichHistoryRemoteStorageResultsPayloadDTO = { |
||||||
|
result: { |
||||||
|
queryHistory: RichHistoryRemoteStorageDTO[]; |
||||||
|
}; |
||||||
|
}; |
||||||
|
|
||||||
|
export default class RichHistoryRemoteStorage implements RichHistoryStorage { |
||||||
|
async addToRichHistory( |
||||||
|
newRichHistoryQuery: Omit<RichHistoryQuery, 'id' | 'createdAt'> |
||||||
|
): Promise<{ warning?: RichHistoryStorageWarningDetails; richHistoryQuery: RichHistoryQuery }> { |
||||||
|
const { result } = await getBackendSrv().post(`/api/query-history`, { |
||||||
|
dataSourceUid: newRichHistoryQuery.datasourceUid, |
||||||
|
queries: newRichHistoryQuery.queries, |
||||||
|
}); |
||||||
|
return { |
||||||
|
richHistoryQuery: fromDTO(result), |
||||||
|
}; |
||||||
|
} |
||||||
|
|
||||||
|
async deleteAll(): Promise<void> { |
||||||
|
throw new Error('not supported'); |
||||||
|
} |
||||||
|
|
||||||
|
async deleteRichHistory(id: string): Promise<void> { |
||||||
|
throw new Error('not supported yet'); |
||||||
|
} |
||||||
|
|
||||||
|
async getRichHistory(filters: RichHistorySearchFilters): Promise<RichHistoryQuery[]> { |
||||||
|
const params = buildQueryParams(filters); |
||||||
|
const queryHistory = await lastValueFrom( |
||||||
|
getBackendSrv().fetch({ |
||||||
|
method: 'GET', |
||||||
|
url: `/api/query-history?${params}`, |
||||||
|
// to ensure any previous requests are cancelled
|
||||||
|
requestId: 'query-history-get-all', |
||||||
|
}) |
||||||
|
); |
||||||
|
return ((queryHistory.data as RichHistoryRemoteStorageResultsPayloadDTO).result.queryHistory || []).map(fromDTO); |
||||||
|
} |
||||||
|
|
||||||
|
async getSettings(): Promise<RichHistorySettings> { |
||||||
|
return { |
||||||
|
activeDatasourceOnly: false, |
||||||
|
lastUsedDatasourceFilters: undefined, |
||||||
|
retentionPeriod: 14, |
||||||
|
starredTabAsFirstTab: false, |
||||||
|
}; |
||||||
|
} |
||||||
|
|
||||||
|
async updateComment(id: string, comment: string | undefined): Promise<RichHistoryQuery> { |
||||||
|
throw new Error('not supported yet'); |
||||||
|
} |
||||||
|
|
||||||
|
async updateSettings(settings: RichHistorySettings): Promise<void> { |
||||||
|
throw new Error('not supported yet'); |
||||||
|
} |
||||||
|
|
||||||
|
async updateStarred(id: string, starred: boolean): Promise<RichHistoryQuery> { |
||||||
|
throw new Error('not supported yet'); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
function buildQueryParams(filters: RichHistorySearchFilters): string { |
||||||
|
let params = `${filters.datasourceFilters |
||||||
|
.map((datasourceName) => { |
||||||
|
const uid = getDataSourceSrv().getInstanceSettings(datasourceName)!.uid; |
||||||
|
return `datasourceUid=${encodeURIComponent(uid)}`; |
||||||
|
}) |
||||||
|
.join('&')}`;
|
||||||
|
if (filters.search) { |
||||||
|
params = params + `&searchString=${filters.search}`; |
||||||
|
} |
||||||
|
if (filters.sortOrder) { |
||||||
|
params = params + `&sort=${filters.sortOrder === SortOrder.Ascending ? 'time-asc' : 'time-desc'}`; |
||||||
|
} |
||||||
|
const relativeFrom = filters.from === 0 ? 'now' : `now-${filters.from}d`; |
||||||
|
const relativeTo = filters.to === 0 ? 'now' : `now-${filters.to}d`; |
||||||
|
// TODO: Unify: remote storage from/to params are swapped comparing to frontend and local storage filters
|
||||||
|
params = params + `&to=${relativeFrom}`; |
||||||
|
params = params + `&from=${relativeTo}`; |
||||||
|
params = params + `&limit=100`; |
||||||
|
params = params + `&page=1`; |
||||||
|
if (filters.starred) { |
||||||
|
params = params + `&onlyStarred=${filters.starred}`; |
||||||
|
} |
||||||
|
return params; |
||||||
|
} |
||||||
@ -0,0 +1,46 @@ |
|||||||
|
import { DatasourceSrv } from '../../features/plugins/datasource_srv'; |
||||||
|
import { RichHistoryQuery } from '../../types'; |
||||||
|
import { backendSrv } from '../services/backend_srv'; |
||||||
|
|
||||||
|
import { RichHistoryRemoteStorageDTO } from './RichHistoryRemoteStorage'; |
||||||
|
import { fromDTO } from './remoteStorageConverter'; |
||||||
|
|
||||||
|
const dsMock = new DatasourceSrv(); |
||||||
|
dsMock.init( |
||||||
|
{ |
||||||
|
// @ts-ignore
|
||||||
|
'name-of-dev-test': { uid: 'dev-test', name: 'name-of-dev-test' }, |
||||||
|
}, |
||||||
|
'' |
||||||
|
); |
||||||
|
|
||||||
|
jest.mock('@grafana/runtime', () => ({ |
||||||
|
...jest.requireActual('@grafana/runtime'), |
||||||
|
getBackendSrv: () => backendSrv, |
||||||
|
getDataSourceSrv: () => dsMock, |
||||||
|
})); |
||||||
|
|
||||||
|
const validRichHistory: RichHistoryQuery = { |
||||||
|
comment: 'comment', |
||||||
|
createdAt: 1000, |
||||||
|
datasourceName: 'name-of-dev-test', |
||||||
|
datasourceUid: 'dev-test', |
||||||
|
id: 'ID', |
||||||
|
queries: [{ refId: 'A' }], |
||||||
|
starred: true, |
||||||
|
}; |
||||||
|
|
||||||
|
const validDTO: RichHistoryRemoteStorageDTO = { |
||||||
|
comment: 'comment', |
||||||
|
datasourceUid: 'dev-test', |
||||||
|
queries: [{ refId: 'A' }], |
||||||
|
starred: true, |
||||||
|
uid: 'ID', |
||||||
|
createdAt: 1, |
||||||
|
}; |
||||||
|
|
||||||
|
describe('RemoteStorage converter', () => { |
||||||
|
it('converts DTO to RichHistoryQuery', () => { |
||||||
|
expect(fromDTO(validDTO)).toMatchObject(validRichHistory); |
||||||
|
}); |
||||||
|
}); |
||||||
@ -0,0 +1,19 @@ |
|||||||
|
import { getDataSourceSrv } from '@grafana/runtime'; |
||||||
|
|
||||||
|
import { RichHistoryQuery } from '../../types'; |
||||||
|
|
||||||
|
import { RichHistoryRemoteStorageDTO } from './RichHistoryRemoteStorage'; |
||||||
|
|
||||||
|
export const fromDTO = (dto: RichHistoryRemoteStorageDTO): RichHistoryQuery => { |
||||||
|
const datasource = getDataSourceSrv().getInstanceSettings({ uid: dto.datasourceUid }); |
||||||
|
|
||||||
|
return { |
||||||
|
id: dto.uid, |
||||||
|
createdAt: dto.createdAt * 1000, |
||||||
|
datasourceName: datasource?.name || '', // will be show on the list as coming from a removed data source
|
||||||
|
datasourceUid: dto.datasourceUid, |
||||||
|
starred: dto.starred, |
||||||
|
comment: dto.comment, |
||||||
|
queries: dto.queries, |
||||||
|
}; |
||||||
|
}; |
||||||
@ -1,8 +1,31 @@ |
|||||||
|
import { config } from '@grafana/runtime'; |
||||||
|
|
||||||
|
import { SortOrder } from '../utils/richHistoryTypes'; |
||||||
|
|
||||||
import RichHistoryLocalStorage from './RichHistoryLocalStorage'; |
import RichHistoryLocalStorage from './RichHistoryLocalStorage'; |
||||||
|
import RichHistoryRemoteStorage from './RichHistoryRemoteStorage'; |
||||||
import RichHistoryStorage from './RichHistoryStorage'; |
import RichHistoryStorage from './RichHistoryStorage'; |
||||||
|
|
||||||
const richHistoryLocalStorage = new RichHistoryLocalStorage(); |
const richHistoryLocalStorage = new RichHistoryLocalStorage(); |
||||||
|
const richHistoryRemoteStorage = new RichHistoryRemoteStorage(); |
||||||
|
|
||||||
export const getRichHistoryStorage = (): RichHistoryStorage => { |
export const getRichHistoryStorage = (): RichHistoryStorage => { |
||||||
return richHistoryLocalStorage; |
return config.queryHistoryEnabled ? richHistoryRemoteStorage : richHistoryLocalStorage; |
||||||
|
}; |
||||||
|
|
||||||
|
interface RichHistorySupportedFeatures { |
||||||
|
availableFilters: SortOrder[]; |
||||||
|
lastUsedDataSourcesAvailable: boolean; |
||||||
|
} |
||||||
|
|
||||||
|
export const supportedFeatures = (): RichHistorySupportedFeatures => { |
||||||
|
return config.queryHistoryEnabled |
||||||
|
? { |
||||||
|
availableFilters: [SortOrder.Descending, SortOrder.Ascending], |
||||||
|
lastUsedDataSourcesAvailable: false, |
||||||
|
} |
||||||
|
: { |
||||||
|
availableFilters: [SortOrder.Descending, SortOrder.Ascending, SortOrder.DatasourceAZ, SortOrder.DatasourceZA], |
||||||
|
lastUsedDataSourcesAvailable: true, |
||||||
|
}; |
||||||
}; |
}; |
||||||
|
|||||||
Loading…
Reference in new issue