grafana/public/app/features/search/service/utils.ts
Josh Hunt 0c36b247af
Chore: Refactor Search/Folder view types into DashboardViewItem (#63162)
* Chore: Refactor Search/Folder view types into DashboardViewItem

* uid is not optional in api

* rename queryResultToNestedFolderItem function

* Fix error from locationInfo being empty

* change queryResultToViewItem to take view instead

* Fix sortMeta fields not showing on search cards

* Show correct parent for panel search results
2023-02-23 15:52:54 +00:00

91 lines
2.4 KiB
TypeScript

import { DataFrameView, IconName } from '@grafana/data';
import { getDashboardSrv } from 'app/features/dashboard/services/DashboardSrv';
import { DashboardViewItem } from '../types';
import { DashboardQueryResult, SearchQuery, SearchResultMeta } from './types';
/** prepare the query replacing folder:current */
export async function replaceCurrentFolderQuery(query: SearchQuery): Promise<SearchQuery> {
if (query.query && query.query.indexOf('folder:current') >= 0) {
query = {
...query,
location: await getCurrentFolderUID(),
query: query.query.replace('folder:current', '').trim(),
};
if (!query.query?.length) {
query.query = '*';
}
}
return Promise.resolve(query);
}
async function getCurrentFolderUID(): Promise<string | undefined> {
try {
let dash = getDashboardSrv().getCurrent();
if (!dash) {
await delay(500); // may not be loaded yet
dash = getDashboardSrv().getCurrent();
}
return Promise.resolve(dash?.meta?.folderUid);
} catch (e) {
console.error(e);
}
return undefined;
}
function delay(ms: number) {
return new Promise((resolve) => setTimeout(resolve, ms));
}
export function getIconForKind(kind: string): IconName {
if (kind === 'dashboard') {
return 'apps';
}
if (kind === 'folder') {
return 'folder';
}
return 'question-circle';
}
export function queryResultToViewItem(
item: DashboardQueryResult,
view?: DataFrameView<DashboardQueryResult>,
index = -1
): DashboardViewItem {
const meta = view?.dataFrame.meta?.custom as SearchResultMeta | undefined;
const viewItem: DashboardViewItem = {
kind: 'dashboard',
uid: item.uid,
title: item.name,
url: item.url,
tags: item.tags ?? [],
};
// Set enterprise sort value property
const sortFieldName = meta?.sortBy;
if (sortFieldName) {
console.log('have sortFieldName', sortFieldName);
const sortFieldValue = item[sortFieldName];
if (typeof sortFieldValue === 'string' || typeof sortFieldValue === 'number') {
viewItem.sortMetaName = sortFieldName;
viewItem.sortMeta = sortFieldValue;
}
}
if (item.location) {
const ancestors = item.location.split('/');
const parentUid = ancestors[ancestors.length - 1];
const parentInfo = meta?.locationInfo[parentUid];
if (parentInfo) {
viewItem.parentTitle = parentInfo.name;
viewItem.parentKind = parentInfo.kind;
}
}
return viewItem;
}