Add VaccinationConfirmationsJob

This adds a job which sends the vaccination confirmation emails at a
specific time in the evening every day, ensuring that any vaccination
records which have been created since the last ones were sent out, get
processed.

The job is set up such that it can be run at any point and it will send
the confirmations for any new vaccination records that have been created
since the last time the job ran will get their confirmation emails sent
out.

Author: thomasleese

app/controllers/concerns/vaccination_mailer_concern.rb

@@ -17,7 +17,7 @@ def send_vaccination_confirmation(vaccination_record)
     text_template_name = :"vaccination_#{mailer_action}"
 
     parents.each do |parent|
-      params = { parent:, vaccination_record:, sent_by: current_user }
+      params = { parent:, vaccination_record:, sent_by: try(:current_user) }
 
       if parent.email.present?
         VaccinationMailer.with(params).public_send(mailer_action).deliver_later
@@ -32,7 +32,7 @@ def send_vaccination_deletion(vaccination_record)
     return if parents.empty?
 
     parents.each do |parent|
-      params = { parent:, vaccination_record:, sent_by: current_user }
+      params = { parent:, vaccination_record:, sent_by: try(:current_user) }
 
       if parent.email.present?
         VaccinationMailer.with(params).deleted.deliver_later

app/jobs/vaccination_confirmations_job.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class VaccinationConfirmationsJob < ApplicationJob
+  include VaccinationMailerConcern
+
+  queue_as :notifications
+
+  def perform
+    # Find the oldest record that has had a confirmation sent, and send confirmations for all subsequent records
+    since =
+      VaccinationRecord
+        .kept
+        .where.not(confirmation_sent_at: nil)
+        .maximum(:created_at) || 24.hours.ago
+    academic_year = Date.current.academic_year
+
+    VaccinationRecord
+      .kept
+      .where("created_at >= ?", since)
+      .where(confirmation_sent_at: nil)
+      .select { _1.academic_year == academic_year }
+      .each do |vaccation_record|
+        send_vaccination_confirmation(vaccation_record)
+        vaccation_record.update!(confirmation_sent_at: Time.current)
+      end
+  end
+end

app/models/vaccination_record.rb

@@ -178,6 +178,10 @@ def dose_volume_ml
     vaccine.dose_volume_ml * 1 if vaccine.present?
   end
 
+  def academic_year
+    performed_at.to_date.academic_year
+  end
+
   private
 
   def requires_location_name?

config/environments/production.rb

@@ -158,6 +158,11 @@
       cron: "every day at 2am",
       class: "TrimActiveRecordSessionsJob",
       description: "Remove ActiveRecord sessions older than 30 days"
+    },
+    vaccination_confirmations: {
+      cron: "every day at 7pm",
+      class: "VaccinationConfirmationsJob",
+      description: "Send vaccination confirmation emails to parents"
     }
   }
 end

spec/features/hpv_vaccination_administered_spec.rb

@@ -52,7 +52,9 @@
     when_i_go_to_the_patient
     then_i_see_that_the_status_is_vaccinated
     and_i_see_the_vaccination_details
-    and_an_email_is_sent_to_the_parent_confirming_the_vaccination
+
+    when_vaccination_confirmations_are_sent
+    then_an_email_is_sent_to_the_parent_confirming_the_vaccination
     and_a_text_is_sent_to_the_parent_confirming_the_vaccination
   end
 
@@ -181,7 +183,11 @@ def and_i_see_the_vaccination_details
     expect(page).to have_content("Vaccination details")
   end
 
