Improve datasource getFields

Author: ddelemeny

src/datasource.ts

@@ -57,6 +57,13 @@ export const REF_ID_STARTER_LOG_VOLUME = 'log-volume-';
 
 export type ElasticDatasource = QuickwitDataSource;
 
+type FieldCapsSpec = {
+  aggregatable?: boolean,
+  searchable?: boolean,
+  type?: string[],
+  _range?: TimeRange
+}
+
 export class QuickwitDataSource
   extends DataSourceWithBackend<ElasticsearchQuery, QuickwitOptions>
   implements
@@ -368,21 +375,21 @@ export class QuickwitDataSource
     );
   }
 
-  getFields(aggregatable?: boolean, type?: string[], _range?: TimeRange): Observable<MetricFindValue[]> {
+  getFields(spec: FieldCapsSpec={}): Observable<MetricFindValue[]> {
     // TODO: use the time range.
     return from(this.getResource('_elastic/' + this.index + '/_field_caps')).pipe(
       map((field_capabilities_response: FieldCapabilitiesResponse) => {
         const shouldAddField = (field: any) => {
-          if (aggregatable === undefined) {
-            return true;
+          if (spec.aggregatable !== undefined && field.aggregatable !== spec.aggregatable) {
+            return false
           }
-          if (aggregatable !== undefined && field.aggregatable !== aggregatable) {
-            return false;
+          if (spec.searchable !== undefined && field.searchable !== spec.searchable){
+            return false
           }
-          if (type?.length === 0) {
-            return true;
+          if (spec.type && spec.type.length !== 0 && !(spec.type.includes(field.type) || spec.type.includes(fieldTypeMap[field.type]))) {
+            return false
           }
-          return type?.includes(field.type) || type?.includes(fieldTypeMap[field.type]);
+          return true
         };
         const fieldCapabilities = Object.entries(field_capabilities_response.fields)
           .flatMap(([field_name, field_capabilities]) => {
@@ -412,8 +419,8 @@ export class QuickwitDataSource
   /**
    * Get tag keys for adhoc filters
    */
-  getTagKeys() {
-    return lastValueFrom(this.getFields());
+  getTagKeys(spec?: FieldCapsSpec) {
+    return lastValueFrom(this.getFields(spec));
   }
 
   /**
@@ -562,7 +569,7 @@ export class QuickwitDataSource
     if (query) {
       if (parsedQuery.find === 'fields') {
         parsedQuery.type = this.interpolateLuceneQuery(parsedQuery.type);
-        return lastValueFrom(this.getFields(true, parsedQuery.type, range));
+        return lastValueFrom(this.getFields({aggregatable:true, type:parsedQuery.type, _range:range}));
       }
       if (parsedQuery.find === 'terms') {
         parsedQuery.field = this.interpolateLuceneQuery(parsedQuery.field);

src/hooks/useFields.test.tsx

@@ -11,6 +11,8 @@ import { ElasticsearchQuery, MetricAggregationType, BucketAggregationType } from
 import { useFields } from './useFields';
 import { renderHook } from '@testing-library/react-hooks';
 
+
+
 describe('useFields hook', () => {
   // TODO: If we move the field type to the configuration objects as described in the hook's source
   // we can stop testing for getField to be called with the correct parameters.
@@ -48,39 +50,39 @@ describe('useFields hook', () => {
       { wrapper, initialProps: 'cardinality' }
     );
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, [], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:[], _range:timeRange});
 
     // All other metric aggregations only work on numbers
     rerender('avg');
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, ['number'], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:['number'], _range:timeRange});
 
     //
     // BUCKET AGGREGATIONS
     //
     // Date Histrogram only works on dates
     rerender('date_histogram');
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, ['date'], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:['date'], _range:timeRange});
 
     // Histrogram only works on numbers
     rerender('histogram');
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, ['number'], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:['number'], _range:timeRange});
 
     // Geohash Grid only works on geo_point data
     rerender('geohash_grid');
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, ['geo_point'], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:['geo_point'], _range:timeRange});
 
     // All other bucket aggregation work on any kind of data
     rerender('terms');
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, [], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:[], _range:timeRange});
 
     // top_metrics work on only on numeric data in 7.7
     rerender('top_metrics');
     result.current();
-    expect(getFields).toHaveBeenLastCalledWith(true, ['number'], timeRange);
+    expect(getFields).toHaveBeenLastCalledWith({aggregatable:true, type:['number'], _range:timeRange});
   });
 });

src/hooks/useFields.ts

@@ -62,7 +62,7 @@ export const useFields = (type: AggregationType | string[]) => {
   return async (q?: string) => {
     // _mapping doesn't support filtering, we avoid sending a request everytime q changes
     if (!rawFields) {
-      rawFields = await lastValueFrom(datasource.getFields(true, filter, range));
+      rawFields = await lastValueFrom(datasource.getFields({aggregatable:true, type:filter, _range:range}));
     }
 
     return rawFields.filter(({ text }) => q === undefined || text.includes(q)).map(toSelectableValue);