Return Logs setup reported page

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

@@ -7,7 +7,9 @@
 
 const InitiateSessionService = require('../services/return-logs/setup/initiate-session.service.js')
 const ReceivedService = require('../services/return-logs/setup/received.service.js')
+const ReportedService = require('../services/return-logs/setup/reported.service.js')
 const SubmitReceivedService = require('../services/return-logs/setup/submit-received.service.js')
+const SubmitReportedService = require('../services/return-logs/setup/submit-reported.service.js')
 
 async function received(request, h) {
   const { sessionId } = request.params
@@ -16,6 +18,13 @@ async function received(request, h) {
   return h.view('return-logs/setup/received.njk', { ...pageData })
 }
 
+async function reported(request, h) {
+  const { sessionId } = request.params
+  const pageData = await ReportedService.go(sessionId)
+
+  return h.view('return-logs/setup/reported.njk', { ...pageData })
+}
+
 async function setup(request, h) {
   const { returnLogId } = request.query
   const session = await InitiateSessionService.go(returnLogId)
@@ -38,8 +47,25 @@ async function submitReceived(request, h) {
   return h.redirect(`/system/return-logs/setup/${sessionId}/reported`)
 }
 
+async function submitReported(request, h) {
+  const {
+    params: { sessionId },
+    payload
+  } = request
+
+  const pageData = await SubmitReportedService.go(sessionId, payload)
+
+  if (pageData.error) {
+    return h.view('return-logs/setup/reported.njk', pageData)
+  }
+
+  return h.redirect(`/system/return-logs/setup/${sessionId}/units`)
+}
+
 module.exports = {
   received,
+  reported,
   setup,
-  submitReceived
+  submitReceived,
+  submitReported
 }

app/presenters/return-logs/setup/reported.presenter.js

@@ -0,0 +1,33 @@
+'use strict'
+
+/**
+ * Format data for the `/return-log/setup/{sessionId}/reported` page
+ * @module ReportedPresenter
+ */
+
+/**
+ * Format data for the `/return-log/setup/{sessionId}/reported` 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,
+    data: { returnReference },
+    reported
+  } = session
+
+  return {
+    pageTitle: 'How was this return reported?',
+    reported: reported ?? null,
+    sessionId,
+    returnReference,
+    backLink: `/system/return-logs/setup/${session.id}/received`
+  }
+}
+
+module.exports = {
+  go
+}

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

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

app/services/return-logs/setup/reported.service.js

@@ -0,0 +1,34 @@
+'use strict'
+
+/**
+ * Orchestrates fetching and presenting the data for `/return-logs/setup/{sessionId}/reported` page
+ * @module ReportedService
+ */
+
+const ReportedPresenter = require('../../../presenters/return-logs/setup/reported.presenter.js')
+const SessionModel = require('../../../models/session.model.js')
+
+/**
+ * Orchestrates fetching and presenting the data for `/return-logs/setup/{sessionId}/reported` page
+ *
+ * Supports generating the data needed for the reported 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 reported page
+ */
+async function go(sessionId) {
+  const session = await SessionModel.query().findById(sessionId)
+
+  const formattedData = ReportedPresenter.go(session)
+
+  return {
+    activeNavBar: 'search',
+    ...formattedData
+  }
+}
+
+module.exports = {
+  go
+}

app/services/return-logs/setup/submit-reported.service.js

@@ -0,0 +1,68 @@
+'use strict'
+
+/**
+ * Orchestrates validating the data for `/return-logs/setup/{sessionId}/reported` page
+ * @module SubmitReportedService
+ */
+
+const ReportedPresenter = require('../../../presenters/return-logs/setup/reported.presenter.js')
+const ReportedValidator = require('../../../validators/return-logs/setup/reported.validator.js')
+const SessionModel = require('../../../models/session.model.js')
+
+/**
+ * Orchestrates validating the data for `/return-logs/setup/{sessionId}/reported` page
+ *
+ * It first retrieves the session instance for the return log setup session in progress.
+ *
+ * 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 reported page else the validation error details
+ */
+async function go(sessionId, payload) {
+  const session = await SessionModel.query().findById(sessionId)
+
+  const validationResult = _validate(payload)
+
+  if (!validationResult) {
+    await _save(session, payload)
+
+    return {}
+  }
+
+  const formattedData = ReportedPresenter.go(session)
+
+  return {
+    activeNavBar: 'search',
+    error: validationResult,
+    ...formattedData
+  }
+}
+
+async function _save(session, payload) {
+  session.reported = payload.reported
+
+  return session.$update()
+}
+
+function _validate(payload) {
+  const validation = ReportedValidator.go(payload)
+
+  if (!validation.error) {
+    return null
+  }
+
+  const { message } = validation.error.details[0]
+
+  return {
+    text: message
+  }
+}
+
+module.exports = {
+  go
+}

app/validators/return-logs/setup/reported.validator.js

@@ -0,0 +1,41 @@
+'use strict'
+
+/**
+ * Validates data submitted for the `/return-logs/setup/{sessionId}/reported` page
+ * @module ReportedValidator
+ */
+
+const Joi = require('joi')
+
+const VALID_VALUES = ['meter-readings', 'abstraction-volumes']
+
+/**
+ * Validates data submitted for the `/return-logs/setup/{sessionId}/reported` page
+ *
+ * @param {object} payload - The payload from the request to be validated
+ *
+ * @returns {object} the result from calling Joi's schema.validate(). It will be an object with a `value:` property. If
+ * any errors are found the `error:` property will also exist detailing what the issues were
+ */
+function go(payload) {
+  const reported = payload.reported
+
+  const errorMessage = 'Select how this return was reported'
+
+  const schema = Joi.object({
+    reported: Joi.string()
+      .required()
+      .valid(...VALID_VALUES)
+      .messages({
+        'any.required': errorMessage,
+        'any.only': errorMessage,
+        'string.empty': errorMessage
+      })
+  })
+
+  return schema.validate({ reported }, { abortEarly: false })
+}
+
+module.exports = {
+  go
+}

app/views/return-logs/setup/reported.njk

@@ -0,0 +1,66 @@
+{% extends 'layout.njk' %}
+{% from "govuk/components/back-link/macro.njk" import govukBackLink %}
+{% from "govuk/components/button/macro.njk" import govukButton %}
+{% from "govuk/components/error-message/macro.njk" import govukErrorMessage %}
+{% from "govuk/components/error-summary/macro.njk" import govukErrorSummary %}
+{% from "govuk/components/radios/macro.njk" import govukRadios %}
+
+{% block breadcrumbs %}
+  {# Back link #}
+  {{
+    govukBackLink({
+      text: 'Back',
+      href: backLink
+    })
+  }}
+{% endblock %}
+
+{% block content %}
+  {# Error summary #}
+  {% if error %}
+    {{ govukErrorSummary({
+      titleText: "There is a problem",
+      errorList: [
+        {
+          text: error.text,
+          href: "#reported-error"
+        }
+      ]
+    }) }}
+  {%endif%}
+
+  {# Main heading #}
+  <div>
+    <span class="govuk-caption-l"> Return reference {{ returnReference }} </span>
+    <h1 class="govuk-heading-l">{{ pageTitle }}</h1>
+  </div>
+  <div>
+    <form method="post">
+      <input type="hidden" name="wrlsCrumb" value="{{wrlsCrumb}}"/>
+
+      {{ govukRadios({
+        name: "reported",
+        errorMessage: error,
+        fieldset: {
+          legend: {
+            classes: "govuk-fieldset__legend--l"
+          }
+        },
+        items: [
+          {
+            value: "meter-readings",
+            text: "Meter Readings",
+            checked: "meter-readings" == reported
+          },
+          {
+            value: "abstraction-volumes",
+            text: "Abstraction Volumes",
+            checked: "abstraction-volumes" == reported
+          }
+        ]
+      }) }}
+
+      {{ govukButton({ text: "Continue", preventDoubleClick: true }) }}
+    </form>
+  </div>
+{% endblock %}