Feature notifications setup submit check (#1755)

* Add Notification setup submit check service
https://eaflood.atlassian.net/browse/WATER-4904

As part of the work to migrate the returns notifications from the legacy code. We need to have a service to send notification to notify.

This change adds the initial service to orchestrate creating, sending and persisting notifications.

The create event and event presenter have been implemented in earlier work and plumbed in this change.


---------

Co-authored-by: Alan Cruikshanks <[email protected]>

Author: jonathangoulding

app/controllers/notifications-setup.controller.js

@@ -14,6 +14,7 @@ const RemoveLicencesService = require('../services/notifications/setup/remove-li
 const ReturnsPeriodService = require('../services/notifications/setup/returns-period.service.js')
 const SubmitAdHocLicenceService = require('../services/notifications/setup/submit-ad-hoc-licence.service.js')
 const SubmitCancelService = require('../services/notifications/setup/submit-cancel.service.js')
+const SubmitCheckService = require('../services/notifications/setup/submit-check.service.js')
 const SubmitRemoveLicencesService = require('../services/notifications/setup/submit-remove-licences.service.js')
 const SubmitReturnsPeriodService = require('../services/notifications/setup/submit-returns-period.service.js')
 
@@ -97,6 +98,14 @@ async function submitCancel(request, h) {
   return h.redirect(`/manage`)
 }
 
+async function submitCheck(request, h) {
+  const { sessionId } = request.params
+
+  SubmitCheckService.go(sessionId)
+
+  return h.redirect(`/system/${basePath}/${sessionId}/confirmation`)
+}
+
 async function submitLicence(request, h) {
   const { sessionId } = request.params
 
@@ -148,6 +157,7 @@ module.exports = {
   viewReturnsPeriod,
   setup,
   submitCancel,
+  submitCheck,
   submitLicence,
   submitRemoveLicences,
   submitReturnsPeriod

app/presenters/notifications/setup/check.presenter.js

@@ -20,7 +20,7 @@ const NOTIFICATION_TYPES = {
  * @param {object[]} recipients - List of recipient objects, each containing recipient details like email or name.
  * @param {number|string} page - The currently selected page
  * @param {object} pagination - The result from `PaginatorPresenter`
- * @param {string} session - The session instance
+ * @param {object} session - The session instance
  *
  * @returns {object} - The data formatted for the view template
  */

app/routes/notifications-setup.routes.js

@@ -89,6 +89,18 @@ const routes = [
       }
     }
   },
+  {
+    method: 'POST',
+    path: basePath + '/{sessionId}/check',
+    options: {
+      handler: NotificationsSetupController.submitCheck,
+      auth: {
+        access: {
+          scope: ['returns']
+        }
+      }
+    }
+  },
   {
     method: 'GET',
     path: basePath + '/{sessionId}/returns-period',

app/services/notifications/setup/submit-check.service.js

@@ -0,0 +1,39 @@
+'use strict'
+
+/**
+ * Orchestrates handling the data for `/notifications/setup/{sessionId}/check` page
+ * @module SubmitCheckService
+ */
+
+const SessionModel = require('../../../models/session.model.js')
+const RecipientsService = require('./fetch-recipients.service.js')
+const DetermineRecipientsService = require('./determine-recipients.service.js')
+const { currentTimeInNanoseconds, calculateAndLogTimeTaken } = require('../../../lib/general.lib.js')
+
+/**
+ * Orchestrates handling the data for `/notifications/setup/{sessionId}/check` page
+ *
+ * This service will transform the recipients into notifications and start processing notifications.
+ *
+ * @param {string} sessionId - The UUID for the notification setup session record
+ *
+ */
+async function go(sessionId) {
+  try {
+    const startTime = currentTimeInNanoseconds()
+
+    const session = await SessionModel.query().findById(sessionId)
+
+    const recipientsData = await RecipientsService.go(session)
+
+    DetermineRecipientsService.go(recipientsData)
+
+    calculateAndLogTimeTaken(startTime, 'Send notifications complete', {})
+  } catch (error) {
+    global.GlobalNotifier.omfg('Send notifications failed', { sessionId }, error)
+  }
+}
+
+module.exports = {
+  go
+}

test/controllers/notifications-setup.controller.test.js

@@ -19,6 +19,7 @@ const ReturnsPeriodService = require('../../app/services/notifications/setup/ret
 const CancelService = require('../../app/services/notifications/setup/cancel.service.js')
 const CheckService = require('../../app/services/notifications/setup/check.service.js')
 const SubmitCancelService = require('../../app/services/notifications/setup/submit-cancel.service.js')
+const SubmitCheckService = require('../../app/services/notifications/setup/submit-check.service.js')
 const SubmitLicenceService = require('../../app/services/notifications/setup/submit-ad-hoc-licence.service.js')
 const SubmitRemoveLicencesService = require('../../app/services/notifications/setup/submit-remove-licences.service.js')
 const SubmitReturnsPeriodService = require('../../app/services/notifications/setup/submit-returns-period.service.js')
@@ -143,6 +144,22 @@ describe('Notifications Setup controller', () => {
         })
       })
     })
+
+    describe('POST', () => {
+      describe('when the request succeeds', () => {
+        beforeEach(async () => {
+          Sinon.stub(SubmitCheckService, 'go').returns()
+          postOptions = postRequestOptions(basePath + `/${session.id}/check`, {})
+        })
+
+        it('redirects the to the next page', async () => {
+          const response = await server.inject(postOptions)
+
+          expect(response.statusCode).to.equal(302)
+          expect(response.headers.location).to.equal(`/system/notifications/setup/${session.id}/confirmation`)
+        })
+      })
+    })
   })
 
   describe('notifications/setup/download', () => {

test/services/notifications/setup/check.service.test.js

@@ -5,7 +5,7 @@ const Lab = require('@hapi/lab')
 const Code = require('@hapi/code')
 const Sinon = require('sinon')
 
-const { describe, it, before } = (exports.lab = Lab.script())
+const { describe, it, afterEach, before } = (exports.lab = Lab.script())
 const { expect } = Code
 
 // Test helpers
@@ -16,7 +16,7 @@ const SessionHelper = require('../../../support/helpers/session.helper.js')
 // Thing under test
 const CheckService = require('../../../../app/services/notifications/setup/check.service.js')
 
-describe('Notifications Setup - Review service', () => {
+describe('Notifications Setup - Check service', () => {
   let removeLicences
   let session
   let testRecipients
@@ -33,6 +33,10 @@ describe('Notifications Setup - Review service', () => {
     Sinon.stub(RecipientsService, 'go').resolves([testRecipients.primaryUser])
   })
 
+  afterEach(() => {
+    Sinon.restore()
+  })
+
   it('correctly presents the data', async () => {
     const result = await CheckService.go(session.id)
 

test/services/notifications/setup/submit-check.service.test.js

@@ -0,0 +1,57 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+const Sinon = require('sinon')
+
+const { describe, it, afterEach, before } = (exports.lab = Lab.script())
+const { expect } = Code
+
+// Test helpers
+const RecipientsFixture = require('../../../fixtures/recipients.fixtures.js')
+const SessionHelper = require('../../../support/helpers/session.helper.js')
+
+// Things we need to stub
+const DetermineRecipientsService = require('../../../../app/services/notifications/setup/determine-recipients.service.js')
+const RecipientsService = require('../../../../app/services/notifications/setup/fetch-recipients.service.js')
+
+// Thing under test
+const SubmitCheckService = require('../../../../app/services/notifications/setup/submit-check.service.js')
+
+describe('Notifications Setup - Submit Check service', () => {
+  let notifierStub
+  let recipients
+  let session
+
+  before(async () => {
+    notifierStub = { omg: Sinon.stub(), omfg: Sinon.stub() }
+    global.GlobalNotifier = notifierStub
+
+    recipients = RecipientsFixture.recipients()
+
+    session = await SessionHelper.add({
+      data: {
+        journey: 'invitations',
+        referenceCode: 'RINV-123',
+        returnsPeriod: 'quarterFour'
+      }
+    })
+
+    recipients = RecipientsFixture.recipients()
+
+    Sinon.stub(DetermineRecipientsService, 'go').resolves()
+    Sinon.stub(RecipientsService, 'go').resolves([recipients.primaryUser])
+  })
+
+  afterEach(() => {
+    Sinon.restore()
+    delete global.GlobalNotifier
+  })
+
+  it('correctly triggers the "DetermineRecipientsService"', async () => {
+    await SubmitCheckService.go(session.id)
+
+    expect(DetermineRecipientsService.go.calledWith([recipients.primaryUser])).to.be.true()
+  })
+})