Merge pull request #186 from quickwit-oss/quick_filter_fix

fix: filters and configurable autocomplete chains

Author: Sh4d1

src/QueryBuilder/elastic.test.ts

@@ -0,0 +1,25 @@
+import { getDataQuery } from './elastic';
+
+describe('getDataQuery', () => {
+  it('uses the requested terms size for autocomplete queries', () => {
+    const query = getDataQuery({ field: 'status', size: 250 }, 'getTerms');
+
+    expect(query.bucketAggs?.[0].settings).toEqual(
+      expect.objectContaining({
+        size: '250',
+        shard_size: '250',
+      })
+    );
+  });
+
+  it('keeps zero as no terms limit', () => {
+    const query = getDataQuery({ field: 'status', size: 0 }, 'getTerms');
+
+    expect(query.bucketAggs?.[0].settings).toEqual(
+      expect.objectContaining({
+        size: '0',
+        shard_size: '0',
+      })
+    );
+  });
+});

src/QueryBuilder/elastic.ts

@@ -58,7 +58,8 @@ export function getDataQuery(queryDef: TermsQuery, refId: string): Elasticsearch
 
   const bucketAggs: BucketAggregation[] = [];
   if (queryDef.field) {
-    bucketAggs.push(getTermsAgg(queryDef.field, 100, 100, orderBy, order))
+    const size = queryDef.size ?? 100;
+    bucketAggs.push(getTermsAgg(queryDef.field, size, size, orderBy, order))
   }
 
   return {

src/configuration/ConfigEditor.tsx

@@ -1,14 +1,20 @@
 import React, { useCallback } from 'react';
-import { DataSourceHttpSettings, Input, InlineField, FieldSet } from '@grafana/ui';
-import { DataSourcePluginOptionsEditorProps, DataSourceSettings } from '@grafana/data';
-import { QuickwitOptions } from '../quickwit';
+import { DataSourceHttpSettings, Input, InlineField, FieldSet, RadioButtonGroup } from '@grafana/ui';
+import { DataSourcePluginOptionsEditorProps, DataSourceSettings, SelectableValue } from '@grafana/data';
+import { FilterAutocompleteChainMode, QuickwitOptions } from '../quickwit';
 import { coerceOptions } from './utils';
 import { Divider } from '../components/Divider';
 import { DataLinks } from './DataLinks';
 import _ from 'lodash';
 
 interface Props extends DataSourcePluginOptionsEditorProps<QuickwitOptions> {}
 
+const filterChainModeOptions: Array<SelectableValue<FilterAutocompleteChainMode>> = [
+  { label: 'No chain', value: 'none' },
+  { label: 'Sample', value: 'sample' },
+  { label: 'Full', value: 'full' },
+];
+
 export const ConfigEditor = (props: Props) => {
   const { options: originalOptions, onOptionsChange } = props;
   const options = coerceOptions(originalOptions);
@@ -103,6 +109,47 @@ export const QuickwitDetails = ({ value, onChange }: DetailsProps) => {
               width={40}
             />
           </InlineField>
+          <InlineField
+            label="Filter autocomplete limit"
+            labelWidth={26}
+            tooltip="Maximum number of values returned for filter autocomplete. Use 0 for no terms limit."
+          >
+            <Input
+              id="quickwit_filter_autocomplete_limit"
+              type="number"
+              min={0}
+              value={value.jsonData.filterAutocompleteLimit}
+              onChange={(event) =>
+                onChange({
+                  ...value,
+                  jsonData: { ...value.jsonData, filterAutocompleteLimit: event.currentTarget.value },
+                })
+              }
+              placeholder="1000"
+              width={40}
+            />
+          </InlineField>
+          <InlineField
+            label="Filter chain mode"
+            labelWidth={26}
+            tooltip="Controls whether earlier filters narrow later autocomplete suggestions. Sample is fast and approximate for field names; Full scans all matching documents and can be slower."
+          >
+            <RadioButtonGroup
+              id="quickwit_filter_autocomplete_chains"
+              options={filterChainModeOptions}
+              value={value.jsonData.filterAutocompleteChainMode}
+              onChange={(mode) =>
+                onChange({
+                  ...value,
+                  jsonData: {
+                    ...value.jsonData,
+                    filterAutocompleteChainMode: mode,
+                    filterAutocompleteUseFilterChains: mode !== 'none',
+                  },
+                })
+              }
+            />
+          </InlineField>
         </FieldSet>
       </div>
     </>

src/configuration/utils.ts

@@ -4,12 +4,19 @@ import { QuickwitOptions } from 'quickwit';
 export const coerceOptions = (
   options: DataSourceSettings<QuickwitOptions, {}>
 ): DataSourceSettings<QuickwitOptions, {}> => {
+  const filterAutocompleteChainMode =
+    options.jsonData.filterAutocompleteChainMode ??
+    (options.jsonData.filterAutocompleteUseFilterChains === false ? 'none' : 'sample');
+
   return {
     ...options,
     jsonData: {
       ...options.jsonData,
       logMessageField: options.jsonData.logMessageField || '',
       logLevelField: options.jsonData.logLevelField || '',
+      filterAutocompleteLimit: options.jsonData.filterAutocompleteLimit ?? '1000',
+      filterAutocompleteChainMode,
+      filterAutocompleteUseFilterChains: filterAutocompleteChainMode !== 'none',
     },
   };
 };