Add dateHistogramInterval utility

src/dev/jest/config.js

@@ -53,7 +53,7 @@ export default {
     '!src/legacy/core_plugins/**/__snapshots__/**/*',
   ],
   moduleNameMapper: {
-    '^plugins/([^\/.]*)/(.*)': '<rootDir>/src/legacy/core_plugins/$1/public/$2',
+    '^plugins/([^\/.]*)(.*)': '<rootDir>/src/legacy/core_plugins/$1/public$2',
     '^ui/(.*)': '<rootDir>/src/legacy/ui/public/$1',
     '^uiExports/(.*)': '<rootDir>/src/dev/jest/mocks/file_mock.js',
     '^test_utils/(.*)': '<rootDir>/src/test_utils/public/$1',

src/legacy/core_plugins/data/common/date_histogram_interval.test.ts

@@ -0,0 +1,50 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { dateHistogramInterval } from './date_histogram_interval';
+
+describe('dateHistogramInterval', () => {
+  it('should return calender_interval key for calendar intervals', () => {
+    expect(dateHistogramInterval('1m')).toEqual({ calendar_interval: '1m' });
+    expect(dateHistogramInterval('1h')).toEqual({ calendar_interval: '1h' });
+    expect(dateHistogramInterval('1d')).toEqual({ calendar_interval: '1d' });
+    expect(dateHistogramInterval('1w')).toEqual({ calendar_interval: '1w' });
+    expect(dateHistogramInterval('1M')).toEqual({ calendar_interval: '1M' });
+    expect(dateHistogramInterval('1y')).toEqual({ calendar_interval: '1y' });
+  });
+
+  it('should return fixed_interval key for fixed intervals', () => {
+    expect(dateHistogramInterval('1ms')).toEqual({ fixed_interval: '1ms' });
+    expect(dateHistogramInterval('42ms')).toEqual({ fixed_interval: '42ms' });
+    expect(dateHistogramInterval('1s')).toEqual({ fixed_interval: '1s' });
+    expect(dateHistogramInterval('42s')).toEqual({ fixed_interval: '42s' });
+    expect(dateHistogramInterval('42m')).toEqual({ fixed_interval: '42m' });
+    expect(dateHistogramInterval('42h')).toEqual({ fixed_interval: '42h' });
+    expect(dateHistogramInterval('42d')).toEqual({ fixed_interval: '42d' });
+  });
+
+  it('should throw an error on invalid intervals', () => {
+    expect(() => dateHistogramInterval('2w')).toThrow();
+    expect(() => dateHistogramInterval('2M')).toThrow();
+    expect(() => dateHistogramInterval('2y')).toThrow();
+    expect(() => dateHistogramInterval('2')).toThrow();
+    expect(() => dateHistogramInterval('y')).toThrow();
+    expect(() => dateHistogramInterval('0.5h')).toThrow();
+  });
+});

src/legacy/core_plugins/data/common/date_histogram_interval.ts

@@ -0,0 +1,49 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { parseEsInterval } from './parse_es_interval';
+
+type Interval = { fixed_interval: string } | { calendar_interval: string };
+
+/**
+ * Checks whether a given Elasticsearch interval is a calendar or fixed interval
+ * and returns an object containing the appropriate date_histogram property for that
+ * interval. So it will return either an object containing the fixed_interval key for
+ * that interval or a calendar_interval. If the specified interval was not a valid Elasticsearch
+ * interval this method will throw an error.
+ *
+ * You can simply spread the returned value of this method into your date_histogram.
+ * @example
+ * const aggregation = {
+ *   date_histogram: {
+ *     field: 'date',
+ *     ...dateHistogramInterval('24h'),
+ *   }
+ * };
+ *
+ * @param interval The interval string to return the appropriate date_histogram key for.
+ */
+export function dateHistogramInterval(interval: string): Interval {
+  const { type } = parseEsInterval(interval);
+  if (type === 'calendar') {
+    return { calendar_interval: interval };
+  } else {
+    return { fixed_interval: interval };
+  }
+}

src/legacy/core_plugins/data/common/index.ts

@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/** @public static code */
+export { dateHistogramInterval } from './date_histogram_interval';
+/** @public static code */
+export {
+  isValidEsInterval,
+  InvalidEsCalendarIntervalError,
+  InvalidEsIntervalFormatError,
+  parseEsInterval,
+  ParsedInterval,
+} from './parse_es_interval';

src/legacy/ui/public/utils/parse_es_interval/index.ts → src/legacy/core_plugins/data/common/parse_es_interval/index.ts

@@ -20,3 +20,4 @@
 export { parseEsInterval, ParsedInterval } from './parse_es_interval';
 export { InvalidEsCalendarIntervalError } from './invalid_es_calendar_interval_error';
 export { InvalidEsIntervalFormatError } from './invalid_es_interval_format_error';
+export { isValidEsInterval } from './is_valid_es_interval';

src/legacy/ui/public/utils/parse_es_interval/invalid_es_calendar_interval_error.ts → src/legacy/core_plugins/data/common/parse_es_interval/invalid_es_calendar_interval_error.ts

@@ -28,7 +28,7 @@ export class InvalidEsCalendarIntervalError extends Error {
     public readonly type: string
   ) {
     super(
-      i18n.translate('common.ui.parseEsInterval.invalidEsCalendarIntervalErrorMessage', {
+      i18n.translate('data.parseEsInterval.invalidEsCalendarIntervalErrorMessage', {
         defaultMessage: 'Invalid calendar interval: {interval}, value must be 1',
         values: { interval },
       })

src/legacy/ui/public/utils/parse_es_interval/invalid_es_interval_format_error.ts → src/legacy/core_plugins/data/common/parse_es_interval/invalid_es_interval_format_error.ts

@@ -22,7 +22,7 @@ import { i18n } from '@kbn/i18n';
 export class InvalidEsIntervalFormatError extends Error {
   constructor(public readonly interval: string) {
     super(
-      i18n.translate('common.ui.parseEsInterval.invalidEsIntervalFormatErrorMessage', {
+      i18n.translate('data.parseEsInterval.invalidEsIntervalFormatErrorMessage', {
         defaultMessage: 'Invalid interval format: {interval}',
         values: { interval },
       })

src/legacy/core_plugins/data/common/parse_es_interval/is_valid_es_interval.ts

@@ -0,0 +1,38 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { parseEsInterval } from './parse_es_interval';
+
+/**
+ * Checks whether a given interval string (e.g. 1w, 24h, ...) is a valid Elasticsearch interval.
+ * Will return false if the interval is not valid in Elasticsearch, otherwise true.
+ * Invalid intervals might be: 2f, since there is no unit 'f'; 2w, since weeks and month intervals
+ * are only allowed with a value of 1, etc.
+ *
+ * @param interval The interval string like 1w, 24h
+ * @returns True if the interval is valid for Elasticsearch
+ */
+export function isValidEsInterval(interval: string): boolean {
+  try {
+    parseEsInterval(interval);
+    return true;
+  } catch {
+    return false;
+  }
+}

src/legacy/core_plugins/data/public/index.ts

@@ -87,3 +87,14 @@ export { ExpressionRenderer, ExpressionRendererProps, ExpressionRunner } from '.
 /** @public types */
 export { IndexPattern, StaticIndexPattern, StaticIndexPatternField, Field } from './index_patterns';
 export { Query } from './query';
+
+/** @public static code */
+export { dateHistogramInterval } from '../common/date_histogram_interval';
+/** @public static code */
+export {
+  isValidEsInterval,
+  InvalidEsCalendarIntervalError,
+  InvalidEsIntervalFormatError,
+  parseEsInterval,
+  ParsedInterval,
+} from '../common/parse_es_interval';

src/legacy/core_plugins/data/public/static.ts

@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/** @public static code */
+export { dateHistogramInterval } from '../common/date_histogram_interval';
+/** @public static code */
+export {
+  isValidEsInterval,
+  InvalidEsCalendarIntervalError,
+  InvalidEsIntervalFormatError,
+  parseEsInterval,
+  ParsedInterval,
+} from '../common/parse_es_interval';

src/legacy/core_plugins/data/server/index.ts

@@ -0,0 +1,30 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/** @public static code */
+export { dateHistogramInterval } from '../common/date_histogram_interval';
+
+/** @public static code */
+export {
+  isValidEsInterval,
+  InvalidEsCalendarIntervalError,
+  InvalidEsIntervalFormatError,
+  parseEsInterval,
+  ParsedInterval,
+} from '../common/parse_es_interval';

src/legacy/ui/public/agg_response/tabify/__tests__/_get_columns.js

@@ -48,7 +48,7 @@ describe('get columns', function () {
     const vis = new Vis(indexPattern, {
       type: 'pie',
       aggs: [
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } }
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } }
       ]
     });
 
@@ -63,10 +63,10 @@ describe('get columns', function () {
     const vis = new Vis(indexPattern, {
       type: 'pie',
       aggs: [
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } }
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } }
       ]
     });
 
@@ -83,12 +83,12 @@ describe('get columns', function () {
     const vis = new Vis(indexPattern, {
       type: 'pie',
       aggs: [
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
         { type: 'avg',            schema: 'metric',   params: { field: 'bytes' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
         { type: 'sum',            schema: 'metric',   params: { field: 'bytes' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } }
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } }
       ]
     });
 
@@ -119,12 +119,12 @@ describe('get columns', function () {
     const vis = new Vis(indexPattern, {
       type: 'histogram',
       aggs: [
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
         { type: 'avg',            schema: 'metric',   params: { field: 'bytes' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } },
         { type: 'sum',            schema: 'metric',   params: { field: 'bytes' } },
-        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp' } }
+        { type: 'date_histogram', schema: 'segment',  params: { field: '@timestamp', interval: '10s' } }
       ]
     });