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.

Sign up for GitHub

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

Jump to bottom

[v10.0.x] TimePicker: Fix issue with previous fiscal quarter not parsing correctly #71093

Merged
merged 1 commit into from Jul 5, 2023
Merged

[v10.0.x] TimePicker: Fix issue with previous fiscal quarter not parsing correctly #71093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 59 additions & 2 deletions packages/grafana-data/src/datetime/datemath.test.ts
View file
Open in desktop
Expand Up @@ -54,6 +54,53 @@ describe('DateMath', () => {
expect(startOfDay).toBe(expected.getTime());
});

describe('with fiscal quarters', () => {
beforeEach(() => {
const fixedTime = dateTime('2023-07-05T06:06:06.666Z').valueOf();
clock = sinon.useFakeTimers(fixedTime);
});

afterEach(() => {
clock.restore();
});

it('should parse current fiscal quarter correctly', () => {
const today = new Date();
const expected = new Date(Date.UTC(today.getUTCFullYear(), 6, 1, 0, 0, 0, 0));

const startOfDay = dateMath.parse('now/fQ', false, 'utc', 0)!.valueOf();
expect(startOfDay).toBe(expected.getTime());
});

it('should parse previous fiscal quarter correctly', () => {
const today = new Date();
const expected = new Date(Date.UTC(today.getUTCFullYear(), 3, 1, 0, 0, 0, 0));

const startOfDay = dateMath.parse('now-1Q/fQ', false, 'utc', 0)!.valueOf();
expect(startOfDay).toBe(expected.getTime());
});

describe('with a custom fiscal year start month', () => {
const FISCAL_YEAR_START_MONTH = 7; // August

it('should parse current fiscal quarter correctly', () => {
const today = new Date();
const expected = new Date(Date.UTC(today.getUTCFullYear(), 4, 1, 0, 0, 0, 0));

const startOfDay = dateMath.parse('now/fQ', false, 'utc', FISCAL_YEAR_START_MONTH)!.valueOf();
expect(startOfDay).toBe(expected.getTime());
});

it('should parse previous fiscal quarter correctly', () => {
const today = new Date();
const expected = new Date(Date.UTC(today.getUTCFullYear(), 1, 1, 0, 0, 0, 0));

const startOfDay = dateMath.parse('now-1Q/fQ', false, 'utc', FISCAL_YEAR_START_MONTH)!.valueOf();
expect(startOfDay).toBe(expected.getTime());
});
});
});

describe('subtraction', () => {
let now: DateTime;
let anchored: DateTime;
Expand Down Expand Up @@ -175,8 +222,8 @@ describe('DateMath', () => {

//fq1 = 2021-02-01 - 2021-04-30
//fq2 = 2021-05-01 - 2021-07-31
//fq4 = 2021-08-01 - 2021-10-31
//fq5 = 2021-11-01 - 2022-01-31
//fq3 = 2021-08-01 - 2021-10-31
//fq4 = 2021-11-01 - 2022-01-31

it('Should round to start of q2 when one month into q2', () => {
let date = dateMath.roundToFiscal(1, dateTime([2021, 6, 1]), 'Q', false);
Expand All @@ -201,5 +248,15 @@ describe('DateMath', () => {
let expected = dateTime([2022, 0, 31]).endOf('M');
expect(date!.valueOf()).toEqual(expected.valueOf());
});

it('should handle fyStartMonths set later in the year correctly', () => {
// Use fyStartMonth to 10 (November)
// Fiscal quarters are then Nov-Jan, Feb-Apr, May-Jul, Aug-Oct
// Use 1st Jan as the date to round
let date = dateMath.roundToFiscal(10, dateTime([2022, 0, 1]), 'Q', false);
// This should round back to 1st Nov 2021
let expected = dateTime([2021, 10, 1]);
expect(date!.valueOf()).toEqual(expected.valueOf());
});
});
});
15 changes: 6 additions & 9 deletions packages/grafana-data/src/datetime/datemath.ts
View file
Open in desktop
Expand Up @@ -163,15 +163,11 @@ export function parseDateMath(
return undefined;
} else {
if (type === 0) {
if (roundUp) {
if (isFiscal) {
roundToFiscal(fiscalYearStartMonth, dateTime, unit, roundUp);
} else {
dateTime.endOf(unit);
}
if (isFiscal) {
roundToFiscal(fiscalYearStartMonth, dateTime, unit, roundUp);
} else {
if (isFiscal) {
roundToFiscal(fiscalYearStartMonth, dateTime, unit, roundUp);
if (roundUp) {
dateTime.endOf(unit);
} else {
dateTime.startOf(unit);
}
Expand Down Expand Up @@ -199,7 +195,8 @@ export function roundToFiscal(fyStartMonth: number, dateTime: any, unit: string,
if (roundUp) {
roundToFiscal(fyStartMonth, dateTime, unit, false).add(2, 'M').endOf('M');
} else {
dateTime.subtract((dateTime.month() - fyStartMonth + 3) % 3, 'M').startOf('M');
// why + 12? to ensure this number is always a positive offset from fyStartMonth
dateTime.subtract((dateTime.month() - fyStartMonth + 12) % 3, 'M').startOf('M');
}
return dateTime;
default:
Expand Down