Add default for multiple upload on return version journey

app/presenters/return-versions/setup/additional-submission-options.presenter.js

@@ -13,16 +13,16 @@
  * @returns {object} - The data formatted for the view template
  */
 function go (session) {
-  const { id: sessionId, licence: { id: licenceId, licenceRef }, additionalSubmissionOptions } = session
-  const data = {
-    additionalSubmissionOptions: additionalSubmissionOptions ?? [],
+  const { id: sessionId, licence: { id: licenceId, licenceRef }, multipleUpload, noAdditionalOptions } = session
+
+  return {
     backLink: `/system/return-versions/setup/${sessionId}/check`,
     licenceId,
     licenceRef,
+    multipleUpload,
+    noAdditionalOptions,
     sessionId
   }
-
-  return data
 }
 
 module.exports = {

app/presenters/return-versions/setup/check/check.presenter.js

@@ -16,12 +16,12 @@ const { returnRequirementReasons } = require('../../../../lib/static-lookups.lib
  * @returns {object} The data formatted for the view template
  */
 function go (session) {
-  const { additionalSubmissionOptions, id: sessionId, journey, licence, note, reason } = session
+  const { multipleUpload, id: sessionId, journey, licence, note, reason } = session
 
   const returnsRequired = journey === 'returns-required'
 
   return {
-    additionalSubmissionOptions: additionalSubmissionOptions ?? [],
+    multipleUpload,
     licenceRef: licence.licenceRef,
     note: _note(note),
     pageTitle: `Check the requirements for returns for ${licence.licenceHolder}`,

app/services/return-versions/setup/check/generate-return-version.service.js

@@ -58,7 +58,7 @@ async function _generateReturnVersion (nextVersionNumber, sessionData, userId) {
     createdBy: userId,
     endDate,
     licenceId: sessionData.licence.id,
-    multipleUpload: _multipleUpload(sessionData?.additionalSubmissionOptions),
+    multipleUpload: sessionData.multipleUpload,
     notes: sessionData?.note?.content,
     reason: sessionData.reason,
     startDate,
@@ -80,10 +80,6 @@ async function _nextVersionNumber (licenceId) {
   return 1
 }
 
-function _multipleUpload (additionalSubmissionOptions) {
-  return additionalSubmissionOptions ? additionalSubmissionOptions.includes('multiple-upload') : false
-}
-
 module.exports = {
   go
 }

app/services/return-versions/setup/initiate-session.service.js

@@ -45,7 +45,7 @@ async function _createSession (data) {
 }
 
 function _data (licence, journey) {
-  const { id, licenceRef, licenceVersions, returnVersions, startDate } = licence
+  const { id, licenceRef, licenceVersions, returnVersions, startDate, waterUndertaker } = licence
   const ends = licence.$ends()
 
   return {
@@ -57,8 +57,10 @@ function _data (licence, journey) {
       licenceRef,
       licenceHolder: licence.$licenceHolder(),
       returnVersions,
-      startDate
+      startDate,
+      waterUndertaker
     },
+    multipleUpload: waterUndertaker,
     journey,
     requirements: [{}]
   }
@@ -73,7 +75,8 @@ async function _fetchLicence (licenceId) {
       'lapsedDate',
       'licenceRef',
       'revokedDate',
-      'startDate'
+      'startDate',
+      'waterUndertaker'
     ])
     .withGraphFetched('licenceVersions')
     .modifyGraph('licenceVersions', (builder) => {

app/services/return-versions/setup/submit-additional-submission-options.service.js

@@ -81,7 +81,9 @@ function _notification (session, payload) {
 }
 
 async function _save (session, payload) {
-  session.additionalSubmissionOptions = payload.additionalSubmissionOptions
+  session.multipleUpload = payload.additionalSubmissionOptions.includes('multiple-upload')
+
+  session.noAdditionalOptions = payload.additionalSubmissionOptions.includes('none')
 
   return session.$update()
 }

app/views/return-versions/setup/additional-submission-options.njk

@@ -56,15 +56,15 @@
           {
             value: "multiple-upload",
             text: "Multiple upload",
-            checked: additionalSubmissionOptions.includes("multiple-upload")
+            checked: multipleUpload
           },
           {
             divider: "or"
           },
           {
             value: "none",
             text: "None",
-            checked: additionalSubmissionOptions.includes("none"),
+            checked: noAdditionalOptions,
             behaviour: "exclusive"
           }
         ]

app/views/return-versions/setup/check.njk

@@ -353,7 +353,7 @@
                 classes: "govuk-body "
               },
               value: {
-                text: 'Yes' if additionalSubmissionOptions.includes('multiple-upload') else "No"
+                text: 'Yes' if multipleUpload else "No"
               }
             }
           ]

test/presenters/return-versions/setup/additional-submission-options.presenter.test.js

@@ -26,6 +26,7 @@ describe('Return Versions Setup - Additional Submission Options presenter', () =
         startDate: '2022-04-01T00:00:00.000Z'
       },
       journey: 'returns-required',
+      multipleUpload: false,
       requirements: [{}],
       startDateOptions: 'licenceStartDate',
       reason: 'major-change'
@@ -39,8 +40,9 @@ describe('Return Versions Setup - Additional Submission Options presenter', () =
       expect(result).to.be.equal({
         backLink: `/system/return-versions/setup/${session.id}/check`,
         licenceId: '8b7f78ba-f3ad-4cb6-a058-78abc4d1383d',
-        additionalSubmissionOptions: [],
         licenceRef: '01/ABC',
+        multipleUpload: false,
+        noAdditionalOptions: undefined,
         sessionId: session.id
       })
     })
@@ -54,24 +56,62 @@ describe('Return Versions Setup - Additional Submission Options presenter', () =
     })
   })
 
