Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert timestamp before passing to validation #192379

Merged
merged 3 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/*
* 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 { convertTimestamp } from './convert_timestamp';

describe('convert_timestamp', () => {
const stringDate = '2024-09-06T11:10:24.681Z';
const stringDateWithSlash = '2019/05/15';
const stringDateWithDot = '10.12.1979';
const anyString = 'asdfgh';
const anyStringWithNumber = '123asdfghjkl';
const epochDate = 1725880672;
const stringifiedEpochDate = '1725880672';

it('should return a string date as it is', () => {
expect(convertTimestamp(stringDate)).toBe(stringDate);
});

it('should return any string as it is', () => {
expect(convertTimestamp(anyString)).toBe(anyString);
});

it('should return any string date with slash as it is', () => {
expect(convertTimestamp(stringDateWithSlash)).toBe(stringDateWithSlash);
});

it('should return any string date with dot as it is', () => {
expect(convertTimestamp(stringDateWithDot)).toBe(stringDateWithDot);
});

it('should return any string with some numbers in it as it is', () => {
expect(convertTimestamp(anyStringWithNumber)).toBe(anyStringWithNumber);
});

it('should return a number if the input is a stringified number', () => {
expect(convertTimestamp('12345678')).toBe(12345678);
});

it('should return an epoch date as it is', () => {
expect(convertTimestamp(epochDate)).toBe(epochDate);
});

it('should return a stringified epoch date as number', () => {
expect(convertTimestamp(stringifiedEpochDate)).toBe(epochDate);
});

it('should return null if timestamp is not passed', () => {
expect(convertTimestamp()).toBe(null);
});

it('should return null if timestamp is null', () => {
expect(convertTimestamp(null)).toBe(null);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/*
* 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.
*/

export function convertTimestamp(timestamp?: string | number | null): string | number | null {
if (timestamp) {
if (typeof timestamp === 'string') {
const trimmedTimestamp = timestamp.trim();
if (trimmedTimestamp.length > 0) {
const parsedTimestamp = parseInt(trimmedTimestamp, 10);

if (!isNaN(parsedTimestamp) && JSON.stringify(parsedTimestamp) === trimmedTimestamp) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is for the case of 123_but_not_a_date not returning 123? Good catch!

Note however:

parseInt('123.0') === 123

So that would fail. I think I usually just deal with the prefix, don't do that sort of check.

Poked around the Kibana repo looking at other parseInt() calls - trying to find some parsing "human" data - and I'm not seeing anyone else making other checks. Of course, folks may not generally know that parseInt() will stop once it hits a non-numeric character and return what it read up to that.

Do you think there's a need for us to do extra checking here?

Copy link
Contributor Author

@ersin-erdal ersin-erdal Sep 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you are right it is to avoid converting the strings starting with numbers.

For date inputs we should only convert the epoch numbers passed as string, all the rest should remain as string. Epoch numbers are always integer so JSON.stringify(parsedTimestamp) === trimmedTimestamp check guarantees that.

'123.0' would remain as string '123.0' and moment validation would return false for it, as expected.

And if we don't do that check 2024-10-10 (valid date string) would be converted to 2024 and lead us to a bug :)

return parsedTimestamp; // return converted epoch
}
return trimmedTimestamp; // return string
}
}
if (typeof timestamp === 'number') {
return timestamp; // return epoch
}
}
return null;
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
SecurityConnectorFeatureId,
} from '@kbn/actions-plugin/common/types';
import { postPagerduty } from './post_pagerduty';
import { convertTimestamp } from '../lib/convert_timestamp';

// uses the PagerDuty Events API v2
// https://v2.developer.pagerduty.com/docs/events-api-v2
Expand Down Expand Up @@ -99,19 +100,12 @@ export const ParamsSchema = schema.object(
{ validate: validateParams }
);

function validateTimestamp(timestamp?: string): string | null {
if (timestamp) {
return timestamp.trim().length > 0 ? timestamp.trim() : null;
}
return null;
}

function validateParams(paramsObject: unknown): string | void {
const { timestamp, eventAction, dedupKey } = paramsObject as ActionParamsType;
const validatedTimestamp = validateTimestamp(timestamp);
if (validatedTimestamp != null) {
const convertedTimestamp = convertTimestamp(timestamp);
if (convertedTimestamp != null) {
try {
const date = moment(validatedTimestamp);
const date = moment(convertedTimestamp);
if (!date.isValid()) {
return i18n.translate('xpack.stackConnectors.pagerduty.invalidTimestampErrorMessage', {
defaultMessage: `error parsing timestamp "{timestamp}"`,
Expand Down Expand Up @@ -327,13 +321,13 @@ function getBodyForEventAction(actionId: string, params: ActionParamsType): Page
return data;
}

const validatedTimestamp = validateTimestamp(params.timestamp);
const convertedTimestamp = convertTimestamp(params.timestamp);

data.payload = {
summary: params.summary || 'No summary provided.',
source: params.source || `Kibana Action ${actionId}`,
severity: params.severity || 'info',
...(validatedTimestamp ? { timestamp: moment(validatedTimestamp).toISOString() } : {}),
...(convertedTimestamp ? { timestamp: moment(convertedTimestamp).toISOString() } : {}),
...omitBy(pick(params, ['component', 'group', 'class']), isUndefined),
...(params.customDetails ? { custom_details: params.customDetails } : {}),
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* 2.0.
*/

import { convertTimestamp } from '../lib/convert_timestamp';
import { api as commonApi } from '../lib/servicenow/api';
import {
ExecutorSubActionAddEventParams,
Expand All @@ -15,8 +16,9 @@ import {
const isValidDate = (d: Date) => !isNaN(d.valueOf());

const formatTimeOfEvent = (timeOfEvent: string | null): string | undefined => {
if (timeOfEvent != null) {
const date = new Date(timeOfEvent);
const convertedTimestamp = convertTimestamp(timeOfEvent);
if (convertedTimestamp != null) {
const date = new Date(convertedTimestamp);

return isValidDate(date)
? // The format is: yyyy-MM-dd HH:mm:ss GMT
Expand Down