Return logs check page - populate Reporting details (#1666)

https://eaflood.atlassian.net/browse/WATER-4806

This PR will focus on populating the "Reporting details" section of the "Check details and enter new volumes or readings" page with data from the session.

Author: Jozzey

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

@@ -5,6 +5,8 @@
  * @module CheckPresenter
  */
 
+const { formatLongDate, sentenceCase } = require('../../base.presenter.js')
+
 /**
  * Formats the data ready for presenting in the `/return-logs/setup/{sessionId}/check` page
  *
@@ -13,13 +15,29 @@
  * @returns {object} page data needed for the `/return-logs/setup/{sessionId}/check` page
  */
 function go(session) {
-  const { id: sessionId, note, returnReference } = session
+  const {
+    id: sessionId,
+    meterMake,
+    meterProvided,
+    meterSerialNumber,
+    note,
+    receivedDate,
+    reported,
+    returnReference,
+    units
+  } = session
 
   return {
+    meterMake,
+    meterProvided,
+    meterSerialNumber,
     note: _note(note),
     pageTitle: 'Check details and enter new volumes or readings',
+    returnReceivedDate: formatLongDate(new Date(receivedDate)),
+    reportingFigures: reported === 'meter-readings' ? 'Meter readings' : sentenceCase(reported),
     returnReference,
-    sessionId
+    sessionId,
+    units: units === 'cubic-metres' ? 'Cubic metres' : sentenceCase(units)
   }
 }
 

app/presenters/return-logs/setup/single-volume.presenter.js

@@ -22,7 +22,7 @@ function go(session) {
     sessionId,
     singleVolume: singleVolume ?? null,
     singleVolumeQuantity: singleVolumeQuantity ?? null,
-    units: units === 'cubic-meters' ? 'cubic meters' : units
+    units: units === 'cubic-metres' ? 'cubic metres' : units
   }
 }
 

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

@@ -7,7 +7,7 @@
 
 const Joi = require('joi')
 
