Allow sorting by median (elastic#79839)

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.getvaluebucketpath.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [AggConfig](./kibana-plugin-plugins-data-public.aggconfig.md) &gt; [getValueBucketPath](./kibana-plugin-plugins-data-public.aggconfig.getvaluebucketpath.md)
+
+## AggConfig.getValueBucketPath() method
+
+Returns the bucket path containing the main value the agg will produce (e.g. for sum of bytes it will point to the sum, for median it will point to the 50 percentile in the percentile multi value bucket)
+
+<b>Signature:</b>
+
+```typescript
+getValueBucketPath(): string;
+```
+<b>Returns:</b>
+
+`string`
+

docs/development/plugins/data/public/kibana-plugin-plugins-data-public.aggconfig.md

@@ -47,6 +47,7 @@ export declare class AggConfig
 |  [getResponseAggs()](./kibana-plugin-plugins-data-public.aggconfig.getresponseaggs.md) |  |  |
 |  [getTimeRange()](./kibana-plugin-plugins-data-public.aggconfig.gettimerange.md) |  |  |
 |  [getValue(bucket)](./kibana-plugin-plugins-data-public.aggconfig.getvalue.md) |  |  |
+|  [getValueBucketPath()](./kibana-plugin-plugins-data-public.aggconfig.getvaluebucketpath.md) |  | Returns the bucket path containing the main value the agg will produce (e.g. for sum of bytes it will point to the sum, for median it will point to the 50 percentile in the percentile multi value bucket) |
 |  [isFilterable()](./kibana-plugin-plugins-data-public.aggconfig.isfilterable.md) |  |  |
 |  [makeLabel(percentageMode)](./kibana-plugin-plugins-data-public.aggconfig.makelabel.md) |  |  |
 |  [nextId(list)](./kibana-plugin-plugins-data-public.aggconfig.nextid.md) | <code>static</code> | Calculate the next id based on the ids in this list {<!-- -->array<!-- -->} list - a list of objects with id properties |

src/plugins/data/common/search/aggs/agg_config.ts

@@ -400,6 +400,15 @@ export class AggConfig {
     return this.params.field;
   }
 
+  /**
+   * Returns the bucket path containing the main value the agg will produce
+   * (e.g. for sum of bytes it will point to the sum, for median it will point
+   *  to the 50 percentile in the percentile multi value bucket)
+   */
+  getValueBucketPath() {
+    return this.type.getValueBucketPath(this);
+  }
+
   makeLabel(percentageMode = false) {
     if (this.params.customLabel) {
       return this.params.customLabel;

src/plugins/data/common/search/aggs/agg_type.ts

@@ -60,6 +60,7 @@ export interface AggTypeConfig<
   getSerializedFormat?: (agg: TAggConfig) => SerializedFieldFormat;
   getValue?: (agg: TAggConfig, bucket: any) => any;
   getKey?: (bucket: any, key: any, agg: TAggConfig) => any;
+  getValueBucketPath?: (agg: TAggConfig) => string;
 }
 
 // TODO need to make a more explicit interface for this
@@ -210,6 +211,10 @@ export class AggType<
     return this.params.find((p: TParam) => p.name === name);
   };
 
+  getValueBucketPath = (agg: TAggConfig) => {
+    return agg.id;
+  };
+
   /**
    * Generic AggType Constructor
    *
@@ -233,6 +238,10 @@ export class AggType<
       this.createFilter = config.createFilter;
     }
 
+    if (config.getValueBucketPath) {
+      this.getValueBucketPath = config.getValueBucketPath;
+    }
+
     if (config.params && config.params.length && config.params[0] instanceof BaseParamType) {
       this.params = config.params as TParam[];
     } else {

src/plugins/data/common/search/aggs/buckets/terms.test.ts

@@ -18,6 +18,7 @@
  */
 
 import { AggConfigs } from '../agg_configs';
+import { METRIC_TYPES } from '../metrics';
 import { mockAggTypesRegistry } from '../test_helpers';
 import { BUCKET_TYPES } from './bucket_agg_types';
 
@@ -133,5 +134,49 @@ describe('Terms Agg', () => {
       expect(params.include).toStrictEqual([1.1, 2, 3.33]);
       expect(params.exclude).toStrictEqual([4, 5.555, 6]);
     });
+
+    test('uses correct bucket path for sorting by median', () => {
+      const indexPattern = {
+        id: '1234',
+        title: 'logstash-*',
+        fields: {
+          getByName: () => field,
+          filter: () => [field],
+        },
+      } as any;
+
+      const field = {
+        name: 'field',
+        indexPattern,
+      };
+
+      const aggConfigs = new AggConfigs(
+        indexPattern,
+        [
+          {
+            id: 'test',
+            params: {
+              field: {
+                name: 'string_field',
+                type: 'string',
+              },
+              orderAgg: {
+                type: METRIC_TYPES.MEDIAN,
+                params: {
+                  field: {
+                    name: 'number_field',
+                    type: 'number',
+                  },
+                },
+              },
+            },
+            type: BUCKET_TYPES.TERMS,
+          },
+        ],
+        { typesRegistry: mockAggTypesRegistry() }
+      );
+      const { [BUCKET_TYPES.TERMS]: params } = aggConfigs.aggs[0].toDsl();
+      expect(params.order).toEqual({ 'test-orderAgg.50': 'desc' });
+    });
   });
 });

