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

Remove setting return cycle in ReturnLogHelper #1398

Merged
merged 4 commits into from
Oct 10, 2024
Merged

Remove setting return cycle in ReturnLogHelper #1398

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5f3838
Remove setting return cycle in ReturnLogHelper
Cruikshanks Oct 10, 2024
fa171bb
Remove the call
Cruikshanks Oct 10, 2024
1fc02df
Resolve the JSDoc lint error
Cruikshanks Oct 10, 2024
ea91b07
Merge branch 'main' into remove-setting-return-cycle-in-helper
robertparkinson Oct 10, 2024
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
27 changes: 22 additions & 5 deletions test/support/helpers/return-log.helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* @module ReturnLogHelper
*/

const { generateUUID } = require('../../../app/lib/general.lib.js')
const { generateLicenceRef } = require('./licence.helper.js')
const { randomInteger } = require('../general.js')
const { timestampForPostgres } = require('../../../app/lib/general.lib.js')
Expand All @@ -23,7 +22,6 @@ const ReturnLogModel = require('../../../app/models/return-log.model.js')
* - `metadata` - {}
* - `receivedDate` - 2023-04-12
* - `returnReference` - [randomly generated - 10000321]
* - `returnCycleId` - UUID
* - `returnsFrequency` - month
* - `startDate` - 2022-04-01
* - `status` - completed
Expand Down Expand Up @@ -85,7 +83,6 @@ function defaults (data = {}) {
},
receivedDate,
returnReference,
returnCycleId: generateUUID(),
returnsFrequency: 'month',
startDate: new Date('2022-04-01'),
status: 'due',
Expand All @@ -98,12 +95,32 @@ function defaults (data = {}) {
}
}

/**
* Returns a randomly generated return log Id
*
* Unlike other tables, the previous team opted to generate a unique ID based on properties of the return log including
* start and end dates, version and references.
*
* So, in order to replicate that we have this helper method, that defaults some of those values, and randomises others
* in order to generate a unique return log ID.
*
* If you have known values, for example, the licence reference they can be passed to this helper and it will
* incorporate them into the ID.
*
* @param {string} [startDate] - the start date as a string, for example '2022-04-01'
* @param {string} [endDate] - the end date as a string, for example '2023-03-31'
* @param {number} [version] - the version number to use, for example 1
* @param {string} [licenceRef] - the licence reference to use
* @param {string} [returnReference] - the return requirement reference to use
*
* @returns {string} the generated return log ID
*/
function generateReturnLogId (
startDate = '2022-04-01',
endDate = '2023-03-31',
version = 1,
licenceRef,
returnReference
licenceRef = null,
returnReference = null
) {
if (!licenceRef) {
licenceRef = generateLicenceRef()
Expand Down
Loading