Skip to content

Commit

Permalink
Return log start and end dates to be determined using the correct cyc…
Browse files Browse the repository at this point in the history 
…le dates (#1397)

https://eaflood.atlassian.net/browse/WATER-4543

As part of the work to replace the legacy system NALD we need to generate return logs. This PR updates the logic around how the start, end and due dates are calculated based on the time of the year the request is being made. This is mostly for new licences that have been imported or for when licences are ended and will need new return logs created.
  • Loading branch information
@robertparkinson
robertparkinson authored Oct 11, 2024
1 parent 9a4a441 commit 7c863e3
Show file tree
Hide file tree
Showing 4 changed files with 165 additions and 61 deletions.
66 changes: 42 additions & 24 deletions app/lib/dates.lib.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,23 @@ function cycleDueDateAsISO (summer) {
* @returns {Date} - the due date of the next cycle.
*/
function cycleDueDate (summer) {
const today = new Date()
const year = today.getFullYear()
const month = today.getMonth()

if (summer) {
return new Date(new Date().getFullYear() + 1,
returnCycleDates.summer.dueDate.month,
returnCycleDates.summer.dueDate.day
)
if (month > returnCycleDates.summer.endDate.month) {
return new Date(year + 1, returnCycleDates.summer.dueDate.month, returnCycleDates.summer.dueDate.day)
}

return new Date(year, returnCycleDates.summer.dueDate.month, returnCycleDates.summer.dueDate.day)
}

if (month > returnCycleDates.allYear.endDate.month) {
return new Date(year + 1, returnCycleDates.allYear.dueDate.month, returnCycleDates.allYear.dueDate.day)
}

return new Date(new Date().getFullYear() + 1,
returnCycleDates.allYear.dueDate.month,
returnCycleDates.allYear.dueDate.day
)
return new Date(year, returnCycleDates.allYear.dueDate.month, returnCycleDates.allYear.dueDate.day)
}

/**
Expand All @@ -94,17 +100,23 @@ function cycleEndDateAsISO (summer) {
* @returns {Date} - the end date of the next cycle.
*/
function cycleEndDate (summer) {
const today = new Date()
const year = today.getFullYear()
const month = today.getMonth()

if (summer) {
return new Date(new Date().getFullYear() + 1,
returnCycleDates.summer.endDate.month,
returnCycleDates.summer.endDate.day
)
if (month > returnCycleDates.summer.endDate.month) {
return new Date(year + 1, returnCycleDates.summer.endDate.month, returnCycleDates.summer.endDate.day)
}

return new Date(year, returnCycleDates.summer.endDate.month, returnCycleDates.summer.endDate.day)
}

return new Date(new Date().getFullYear() + 1,
returnCycleDates.allYear.endDate.month,
returnCycleDates.allYear.endDate.day
)
if (month > returnCycleDates.allYear.endDate.month) {
return new Date(year + 1, returnCycleDates.allYear.endDate.month, returnCycleDates.allYear.endDate.day)
}

return new Date(year, returnCycleDates.allYear.endDate.month, returnCycleDates.allYear.endDate.day)
}

/**
Expand All @@ -124,17 +136,23 @@ function cycleStartDateAsISO (summer) {
* @returns {Date} - the start date of the next cycle.
*/
function cycleStartDate (summer) {
const today = new Date()
const year = today.getFullYear()
const month = today.getMonth()

if (summer) {
return new Date(new Date().getFullYear(),
returnCycleDates.summer.startDate.month,
returnCycleDates.summer.startDate.day
)
if (month < returnCycleDates.summer.startDate.month) {
return new Date(year - 1, returnCycleDates.summer.startDate.month, returnCycleDates.summer.startDate.day)
}

return new Date(year, returnCycleDates.summer.startDate.month, returnCycleDates.summer.startDate.day)
}

if (month < returnCycleDates.allYear.startDate.month) {
return new Date(year - 1, returnCycleDates.allYear.startDate.month, returnCycleDates.allYear.startDate.day)
}

return new Date(new Date().getFullYear(),
returnCycleDates.allYear.startDate.month,
returnCycleDates.allYear.startDate.day
)
return new Date(year, returnCycleDates.allYear.startDate.month, returnCycleDates.allYear.startDate.day)
}

/**
Expand Down
81 changes: 68 additions & 13 deletions test/lib/dates.lib.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,15 @@ const Code = require('@hapi/code')
const { describe, it, beforeEach } = exports.lab = Lab.script()
const { expect } = Code

const { returnCycleDates } = require('../../app/lib/static-lookups.lib.js')

// Thing under test
const DateLib = require('../../app/lib/dates.lib.js')

describe('Dates lib', () => {
const today = new Date()
const month = today.getMonth()

let expectedDate
let summer

Expand Down Expand Up @@ -95,7 +100,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = true

expectedDate = new Date(new Date().getFullYear() + 1, 10, 28)
if (month > returnCycleDates.summer.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 10, 28)
} else {
expectedDate = new Date(new Date().getFullYear(), 10, 28)
}
})

it('should return the due date for the current summer cycle', () => {
Expand All @@ -109,7 +118,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = false

expectedDate = new Date(new Date().getFullYear() + 1, 3, 28)
if (month > returnCycleDates.allYear.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 3, 28)
} else {
expectedDate = new Date(new Date().getFullYear(), 3, 28)
}
})

it('should return the due date of the current winter and all year cycle', () => {
Expand All @@ -125,7 +138,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = true

expectedDate = new Date(new Date().getFullYear() + 1, 10, 28).toISOString().split('T')[0]
if (month > returnCycleDates.summer.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 10, 28).toISOString().split('T')[0]
} else {
expectedDate = new Date(new Date().getFullYear(), 10, 28).toISOString().split('T')[0]
}
})

it('should return the due date for the current summer cycle formatted as YYYY-MM-DD', () => {
Expand All @@ -139,7 +156,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = false

expectedDate = new Date(new Date().getFullYear() + 1, 3, 28).toISOString().split('T')[0]
if (month > returnCycleDates.allYear.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 3, 28).toISOString().split('T')[0]
} else {
expectedDate = new Date(new Date().getFullYear(), 3, 28).toISOString().split('T')[0]
}
})

it('should return the due date of the current winter and all year cycle formatted as YYYY-MM-DD', () => {
Expand All @@ -155,7 +176,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = true

expectedDate = new Date(new Date().getFullYear() + 1, 9, 31)
if (month > returnCycleDates.summer.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 9, 31)
} else {
expectedDate = new Date(new Date().getFullYear(), 9, 31)
}
})

it('should return the due date for the current summer cycle', () => {
Expand All @@ -169,7 +194,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = false

expectedDate = new Date(new Date().getFullYear() + 1, 2, 31)
if (month > returnCycleDates.allYear.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 2, 31)
} else {
expectedDate = new Date(new Date().getFullYear(), 2, 31)
}
})

it('should return the due date of the current winter and all year cycle', () => {
Expand All @@ -185,7 +214,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = true

expectedDate = new Date(new Date().getFullYear() + 1, 9, 31).toISOString().split('T')[0]
if (month > returnCycleDates.summer.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 9, 31).toISOString().split('T')[0]
} else {
expectedDate = new Date(new Date().getFullYear(), 9, 31).toISOString().split('T')[0]
}
})

it('should return the due date for the current summer cycle formatted as YYYY-MM-DD', () => {
Expand All @@ -199,7 +232,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = false

expectedDate = new Date(new Date().getFullYear() + 1, 2, 31).toISOString().split('T')[0]
if (month > returnCycleDates.allYear.endDate.month) {
expectedDate = new Date(new Date().getFullYear() + 1, 2, 31).toISOString().split('T')[0]
} else {
expectedDate = new Date(new Date().getFullYear(), 2, 31).toISOString().split('T')[0]
}
})

it('should return the due date of the current winter and all year cycle formatted as YYYY-MM-DD', () => {
Expand All @@ -215,10 +252,14 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = true

expectedDate = new Date(new Date().getFullYear(), 10, 1)
if (month < returnCycleDates.summer.startDate.month) {
expectedDate = new Date(new Date().getFullYear() - 1, 10, 1)
} else {
expectedDate = new Date(new Date().getFullYear(), 10, 1)
}
})

it('should return the due date for the current summer cycle', () => {
it('should return the start date for the current summer cycle', () => {
const result = DateLib.cycleStartDate(summer)

expect(result).to.equal(expectedDate)
Expand All @@ -229,7 +270,11 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = false

expectedDate = new Date(new Date().getFullYear(), 3, 1)
if (month < returnCycleDates.allYear.startDate.month) {
expectedDate = new Date(new Date().getFullYear() - 1, 3, 1)
} else {
expectedDate = new Date(new Date().getFullYear(), 3, 1)
}
})

it('should return the due date of the current winter and all year cycle', () => {
Expand All @@ -245,10 +290,14 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = true

expectedDate = new Date(new Date().getFullYear(), 10, 1).toISOString().split('T')[0]
if (month < returnCycleDates.summer.startDate.month) {
expectedDate = new Date(new Date().getFullYear() - 1, 10, 1).toISOString().split('T')[0]
} else {
expectedDate = new Date(new Date().getFullYear(), 10, 1).toISOString().split('T')[0]
}
})

it('should return the due date for the current summer cycle formatted as YYYY-MM-DD', () => {
it('should return the start date for the current summer cycle formatted as YYYY-MM-DD', () => {
const result = DateLib.cycleStartDateAsISO(summer)

expect(result).to.equal(expectedDate)
Expand All @@ -259,6 +308,12 @@ describe('Dates lib', () => {
beforeEach(() => {
summer = false

if (month < returnCycleDates.allYear.startDate.month) {
expectedDate = new Date(new Date().getFullYear() - 1, 3, 1).toISOString().split('T')[0]
} else {
expectedDate = new Date(new Date().getFullYear(), 3, 1).toISOString().split('T')[0]
}

expectedDate = new Date(new Date().getFullYear(), 3, 1).toISOString().split('T')[0]
})

Expand Down
12 changes: 10 additions & 2 deletions test/services/jobs/return-logs/fetch-return-requirements.service.test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ const { describe, it, before } = exports.lab = Lab.script()
const { expect } = Code

// Test helpers
const { returnCycleDates } = require('../../../../app/lib/static-lookups.lib.js')
const { formatDateObjectToISO } = require('../../../../app/lib/dates.lib.js')
const LicenceHelper = require('../../../support/helpers/licence.helper.js')
const PointHelper = require('../../../support/helpers/point.helper.js')
const PrimaryPurposeHelper = require('../../../support/helpers/primary-purpose.helper.js')
Expand All @@ -23,6 +25,9 @@ const SecondaryPurposeHelper = require('../../../support/helpers/secondary-purpo
const FetchReturnRequirementsService = require('../../../../app/services/jobs/return-logs/fetch-return-requirements.service.js')

describe('Fetch return logs service', () => {
const today = new Date()
const month = today.getMonth()
const year = today.getFullYear()
const summerReturns = []
const allYearReturns = []

Expand All @@ -44,7 +49,11 @@ describe('Fetch return logs service', () => {
let revokedDate
let secondaryPurpose
let secondaryPurpose2
let startDate
let startDate = formatDateObjectToISO(new Date(year, 11, 1))

if (month < returnCycleDates.summer.startDate.month) {
startDate = formatDateObjectToISO(new Date(year - 1, 11, 1))
}

describe('when summer is false, one return requirement and a licenceRef provided', () => {
before(async () => {
Expand Down Expand Up @@ -774,7 +783,6 @@ describe('Fetch return logs service', () => {

describe('when summer is true, the return version start date is after the cycle start date, one return requirement and a licenceRef provided', () => {
before(async () => {
startDate = new Date(new Date().getFullYear(), 11, 1).toISOString().split('T')[0]
primaryPurpose = PrimaryPurposeHelper.select()
purpose = PurposeHelper.select()
secondaryPurpose = SecondaryPurposeHelper.select()
Expand Down
Loading

0 comments on commit 7c863e3

Please sign in to comment.