src/plugins/data/common/search/aggs/buckets/terms.ts

@@ -41,7 +41,6 @@ import {
 export const termsAggFilter = [
   '!top_hits',
   '!percentiles',
-  '!median',
   '!std_dev',
   '!derivative',
   '!moving_avg',
@@ -198,14 +197,14 @@ export const getTermsBucketAgg = () =>
             return;
           }
 
-          const orderAggId = orderAgg.id;
+          const orderAggPath = orderAgg.getValueBucketPath();
 
           if (orderAgg.parentId && aggs) {
             orderAgg = aggs.byId(orderAgg.parentId);
           }
 
           output.subAggs = (output.subAggs || []).concat(orderAgg);
-          order[orderAggId] = dir;
+          order[orderAggPath] = dir;
         },
       },
       {

src/plugins/data/common/search/aggs/metrics/median.test.ts

@@ -63,6 +63,12 @@ describe('AggTypeMetricMedianProvider class', () => {
     expect(dsl.median.percentiles.percents).toEqual([50]);
   });
 
+  it('points to right value within multi metric for value bucket path', () => {
+    expect(aggConfigs.byId(METRIC_TYPES.MEDIAN)!.getValueBucketPath()).toEqual(
+      `${METRIC_TYPES.MEDIAN}.50`
+    );
+  });
+
   it('converts the response', () => {
     const agg = aggConfigs.getResponseAggs()[0];
 

src/plugins/data/common/search/aggs/metrics/median.ts

@@ -42,6 +42,9 @@ export const getMedianMetricAgg = () => {
         values: { field: aggConfig.getFieldDisplayName() },
       });
     },
+    getValueBucketPath(aggConfig) {
+      return `${aggConfig.id}.50`;
+    },
     params: [
       {
         name: 'field',

src/plugins/data/public/public.api.md

@@ -128,6 +128,7 @@ export class AggConfig {
     getTimeRange(): import("../../../public").TimeRange | undefined;
     // (undocumented)
     getValue(bucket: any): any;
+    getValueBucketPath(): string;
     // (undocumented)
     id: string;
     // (undocumented)

src/plugins/vis_default_editor/public/components/controls/order_agg.test.tsx

@@ -106,7 +106,7 @@ describe('OrderAggParamEditor component', () => {
 
     mount(<OrderByParamEditor {...props} />);
 
-    expect(setValue).toHaveBeenCalledWith('agg5');
+    expect(setValue).toHaveBeenCalledWith('agg3');
   });
 
   it('defaults to the _key metric if no agg is compatible', () => {