mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 18:27:59 -04:00
eb0ef19583
* chore(NA): upgrade bazel into v5 * chore(NA): initial work to upgrade to rules v5 * chore(NA): remove @elastic/datemath jest unit test for eslint plugin imports * chore(NA): removed packager tsc_wrapped added my mistake
65 lines
2.7 KiB
TypeScript
65 lines
2.7 KiB
TypeScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0; you may not use this file except in compliance with the Elastic License
|
|
* 2.0.
|
|
*/
|
|
|
|
import { duration, Duration, unitOfTime } from 'moment';
|
|
import dateMath from '@kbn/datemath';
|
|
|
|
type SupportedUnits = unitOfTime.Base;
|
|
|
|
// Assume interval is in the form (value)(unit), such as "1h"
|
|
const INTERVAL_STRING_RE = new RegExp('^([0-9]*)\\s*(' + dateMath.units.join('|') + ')$');
|
|
|
|
// moment.js is only designed to allow fractional values between 0 and 1
|
|
// for units of hour or less.
|
|
const SUPPORT_ZERO_DURATION_UNITS: SupportedUnits[] = ['ms', 's', 'm', 'h'];
|
|
|
|
// List of time units which are supported for use in Elasticsearch durations
|
|
// (such as anomaly detection job bucket spans)
|
|
// See https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#time-units
|
|
const SUPPORT_ES_DURATION_UNITS: SupportedUnits[] = ['ms', 's', 'm', 'h', 'd'];
|
|
|
|
// Parses an interval String, such as 7d, 1h or 30m to a moment duration.
|
|
// Optionally carries out an additional check that the interval is supported as a
|
|
// time unit by Elasticsearch, as units greater than 'd' for example cannot be used
|
|
// for anomaly detection job bucket spans.
|
|
// Differs from the Kibana ui/utils/parse_interval in the following ways:
|
|
// 1. A value-less interval such as 'm' is not allowed - in line with the ML back-end
|
|
// not accepting such interval Strings for the bucket span of a job.
|
|
// 2. Zero length durations 0ms, 0s, 0m and 0h are accepted as-is.
|
|
// Note that when adding or subtracting fractional durations, moment is only designed
|
|
// to work with units less than 'day'.
|
|
// 3. Fractional intervals e.g. 1.5h or 4.5d are not allowed, in line with the behaviour
|
|
// of the Elasticsearch date histogram aggregation.
|
|
export function parseInterval(
|
|
interval: string | number,
|
|
checkValidEsUnit = false
|
|
): Duration | null {
|
|
const matches = String(interval).trim().match(INTERVAL_STRING_RE);
|
|
if (!Array.isArray(matches) || matches.length < 3) {
|
|
return null;
|
|
}
|
|
|
|
try {
|
|
const value = parseInt(matches[1], 10);
|
|
const unit = matches[2] as SupportedUnits;
|
|
|
|
// In line with moment.js, only allow zero value intervals when the unit is less than 'day'.
|
|
// And check for isNaN as e.g. valueless 'm' will pass the regex test,
|
|
// plus an optional check that the unit is not w/M/y which are not fully supported by ES.
|
|
if (
|
|
isNaN(value) ||
|
|
(value < 1 && SUPPORT_ZERO_DURATION_UNITS.indexOf(unit) === -1) ||
|
|
(checkValidEsUnit === true && SUPPORT_ES_DURATION_UNITS.indexOf(unit) === -1)
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
return duration(value, unit);
|
|
} catch (e) {
|
|
return null;
|
|
}
|
|
}
|