What do you want to do with this return?

.env.example

@@ -76,3 +76,4 @@ ENABLE_TWO_PART_TARIFF_SUPPLEMENTARY=false
 ENABLE_MONITORING_STATIONS_VIEW=true
 ENABLE_LICENCE_PURPOSES_VIEW=true
 ENABLE_LICENCE_POINTS_VIEW=true
+ENABLE_SYSTEM_RETURNS_VIEW=true

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

@@ -8,30 +8,39 @@
 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 StartService = require('../services/return-logs/setup/start.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 SubmitStartService = require('../services/return-logs/setup/submit-start.service.js')
 const SubmitUnitsService = require('../services/return-logs/setup/submit-units.service.js')
 const UnitsService = require('../services/return-logs/setup/units.service.js')
 
 async function received(request, h) {
   const { sessionId } = request.params
   const pageData = await ReceivedService.go(sessionId)
 
-  return h.view('return-logs/setup/received.njk', { ...pageData })
+  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 })
+  return h.view('return-logs/setup/reported.njk', pageData)
 }
 
 async function setup(request, h) {
   const { returnLogId } = request.query
   const session = await InitiateSessionService.go(returnLogId)
 
-  return h.redirect(`/system/return-logs/setup/${session.id}/how-to-edit`)
+  return h.redirect(`/system/return-logs/setup/${session.id}/start`)
+}
+
+async function start(request, h) {
+  const { sessionId } = request.params
+  const pageData = await StartService.go(sessionId)
+
+  return h.view('return-logs/setup/start.njk', pageData)
 }
 
 async function submitReceived(request, h) {
@@ -64,6 +73,18 @@ async function submitReported(request, h) {
   return h.redirect(`/system/return-logs/setup/${sessionId}/units`)
 }
 
+async function submitStart(request, h) {
+  const { sessionId } = request.params
+
+  const pageData = await SubmitStartService.go(sessionId, request.payload)
+
+  if (pageData.error) {
+    return h.view('return-logs/setup/start.njk', pageData)
+  }
+
+  return h.redirect(`/system/return-logs/setup/${sessionId}/received`)
+}
+
 async function submitUnits(request, h) {
   const {
     params: { sessionId },
@@ -90,8 +111,10 @@ module.exports = {
   received,
   reported,
   setup,
+  start,
   submitReceived,
   submitReported,
+  submitStart,
   submitUnits,
   units
 }

app/presenters/bill-runs/review/base-review.presenter.js

@@ -4,6 +4,7 @@ const Big = require('big.js')
 
 const { formatLongDate } = require('../../base.presenter.js')
 const DetermineAbstractionPeriodService = require('../../../services/bill-runs/determine-abstraction-periods.service.js')
+const FeatureFlagsConfig = require('../../../../config/feature-flags.config.js')
 
 /**
  * Calculates the total allocated volume across all review change elements
@@ -31,7 +32,11 @@ function determineReturnLink(reviewReturn) {
   const { returnId, returnStatus } = reviewReturn
 
   if (['due', 'received'].includes(returnStatus)) {
-    return `/return/internal?returnId=${returnId}`
+    if (FeatureFlagsConfig.enableSystemReturnsView) {
+      return `/system/return-logs/setup?returnLogId=${returnId}`
+    } else {
+      return `/return/internal?returnId=${returnId}`
+    }
   }
 
   return `/returns/return?id=${returnId}`

app/presenters/licences/view-licence-returns.presenter.js

@@ -5,6 +5,7 @@
  * @module ViewLicenceReturnsPresenter
  */
 
+const FeatureFlagsConfig = require('../../../config/feature-flags.config.js')
 const { formatLongDate } = require('../base.presenter.js')
 
 /**
@@ -34,7 +35,11 @@ function _link(status, returnLogId, canManageReturns) {
   }
 
   if (canManageReturns) {
-    return `/return/internal?returnId=${returnLogId}`
+    if (FeatureFlagsConfig.enableSystemReturnsView) {
+      return `/system/return-logs/setup?returnLogId=${returnLogId}`
+    } else {
+      return `/return/internal?returnId=${returnLogId}`
+    }
   }
 
   return null

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

@@ -0,0 +1,77 @@
+'use strict'
+
+/**
+ * Formats the data ready for presenting in the `/return-logs/setup/{sessionId}/start` page
+ * @module StartPresenter
+ */
+
+const { formatAbstractionPeriod, formatLongDate } = require('../../base.presenter.js')
+
+/**
+ * Formats the data ready for presenting in the `/return-logs/setup/{sessionId}/start` page
+ *
+ * @param {module:SessionModel} session - The session instance to format
+ *
+ * @returns {object} page data needed for the `/return-logs/setup/{sessionId}/start` page
+ */
+function go(session) {
+  const {
+    dueDate,
+    endDate,
+    journey,
+    licenceId,
+    licenceRef,
+    periodStartDay,
+    periodStartMonth,
+    periodEndDay,
+    periodEndMonth,
+    purposes,
+    receivedDate,
+    returnReference,
+    siteDescription,
+    startDate,
+    status,
+    twoPartTariff
+  } = session
+
+  return {
+    abstractionPeriod: `From ${formatAbstractionPeriod(
+      periodStartDay,
+      periodStartMonth,
+      periodEndDay,
+      periodEndMonth
+    )}`,
+    displayRecordReceipt: receivedDate === null,
+    journey: journey ?? null,
+    licenceId,
+    licenceRef,
+    pageTitle: 'Abstraction return',
+    purposes,
+    returnsPeriod: `From ${formatLongDate(new Date(startDate))} to ${formatLongDate(new Date(endDate))}`,
+    returnReference,
+    siteDescription,
+    status: _status(status, dueDate),
+    tariffType: twoPartTariff ? 'Two part tariff' : 'Standard tariff'
+  }
+}
+
+function _status(status, dueDate) {
+  if (status === 'due') {
+    // Work out if the return is overdue (status is still 'due' and it is past the due date)
+    const today = new Date()
+    // Reset today's time to midnight to ensure only the date is compared
+    today.setHours(0, 0, 0, 0)
+
+    if (new Date(dueDate) < today) {
+      return 'overdue'
+    }
+  }
+
+  // For all other cases we can just return the status and the return-status-tag macro will know how to display it
+  // return status
+  return status
+}
+
+module.exports = {
+  go
+}

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

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

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

@@ -49,7 +49,10 @@ async function _fetchReturnLog(returnLogId) {
       'returnLogs.id as returnLogId',
       'returnLogs.startDate',
       'returnLogs.endDate',
+      'returnLogs.receivedDate',
       'returnLogs.returnReference',
+      'returnLogs.dueDate',
+      'returnLogs.status',
       'returnLogs.underQuery',
       ref('returnLogs.metadata:nald.periodStartDay').castInt().as('periodStartDay'),
       ref('returnLogs.metadata:nald.periodStartMonth').castInt().as('periodStartMonth'),

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

@@ -0,0 +1,31 @@
+'use strict'
+
+/**
+ * Orchestrates fetching and presenting the data needed for the `/return-logs/setup/{sessionId}/start` page
+ * @module StartService
+ */
+
+const SessionModel = require('../../../models/session.model.js')
+const StartPresenter = require('../../../presenters/return-logs/setup/start.presenter.js')
+
+/**
+ * Orchestrates fetching and presenting the data needed for the `/return-logs/setup/{sessionId}/start` page
+ *
+ * @param {string} sessionId - The UUID of the current session
+ *
+ * @returns {Promise<object>} page data needed by the view template
+ */
+async function go(sessionId) {
+  const session = await SessionModel.query().findById(sessionId)
+
+  const formattedData = StartPresenter.go(session)
+
+  return {
+    activeNavBar: 'search',
+    ...formattedData
+  }
+}
+
+module.exports = {
+  go
+}

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

@@ -0,0 +1,62 @@
+'use strict'
+
+/**
+ * Handles the user submission for the `/return-logs/setup/{sessionId}/start` page
+ * @module SubmitStartService
+ */
+
+const SessionModel = require('../../../models/session.model.js')
+const StartPresenter = require('../../../presenters/return-logs/setup/start.presenter.js')
+const StartValidator = require('../../../validators/return-logs/setup/start.validator.js')
+
+/**
+ * Handles the user submission for the `/return-logs/setup/{sessionId}/start` page
+ *
+ * @param {string} sessionId - The UUID of the current session
+ * @param {object} payload - The submitted form data
+ *
+ * @returns {Promise<object>} An object with a `journey:` property if there are no errors else the page data for
+ * the abstraction return page including 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 = StartPresenter.go(session)
+
+  return {
+    activeNavBar: 'search',
+    error: validationResult,
+    ...formattedData
+  }
+}
+
+async function _save(session, payload) {
+  session.journey = payload.journey
+
+  return session.$update()
+}
+
+function _validate(payload) {
+  const validation = StartValidator.go(payload)
+
+  if (!validation.error) {
+    return null
+  }
+
+  const { message } = validation.error.details[0]
+
+  return {
+    text: message
+  }
+}
+
+module.exports = {
+  go
+}

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

@@ -0,0 +1,39 @@
+'use strict'
+
+/**
+ * Validates data submitted for the `/return-logs/setup/{sessionId}/start` page
+ * @module StartValidator
+ */
+
+const Joi = require('joi')
+
+const VALID_VALUES = ['enter-return', 'nil-return', 'record-receipt']
+
+/**
+ * Validates data submitted for the `/return-logs/setup/{sessionId}/start` 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 errorMessage = 'Select what you want to do with this return'
+
+  const schema = Joi.object({
+    journey: Joi.string()
+      .required()
+      .valid(...VALID_VALUES)
+      .messages({
+        'any.required': errorMessage,
+        'any.only': errorMessage,
+        'string.empty': errorMessage
+      })
+  })
+
+  return schema.validate(payload, { abortEarly: false })
+}
+
+module.exports = {
+  go
+}