-  def and_an_email_is_sent_to_the_parent_confirming_the_vaccination
+  def when_vaccination_confirmations_are_sent
+    VaccinationConfirmationsJob.perform_now
+  end
+
+  def then_an_email_is_sent_to_the_parent_confirming_the_vaccination
     expect_email_to(
       @patient.consents.last.parent.email,
       :vaccination_confirmation_administered

spec/features/hpv_vaccination_already_had_spec.rb

@@ -22,7 +22,9 @@
 
     when_i_go_to_the_patient
     then_i_see_that_the_status_is_could_not_vaccinate
-    and_an_email_is_sent_saying_the_vaccination_didnt_happen
+
+    when_vaccination_confirmations_are_sent
+    then_an_email_is_sent_saying_the_vaccination_didnt_happen
     and_a_text_is_sent_saying_the_vaccination_didnt_happen
   end
 
@@ -89,7 +91,11 @@ def then_i_see_that_the_status_is_could_not_vaccinate
     )
   end
 
-  def and_an_email_is_sent_saying_the_vaccination_didnt_happen
+  def when_vaccination_confirmations_are_sent
+    VaccinationConfirmationsJob.perform_now
+  end
+
+  def then_an_email_is_sent_saying_the_vaccination_didnt_happen
     expect_email_to(
       @patient.consents.last.parent.email,
       :vaccination_confirmation_not_administered

spec/features/hpv_vaccination_clinic_spec.rb

@@ -25,7 +25,9 @@
 
     when_i_go_to_the_patient
     then_i_see_that_the_status_is_vaccinated
-    and_an_email_is_sent_to_the_parent_confirming_the_vaccination
+
+    when_vaccination_confirmations_are_sent
+    then_an_email_is_sent_to_the_parent_confirming_the_vaccination
     and_a_text_is_sent_to_the_parent_confirming_the_vaccination
   end
 
@@ -108,7 +110,11 @@ def then_i_see_that_the_status_is_vaccinated
     expect(page).to have_content("Vaccinated")
   end
 
-  def and_an_email_is_sent_to_the_parent_confirming_the_vaccination
+  def when_vaccination_confirmations_are_sent
+    VaccinationConfirmationsJob.perform_now
+  end
+
+  def then_an_email_is_sent_to_the_parent_confirming_the_vaccination
     expect_email_to(
       @patient.consents.last.parent.email,
       :vaccination_confirmation_administered

spec/features/hpv_vaccination_delayed_spec.rb

@@ -17,7 +17,9 @@
 
     when_i_go_to_the_patient
     then_i_see_that_the_status_is_delayed
-    and_an_email_is_sent_to_the_parent_confirming_the_delay
+
+    when_vaccination_confirmations_are_sent
+    then_an_email_is_sent_to_the_parent_confirming_the_delay
     and_a_text_is_sent_to_the_parent_confirming_the_delay
   end
 
@@ -83,7 +85,11 @@ def then_i_see_that_the_status_is_delayed
     )
   end
 
-  def and_an_email_is_sent_to_the_parent_confirming_the_delay
+  def when_vaccination_confirmations_are_sent
+    VaccinationConfirmationsJob.perform_now
+  end
+
+  def then_an_email_is_sent_to_the_parent_confirming_the_delay
     expect_email_to(
       @patient.consents.last.parent.email,
       :vaccination_confirmation_not_administered

spec/features/hpv_vaccination_offline_spec.rb

@@ -9,6 +9,8 @@
   end
 
   scenario "Download spreadsheet, record offline at a school session, upload vaccination outcomes back into Mavis" do
+    stub_pds_get_nhs_number_to_return_a_patient
+
     given_an_hpv_programme_is_underway
     when_i_choose_to_record_offline_from_a_school_session_page
     then_i_see_an_excel_spreadsheet_for_recording_offline
@@ -17,9 +19,15 @@
     and_i_upload_the_modified_csv_file
     and_i_navigate_to_the_session_page
     then_i_see_the_uploaded_vaccination_outcomes_reflected_in_the_session
+
+    when_vaccination_confirmations_are_sent
+    then_an_email_is_sent_to_the_parent_confirming_the_vaccination
+    and_a_text_is_sent_to_the_parent_confirming_the_vaccination
   end
 
   scenario "Download spreadsheet, record offline at a clinic, upload vaccination outcomes back into Mavis" do
+    stub_pds_get_nhs_number_to_return_a_patient
+
     given_an_hpv_programme_is_underway(clinic: true)
     when_i_choose_to_record_offline_from_a_clinic_page
     then_i_see_an_excel_spreadsheet_for_recording_offline
@@ -29,6 +37,10 @@
     and_i_navigate_to_the_clinic_page
     then_i_see_the_uploaded_vaccination_outcomes_reflected_in_the_session
     and_the_clinic_location_is_displayed
+
+    when_vaccination_confirmations_are_sent
+    then_an_email_is_sent_to_the_parent_confirming_the_vaccination
+    and_a_text_is_sent_to_the_parent_confirming_the_vaccination
   end
 
   def given_an_hpv_programme_is_underway(clinic: false)
@@ -267,4 +279,36 @@ def then_i_see_the_uploaded_vaccination_outcomes_reflected_in_the_session
   def and_the_clinic_location_is_displayed
     expect(page).to have_content("Westfield Shopping Centre")
   end
+
+  def when_vaccination_confirmations_are_sent
+    VaccinationConfirmationsJob.perform_now
+  end
+
+  def then_an_email_is_sent_to_the_parent_confirming_the_vaccination
+    expect_email_to(
+      @vaccinated_patient.consents.last.parent.email,
+      :vaccination_confirmation_administered,
+      :any
+    )
+
+    expect_email_to(
+      @unvaccinated_patient.consents.last.parent.email,
+      :vaccination_confirmation_not_administered,
+      :any
+    )
+  end
+
+  def and_a_text_is_sent_to_the_parent_confirming_the_vaccination
+    expect_text_to(
+      @vaccinated_patient.consents.last.parent.phone,
+      :vaccination_confirmation_administered,
+      :any
+    )
+
+    expect_text_to(
+      @unvaccinated_patient.consents.last.parent.phone,
+      :vaccination_confirmation_not_administered,
+      :any
+    )
+  end
 end

spec/jobs/vaccination_confirmations_job_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+describe VaccinationConfirmationsJob do
+  let(:job) { described_class.new }
+
+  describe "#perform" do
+    subject(:perform) { job.perform }
+
+    let(:programme) { create(:programme) }
+
+    let(:existing_vaccination_record_already_sent) do
+      create(
+        :vaccination_record,
+        :confirmation_sent,
+        programme:,
+        created_at: 3.days.ago
+      )
+    end
+
+    let(:old_vaccination_record) do
+      create(:vaccination_record, created_at: 2.days.ago, programme:)
+    end
+
+    let(:new_vaccination_record) { create(:vaccination_record, programme:) }
+
+    let(:discarded_vaccination_record) do
+      create(:vaccination_record, :discarded, programme:)
+    end
+
+    let(:historical_vaccination_record) do
+      create(
+        :vaccination_record,
+        performed_at: Time.zone.local(2020, 1, 1),
+        programme:
+      )
+    end
+
+    before { allow(job).to receive(:send_vaccination_confirmation) }
+
+    it "sends vaccination confirmations for approriate records" do
+      expect(job).not_to receive(:send_vaccination_confirmation).with(
+        existing_vaccination_record_already_sent
+      )
+      expect(job).to receive(:send_vaccination_confirmation).with(
+        old_vaccination_record
+      )
+      expect(job).to receive(:send_vaccination_confirmation).with(
+        new_vaccination_record
+      )
+      expect(job).not_to receive(:send_vaccination_confirmation).with(
+        discarded_vaccination_record
+      )
+      expect(job).not_to receive(:send_vaccination_confirmation).with(
+        historical_vaccination_record
+      )
+
+      perform
+    end
+
+    it "records when the confirmation was sent" do
+      freeze_time do
+        expect { perform }.to change {
+          new_vaccination_record.reload.confirmation_sent_at
+        }.from(nil).to(Time.current)
+      end
+    end
+  end
+end