Hides advanced json for count metric (elastic#74636)

* remove advanced json for count agg * Remove only advanced json from count agg * use Constant from data plugin * add the logic to data plugin * remove json arg from function definition * remove unecessary translations Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
jloleysens · Aug 31, 2020 · 9ddd49a · 9ddd49a
1 parent 5f781dc
commit 9ddd49a
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 34 deletions.
diff --git a/src/plugins/data/common/search/aggs/agg_type.test.ts b/src/plugins/data/common/search/aggs/agg_type.test.ts
@@ -99,6 +99,17 @@ describe('AggType Class', () => {
           expect(aggType.params[1].name).toBe('customLabel');
         });
 
+        test('disables json param', () => {
+          const aggType = new AggType({
+            name: 'name',
+            title: 'title',
+            json: false,
+          });
+
+          expect(aggType.params.length).toBe(1);
+          expect(aggType.params[0].name).toBe('customLabel');
+        });
+
         test('can disable customLabel', () => {
           const aggType = new AggType({
             name: 'smart agg',

diff --git a/src/plugins/data/common/search/aggs/agg_type.ts b/src/plugins/data/common/search/aggs/agg_type.ts
@@ -47,6 +47,7 @@ export interface AggTypeConfig<
   getRequestAggs?: ((aggConfig: TAggConfig) => TAggConfig[]) | (() => TAggConfig[] | void);
   getResponseAggs?: ((aggConfig: TAggConfig) => TAggConfig[]) | (() => TAggConfig[] | void);
   customLabels?: boolean;
+  json?: boolean;
   decorateAggConfig?: () => any;
   postFlightRequest?: (
     resp: any,
@@ -235,13 +236,17 @@ export class AggType<
     if (config.params && config.params.length && config.params[0] instanceof BaseParamType) {
       this.params = config.params as TParam[];
     } else {
-      // always append the raw JSON param
+      // always append the raw JSON param unless it is configured to false
       const params: any[] = config.params ? [...config.params] : [];
-      params.push({
-        name: 'json',
-        type: 'json',
-        advanced: true,
-      });
+
+      if (config.json !== false) {
+        params.push({
+          name: 'json',
+          type: 'json',
+          advanced: true,
+        });
+      }
+
       // always append custom label
 
       if (config.customLabels !== false) {

diff --git a/src/plugins/data/common/search/aggs/metrics/count.ts b/src/plugins/data/common/search/aggs/metrics/count.ts
@@ -28,6 +28,7 @@ export const getCountMetricAgg = () =>
       defaultMessage: 'Count',
     }),
     hasNoDsl: true,
+    json: false,
     makeLabel() {
       return i18n.translate('data.search.aggs.metrics.countLabel', {
         defaultMessage: 'Count',

diff --git a/src/plugins/data/common/search/aggs/metrics/count_fn.test.ts b/src/plugins/data/common/search/aggs/metrics/count_fn.test.ts
@@ -34,26 +34,12 @@ describe('agg_expression_functions', () => {
             "id": undefined,
             "params": Object {
               "customLabel": undefined,
-              "json": undefined,
             },
             "schema": undefined,
             "type": "count",
           },
         }
       `);
     });
-
-    test('correctly parses json string argument', () => {
-      const actual = fn({
-        json: '{ "foo": true }',
-      });
-
-      expect(actual.value.params.json).toEqual({ foo: true });
-      expect(() => {
-        fn({
-          json: '/// intentionally malformed json ///',
-        });
-      }).toThrowErrorMatchingInlineSnapshot(`"Unable to parse json argument string"`);
-    });
   });
 });
diff --git a/src/plugins/data/common/search/aggs/metrics/count_fn.ts b/src/plugins/data/common/search/aggs/metrics/count_fn.ts
@@ -20,7 +20,6 @@
 import { i18n } from '@kbn/i18n';
 import { ExpressionFunctionDefinition } from 'src/plugins/expressions/common';
 import { AggExpressionType, AggExpressionFunctionArgs, METRIC_TYPES } from '../';
-import { getParsedValue } from '../utils/get_parsed_value';
 
 const fnName = 'aggCount';
 
@@ -55,12 +54,6 @@ export const aggCount = (): FunctionDefinition => ({
         defaultMessage: 'Schema to use for this aggregation',
       }),
     },
-    json: {
-      types: ['string'],
-      help: i18n.translate('data.search.aggs.metrics.count.json.help', {
-        defaultMessage: 'Advanced json to include when the agg is sent to Elasticsearch',
-      }),
-    },
     customLabel: {
       types: ['string'],
       help: i18n.translate('data.search.aggs.metrics.count.customLabel.help', {
@@ -78,10 +71,7 @@ export const aggCount = (): FunctionDefinition => ({
         enabled,
         schema,
         type: METRIC_TYPES.COUNT,
-        params: {
-          ...rest,
-          json: getParsedValue(args, 'json'),
-        },
+        params: rest,
       },
     };
   },

diff --git a/src/plugins/vis_default_editor/public/components/agg_params_helper.ts b/src/plugins/vis_default_editor/public/components/agg_params_helper.ts
@@ -26,7 +26,7 @@ import {
   IAggType,
   IndexPattern,
   IndexPatternField,
-} from 'src/plugins/data/public';
+} from '../../../data/public';
 import { filterAggTypes, filterAggTypeFields } from '../agg_filters';
 import { groupAndSortBy, ComboBoxGroupedOptions } from '../utils';
 import { AggTypeState, AggParamsState } from './agg_params_state';

diff --git a/test/functional/apps/visualize/_point_series_options.js b/test/functional/apps/visualize/_point_series_options.js
@@ -24,6 +24,7 @@ export default function ({ getService, getPageObjects }) {
   const retry = getService('retry');
   const kibanaServer = getService('kibanaServer');
   const browser = getService('browser');
+  const testSubjects = getService('testSubjects');
   const PageObjects = getPageObjects([
     'visualize',
     'header',
@@ -148,6 +149,10 @@ export default function ({ getService, getPageObjects }) {
         });
       });
 
+      it('should not show advanced json for count agg', async function () {
+        await testSubjects.missingOrFail('advancedParams-1');
+      });
+
       it('should put secondary axis on the right', async function () {
         const length = await PageObjects.visChart.getRightValueAxes();
         expect(length).to.be(1);

diff --git a/x-pack/plugins/translations/translations/ja-JP.json b/x-pack/plugins/translations/translations/ja-JP.json
@@ -1115,7 +1115,6 @@
     "data.search.aggs.metrics.count.customLabel.help": "このアグリゲーションのカスタムラベルを表します",
     "data.search.aggs.metrics.count.enabled.help": "このアグリゲーションが有効かどうかを指定します",
     "data.search.aggs.metrics.count.id.help": "このアグリゲーションのID",
-    "data.search.aggs.metrics.count.json.help": "アグリゲーションがElasticsearchに送信されるときに含める高度なJSON",
     "data.search.aggs.metrics.count.schema.help": "このアグリゲーションで使用するスキーマ",
     "data.search.aggs.metrics.countLabel": "カウント",
     "data.search.aggs.metrics.countTitle": "カウント",

diff --git a/x-pack/plugins/translations/translations/zh-CN.json b/x-pack/plugins/translations/translations/zh-CN.json
@@ -1116,7 +1116,6 @@
     "data.search.aggs.metrics.count.customLabel.help": "表示此聚合的定制标签",
     "data.search.aggs.metrics.count.enabled.help": "指定是否启用此聚合",
     "data.search.aggs.metrics.count.id.help": "此聚合的 ID",
-    "data.search.aggs.metrics.count.json.help": "聚合发送至 Elasticsearch 时要包括的高级 json",
     "data.search.aggs.metrics.count.schema.help": "要用于此聚合的方案",
     "data.search.aggs.metrics.countLabel": "计数",
     "data.search.aggs.metrics.countTitle": "计数",