fix(app): simplified check licence

app/services/return-requirements/check-licence-ended.service.js

@@ -1,18 +1,50 @@
-// check-licence-ended.service.js
-
 'use strict'
 
 /**
- * Service to check if a licence has ended.
- * This service checks the 'ends' date of the licence data and determines if the licence has ended.
+ * Fetches and checks data needed for the view `/return-requirements/{sessionId}/check-your-answers` page
+ * @module CheckLicenceService
+ */
+
+const LicenceModel = require('../../models/licence.model.js')
+
+/**
+ * Fetch the matching licence and return data needed for the check your answers page
+ *
+ * Was built to provide the data needed for the '/return-requirements/{id}/check-your-answers' page
+ *
+ * @param {string} id The UUID for the licence to fetch
+ *
+ * @returns {Promise<Object>} the data needed for "check your answers" page when user submits for approval
+ */
+async function go (id) {
+  const licence = await _fetchLicence(id)
+  const licenceEnded = _checkLicenceEnded(licence)
+  return licenceEnded
+}
+
+async function _fetchLicence (id) {
+  return LicenceModel.query()
+    .findById(id)
+    .select([
+      'expiredDate',
+      'id',
+      'lapsedDate',
+      'licenceRef',
+      'revokedDate',
+      'startDate'
+    ])
+}
+
+/**
+ * Check if a licence has ended.
  * If it's not within range, we assume it's either lapsed, expired or revoked
  * It returns true if the licence has ended, false otherwise.
  *
  * @param {object} licenceData - The licence data object
  * @returns {boolean} - True if the licence has ended, false otherwise
  */
-async function checkLicenceEnded (licenceData) {
-  const { ends } = licenceData
+function _checkLicenceEnded (licence) {
+  const { $ends: ends } = licence
 
   if (!ends) {
     return false
@@ -26,5 +58,5 @@ async function checkLicenceEnded (licenceData) {
 }
 
 module.exports = {
-  checkLicenceEnded
+  go
 }

app/services/return-requirements/submit-check-your-answers.service.js

@@ -13,13 +13,12 @@
  */
 const CheckLicenceEndedService = require('./check-licence-ended.service.js')
 const SessionModel = require('../../models/session.model.js')
-const FetchLicenceService = require('./fetch-licence.service.js')
 const ExpandedError = require('../../errors/expanded.error.js')
 
 async function go (sessionId) {
   const session = await SessionModel.query().findById(sessionId)
-  const licenceData = await FetchLicenceService.go(session.data.licence.id)
-  const isLicenceEnded = await CheckLicenceEndedService.checkLicenceEnded(licenceData)
+  const licenceData = await CheckLicenceEndedService.go(session.data.licence.id)
+  const isLicenceEnded = await licenceData.ended
 
   if (isLicenceEnded) {
     throw new ExpandedError('Invalid return requirement', { licenceData })

test/services/return-requirements/check-licence-ended.service.test.js

@@ -4,51 +4,30 @@
 const Lab = require('@hapi/lab')
 const Code = require('@hapi/code')
 
-const { describe, it } = exports.lab = Lab.script()
+const { describe, it, beforeEach } = exports.lab = Lab.script()
 const { expect } = Code
 
+// Test helpers
+const DatabaseSupport = require('../../support/database.js')
+const LicenceHelper = require('../../support/helpers/licence.helper.js')
+
 // Thing under test
 const CheckLicenceEndedService = require('../../../app/services/return-requirements/check-licence-ended.service.js')
 
-describe('Check Licence Ended Service', () => {
-  describe('when the licence has not ended', () => {
-    it('returns false', async () => {
-      // tomorrow
-      const futureDate = new Date()
-      futureDate.setDate(futureDate.getDate() + 1)
-
-      const licenceData = {
-        ends: {
-          date: futureDate.toISOString()
-        }
-      }
+describe('CheckLicenceEndedService', () => {
+  let licence
 
-      const result = await CheckLicenceEndedService.checkLicenceEnded(licenceData)
-      expect(result).to.be.false()
-    })
+  beforeEach(async () => {
+    await DatabaseSupport.clean()
   })
 
-  describe('when the licence has ended', () => {
-    it('returns true', async () => {
-      // a date in the past
-      const pastDate = new Date('2024-02-14')
-
-      const licenceData = {
-        ends: {
-          date: pastDate.toISOString()
-        }
-      }
-
-      const result = await CheckLicenceEndedService.checkLicenceEnded(licenceData)
-      expect(result).to.be.true()
+  describe('go', () => {
+    beforeEach(async () => {
+      licence = await LicenceHelper.add()
     })
-  })
-
-  describe('when the licence ends data is not available', () => {
-    it('returns false', async () => {
-      const licenceData = {}
 
-      const result = await CheckLicenceEndedService.checkLicenceEnded(licenceData)
+    it('fetches licence data correctly', async () => {
+      const result = await CheckLicenceEndedService.go(licence.id)
       expect(result).to.be.false()
     })
   })

test/services/return-requirements/submit-check-your-answers.service.test.js

@@ -13,7 +13,7 @@ const SessionHelper = require('../../support/helpers/session.helper.js')
 const ExpandedError = require('../../../app/errors/expanded.error.js')
 
 // Thing under test
-const FetchLicenceService = require('../../../app/services/return-requirements/fetch-licence.service.js')
+const CheckLicenceEndedService = require('../../../app/services/return-requirements/check-licence-ended.service.js')
 const SubmitCheckYourAnswersService = require('../../../app/services/return-requirements/submit-check-your-answers.service.js')
 
 describe('Submit Check Your Answers service', () => {
@@ -39,10 +39,7 @@ describe('Submit Check Your Answers service', () => {
 
   describe('POST /return-requirements/{sessionDd}/check-your-answers', () => {
     beforeEach(() => {
-      Sinon.stub(FetchLicenceService, 'go').resolves({
-        id: licenceId,
-        ends: null
-      })
+      Sinon.stub(CheckLicenceEndedService, 'go').resolves(false)
     })
 
     describe('When called with a valid licence', () => {