Amend no returns message in view licence Returns tab

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

@@ -5,19 +5,25 @@
  * @module ViewLicenceReturnsPresenter
  */
 
-const { formatLongDate } = require('../base.presenter')
+const { formatLongDate } = require('../base.presenter.js')
 
 /**
  * Formats common data for the `/licences/{id}/*` view licence pages
  *
+ * @param {module:ReturnLogModel[]} returnsData - The session for the return requirement journey
+ * @param {boolean} hasRequirements - If the licence has return versions then it has requirements
+ *
  * @returns {Object} The data formatted for the view template
  */
-function go (returnsData) {
-  const returns = _formatReturnToTableRow(returnsData.returns)
+function go (returnsData, hasRequirements) {
+  const returns = _formatReturnToTableRow(returnsData)
+
+  const hasReturns = returns.length > 0
 
   return {
     activeTab: 'returns',
-    returns
+    returns,
+    noReturnsMessage: _noReturnsMessage(hasReturns, hasRequirements)
   }
 }
 
@@ -53,6 +59,18 @@ function _formatStatus (status) {
   return 'NO STATUS'
 }
 
+function _noReturnsMessage (hasReturns, hasRequirements) {
+  if (!hasReturns && !hasRequirements) {
+    return 'No requirements for returns have been set up for this licence.'
+  }
+
+  if (hasRequirements && !hasReturns) {
+    return 'No returns for this licence.'
+  }
+
+  return null
+}
+
 module.exports = {
   go
 }

app/services/licences/determine-licence-has-return-versions.service.js

@@ -0,0 +1,35 @@
+'use strict'
+
+/**
+ * Determines if a licence has requirements
+ * @module DetermineLicenceHasReturnVersionsService
+ */
+
+const ReturnVersionModel = require('../../models/return-version.model.js')
+
+/**
+ * Determines if a licence has requirements
+ *
+ * @param {string} licenceId - The UUID of the licence to determine if return versions exist
+ *
+ * @returns {Promise<Boolean>} true if the licence has return versions else false
+ */
+async function go (licenceId) {
+  const requirement = await _fetch(licenceId)
+
+  return !!requirement
+}
+
+async function _fetch (licenceId) {
+  return ReturnVersionModel.query()
+    .select([
+      'id'
+    ])
+    .where('licenceId', licenceId)
+    .limit(1)
+    .first()
+}
+
+module.exports = {
+  go
+}

app/services/licences/view-licence-returns.service.js

@@ -5,23 +5,28 @@
  * @module ViewLicenceSummaryService
  */
 
-const FetchLicenceReturnsService = require('./fetch-licence-returns.service')
-const ViewLicenceService = require('./view-licence.service')
-const ViewLicenceReturnsPresenter = require('../../presenters/licences/view-licence-returns.presenter')
-const PaginatorPresenter = require('../../presenters/paginator.presenter')
+const DetermineLicenceHasReturnVersionsService = require('./determine-licence-has-return-versions.service.js')
+const FetchLicenceReturnsService = require('./fetch-licence-returns.service.js')
+const PaginatorPresenter = require('../../presenters/paginator.presenter.js')
+const ViewLicenceReturnsPresenter = require('../../presenters/licences/view-licence-returns.presenter.js')
+const ViewLicenceService = require('./view-licence.service.js')
 
 /**
  * Orchestrates fetching and presenting the data needed for the licence summary page
  *
  * @param {string} licenceId - The UUID of the licence
+ * @param {Object} auth - The auth object taken from `request.auth` containing user details
+ * @param {Object} page - The current page for the pagination service
  *
  * @returns {Promise<Object>} an object representing the `pageData` needed by the licence summary template.
  */
 async function go (licenceId, auth, page) {
   const commonData = await ViewLicenceService.go(licenceId, auth)
 
+  const hasRequirements = await DetermineLicenceHasReturnVersionsService.go(licenceId)
+
   const returnsData = await FetchLicenceReturnsService.go(licenceId, page)
-  const pageData = ViewLicenceReturnsPresenter.go(returnsData)
+  const pageData = ViewLicenceReturnsPresenter.go(returnsData.returns, hasRequirements)
 
   const pagination = PaginatorPresenter.go(returnsData.pagination.total, Number(page), `/system/licences/${licenceId}/returns`)
 

app/services/licences/view-licence.service.js

@@ -12,7 +12,7 @@ const ViewLicencePresenter = require('../../presenters/licences/view-licence.pre
  * Orchestrates fetching and presenting the data needed for the licence summary page
  *
  * @param {string} licenceId - The UUID of the licence
- * @param {string} auth - Auth object
+ * @param {Object} auth - The auth object taken from `request.auth` containing user details
  * @returns {Promise<Object>} an object representing the `pageData` needed by the licence summary template.
  */
 async function go (licenceId, auth) {

app/views/licences/tabs/returns.njk

@@ -19,36 +19,56 @@
   {% endif %}
 {% endmacro %}
 
-<table class="govuk-table">
-  <h2 class="govuk-heading-l">Returns</h2>
-  {% if returns.length > 0 %}
-    <thead class="govuk-table__head">
-    <tr class="govuk-table__row">
-      <th scope="col" class="govuk-table__header">Return reference and dates</th>
-      <th scope="col" class="govuk-table__header">Purpose and description</th>
-      <th scope="col" class="govuk-table__header">Due date</th>
-      <th scope="col" class="govuk-table__header">Status</th>
-    </tr>
-    </thead>
-    <tbody class="govuk-table__body">
-    {% for return in returns %}
-      <tr class="govuk-table__row govuk-body-s">
-        <th class="govuk-table__cell">
-          <a href="/return/internal?returnId={{ return.id }}" class="govuk-link">{{ return.reference }} </a>
-          <p class="govuk-body-s"> {{ return.dates }}</p>
-        </th>
-        <td class="govuk-table__cell">{{ return.purpose }} <p class="govuk-body-s"> {{ return.description }}</p></td>
-        <td class="govuk-table__cell">{{ return.dueDate }}</td>
-        <td class="govuk-table__cell">{{ formatStatus(return.status) }}</td>
-      </tr>
-    {% endfor %}
-    </tbody>
-  {% else %}
-    <p>No returns found</p>
-  {% endif %}
-</table>
+<h2 class="govuk-heading-l">Returns</h2>
+
+{% if noReturnsMessage %}
+  <p> {{ noReturnsMessage }} </p>
+{% else %}
+
+  {% macro referenceColumn(return) %}
+    <a href="/return/internal?returnId={{ return.id }}" class="govuk-link">{{ return.reference }} </a>
+    <p class="govuk-body-s"> {{ return.dates }}</p>
+  {% endmacro %}
+
+  {% set returnRows = [] %}
+
+  {% for returnItem in  returns %}
+    {% set returnRows = (returnRows.push([
+      {
+        html: referenceColumn(returnItem)
+      },
+      {
+        html:  returnItem.purpose +  "<p class=\"govuk-body-s\">" + returnItem.description + "</p>"
+      },
+      {
+        text: returnItem.dueDate
+      },
+      {
+        html: formatStatus(returnItem.status)
+      }
+    ]), returnRows) %}
+  {% endfor %}
+
+  {{ govukTable({
+    head: [
+      {
+        text: 'Return reference and dates'
+      },
+      {
+        text: 'Purpose and description'
+      },
+      {
+        text: 'Due date'
+      },
+      {
+        text: 'Status'
+      }
+    ],
+    rows: returnRows
+  }) }}
+{% endif %}
 
-{% if returns and pagination.numberOfPages > 1 %}
+{% if pagination.numberOfPages > 1 %}
   {{ govukPagination(pagination.component) }}
 {% endif %}
 

test/controllers/licences.controller.test.js

@@ -403,9 +403,15 @@ describe('Licences controller', () => {
       }
     })
 
-    describe('when a request is valid and has returns', () => {
+    describe('when a request is valid', () => {
       beforeEach(async () => {
-        Sinon.stub(ViewLicenceReturnsService, 'go').resolves(_viewLicenceReturns())
+        Sinon.stub(ViewLicenceReturnsService, 'go').resolves({
+          activeTab: 'returns',
+          returns: [
+            { id: 'returns-id' }
+          ],
+          noReturnsMessage: null
+        })
       })
 
       it('returns the page successfully', async () => {
@@ -420,24 +426,6 @@ describe('Licences controller', () => {
         expect(response.payload).to.contain('Status')
       })
     })
-
-    describe('when a request is valid and has NO returns', () => {
-      beforeEach(async () => {
-        Sinon.stub(ViewLicenceReturnsService, 'go').resolves({
-          activeTab: 'returns',
-          returns: []
-        })
-      })
-
-      it('returns the page successfully', async () => {
-        const response = await server.inject(options)
-
-        expect(response.statusCode).to.equal(200)
-        expect(response.payload).to.contain('Returns')
-        //  Check the table titles
-        expect(response.payload).to.contain('No returns found')
-      })
-    })
   })
 })
 
@@ -474,13 +462,6 @@ function _viewLicenceContactDetails () {
   }
 }
 
-function _viewLicenceReturns () {
-  return {
-    activeTab: 'returns',
-    returns: [{ id: 'returns-id' }]
-  }
-}
-
 function _viewLicenceSummary () {
   return {
     id: '7861814c-ca19-43f2-be11-3c612f0d744b',