Merge branch 'main' into feature-notifications-download-link-presenter

Author: jonathangoulding

app/controllers/return-logs-setup.controller.js

@@ -11,13 +11,15 @@ const InitiateSessionService = require('../services/return-logs/setup/initiate-s
 const MeterDetailsService = require('../services/return-logs/setup/meter-details.service.js')
 const MeterProvidedService = require('../services/return-logs/setup/meter-provided.service.js')
 const NoteService = require('../services/return-logs/setup/note.service.js')
+const PeriodUsedService = require('../services/return-logs/setup/period-used.service.js')
 const ReceivedService = require('../services/return-logs/setup/received.service.js')
 const ReportedService = require('../services/return-logs/setup/reported.service.js')
 const SingleVolumeService = require('../services/return-logs/setup/single-volume.service.js')
 const SubmissionService = require('../services/return-logs/setup/submission.service.js')
 const SubmitMeterDetailsService = require('../services/return-logs/setup/submit-meter-details.service.js')
 const SubmitMeterProvidedService = require('../services/return-logs/setup/submit-meter-provided.service.js')
 const SubmitNoteService = require('../services/return-logs/setup/submit-note.service.js')
+const SubmitPeriodUsedService = require('../services/return-logs/setup/submit-period-used.service.js')
 const SubmitReceivedService = require('../services/return-logs/setup/submit-received.service.js')
 const SubmitReportedService = require('../services/return-logs/setup/submit-reported.service.js')
 const SubmitSingleVolumeService = require('../services/return-logs/setup/submit-single-volume.service.js')
@@ -66,6 +68,13 @@ async function note(request, h) {
   return h.view('return-logs/setup/note.njk', pageData)
 }
 
+async function periodUsed(request, h) {
+  const { sessionId } = request.params
+  const pageData = await PeriodUsedService.go(sessionId)
+
+  return h.view('return-logs/setup/period-used.njk', pageData)
+}
+
 async function received(request, h) {
   const { sessionId } = request.params
   const pageData = await ReceivedService.go(sessionId)
@@ -148,6 +157,18 @@ async function submitNote(request, h) {
   return h.redirect(`/system/return-logs/setup/${sessionId}/check`)
 }
 
+async function submitPeriodUsed(request, h) {
+  const { sessionId } = request.params
+
+  const pageData = await SubmitPeriodUsedService.go(sessionId, request.payload)
+
+  if (pageData.error) {
+    return h.view('return-logs/setup/period-used.njk', pageData)
+  }
+
+  return h.redirect(`/system/return-logs/setup/${sessionId}/check`)
+}
+
 async function submitReceived(request, h) {
   const {
     params: { sessionId },
@@ -191,7 +212,7 @@ async function submitSingleVolume(request, h) {
   }
 
   if (pageData.singleVolume === 'no') {
-    return h.redirect(`/system/return-logs/setup/${sessionId}/check-answers`)
+    return h.redirect(`/system/return-logs/setup/${sessionId}/check`)
   }
 
   return h.redirect(`/system/return-logs/setup/${sessionId}/period-used`)
@@ -238,6 +259,7 @@ module.exports = {
   meterDetails,
   meterProvided,
   note,
+  periodUsed,
   received,
   reported,
   setup,
@@ -246,6 +268,7 @@ module.exports = {
   submitMeterDetails,
   submitMeterProvided,
   submitNote,
+  submitPeriodUsed,
   submitReceived,
   submitReported,
   submitSingleVolume,

app/presenters/return-logs/setup/period-used.presenter.js

@@ -0,0 +1,52 @@
+'use strict'
+
+/**
+ * Format data for the `/return-log/setup/{sessionId}/period-used` page
+ * @module PeriodUsedPresenter
+ */
+
+const { formatAbstractionPeriod } = require('../../base.presenter.js')
+
+/**
+ * Format data for the `/return-log/setup/{sessionId}/period-used` page
+ *
+ * @param {module:SessionModel} session - The return log setup session instance
+ *
+ * @returns {object} page data needed by the view template
+ */
+function go(session) {
+  const {
+    id: sessionId,
+    periodStartDay,
+    periodStartMonth,
+    periodEndDay,
+    periodEndMonth,
+    periodDateUsedOptions,
+    returnReference,
+    periodUsedFromDay,
+    periodUsedFromMonth,
+    periodUsedFromYear,
+    periodUsedToDay,
+    periodUsedToMonth,
+    periodUsedToYear
+  } = session
+
+  return {
+    abstractionPeriod: formatAbstractionPeriod(periodStartDay, periodStartMonth, periodEndDay, periodEndMonth),
+    backLink: `/system/return-logs/setup/${sessionId}/single-volume`,
+    pageTitle: 'What period was used for this volume?',
+    periodDateUsedOptions: periodDateUsedOptions ?? null,
+    periodUsedFromDay: periodUsedFromDay ?? null,
+    periodUsedFromMonth: periodUsedFromMonth ?? null,
+    periodUsedFromYear: periodUsedFromYear ?? null,
+    periodUsedToDay: periodUsedToDay ?? null,
+    periodUsedToMonth: periodUsedToMonth ?? null,
+    periodUsedToYear: periodUsedToYear ?? null,
+    returnReference,
+    sessionId
+  }
+}
+
+module.exports = {
+  go
+}

app/routes/return-logs-setup.routes.js

@@ -242,6 +242,30 @@ const routes = [
         }
       }
     }
+  },
+  {
+    method: 'GET',
+    path: '/return-logs/setup/{sessionId}/period-used',
+    options: {
+      handler: ReturnLogsSetupController.periodUsed,
+      auth: {
+        access: {
+          scope: ['billing']
+        }
+      }
+    }
+  },
+  {
+    method: 'POST',
+    path: '/return-logs/setup/{sessionId}/period-used',
+    options: {
+      handler: ReturnLogsSetupController.submitPeriodUsed,
+      auth: {
+        access: {
+          scope: ['billing']
+        }
+      }
+    }
   }
 ]
 

app/services/return-logs/setup/period-used.service.js

@@ -0,0 +1,34 @@
+'use strict'
+
+/**
+ * Orchestrates fetching and presenting the data for `/return-logs/setup/{sessionId}/period-used` page
+ * @module PeriodUsedService
+ */
+
+const PeriodUsedPresenter = require('../../../presenters/return-logs/setup/period-used.presenter.js')
+const SessionModel = require('../../../models/session.model.js')
+
+/**
+ * Orchestrates fetching and presenting the data for `/return-logs/setup/{sessionId}/period-used` page
+ *
+ * Supports generating the data needed for the period used page in the return log setup journey. It fetches the
+ * current session record and formats the data needed for the page.
+ *
+ * @param {string} sessionId - The UUID of the current session
+ *
+ * @returns {Promise<object>} The view data for the period used page
+ */
+async function go(sessionId) {
+  const session = await SessionModel.query().findById(sessionId)
+
+  const formattedData = PeriodUsedPresenter.go(session)
+
+  return {
+    activeNavBar: 'search',
+    ...formattedData
+  }
+}
+
+module.exports = {
+  go
+}

app/services/return-logs/setup/submit-period-used.service.js

@@ -0,0 +1,110 @@
+'use strict'
+
+/**
+ * Orchestrates validating the data for `/return-logs/setup/{sessionId}/period-used` page
+ * @module SubmitPeriodUsedService
+ */
+
+const PeriodUsedPresenter = require('../../../presenters/return-logs/setup/period-used.presenter.js')
+const PeriodUsedValidator = require('../../../validators/return-logs/setup/period-used.validator.js')
+const SessionModel = require('../../../models/session.model.js')
+
+/**
+ * Orchestrates validating the data for `/return-logs/setup/{sessionId}/period-used` page
+ *
+ * It first retrieves the session instance for the return log setup session in progress. The session has details about
+ * the return log that are needed to validate that the chosen date is valid.
+ *
+ * The validation result is then combined with the output of the presenter to generate the page data needed by the view.
+ * If there was a validation error the controller will re-render the page so needs this information. If all is well the
+ * controller will redirect to the next page in the journey.
+ *
+ * @param {string} sessionId - The UUID of the current session
+ * @param {object} payload - The submitted form data
+ *
+ * @returns {Promise<object>} If no errors the page data for the period-used page else the validation error details
+ */
+async function go(sessionId, payload) {
+  const session = await SessionModel.query().findById(sessionId)
+
+  const validationResult = _validate(payload, session)
+
+  if (!validationResult) {
+    await _save(session, payload)
+
+    return {}
+  }
+
+  const formattedData = _submittedSessionData(session, payload)
+
+  return {
+    activeNavBar: 'search',
+    error: validationResult,
+    ...formattedData
+  }
+}
+
+async function _save(session, payload) {
+  session.periodDateUsedOptions = payload.periodDateUsedOptions
+  session.fromFullDate = payload.fromFullDate
+  session.toFullDate = payload.toFullDate
+  session.periodUsedFromDay = payload['period-used-from-day']
+  session.periodUsedFromMonth = payload['period-used-from-month']
+  session.periodUsedFromYear = payload['period-used-from-year']
+  session.periodUsedToDay = payload['period-used-to-day']
+  session.periodUsedToMonth = payload['period-used-to-month']
+  session.periodUsedToYear = payload['period-used-to-year']
+
+  return session.$update()
+}
+
+function _submittedSessionData(session, payload) {
+  session.periodDateUsedOptions = payload.periodDateUsedOptions ?? null
+  session.periodUsedFromDay = payload['period-used-from-day'] ?? null
+  session.periodUsedFromMonth = payload['period-used-from-month'] ?? null
+  session.periodUsedFromYear = payload['period-used-from-year'] ?? null
+  session.periodUsedToDay = payload['period-used-to-day'] ?? null
+  session.periodUsedToMonth = payload['period-used-to-month'] ?? null
+  session.periodUsedToYear = payload['period-used-to-year'] ?? null
+
+  return PeriodUsedPresenter.go(session)
+}
+
+function _validate(payload, session) {
+  const { startDate, endDate } = session
+
+  const validation = PeriodUsedValidator.go(payload, startDate, endDate)
+
+  if (!validation.error) {
+    return null
+  }
+
+  const result = {
+    errorList: []
+  }
+
+  validation.error.details.forEach((detail) => {
+    let href
+
+    if (detail.context.key === 'fromFullDate') {
+      href = '#from-full-date'
+    } else if (detail.context.key === 'toFullDate') {
+      href = '#to-full-date'
+    } else {
+      href = '#period-date-used-options'
+    }
+
+    result.errorList.push({
+      href,
+      text: detail.message
+    })
+
+    result[detail.context.key] = { message: detail.message }
+  })
+
+  return result
+}
+
+module.exports = {
+  go
+}