Commit 75e14aa1 by Zoltán Bedi Committed by GitHub

Chore: Let kbn util infer types (#26907)

* Chore: Let kbn util infer types

Type fixes where needed

* Address review comments + test fix

* Modify kbn method and property names to pascalCase
parent 6b1b52b7
...@@ -43,7 +43,7 @@ export interface QueryResultMeta { ...@@ -43,7 +43,7 @@ export interface QueryResultMeta {
* Legacy data source specific, should be moved to custom * Legacy data source specific, should be moved to custom
* */ * */
gmdMeta?: any[]; // used by cloudwatch gmdMeta?: any[]; // used by cloudwatch
alignmentPeriod?: string; // used by cloud monitoring alignmentPeriod?: number; // used by cloud monitoring
searchWords?: string[]; // used by log models and loki searchWords?: string[]; // used by log models and loki
limit?: number; // used by log models and loki limit?: number; // used by log models and loki
json?: boolean; // used to keep track of old json doc values json?: boolean; // used to keep track of old json doc values
......
...@@ -32,7 +32,7 @@ export interface ValueFormatCategory { ...@@ -32,7 +32,7 @@ export interface ValueFormatCategory {
formats: ValueFormat[]; formats: ValueFormat[];
} }
interface ValueFormatterIndex { export interface ValueFormatterIndex {
[id: string]: ValueFormatter; [id: string]: ValueFormatter;
} }
......
...@@ -14,7 +14,7 @@ function tip($compile: any) { ...@@ -14,7 +14,7 @@ function tip($compile: any) {
'<i class="grafana-tip fa fa-' + '<i class="grafana-tip fa fa-' +
(attrs.icon || 'question-circle') + (attrs.icon || 'question-circle') +
'" bs-tooltip="\'' + '" bs-tooltip="\'' +
kbn.addslashes(elem.text()) + kbn.addSlashes(elem.text()) +
'\'"></i>'; '\'"></i>';
_t = _t.replace(/{/g, '\\{').replace(/}/g, '\\}'); _t = _t.replace(/{/g, '\\{').replace(/}/g, '\\}');
elem.replaceWith($compile(angular.element(_t))(scope)); elem.replaceWith($compile(angular.element(_t))(scope));
......
...@@ -61,7 +61,7 @@ export class ContextSrv { ...@@ -61,7 +61,7 @@ export class ContextSrv {
if (!config.minRefreshInterval) { if (!config.minRefreshInterval) {
return true; return true;
} }
return kbn.interval_to_ms(interval) >= kbn.interval_to_ms(config.minRefreshInterval); return kbn.intervalToMs(interval) >= kbn.intervalToMs(config.minRefreshInterval);
} }
getValidInterval(interval: string) { getValidInterval(interval: string) {
......
...@@ -53,7 +53,7 @@ describe('Chcek KBN value formats', () => { ...@@ -53,7 +53,7 @@ describe('Chcek KBN value formats', () => {
describe('describe_interval', () => { describe('describe_interval', () => {
it('falls back to seconds if input is a number', () => { it('falls back to seconds if input is a number', () => {
expect(kbn.describe_interval('123')).toEqual({ expect(kbn.describeInterval('123')).toEqual({
sec: 1, sec: 1,
type: 's', type: 's',
count: 123, count: 123,
...@@ -61,7 +61,7 @@ describe('describe_interval', () => { ...@@ -61,7 +61,7 @@ describe('describe_interval', () => {
}); });
it('parses a valid time unt string correctly', () => { it('parses a valid time unt string correctly', () => {
expect(kbn.describe_interval('123h')).toEqual({ expect(kbn.describeInterval('123h')).toEqual({
sec: 3600, sec: 3600,
type: 'h', type: 'h',
count: 123, count: 123,
...@@ -69,7 +69,7 @@ describe('describe_interval', () => { ...@@ -69,7 +69,7 @@ describe('describe_interval', () => {
}); });
it('fails if input is invalid', () => { it('fails if input is invalid', () => {
expect(() => kbn.describe_interval('123xyz')).toThrow(); expect(() => kbn.describeInterval('123xyz')).toThrow();
expect(() => kbn.describe_interval('xyz')).toThrow(); expect(() => kbn.describeInterval('xyz')).toThrow();
}); });
}); });
...@@ -253,7 +253,7 @@ export class AlertTabCtrl { ...@@ -253,7 +253,7 @@ export class AlertTabCtrl {
this.frequencyWarning = ''; this.frequencyWarning = '';
try { try {
const frequencySecs = kbn.interval_to_seconds(this.alert.frequency); const frequencySecs = kbn.intervalToSeconds(this.alert.frequency);
if (frequencySecs < this.alertingMinIntervalSecs) { if (frequencySecs < this.alertingMinIntervalSecs) {
this.frequencyWarning = this.frequencyWarning =
'A minimum evaluation interval of ' + 'A minimum evaluation interval of ' +
......
...@@ -37,7 +37,7 @@ const timeRangeValidationEvents: ValidationEvents = { ...@@ -37,7 +37,7 @@ const timeRangeValidationEvents: ValidationEvents = {
return true; return true;
} }
try { try {
kbn.interval_to_seconds(value); kbn.intervalToSeconds(value);
return true; return true;
} catch { } catch {
return false; return false;
...@@ -125,7 +125,7 @@ export class ApiKeysPage extends PureComponent<Props, any> { ...@@ -125,7 +125,7 @@ export class ApiKeysPage extends PureComponent<Props, any> {
// make sure that secondsToLive is number or null // make sure that secondsToLive is number or null
const secondsToLive = this.state.newApiKey['secondsToLive']; const secondsToLive = this.state.newApiKey['secondsToLive'];
this.state.newApiKey['secondsToLive'] = secondsToLive ? kbn.interval_to_seconds(secondsToLive) : null; this.state.newApiKey['secondsToLive'] = secondsToLive ? kbn.intervalToSeconds(secondsToLive) : null;
this.props.addApiKey(this.state.newApiKey, openModal, this.props.includeExpired); this.props.addApiKey(this.state.newApiKey, openModal, this.props.includeExpired);
this.setState((prevState: State) => { this.setState((prevState: State) => {
return { return {
......
...@@ -39,7 +39,7 @@ export class TimePickerSettings extends PureComponent<Props, State> { ...@@ -39,7 +39,7 @@ export class TimePickerSettings extends PureComponent<Props, State> {
if (config.minRefreshInterval) { if (config.minRefreshInterval) {
intervals = intervals.filter(rate => { intervals = intervals.filter(rate => {
return kbn.interval_to_ms(rate) >= kbn.interval_to_ms(config.minRefreshInterval); return kbn.intervalToMs(rate) >= kbn.intervalToMs(config.minRefreshInterval);
}); });
} }
......
...@@ -115,7 +115,7 @@ export class TimeSrv { ...@@ -115,7 +115,7 @@ export class TimeSrv {
// when time window specified in ms // when time window specified in ms
timeWindowMs = parseInt(timeWindow, 10); timeWindowMs = parseInt(timeWindow, 10);
} else { } else {
timeWindowMs = kbn.interval_to_ms(timeWindow); timeWindowMs = kbn.intervalToMs(timeWindow);
} }
return { return {
...@@ -181,7 +181,7 @@ export class TimeSrv { ...@@ -181,7 +181,7 @@ export class TimeSrv {
if (interval) { if (interval) {
const validInterval = this.contextSrv.getValidInterval(interval); const validInterval = this.contextSrv.getValidInterval(interval);
const intervalMs = kbn.interval_to_ms(validInterval); const intervalMs = kbn.intervalToMs(validInterval);
this.refreshTimer = this.timer.register( this.refreshTimer = this.timer.register(
this.$timeout(() => { this.$timeout(() => {
......
...@@ -97,7 +97,7 @@ export class PlaylistSrv { ...@@ -97,7 +97,7 @@ export class PlaylistSrv {
.get(`/api/playlists/${playlistId}/dashboards`) .get(`/api/playlists/${playlistId}/dashboards`)
.then((dashboards: any) => { .then((dashboards: any) => {
this.dashboards = dashboards; this.dashboards = dashboards;
this.interval = kbn.interval_to_ms(playlist.interval); this.interval = kbn.intervalToMs(playlist.interval);
this.next(); this.next();
}); });
}); });
......
...@@ -81,7 +81,7 @@ describe('interval actions', () => { ...@@ -81,7 +81,7 @@ describe('interval actions', () => {
expect(appEventMock.emit).toHaveBeenCalledWith(AppEvents.alertError, [ expect(appEventMock.emit).toHaveBeenCalledWith(AppEvents.alertError, [
'Templating', 'Templating',
`Invalid interval string, has to be either unit-less or end with one of the following units: "${Object.keys( `Invalid interval string, has to be either unit-less or end with one of the following units: "${Object.keys(
kbn.intervals_in_seconds kbn.intervalsInSeconds
).join(', ')}"`, ).join(', ')}"`,
]); ]);
setTimeSrv(originalTimeSrv); setTimeSrv(originalTimeSrv);
...@@ -99,7 +99,7 @@ describe('interval actions', () => { ...@@ -99,7 +99,7 @@ describe('interval actions', () => {
const dependencies: UpdateAutoValueDependencies = { const dependencies: UpdateAutoValueDependencies = {
kbn: { kbn: {
calculateInterval: jest.fn(), calculateInterval: jest.fn(),
}, } as any,
getTimeSrv: () => { getTimeSrv: () => {
return ({ return ({
timeRange: jest.fn().mockReturnValue({ timeRange: jest.fn().mockReturnValue({
...@@ -152,7 +152,7 @@ describe('interval actions', () => { ...@@ -152,7 +152,7 @@ describe('interval actions', () => {
const dependencies: UpdateAutoValueDependencies = { const dependencies: UpdateAutoValueDependencies = {
kbn: { kbn: {
calculateInterval: jest.fn().mockReturnValue({ interval: '10s' }), calculateInterval: jest.fn().mockReturnValue({ interval: '10s' }),
}, } as any,
getTimeSrv: () => { getTimeSrv: () => {
return ({ return ({
timeRange: timeRangeMock, timeRange: timeRangeMock,
......
...@@ -13,7 +13,7 @@ export interface Props { ...@@ -13,7 +13,7 @@ export interface Props {
templateVariableOptions: Array<SelectableValue<string>>; templateVariableOptions: Array<SelectableValue<string>>;
alignmentPeriod: string; alignmentPeriod: string;
perSeriesAligner: string; perSeriesAligner: string;
usedAlignmentPeriod: string; usedAlignmentPeriod?: number;
} }
export const AlignmentPeriods: FC<Props> = ({ export const AlignmentPeriods: FC<Props> = ({
...@@ -25,7 +25,9 @@ export const AlignmentPeriods: FC<Props> = ({ ...@@ -25,7 +25,9 @@ export const AlignmentPeriods: FC<Props> = ({
usedAlignmentPeriod, usedAlignmentPeriod,
}) => { }) => {
const alignment = alignOptions.find(ap => ap.value === templateSrv.replace(perSeriesAligner)); const alignment = alignOptions.find(ap => ap.value === templateSrv.replace(perSeriesAligner));
const formatAlignmentText = `${kbn.secondsToHms(usedAlignmentPeriod)} interval (${alignment ? alignment.text : ''})`; const formatAlignmentText = usedAlignmentPeriod
? `${kbn.secondsToHms(usedAlignmentPeriod)} interval (${alignment ? alignment.text : ''})`
: '';
const options = alignmentPeriods.map(ap => ({ const options = alignmentPeriods.map(ap => ({
...ap, ...ap,
label: ap.text, label: ap.text,
......
...@@ -7,7 +7,7 @@ import { SelectableValue } from '@grafana/data'; ...@@ -7,7 +7,7 @@ import { SelectableValue } from '@grafana/data';
export interface Props { export interface Props {
refId: string; refId: string;
usedAlignmentPeriod: string; usedAlignmentPeriod?: number;
variableOptionGroup: SelectableValue<string>; variableOptionGroup: SelectableValue<string>;
onChange: (query: MetricQuery) => void; onChange: (query: MetricQuery) => void;
onRunQuery: () => void; onRunQuery: () => void;
......
...@@ -67,7 +67,7 @@ export class QueryEditor extends PureComponent<Props, State> { ...@@ -67,7 +67,7 @@ export class QueryEditor extends PureComponent<Props, State> {
const sloQuery = { ...defaultSLOQuery, ...query.sloQuery, projectName: datasource.getDefaultProject() }; const sloQuery = { ...defaultSLOQuery, ...query.sloQuery, projectName: datasource.getDefaultProject() };
const queryType = query.queryType || QueryType.METRICS; const queryType = query.queryType || QueryType.METRICS;
const meta = this.props.data?.series.length ? this.props.data?.series[0].meta : {}; const meta = this.props.data?.series.length ? this.props.data?.series[0].meta : {};
const usedAlignmentPeriod = meta?.alignmentPeriod as string; const usedAlignmentPeriod = meta?.alignmentPeriod;
const variableOptionGroup = { const variableOptionGroup = {
label: 'Template Variables', label: 'Template Variables',
expanded: false, expanded: false,
......
...@@ -7,7 +7,7 @@ import { SLOQuery } from '../types'; ...@@ -7,7 +7,7 @@ import { SLOQuery } from '../types';
import CloudMonitoringDatasource from '../datasource'; import CloudMonitoringDatasource from '../datasource';
export interface Props { export interface Props {
usedAlignmentPeriod: string; usedAlignmentPeriod?: number;
variableOptionGroup: SelectableValue<string>; variableOptionGroup: SelectableValue<string>;
onChange: (query: SLOQuery) => void; onChange: (query: SLOQuery) => void;
onRunQuery: () => void; onRunQuery: () => void;
......
...@@ -419,7 +419,7 @@ export class CloudWatchDatasource extends DataSourceApi<CloudWatchQuery, CloudWa ...@@ -419,7 +419,7 @@ export class CloudWatchDatasource extends DataSourceApi<CloudWatchQuery, CloudWa
if (/^\d+$/.test(period)) { if (/^\d+$/.test(period)) {
period = parseInt(period, 10); period = parseInt(period, 10);
} else { } else {
period = kbn.interval_to_seconds(period); period = kbn.intervalToSeconds(period);
} }
if (period < 1) { if (period < 1) {
......
...@@ -490,7 +490,7 @@ export class AzureMonitorQueryCtrl extends QueryCtrl { ...@@ -490,7 +490,7 @@ export class AzureMonitorQueryCtrl extends QueryCtrl {
const allowedTimeGrainsMs: number[] = []; const allowedTimeGrainsMs: number[] = [];
timeGrains.forEach((tg: any) => { timeGrains.forEach((tg: any) => {
if (tg.value !== 'auto') { if (tg.value !== 'auto') {
allowedTimeGrainsMs.push(kbn.interval_to_ms(TimegrainConverter.createKbnUnitFromISO8601Duration(tg.value))); allowedTimeGrainsMs.push(kbn.intervalToMs(TimegrainConverter.createKbnUnitFromISO8601Duration(tg.value)));
} }
}); });
return allowedTimeGrainsMs; return allowedTimeGrainsMs;
......
...@@ -36,11 +36,11 @@ export default class TimeGrainConverter { ...@@ -36,11 +36,11 @@ export default class TimeGrainConverter {
const timeGrains = _.filter(allowedTimeGrains, o => o !== 'auto'); const timeGrains = _.filter(allowedTimeGrains, o => o !== 'auto');
let closest = timeGrains[0]; let closest = timeGrains[0];
const intervalMs = kbn.interval_to_ms(interval); const intervalMs = kbn.intervalToMs(interval);
for (let i = 0; i < timeGrains.length; i++) { for (let i = 0; i < timeGrains.length; i++) {
// abs (num - val) < abs (num - curr): // abs (num - val) < abs (num - curr):
if (intervalMs > kbn.interval_to_ms(timeGrains[i])) { if (intervalMs > kbn.intervalToMs(timeGrains[i])) {
if (i + 1 < timeGrains.length) { if (i + 1 < timeGrains.length) {
closest = timeGrains[i + 1]; closest = timeGrains[i + 1];
} else { } else {
......
...@@ -22,11 +22,10 @@ export class MetricTankMetaInspector extends PureComponent<Props, State> { ...@@ -22,11 +22,10 @@ export class MetricTankMetaInspector extends PureComponent<Props, State> {
const runtimeNotice = getRuntimeConsolidationNotice([meta]); const runtimeNotice = getRuntimeConsolidationNotice([meta]);
const normFunc = (meta['consolidator-normfetch'] ?? '').replace('Consolidator', ''); const normFunc = (meta['consolidator-normfetch'] ?? '').replace('Consolidator', '');
let totalSeconds = 0; const totalSeconds = buckets.reduce(
(acc, bucket) => acc + (bucket.retention ? kbn.intervalToSeconds(bucket.retention) : 0),
for (const bucket of buckets) { 0
totalSeconds += kbn.interval_to_seconds(bucket.retention); );
}
return ( return (
<div className={styles.metaItem} key={key}> <div className={styles.metaItem} key={key}>
...@@ -46,7 +45,7 @@ export class MetricTankMetaInspector extends PureComponent<Props, State> { ...@@ -46,7 +45,7 @@ export class MetricTankMetaInspector extends PureComponent<Props, State> {
<div> <div>
{buckets.map((bucket, index) => { {buckets.map((bucket, index) => {
const bucketLength = kbn.interval_to_seconds(bucket.retention); const bucketLength = bucket.retention ? kbn.intervalToSeconds(bucket.retention) : 0;
const lengthPercent = (bucketLength / totalSeconds) * 100; const lengthPercent = (bucketLength / totalSeconds) * 100;
const isActive = index === meta['archive-read']; const isActive = index === meta['archive-read'];
......
...@@ -205,7 +205,7 @@ export class OpenTsQueryCtrl extends QueryCtrl { ...@@ -205,7 +205,7 @@ export class OpenTsQueryCtrl extends QueryCtrl {
if (this.target.shouldDownsample) { if (this.target.shouldDownsample) {
try { try {
if (this.target.downsampleInterval) { if (this.target.downsampleInterval) {
kbn.describe_interval(this.target.downsampleInterval); kbn.describeInterval(this.target.downsampleInterval);
} else { } else {
errs.downsampleInterval = "You must supply a downsample interval (e.g. '1m' or '1h')."; errs.downsampleInterval = "You must supply a downsample interval (e.g. '1m' or '1h').";
} }
......
...@@ -327,9 +327,9 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions> ...@@ -327,9 +327,9 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
const range = Math.ceil(end - start); const range = Math.ceil(end - start);
// options.interval is the dynamically calculated interval // options.interval is the dynamically calculated interval
let interval: number = kbn.interval_to_seconds(options.interval); let interval: number = kbn.intervalToSeconds(options.interval);
// Minimum interval ("Min step"), if specified for the query or datasource. or same as interval otherwise // Minimum interval ("Min step"), if specified for the query or datasource. or same as interval otherwise
const minInterval = kbn.interval_to_seconds( const minInterval = kbn.intervalToSeconds(
templateSrv.replace(target.interval || options.interval, options.scopedVars) templateSrv.replace(target.interval || options.interval, options.scopedVars)
); );
const intervalFactor = target.intervalFactor || 1; const intervalFactor = target.intervalFactor || 1;
...@@ -495,7 +495,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions> ...@@ -495,7 +495,7 @@ export class PrometheusDatasource extends DataSourceApi<PromQuery, PromOptions>
const scopedVars = { const scopedVars = {
__interval: { text: this.interval, value: this.interval }, __interval: { text: this.interval, value: this.interval },
__interval_ms: { text: kbn.interval_to_ms(this.interval), value: kbn.interval_to_ms(this.interval) }, __interval_ms: { text: kbn.intervalToMs(this.interval), value: kbn.intervalToMs(this.interval) },
...this.getRangeScopedVars(getTimeSrv().timeRange()), ...this.getRangeScopedVars(getTimeSrv().timeRange()),
}; };
const interpolated = templateSrv.replace(query, scopedVars, this.interpolateQueryExpr); const interpolated = templateSrv.replace(query, scopedVars, this.interpolateQueryExpr);
......
...@@ -180,9 +180,9 @@ export class HeatmapCtrl extends MetricsPanelCtrl { ...@@ -180,9 +180,9 @@ export class HeatmapCtrl extends MetricsPanelCtrl {
const xBucketSizeByNumber = Math.floor((this.range.to.valueOf() - this.range.from.valueOf()) / xBucketNumber); const xBucketSizeByNumber = Math.floor((this.range.to.valueOf() - this.range.from.valueOf()) / xBucketNumber);
// Parse X bucket size (number or interval) // Parse X bucket size (number or interval)
const isIntervalString = kbn.interval_regex.test(this.panel.xBucketSize); const isIntervalString = kbn.intervalRegex.test(this.panel.xBucketSize);
if (isIntervalString) { if (isIntervalString) {
xBucketSize = kbn.interval_to_ms(this.panel.xBucketSize); xBucketSize = kbn.intervalToMs(this.panel.xBucketSize);
} else if ( } else if (
isNaN(Number(this.panel.xBucketSize)) || isNaN(Number(this.panel.xBucketSize)) ||
this.panel.xBucketSize === '' || this.panel.xBucketSize === '' ||
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment