Add notification setup event presenter (#1758)

jonathangoulding · web-flow · commit b1273a125879 · 2025-02-28T08:06:25.000-08:00
* Add notification setup even presenter https://eaflood.atlassian.net/browse/WATER-4904 As part of the work to handle notifications in the system code. We need to follow some patterns established by the legacy code. This change adds the event presenter to structure the data to insert into 'wabs.public.events'. This presenter will need to use existing legacy concepts such as setting a 'subtype' in order for the legacy reporting pages to continue to work.
diff --git a/app/presenters/notifications/setup/create-event.presenter.js b/app/presenters/notifications/setup/create-event.presenter.js
@@ -0,0 +1,106 @@
+'use strict'
+
+/**
+ * Formats a notification `SessionModel` instance into the data needed for a 'EventModel' record
+ * @module CreateEventPresenter
+ */
+
+const { transformStringOfLicencesToArray } = require('../../../lib/general.lib.js')
+
+/**
+ * Formats a notification `SessionModel` instance into the data needed for a 'EventModel' record
+ *
+ * @param {SessionModel} session
+ *
+ * @returns {object} - The data formatted for the view template
+ */
+function go(session) {
+  const { referenceCode, recipients, determinedReturnsPeriod, journey, removeLicences = [] } = session
+
+  return {
+    licences: _licences(recipients),
+    metadata: {
+      name: _name(journey),
+      options: {
+        excludeLicences: removeLicences
+      },
+      recipients: recipients.length,
+      returnCycle: _returnCycle(determinedReturnsPeriod)
+    },
+    referenceCode,
+    status: 'started',
+    subtype: _subType(journey)
+  }
+}
+
+/**
+ * All the licences associated with an event (licences that will receive notifications) are stored in
+ * `water.events.licences`. It is not clear where theses are used. But to be consistent we follow the established
+ * pattern.
+ *
+ * @private
+ */
+function _licences(recipients) {
+  return recipients.flatMap((recipient) => {
+    return transformStringOfLicencesToArray(recipient.licence_refs)
+  })
+}
+
+/**
+ * This name is used in the legacy UI to render the notification type on '/notifications/report'.
+ * This has been done to allow all types of notifications to be rendered in the UI. The data is taken straight from the
+ * metadata and rendered in the view.
+ *
+ * We need to be consistent with this pattern.
+ *
+ * @private
+ */
+function _name(journey) {
+  if (journey === 'invitations') {
+    return 'Returns: invitation'
+  } else if (journey === 'reminders') {
+    return 'Returns: reminder'
+  } else {
+    return ''
+  }
+}
+
+function _returnCycle(returnsPeriod) {
+  return {
+    dueDate: returnsPeriod.dueDate,
+    endDate: returnsPeriod.endDate,
+    isSummer: returnsPeriod.summer,
+    startDate: returnsPeriod.startDate
+  }
+}
+
+/**
+ *
+ * The legacy code has the concept of 'subType' this is used when querying to get notifications.
+ *
+ * Below is an example of a query used in 'water-abstraction-service'.
+ *
+ * ```sql
+ * SELECT * FROM water.scheduled_notification
+ *     WHERE event_id = (SELECT event_id FROM water.events
+ *       WHERE subtype = 'returnInvitation'
+ *       AND status = 'completed'
+ *       ORDER BY created DESC LIMIT 1)
+ *     AND licences \\? :licenceRef
+ * ```
+ *
+ * @private
+ */
+function _subType(journey) {
+  if (journey === 'invitations') {
+    return 'returnInvitation'
+  } else if (journey === 'reminders') {
+    return 'returnReminder'
+  } else {
+    return ''
+  }
+}
+
+module.exports = {
+  go
+}
diff --git a/test/fixtures/recipients.fixtures.js b/test/fixtures/recipients.fixtures.js
@@ -113,7 +113,7 @@ function _addReturnTo() {
 
 function _addLicenceHolderWithMultipleLicences() {
   return {
-    licence_refs: `${generateLicenceRef()}, ${generateLicenceRef()}`,
+    licence_refs: `${generateLicenceRef()},${generateLicenceRef()}`,
     contact_type: 'Licence holder',
     contact: _contact('3', 'Licence holder with multiple licences', 'Licence holder'),
     contact_hash_id: '22f6457b6be9fd63d8a9a8dd2ed09878075'
diff --git a/test/presenters/notifications/setup/create-event.presenter.test.js b/test/presenters/notifications/setup/create-event.presenter.test.js
@@ -0,0 +1,197 @@
+'use strict'
+
+// Test framework dependencies
+const Lab = require('@hapi/lab')
+const Code = require('@hapi/code')
+
+const { describe, it, beforeEach } = (exports.lab = Lab.script())
+const { expect } = Code
+
+// Test helpers
+const RecipientsFixture = require('../../../fixtures/recipients.fixtures.js')
+
+// Thing under test
+const CreateEventPresenter = require('../../../../app/presenters/notifications/setup/create-event.presenter.js')
+
+describe('Notifications Setup - Event presenter', () => {
+  let session
+  let recipients
+
+  beforeEach(async () => {
+    recipients = RecipientsFixture.recipients()
+
+    session = {
+      returnsPeriod: 'quarterFour',
+      removeLicences: [],
+      journey: 'invitations',
+      referenceCode: 'RINV-123',
+      recipients: [...Object.values(recipients)],
+      determinedReturnsPeriod: {
+        dueDate: new Date(`2025-07-28`),
+        endDate: new Date(`2025-06-30`),
+        startDate: new Date(`2025-04-01`),
+        summer: 'true'
+      }
+    }
+  })
+
+  it('correctly presents the data', () => {
+    const result = CreateEventPresenter.go(session)
+
+    expect(result).to.equal({
+      licences: [
+        recipients.primaryUser.licence_refs,
+        recipients.returnsAgent.licence_refs,
+        recipients.licenceHolder.licence_refs,
+        recipients.returnsTo.licence_refs,
+        ...recipients.licenceHolderWithMultipleLicences.licence_refs.split(',')
+      ],
+      metadata: {
+        name: 'Returns: invitation',
+        options: {
+          excludeLicences: []
+        },
+        recipients: 5,
+        returnCycle: {
+          dueDate: session.determinedReturnsPeriod.dueDate,
+          endDate: session.determinedReturnsPeriod.endDate,
+          isSummer: 'true',
+          startDate: session.determinedReturnsPeriod.startDate
+        }
+      },
+      referenceCode: 'RINV-123',
+      status: 'started',
+      subtype: 'returnInvitation'
+    })
+  })
+
+  describe('the "licences" property', () => {
+    it('correctly return an array of all licence from all recipients', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.licences).to.equal([
+        recipients.primaryUser.licence_refs,
+        recipients.returnsAgent.licence_refs,
+        recipients.licenceHolder.licence_refs,
+        recipients.returnsTo.licence_refs,
+        ...recipients.licenceHolderWithMultipleLicences.licence_refs.split(',')
+      ])
+    })
+  })
+
+  describe('the "metadata" property', () => {
+    describe('the "options.excludeLicences" property', () => {
+      describe('when there licences excluded from the recipients list', () => {
+        beforeEach(() => {
+          session.removeLicences = ['123', '456']
+        })
+
+        it('correctly returns the exclude licences', () => {
+          const result = CreateEventPresenter.go(session)
+
+          expect(result.metadata.options.excludeLicences).to.equal(['123', '456'])
+        })
+      })
+
+      describe('when there are no licences excluded from the recipients list', () => {
+        beforeEach(() => {
+          session.removeLicences = []
+        })
+
+        it('correctly returns the exclude licences', () => {
+          const result = CreateEventPresenter.go(session)
+
+          expect(result.metadata.options.excludeLicences).to.equal([])
+        })
+      })
+    })
+
+    describe('the "recipients" property', () => {
+      beforeEach(() => {
+        session.recipients = [...Object.values(recipients)]
+      })
+
+      it('correctly returns the length of recipients', () => {
+        const result = CreateEventPresenter.go(session)
+
+        expect(result.metadata.recipients).to.equal(5)
+      })
+    })
+
+    describe('the "returnCycle" property', () => {
+      beforeEach(() => {
+        session.determinedReturnsPeriod = {
+          dueDate: new Date(`2025-07-28`),
+          endDate: new Date(`2025-06-30`),
+          startDate: new Date(`2025-04-01`),
+          summer: 'true'
+        }
+      })
+
+      it('correctly returns the return cycle', () => {
+        const result = CreateEventPresenter.go(session)
+
+        expect(result.metadata.returnCycle).to.equal({
+          dueDate: session.determinedReturnsPeriod.dueDate,
+          endDate: session.determinedReturnsPeriod.endDate,
+          isSummer: 'true',
+          startDate: session.determinedReturnsPeriod.startDate
+        })
+      })
+    })
+  })
+
+  describe('when the journey is for "invitations"', () => {
+    beforeEach(() => {
+      session.journey = 'invitations'
+    })
+
+    it('correctly sets the "metadata.name"', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.metadata.name).to.equal('Returns: invitation')
+    })
+
+    it('correctly sets the "subtype"', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.subtype).to.equal('returnInvitation')
+    })
+  })
+
+  describe('when the journey is for "reminders"', () => {
+    beforeEach(() => {
+      session.journey = 'reminders'
+    })
+
+    it('correctly sets the "metadata.name"', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.metadata.name).to.equal('Returns: reminder')
+    })
+
+    it('correctly sets the "subtype"', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.subtype).to.equal('returnReminder')
+    })
+  })
+
+  describe('when the journey is not recognised', () => {
+    beforeEach(() => {
+      session.journey = ''
+    })
+
+    it('correctly sets the "metadata.name"', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.metadata.name).to.equal('')
+    })
+
+    it('correctly sets the "subtype"', () => {
+      const result = CreateEventPresenter.go(session)
+
+      expect(result.subtype).to.equal('')
+    })
+  })
+})
