Clinics refactoring: clinic setup model relationships (#255)

Switched the storage of clinic vaccination periods from a foreign key-based approach to using embedded objects in the session. This will allow simplification of sessions checking and using values in the vaccination periods during wizard journeys, as well as simplification of providing data to summaryRows, reducing duplication and complexity.

* Reduce dependencies in ClinicVaccinationPeriod

Removed the session_id foreign key and the getter to return the object, as neither was being used.

* Remove references to vaccination period's session ID

* Embed clinic vaccination periods in Session

This is side-by-side with existing array of IDs for now, but will ultimately replace that.

Added add and remove method for these embedded vaccination periods too.

* Replace vaccination period IDs array with embedded periods

Note: this is not a working build; I'm still part way through the wider refactoring of clinic session models.

* Stop creating an empty file of vaccination period data

* Directly access a session's vaccination periods in Nunjucks

Also renamed the Session class's clinicVaccinationPeriods to just vaccinationPeriods.

* Update session with vaccination period details

This commit fixes earlier ones that still had attempts to use ClinicVaccinationPeriod.update (which no longer exists). It also fixes a couple of linter issues.

* Set clinic session vaccinator count correctly

Was previously trying to call a non-existent method that I expected to create but decided against.

* Fix editing of vaccination periods in clinic sessions

Previously, when editing an existing clinic, the addition of a new vaccination period left its vaccinator count uninitialised, which caused an inability to calculate the total number of appointments, littering the UI with NaN in places.

Author: malross

app/controllers/session.js

@@ -15,7 +15,6 @@ import {
 } from '../enums.js'
 import {
   Clinic,
-  ClinicVaccinationPeriod,
   DefaultBatch,
   Instruction,
   PatientSession,
@@ -496,25 +495,14 @@ export const sessionController = {
     // Copy the saved session to the wizard context, if not already there
     let session = Session.findOne(session_id, data.wizard)
     if (!session) {
-      // NB: response.locals.session was set in read()
+      // NB: response.locals.session was read from the global context in read()
       session = Session.create(response.locals.session, data.wizard)
-      if (session.type === SessionType.Clinic) {
-        response.locals.session.vaccinationPeriods.forEach(
-          (vaccinationPeriod) => {
-            ClinicVaccinationPeriod.create(vaccinationPeriod, data.wizard)
-          }
-        )
-      }
     }
 
     // Set up the transaction metadata that controls how some clinic values are entered
     if (session.type === SessionType.Clinic) {
       const vaccinatorCounts = new Set(
-        session.vaccination_period_ids.map(
-          (period_id) =>
-            ClinicVaccinationPeriod.findOne(period_id, data.wizard)
-              ?.vaccinatorCount
-        )
+        session.vaccinationPeriods.map((period) => period.vaccinatorCount)
       )
       const variableVaccinatorCounts = vaccinatorCounts.size > 1
       data.transaction = {
@@ -533,9 +521,7 @@ export const sessionController = {
 
     if (session.type === SessionType.Clinic) {
       response.locals.vaccinationPeriodsSummary = getVaccinationPeriodsSummary(
-        session.vaccination_period_ids.map((period_id) =>
-          ClinicVaccinationPeriod.findOne(period_id, data.wizard)
-        ),
+        session.vaccinationPeriods,
         session.appointmentLength
       )
     }
@@ -559,17 +545,6 @@ export const sessionController = {
         data
       )
 
-      // Update any clinic vaccination periods
-      if (session.type === SessionType.Clinic) {
-        session.vaccination_period_ids.forEach((period_id) => {
-          const vaccinationPeriod = ClinicVaccinationPeriod.findOne(
-            period_id,
-            data.wizard
-          )
-          ClinicVaccinationPeriod.update(period_id, vaccinationPeriod, data)
-        })
-      }
-
       // Clean up session data
       delete data.vaccinationPeriods
       delete data.transaction
@@ -597,13 +572,6 @@ export const sessionController = {
       }
       response.locals.session = new Session(session, data)
 
-      const vaccinationPeriods = session.vaccinationPeriods
-      if (vaccinationPeriods) {
-        response.locals.vaccinationPeriods = vaccinationPeriods.map(
-          (period) => new ClinicVaccinationPeriod(period, data)
-        )
-      }
-
       const journey = {
         [`/`]: {},
         [`/${session_id}/${type}/type`]: {},
@@ -670,10 +638,10 @@ export const sessionController = {
         }
 
         // Generate summary info for the check-answers page
-        if (vaccinationPeriods) {
+        if (session.vaccinationPeriods) {
           response.locals.vaccinationPeriodsSummary =
             getVaccinationPeriodsSummary(
-              vaccinationPeriods,
+              session.vaccinationPeriods,
               session.appointmentLength
             )
         }
@@ -731,95 +699,72 @@ export const sessionController = {
 
     if (session.type === SessionType.Clinic) {
       // Add the first vaccination period, if not already there
-      if (!session.vaccination_period_ids?.length) {
-        const vaccination_period_ids = [
-          ClinicVaccinationPeriod.create(
-            { session_id: session.id },
-            data.wizard
-          ).uuid
-        ]
-        Session.update(session_id, { vaccination_period_ids }, data.wizard)
+      if (!session.vaccinationPeriods?.length) {
+        session.addVaccinationPeriod()
+        Session.update(session_id, session, data.wizard)
       }
 
       // Act accordingly for each of the possible button clicks in the vaccination periods page
       if (view === 'vaccination-periods') {
         // Save the times entered, no matter what we're doing next
-        for (const [period_id, vaccinationPeriod] of Object.entries(
+        for (let [period_uuid, vaccinationPeriodValues] of Object.entries(
           request.body.vaccinationPeriods
         )) {
+          // Make sure the period start and end have date information as well as time
           const sessionDate_ = session.date
             ? session.date_
             : convertIsoDateToObject(today())
-          ClinicVaccinationPeriod.update(
-            period_id,
-            _.merge(
-              // make sure the period start and end have date information as well as time
-              { startAt_: { ...sessionDate_ }, endAt_: { ...sessionDate_ } },
-              vaccinationPeriod
-            ),
-            data.wizard
-          )
+          const dateValues = {
+            startAt_: { ...sessionDate_ },
+            endAt_: { ...sessionDate_ }
+          }
+          vaccinationPeriodValues = _.merge(dateValues, vaccinationPeriodValues)
+
+          const vaccinationPeriod = session.getVaccinationPeriod(period_uuid)
+          vaccinationPeriod.startAt_ = vaccinationPeriodValues.startAt_
+          vaccinationPeriod.endAt_ = vaccinationPeriodValues.endAt_
+
+          Session.update(session_id, session, data.wizard)
         }
 
         // Add or remove vaccination periods, if requested
         const action = request.body.action
         if (action === 'add-period') {
-          // Add another vaccination period
-          const vaccination_period_ids = [
-            ...session.vaccination_period_ids,
-            ClinicVaccinationPeriod.create(
-              { session_id: session.id },
-              data.wizard
-            ).uuid
-          ]
-          Session.update(session_id, { vaccination_period_ids }, data.wizard)
+          session.addVaccinationPeriod()
+          Session.update(session_id, session, data.wizard)
 
           nextPage = request.originalUrl
         } else if (action.startsWith('remove-period-')) {
           // Remove a vaccination period
-          const periodIndex = parseInt(
-            action.substring('remove-period-'.length),
-            10
-          )
-          const period_id = session.vaccination_period_ids[periodIndex]
-          const vaccination_period_ids =
-            session.vaccination_period_ids.toSpliced(periodIndex, 1)
-          Session.update(session_id, { vaccination_period_ids }, data.wizard)
-
-          ClinicVaccinationPeriod.delete(period_id, data.wizard)
+          const index = parseInt(action.substring('remove-period-'.length))
+          const period_id = session.vaccinationPeriods[index].uuid
+          session.removeVaccinationPeriod(period_id)
+          Session.update(session_id, session, data.wizard)
 
           nextPage = request.originalUrl
         }
       } else if (view === 'vaccinators') {
         if (
-          session.vaccination_period_ids.length > 1 &&
+          session?.vaccinationPeriods.length > 1 &&
           request.body.transaction.hasVariableVaccinatorCounts === 'false'
         ) {
           // Set the same number of vaccinators in all vaccination periods
-          for (const period_id of session.vaccination_period_ids) {
-            ClinicVaccinationPeriod.update(
-              period_id,
-              {
-                vaccinatorCount: parseInt(
-                  request.body.transaction.consistentVaccinatorCount,
-                  10
-                )
-              },
-              data.wizard
-            )
+          const vaccinatorCount = parseInt(
+            request.body.transaction.consistentVaccinatorCount
+          )
+          for (const period of session.vaccinationPeriods) {
+            period.vaccinatorCount = vaccinatorCount
           }
         } else {
           // Each vaccination period gets its own number of vaccinators
-          for (const [period_id, vaccinationPeriod] of Object.entries(
+          for (const [period_uuid, vaccinationPeriodValues] of Object.entries(
             request.body.vaccinationPeriods
           )) {
-            ClinicVaccinationPeriod.update(
-              period_id,
-              vaccinationPeriod,
-              data.wizard
-            )
+            session.getVaccinationPeriod(period_uuid).vaccinatorCount =
+              vaccinationPeriodValues.vaccinatorCount
           }
         }
+        Session.update(session_id, session, data.wizard)
       }
     }
 

app/data.js

@@ -2,7 +2,6 @@ import vaccines from './datasets/vaccines.js'
 import batches from '../.data/batches.json' with { type: 'json' }
 import clinicAppointments from '../.data/clinic-appointments.json' with { type: 'json' }
 import clinicBookings from '../.data/clinic-bookings.json' with { type: 'json' }
-import clinicVaccinationPeriods from '../.data/clinic-vaccination-periods.json' with { type: 'json' }
 import clinics from '../.data/clinics.json' with { type: 'json' }
 import instructions from '../.data/instructions.json' with { type: 'json' }
 import moves from '../.data/moves.json' with { type: 'json' }
@@ -35,7 +34,6 @@ const data = {
   batches,
   clinicAppointments,
   clinicBookings,
-  clinicVaccinationPeriods,
   clinics,
   counts: {},
   defaultBatches: {},

app/generators/clinic-vaccination-periods.js

@@ -1,16 +1,14 @@
 import { fakerEN_GB as faker } from '@faker-js/faker'
 import { addMinutes } from 'date-fns'
 
-import { ClinicVaccinationPeriod } from '../models.js'
+import { Session } from '../models.js'
 
 /**
  * Generate one or more time periods during which vaccinations will be administered at a clinic
  *
- * @param {string} session_id - session ID for the clinic whose vaccination periods we're creating
- * @param {Date} sessionDate - the date on which the clinic's running
- * @returns {Array<ClinicVaccinationPeriod>} - one or more vaccination periods
+ * @param {Session} session - the session to which we're adding vaccination periods
  */
-export function generateClinicVaccinationPeriods(session_id, sessionDate) {
+export function generateClinicVaccinationPeriods(session) {
   const periodCount = faker.helpers.weightedArrayElement([
     { value: 1, weight: 70 },
     { value: 2, weight: 30 }
@@ -27,6 +25,7 @@ export function generateClinicVaccinationPeriods(session_id, sessionDate) {
     vaccinationPeriodLengths.reduce((total, next) => total + next, 0) +
     breakLength
 
+  const sessionDate = new Date(session.date)
   const earliestSessionStartTime = new Date(sessionDate.setUTCHours(9, 0)) // 9am
   const latestSessionFinishTime = new Date(sessionDate.setUTCHours(20, 0)) // 8pm
   const sessionWindow = Math.floor(
@@ -42,9 +41,8 @@ export function generateClinicVaccinationPeriods(session_id, sessionDate) {
   const sessionStartTime = addMinutes(earliestSessionStartTime, startOffset)
 
   let nextPeriodStartTime = sessionStartTime
-  return vaccinationPeriodLengths.map((periodLength) => {
-    const vaccinationPeriod = new ClinicVaccinationPeriod({
-      session_id,
+  vaccinationPeriodLengths.forEach((periodLength) => {
+    session.addVaccinationPeriod({
       startAt: nextPeriodStartTime,
       endAt: addMinutes(nextPeriodStartTime, periodLength),
       vaccinatorCount: faker.helpers.weightedArrayElement([
@@ -57,7 +55,5 @@ export function generateClinicVaccinationPeriods(session_id, sessionDate) {
       nextPeriodStartTime,
       periodLength + breakLength
     )
-
-    return vaccinationPeriod
   })
 }