-  describe('the "additionalSubmissionOptions" property', () => {
-    describe('when the user has previously submitted additional submission options', () => {
+  describe('the "multipleUpload" property', () => {
+    describe('when the user has previously submitted "multipleUpload" for additional options or it has been set initially when the licence holder is a water company', () => {
       beforeEach(() => {
-        session.additionalSubmissionOptions = ['multiple-upload']
+        session.multipleUpload = true
       })
 
-      it('returns the options', () => {
+      it('returns true', () => {
         const result = AdditionalSubmissionOptionsPresenter.go(session)
 
-        expect(result.additionalSubmissionOptions).to.include('multiple-upload')
+        expect(result.multipleUpload).to.be.true()
       })
     })
 
-    describe('when the user has not previously chosen options', () => {
-      it('returns empty options', () => {
+    describe('when the user has not previously submitted "multipleUpload" for additional options', () => {
+      beforeEach(() => {
+        session.multipleUpload = false
+      })
+
+      it('returns false', () => {
+        const result = AdditionalSubmissionOptionsPresenter.go(session)
+
+        expect(result.multipleUpload).to.be.false()
+      })
+    })
+  })
+
+  describe('the "noAdditionalOptions" property', () => {
+    describe('when the user has previously submitted "none" for additional options', () => {
+      beforeEach(() => {
+        session.noAdditionalOptions = true
+      })
+
+      it('returns true', () => {
+        const result = AdditionalSubmissionOptionsPresenter.go(session)
+
+        expect(result.noAdditionalOptions).to.be.true()
+      })
+    })
+
+    describe('when the user has selected another additional option', () => {
+      beforeEach(() => {
+        session.noAdditionalOptions = false
+      })
+
+      it('returns false', () => {
+        const result = AdditionalSubmissionOptionsPresenter.go(session)
+
+        expect(result.noAdditionalOptions).to.be.false()
+      })
+    })
+
+    describe('when the user has not previously submitted for no additional options', () => {
+      it('returns false', () => {
         const result = AdditionalSubmissionOptionsPresenter.go(session)
 
-        expect(result.additionalSubmissionOptions).to.be.empty()
+        expect(result.noAdditionalOptions).to.be.undefined()
       })
     })
   })

test/presenters/return-versions/setup/check/check.presenter.test.js

@@ -26,6 +26,7 @@ describe('Return Versions Setup - Check presenter', () => {
         licenceHolder: 'Turbo Kid',
         startDate: '2022-04-01T00:00:00.000Z'
       },
+      multipleUpload: false,
       returnVersionStartDate: '2023-01-01',
       startDateOptions: 'licenceStartDate',
       reason: 'major-change'
@@ -37,8 +38,8 @@ describe('Return Versions Setup - Check presenter', () => {
       const result = CheckPresenter.go(session)
 
       expect(result).to.equal({
-        additionalSubmissionOptions: [],
         licenceRef: '01/ABC',
+        multipleUpload: false,
         note: {
           actions: [
             {
@@ -57,24 +58,24 @@ describe('Return Versions Setup - Check presenter', () => {
     })
   })
 
-  describe('the "additionalSubmissionOptions" property', () => {
-    describe('when the user has checked additionalSubmissionOptions', () => {
+  describe('the "multipleUpload" property', () => {
+    describe('when there is a multipleUpload', () => {
       beforeEach(() => {
-        session.additionalSubmissionOptions = ['multiple-upload']
+        session.multipleUpload = true
       })
 
-      it('returns a checked option', () => {
+      it('returns the value', () => {
         const result = CheckPresenter.go(session)
 
-        expect(result.additionalSubmissionOptions).to.include('multiple-upload')
+        expect(result.multipleUpload).to.be.true()
       })
     })
 
-    describe('when the user has not checked an option', () => {
-      it('returns no options', () => {
+    describe('when there is not a multipleUpload', () => {
+      it('returns the value', () => {
         const result = CheckPresenter.go(session)
 
-        expect(result.additionalSubmissionOptions).to.be.empty()
+        expect(result.multipleUpload).to.be.false()
       })
     })
   })

test/services/return-versions/setup/additional-submission-options.service.test.js

@@ -28,6 +28,8 @@ describe('Return Versions Setup - Additional Submission Options service', () =>
           licenceHolder: 'Turbo Kid',
           startDate: '2022-04-01T00:00:00.000Z'
         },
+        multipleUpload: false,
+        noAdditionalOptions: undefined,
         journey: 'returns-required',
         requirements: [{}],
         startDateOptions: 'licenceStartDate',
@@ -47,8 +49,9 @@ describe('Return Versions Setup - Additional Submission Options service', () =>
       const result = await AdditionalSubmissionOptionsService.go(session.id)
 
       expect(result).to.equal({
+        multipleUpload: false,
+        noAdditionalOptions: undefined,
         activeNavBar: 'search',
-        additionalSubmissionOptions: [],
         backLink: `/system/return-versions/setup/${session.id}/check`,
         licenceId: '8b7f78ba-f3ad-4cb6-a058-78abc4d1383d',
         licenceRef: '01/ABC',

test/services/return-versions/setup/check/check.service.test.js

@@ -33,6 +33,7 @@ describe('Return Versions Setup - Check service', () => {
           licenceHolder: 'Turbo Kid',
           startDate: '2022-04-01T00:00:00.000Z'
         },
+        multipleUpload: false,
         returnVersionStartDate: '2023-01-01',
         journey: 'returns-required',
         requirements: [{}],
@@ -60,8 +61,8 @@ describe('Return Versions Setup - Check service', () => {
 
       expect(result).to.equal({
         activeNavBar: 'search',
-        additionalSubmissionOptions: [],
         licenceRef: '01/ABC',
+        multipleUpload: false,
         note: {
           actions: [
             {

test/services/return-versions/setup/check/generate-return-version.service.test.js

@@ -38,8 +38,7 @@ describe('Return Versions Setup - Generate Return Version service', () => {
     beforeEach(async () => {
       licenceId = generateUUID()
       sessionData = {
-        method: 'use-existing-requirements',
-        reason: 'minor-change',
+        checkPageVisited: true,
         journey: 'returns-required',
         licence: {
           id: licenceId,
@@ -61,9 +60,11 @@ describe('Return Versions Setup - Generate Return Version service', () => {
           ],
           currentVersionStartDate: '2023-02-13T00:00:00.000Z'
         },
-        returnVersionStartDate: '2023-02-13',
+        method: 'use-existing-requirements',
+        multipleUpload: false,
+        reason: 'minor-change',
         requirements: ['return requirements data'],
-        checkPageVisited: true,
+        returnVersionStartDate: '2023-02-13',
         startDateOptions: 'licenceStartDate'
       }
 
@@ -99,12 +100,7 @@ describe('Return Versions Setup - Generate Return Version service', () => {
     beforeEach(async () => {
       licenceId = generateUUID()
       sessionData = {
-        note: {
-          content: 'This is a test note',
-          userEmail: '[email protected]'
-        },
-        method: 'set-up-manually',
-        reason: 'change-to-special-agreement',
+        checkPageVisited: true,
         journey: 'returns-required',
         licence: {
           id: licenceId,
@@ -114,13 +110,16 @@ describe('Return Versions Setup - Generate Return Version service', () => {
           licenceHolder: 'Another licence holder',
           returnVersions: []
         },
+        method: 'set-up-manually',
+        multipleUpload: true,
+        note: {
+          content: 'This is a test note',
+          userEmail: '[email protected]'
+        },
+        reason: 'change-to-special-agreement',
         requirements: ['return requirements data'],
         returnVersionStartDate: '2023-02-13',
-        checkPageVisited: true,
-        startDateOptions: 'anotherStartDate',
-        additionalSubmissionOptions: [
-          'multiple-upload'
-        ]
+        startDateOptions: 'anotherStartDate'
       }
     })
 
@@ -151,7 +150,7 @@ describe('Return Versions Setup - Generate Return Version service', () => {
     beforeEach(async () => {
       licenceId = generateUUID()
       sessionData = {
-        reason: 'returns-exception',
+        checkPageVisited: true,
         journey: 'no-returns-required',
         licence: {
           id: licenceId,
@@ -162,9 +161,10 @@ describe('Return Versions Setup - Generate Return Version service', () => {
           returnVersions: [],
           currentVersionStartDate: '2023-02-13T00:00:00.000Z'
         },
-        returnVersionStartDate: '2023-02-13',
+        multipleUpload: false,
+        reason: 'returns-exception',
         requirements: [{}],
-        checkPageVisited: true,
+        returnVersionStartDate: '2023-02-13',
         startDateOptions: 'licenceStartDate'
       }
     })

test/services/return-versions/setup/initiate-session.service.test.js

@@ -64,8 +64,10 @@ describe('Return Versions Setup - Initiate Session service', () => {
             licenceRef,
             licenceHolder: 'Licence Holder Ltd',
             returnVersions: [],
-            startDate: new Date('2022-01-01')
+            startDate: new Date('2022-01-01'),
+            waterUndertaker: false
           },
+          multipleUpload: false,
           journey: 'returns-required',
           requirements: [{}]
         }, { skip: ['id'] })