@grafana/data: Introduce new getTagKeys/getTagValues response interface (#88369)

* @grafana/data: Introduce new getTagKeys/getTagValues response interface

packages/grafana-data/src/types/datasource.ts

@@ -285,12 +285,12 @@ abstract class DataSourceApi<
   /**
    * Get tag keys for adhoc filters
    */
-  getTagKeys?(options?: DataSourceGetTagKeysOptions<TQuery>): Promise<MetricFindValue[]>;
+  getTagKeys?(options?: DataSourceGetTagKeysOptions<TQuery>): Promise<GetTagResponse> | Promise<MetricFindValue[]>;
 
   /**
    * Get tag values for adhoc filters
    */
-  getTagValues?(options: DataSourceGetTagValuesOptions<TQuery>): Promise<MetricFindValue[]>;
+  getTagValues?(options: DataSourceGetTagValuesOptions<TQuery>): Promise<GetTagResponse> | Promise<MetricFindValue[]>;
 
   /**
    * Set after constructor call, as the data source instance is the most common thing to pass around
@@ -713,6 +713,11 @@ export interface HistoryItem<TQuery extends DataQuery = DataQuery> {
   query: TQuery;
 }
 
+export interface GetTagResponse {
+  data: MetricFindValue[];
+  error?: DataQueryError;
+}
+
 abstract class LanguageProvider {
   abstract datasource: DataSourceApi<any, any>;
   abstract request: (url: string, params?: any) => Promise<any>;

public/app/features/variables/adhoc/picker/AdHocFilterKey.tsx

@@ -69,7 +69,8 @@ const fetchFilterKeys = async (
   }
 
   const otherFilters = allFilters.filter((f) => f.key !== currentKey);
-  const metrics = await ds.getTagKeys({ filters: otherFilters });
+  const response = await ds.getTagKeys({ filters: otherFilters });
+  const metrics = Array.isArray(response) ? response : response.data;
   return metrics.map((m) => ({ label: m.text, value: m.text }));
 };
 

public/app/features/variables/adhoc/picker/AdHocFilterValue.tsx

@@ -1,7 +1,7 @@
 import { css } from '@emotion/css';
 import React from 'react';
 
-import { AdHocVariableFilter, DataSourceRef, MetricFindValue, SelectableValue } from '@grafana/data';
+import { AdHocVariableFilter, DataSourceRef, SelectableValue } from '@grafana/data';
 import { SegmentAsync, useStyles2 } from '@grafana/ui';
 import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv';
 
@@ -57,8 +57,9 @@ const fetchFilterValues = async (
   const timeRange = getTimeSrv().timeRange();
   // Filter out the current filter key from the list of all filters
   const otherFilters = allFilters.filter((f) => f.key !== key);
-  const metrics = await ds.getTagValues({ key, filters: otherFilters, timeRange });
-  return metrics.map((m: MetricFindValue) => ({ label: m.text, value: m.text }));
+  const response = await ds.getTagValues({ key, filters: otherFilters, timeRange });
+  const metrics = Array.isArray(response) ? response : response.data;
+  return metrics.map((m) => ({ label: m.text, value: m.text }));
 };
 
 function getStyles() {

public/app/plugins/datasource/tempo/_importedDependencies/components/AdHocFilter/AdHocFilterKey.tsx

@@ -68,7 +68,8 @@ const fetchFilterKeys = async (
   }
 
   const otherFilters = allFilters.filter((f) => f.key !== currentKey);
-  const metrics = await ds.getTagKeys({ filters: otherFilters });
+  const response = await ds.getTagKeys({ filters: otherFilters });
+  const metrics = Array.isArray(response) ? response : response.data;
   return metrics.map((m) => ({ label: m.text, value: m.text }));
 };
 

public/app/plugins/datasource/tempo/_importedDependencies/components/AdHocFilter/AdHocFilterValue.tsx

@@ -1,12 +1,6 @@
 import React from 'react';
 
-import {
-  AdHocVariableFilter,
-  DataSourceRef,
-  MetricFindValue,
-  SelectableValue,
-  getDefaultTimeRange,
-} from '@grafana/data';
+import { AdHocVariableFilter, DataSourceRef, SelectableValue, getDefaultTimeRange } from '@grafana/data';
 // import { getTimeSrv } from 'app/features/dashboard/services/TimeSrv';
 import { getDataSourceSrv } from '@grafana/runtime';
 import { SegmentAsync } from '@grafana/ui';
@@ -63,6 +57,7 @@ const fetchFilterValues = async (
 
   // Filter out the current filter key from the list of all filters
   const otherFilters = allFilters.filter((f) => f.key !== key);
-  const metrics = await ds.getTagValues({ key, filters: otherFilters, timeRange });
-  return metrics.map((m: MetricFindValue) => ({ label: m.text, value: m.text }));
+  const response = await ds.getTagValues({ key, filters: otherFilters, timeRange });
+  const metrics = Array.isArray(response) ? response : response.data;
+  return metrics.map((m) => ({ label: m.text, value: m.text }));
 };