-const VALID_VALUES = ['cubic-meters', 'litres', 'megalitres', 'gallons']
+const VALID_VALUES = ['cubic-metres', 'litres', 'megalitres', 'gallons']
 
 /**
  * Validates data submitted for the `/return-logs/setup/{sessionId}/units` page

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

@@ -41,6 +41,17 @@
     <hr class="govuk-section-break--visible">
   </div>
 
+
+  {# Meter details #}
+  {% set meterDetails %}
+    {% if meterProvided === 'yes' %}
+      <div>{{meterMake}}</div><div>{{meterSerialNumber}}</div>
+    {% else %}
+      <div>Not provided</div>
+    {% endif %}
+  {% endset %}
+
+
   {# Reporting details #}
   <div class="govuk-!-margin-bottom-9">
     {{ govukSummaryList({
@@ -55,7 +66,7 @@
             text: "Return received"
           },
           value: {
-            html: "8 January 2025"
+            text: returnReceivedDate
           },
           actions: {
             items: [
@@ -72,7 +83,7 @@
             text: "Reporting figures"
           },
           value: {
-            html: "Volumes"
+            text: reportingFigures
           },
           actions: {
             items: [
@@ -89,7 +100,7 @@
             text: "Meter details"
           },
           value: {
-            html: "<div>Meter make</div>" + "<div>Meter serial number</div>"
+            html: meterDetails
           },
           actions: {
             items: [
@@ -106,7 +117,7 @@
             text: "Units"
           },
           value: {
-            html: "Cubic meters"
+            text: units
           },
           actions: {
             items: [
@@ -132,7 +143,7 @@
           text: "Month"
         },
         {
-          text: "Total cubic meters",
+          text: "Total cubic metres",
           format: "numeric"
         },
         {

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

@@ -48,9 +48,9 @@
         },
         items: [
           {
-            value: "cubic-meters",
-            text: "Cubic Meters",
-            checked: "cubic-meters" === units
+            value: "cubic-metres",
+            text: "Cubic Metres",
+            checked: "cubic-metres" === units
           },
           {
             value: "litres",

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

@@ -96,6 +96,9 @@ describe('Return Logs Setup controller', () => {
       describe('when a request is valid', () => {
         beforeEach(() => {
           Sinon.stub(CheckService, 'go').resolves({
+            meterMake: 'Test meter make',
+            meterProvided: 'yes',
+            meterSerialNumber: '098765',
             pageTitle: 'Check details and enter new volumes or readings',
             returnReference: '1234567',
             sessionId
@@ -107,6 +110,8 @@ describe('Return Logs Setup controller', () => {
 
           expect(response.statusCode).to.equal(200)
           expect(response.payload).to.contain('Check details and enter new volumes or readings')
+          expect(response.payload).to.contain('Test meter make')
+          expect(response.payload).to.contain('098765')
           expect(response.payload).to.contain('1234567')
           expect(response.payload).to.contain(sessionId)
         })

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

@@ -16,7 +16,13 @@ describe('Return Logs Setup - Check presenter', () => {
   beforeEach(() => {
     session = {
       id: 'e840675e-9fb9-4ce1-bf0a-d140f5c57f47',
-      returnReference: '1234'
+      meterMake: 'Test meter make',
+      meterProvided: 'yes',
+      meterSerialNumber: '098765',
+      receivedDate: '2025-01-31T00:00:00.000Z',
+      reported: 'volumes',
+      returnReference: '1234',
+      units: 'megalitres'
     }
   })
 
@@ -25,6 +31,9 @@ describe('Return Logs Setup - Check presenter', () => {
       const result = CheckPresenter.go(session)
 
       expect(result).to.equal({
+        meterMake: 'Test meter make',
+        meterProvided: 'yes',
+        meterSerialNumber: '098765',
         note: {
           actions: [
             {
@@ -35,8 +44,11 @@ describe('Return Logs Setup - Check presenter', () => {
           text: 'No notes added'
         },
         pageTitle: 'Check details and enter new volumes or readings',
+        returnReceivedDate: '31 January 2025',
+        reportingFigures: 'Volumes',
         returnReference: '1234',
-        sessionId: session.id
+        sessionId: session.id,
+        units: 'Megalitres'
       })
     })
   })
@@ -84,4 +96,80 @@ describe('Return Logs Setup - Check presenter', () => {
       })
     })
   })
+
+  describe('the "reportingFigures" property', () => {
+    describe('when the user has used meter readings', () => {
+      beforeEach(() => {
+        session.reported = 'meter-readings'
+      })
+
+      it('returns the method of gathering the figures as "Meter readings"', () => {
+        const result = CheckPresenter.go(session)
+
+        expect(result.reportingFigures).to.equal('Meter readings')
+      })
+    })
+
+    describe('when the user has used volumes', () => {
+      beforeEach(() => {
+        session.reported = 'volumes'
+      })
+
+      it('returns the method of gathering the figures as "Volumes"', () => {
+        const result = CheckPresenter.go(session)
+
+        expect(result.reportingFigures).to.equal('Volumes')
+      })
+    })
+  })
+
+  describe('the "units" property', () => {
+    describe('when the user has used cubic metres', () => {
+      beforeEach(() => {
+        session.units = 'cubic-metres'
+      })
+
+      it('returns the unit of measurement as "Cubic metres"', () => {
+        const result = CheckPresenter.go(session)
+
+        expect(result.units).to.equal('Cubic metres')
+      })
+    })
+
+    describe('when the user has used litres', () => {
+      beforeEach(() => {
+        session.units = 'litres'
+      })
+
+      it('returns the unit of measurement as "Litres"', () => {
+        const result = CheckPresenter.go(session)
+
+        expect(result.units).to.equal('Litres')
+      })
+    })
+
+    describe('when the user has used megalitres', () => {
+      beforeEach(() => {
+        session.units = 'megalitres'
+      })
+
+      it('returns the unit of measurement as "Megalitres"', () => {
+        const result = CheckPresenter.go(session)
+
+        expect(result.units).to.equal('Megalitres')
+      })
+    })
+
+    describe('when the user has used gallons', () => {
+      beforeEach(() => {
+        session.units = 'gallons'
+      })
+
+      it('returns the unit of measurement as "Gallons"', () => {
+        const result = CheckPresenter.go(session)
+
+        expect(result.units).to.equal('Gallons')
+      })
+    })
+  })
 })

test/presenters/return-logs/setup/single-volume.presenter.test.js

@@ -78,15 +78,15 @@ describe('Return Logs Setup - Single Volume presenter', () => {
   })
 
   describe('the "units" property', () => {
-    describe('when the "units" property is "cubic-meters"', () => {
+    describe('when the "units" property is "cubic-metres"', () => {
       beforeEach(() => {
-        session.units = 'cubic-meters'
+        session.units = 'cubic-metres'
       })
 
       it('returns the "units" property presenter correctly', () => {
         const result = SingleVolumePresenter.go(session)
 
-        expect(result.units).to.equal('cubic meters')
+        expect(result.units).to.equal('cubic metres')
       })
     })
 

test/presenters/return-logs/setup/units.presenter.test.js

@@ -35,15 +35,15 @@ describe('Return Logs Setup - Units presenter', () => {
   })
 
   describe('the "units" property', () => {
-    describe('when the user has previously selected "Cubic Meters" as the reported type', () => {
+    describe('when the user has previously selected "Cubic Metres" as the reported type', () => {
       beforeEach(() => {
-        session.units = 'cubic-meters'
+        session.units = 'cubic-metres'
       })
 
       it('returns the "units" property populated to re-select the option', () => {
         const result = UnitsPresenter.go(session)
 
-        expect(result.units).to.equal('cubic-meters')
+        expect(result.units).to.equal('cubic-metres')
       })
     })
 

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

@@ -19,7 +19,15 @@ describe('Return Logs Setup - Check service', () => {
   let yarStub
 
   before(async () => {
-    session = await SessionHelper.add({ data: { returnReference: '1234' } })
+    session = await SessionHelper.add({
+      data: {
+        meterProvided: 'no',
+        receivedDate: '2025-01-31T00:00:00.000Z',
+        reported: 'volumes',
+        returnReference: '1234',
+        units: 'megalitres'
+      }
+    })
 
     yarStub = { flash: Sinon.stub().returns([]) }
   })
@@ -30,6 +38,9 @@ describe('Return Logs Setup - Check service', () => {
 
       expect(result).to.equal({
         activeNavBar: 'search',
+        meterMake: undefined,
+        meterProvided: 'no',
+        meterSerialNumber: undefined,
         note: {
           actions: [
             {
@@ -41,8 +52,11 @@ describe('Return Logs Setup - Check service', () => {
         },
         notification: undefined,
         pageTitle: 'Check details and enter new volumes or readings',
+        returnReceivedDate: '31 January 2025',
+        reportingFigures: 'Volumes',
         returnReference: '1234',
-        sessionId: session.id
+        sessionId: session.id,
+        units: 'Megalitres'
       })
     })
 

test/services/return-logs/setup/single-volume.service.test.js

@@ -20,7 +20,7 @@ describe('Return Logs Setup - Single Volume service', () => {
     session = await SessionHelper.add({
       data: {
         returnReference: '012345',
-        units: 'cubic-meters'
+        units: 'cubic-metres'
       }
     })
   })
@@ -43,7 +43,7 @@ describe('Return Logs Setup - Single Volume service', () => {
           returnReference: '012345',
           singleVolume: null,
           singleVolumeQuantity: null,
-          units: 'cubic meters'
+          units: 'cubic metres'
         },
         { skip: ['sessionId'] }
       )

test/validators/return-logs/setup/units.validator.test.js

@@ -14,9 +14,9 @@ describe('Return Logs Setup - Units validator', () => {
   let payload
 
   describe('when a valid payload is provided', () => {
-    describe('because the user selected the "cubic-meters" option', () => {
+    describe('because the user selected the "cubic-metres" option', () => {
       beforeEach(() => {
-        payload = { units: 'cubic-meters' }
+        payload = { units: 'cubic-metres' }
       })
 
       it('confirms the payload is valid', () => {