Convert GOV.UK Notify jobs to Sidekiq

This adds Sidekiq-only versions of the `EmailDeliveryJob`,
`SMSDeliveryJob` and `NotifyDeliveryJob` jobs, to support the migration
to using Sidekiq directly.

Using Sidekiq directly doesn't support named parameters in jobs, so we
now have to pass a JSON-serializable hash containing the parameters that
are passed to the `GovukNotifyPersonalisation` class. I'd like to
refactor this further to add safeguards to ensure the right keys are
used, but for now I didn't want to change too much here.

Jira-Issue: MAV-7288

Author: thomasleese

app/jobs/email_delivery_sidekiq_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class EmailDeliverySidekiqJob < NotifyDeliverySidekiqJob
+  include GovukNotifyThrottlingConcern
+
+  def perform(template_name, params)
+    EmailDeliveryJob.new.perform(template_name, **fetch_params(params))
+  end
+end

app/jobs/notify_delivery_sidekiq_job.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "notifications/client"
+
+# This is a temporary copy of `NotifyDeliveryJob` that will be removed when
+# all jobs have been converted to Sidekiq.
+class NotifyDeliverySidekiqJob < ApplicationJobSidekiq
+  TEAM_ONLY_API_KEY_MESSAGE =
+    "Can’t send to this recipient using a team-only API key"
+
+  sidekiq_options queue: :notifications
+
+  def fetch_params(params)
+    {
+      academic_year: params["academic_year"],
+      consent: (id = params["consent_id"]) && Consent.find(id),
+      consent_form: (id = params["consent_form_id"]) && ConsentForm.find(id),
+      disease_types: params["disease_types"],
+      parent: (id = params["parent_id"]) && Parent.find(id),
+      patient: (id = params["patient_id"]) && Patient.find(id),
+      programme_types: params["programme_types"] || [],
+      sent_by: (id = params["sent_by_user_id"]) && User.find(id),
+      session: (id = params["session_id"]) && Session.find(id),
+      team: (id = params["team_id"]) && Team.find(id),
+      team_location: (id = params["team_location_id"]) && TeamLocation.find(id),
+      vaccination_record:
+        (id = params["vaccination_record_id"]) && VaccinationRecord.find(id)
+    }
+  end
+
+  def self.client
+    @client ||=
+      Notifications::Client.new(
+        Settings.govuk_notify["#{Settings.govuk_notify.mode}_key"]
+      )
+  end
+
+  def self.deliveries
+    @deliveries ||= []
+  end
+
+  def self.send_via_notify? = Settings.govuk_notify&.enabled
+
+  def self.send_via_test? = Rails.env.test?
+
+  class UnknownTemplate < StandardError
+  end
+end

app/jobs/sms_delivery_sidekiq_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class SMSDeliverySidekiqJob < NotifyDeliverySidekiqJob
+  include GovukNotifyThrottlingConcern
+
+  def perform(template_name, params)
+    SMSDeliveryJob.new.perform(template_name, **fetch_params(params))
+  end
+end

app/lib/already_had_notification_sender.rb

@@ -29,21 +29,17 @@ def call
       ).parents_with_consent
 
     parents_with_consent.each do |parent, consent|
+      params = {
+        "parent_id" => parent.id,
+        "vaccination_record_id" => vaccination_record.id,
+        "consent_id" => consent.id
+      }
+
       if parent.phone_receive_updates
-        SMSDeliveryJob.perform_later(
-          :vaccination_already_had,
-          parent:,
-          vaccination_record:,
-          consent:
-        )
+        SMSDeliverySidekiqJob.perform_async("vaccination_already_had", params)
       end
 
-      EmailDeliveryJob.perform_later(
-        :vaccination_already_had,
-        parent:,
-        vaccination_record:,
-        consent:
-      )
+      EmailDeliverySidekiqJob.perform_async("vaccination_already_had", params)
 
       consent.update!(
         patient_already_vaccinated_notification_sent_at: Time.current

app/lib/notifier/consent.rb

@@ -10,10 +10,14 @@ def initialize(consent)
   def send_confirmation(session:, triage:, sent_by:)
     return unless send_notification?
 
-    params = { consent:, session:, sent_by: }
+    params = {
+      "consent_id" => consent.id,
+      "session_id" => session.id,
+      "sent_by_user_id" => sent_by.id
+    }
 
     if triage
-      send_triage_email(triage, params)
+      send_triage_email(triage, session, params)
     elsif consent.requires_triage?
       send_consent_email(:triage, params)
     elsif consent.response_refused?
@@ -34,38 +38,38 @@ def send_notification?
       !consent.via_self_consent?
   end
 
-  def send_triage_email(triage, params)
-    template = triage_email_template(triage, params[:session])
-    EmailDeliveryJob.perform_later(template, **params)
+  def send_triage_email(triage, session, params)
+    template_name = triage_email_template(triage, session)
+    EmailDeliverySidekiqJob.perform_async(template_name, params)
   end
 
   def triage_email_template(triage, session)
     if triage.safe_to_vaccinate?
       if programme.mmr? && patient_on_last_dose?(session)
-        :triage_vaccination_will_happen_mmr_second_dose
+        "triage_vaccination_will_happen_mmr_second_dose"
       else
-        :triage_vaccination_will_happen
+        "triage_vaccination_will_happen"
       end
     elsif triage.do_not_vaccinate?
-      :triage_vaccination_wont_happen
+      "triage_vaccination_wont_happen"
     elsif triage.delay_vaccination?
-      :triage_delay_vaccination
+      "triage_delay_vaccination"
     elsif triage.invite_to_clinic?
-      resolve_email_template(:triage_vaccination_at_clinic, triage.team)
+      resolve_email_template("triage_vaccination_at_clinic", triage.team)
     elsif triage.keep_in_triage?
-      :consent_confirmation_triage
+      "consent_confirmation_triage"
     end
   end
 
   def send_consent_email(type, params)
-    template = :"consent_confirmation_#{type}"
-    EmailDeliveryJob.perform_later(template, **params)
+    template_name = "consent_confirmation_#{type}"
+    EmailDeliverySidekiqJob.perform_async(template_name, params)
   end
 
   def send_consent_sms(type, consent, params)
     if consent.parent.phone_receive_updates
-      template = :"consent_confirmation_#{type}"
-      SMSDeliveryJob.perform_later(template, **params)
+      template_name = "consent_confirmation_#{type}"
+      SMSDeliverySidekiqJob.perform_async(template_name, params)
     end
   end
 
@@ -76,7 +80,7 @@ def send_consent_email_and_sms(type, consent, params)
 
   def resolve_email_template(template_name, team)
     ods_code = team.organisation.ods_code.downcase
-    template_names = [:"#{template_name}_#{ods_code}", template_name]
+    template_names = ["#{template_name}_#{ods_code}", template_name]
     template_names.find { NotifyTemplate.exists?(it, channel: :email) }
   end
 

app/lib/notifier/consent_form.rb

@@ -31,22 +31,24 @@ def send_confirmation
 
   def send_unknown_contact_details_warning(patient:)
     patient.parents.each do |parent|
+      params = {
+        "consent_form_id" => consent_form.id,
+        "parent_id" => parent.id,
+        "patient_id" => patient.id
+      }
+
       if parent.email.present?
-        EmailDeliveryJob.perform_later(
-          :consent_unknown_contact_details_warning,
-          consent_form:,
-          parent:,
-          patient:
+        EmailDeliverySidekiqJob.perform_async(
+          "consent_unknown_contact_details_warning",
+          params
         )
       end
 
       next unless parent.phone.present? && parent.phone_receive_updates
 
-      SMSDeliveryJob.perform_later(
-        :consent_unknown_contact_details_warning,
-        consent_form:,
-        parent:,
-        patient:
+      SMSDeliverySidekiqJob.perform_async(
+        "consent_unknown_contact_details_warning",
+        params
       )
     end
   end
@@ -56,32 +58,50 @@ def send_unknown_contact_details_warning(patient:)
   attr_reader :consent_form
 
   def send_confirmation_given(programme_types: nil, disease_types: nil)
-    params = { consent_form: }
-    params[:programme_types] = programme_types if programme_types
-    params[:disease_types] = disease_types if disease_types
+    params = { "consent_form_id" => consent_form.id }
+    params["programme_types"] = programme_types if programme_types
+    params["disease_types"] = disease_types if disease_types
 
     if consent_form.health_answers_require_triage?
-      EmailDeliveryJob.perform_later(:consent_confirmation_triage, **params)
+      EmailDeliverySidekiqJob.perform_async(
+        "consent_confirmation_triage",
+        params
+      )
     elsif consent_form.session&.clinic? || consent_form.session&.completed?
-      EmailDeliveryJob.perform_later(:consent_confirmation_clinic, **params)
+      EmailDeliverySidekiqJob.perform_async(
+        "consent_confirmation_clinic",
+        params
+      )
     else
-      EmailDeliveryJob.perform_later(:consent_confirmation_given, **params)
+      EmailDeliverySidekiqJob.perform_async(
+        "consent_confirmation_given",
+        params
+      )
 
       if consent_form.parent_phone_receive_updates
-        SMSDeliveryJob.perform_later(:consent_confirmation_given, **params)
+        SMSDeliverySidekiqJob.perform_async(
+          "consent_confirmation_given",
+          params
+        )
       end
     end
   end
 
   def send_confirmation_refused(programme_types: nil, disease_types: nil)
-    params = { consent_form: }
-    params[:programme_types] = programme_types if programme_types
-    params[:disease_types] = disease_types if disease_types
+    params = { "consent_form_id" => consent_form.id }
+    params["programme_types"] = programme_types if programme_types
+    params["disease_types"] = disease_types if disease_types
 
-    EmailDeliveryJob.perform_later(:consent_confirmation_refused, **params)
+    EmailDeliverySidekiqJob.perform_async(
+      "consent_confirmation_refused",
+      params
+    )
 
     if consent_form.parent_phone_receive_updates
-      SMSDeliveryJob.perform_later(:consent_confirmation_refused, **params)
+      SMSDeliverySidekiqJob.perform_async(
+        "consent_confirmation_refused",
+        params
+      )
     end
   end
 end

app/lib/notifier/patient.rb

@@ -148,11 +148,18 @@ def send_clinic_invitation(
 
     template_name = find_clinic_template_name(type, team:)
 
-    params = { academic_year:, patient:, programme_types:, sent_by:, team: }
+    base_params = {
+      "academic_year" => academic_year,
+      "patient_id" => patient.id,
+      "programme_types" => programme_types,
+      "sent_by_user_id" => sent_by.id,
+      "team_id" => team.id
+    }
 
     parents.each do |parent|
-      EmailDeliveryJob.perform_later(template_name, parent:, **params)
-      SMSDeliveryJob.perform_later(template_name, parent:, **params)
+      params = base_params.merge("parent_id" => parent.id)
+      EmailDeliverySidekiqJob.perform_async(template_name, params)
+      SMSDeliverySidekiqJob.perform_async(template_name, params)
     end
 
     clinic_notification
@@ -226,16 +233,22 @@ def send_consent_notification(
     disease_types = programmes_to_send_for.flat_map(&:disease_types).presence
 
     parents.each do |parent|
-      params = { disease_types:, parent:, patient:, programme_types:, sent_by: }
+      params = {
+        "disease_types" => disease_types,
+        "parent_id" => parent.id,
+        "patient_id" => patient.id,
+        "programme_types" => programme_types,
+        "sent_by_user_id" => sent_by&.id
+      }
 
       if session
-        params[:session] = session
+        params["session_id"] = session.id
       else
-        params[:team_location] = team_location
+        params["team_location_id"] = team_location.id
       end
 
-      EmailDeliveryJob.perform_later(email_template, **params)
-      SMSDeliveryJob.perform_later(sms_template, **params)
+      EmailDeliverySidekiqJob.perform_async(email_template, params)
+      SMSDeliverySidekiqJob.perform_async(sms_template, params)
     end
 
     PatientStatusUpdaterJob.perform_async(patient.id)
@@ -254,9 +267,9 @@ def generate_consent_templates(
 
     base_template =
       if is_school && CONSENT_REMINDER_TYPES.include?(type)
-        :consent_school_reminder
+        "consent_school_reminder"
       else
-        :"consent_#{is_school ? "school" : "clinic"}_#{type}"
+        "consent_#{is_school ? "school" : "clinic"}_#{type}"
       end
 
     # We can only handle a single programme group or variant in the template.
@@ -300,7 +313,7 @@ def generate_consent_templates(
           )
         template || base_template
       elsif is_school
-        :consent_school_reminder
+        "consent_school_reminder"
       end
 
     [email_template, sms_template]
@@ -321,7 +334,7 @@ def resolve_consent_template(
 
     combinations
       .lazy
-      .map { |parts| :"#{base_template}_#{parts.join("_")}" }
+      .map { |parts| "#{base_template}_#{parts.join("_")}" }
       .detect { NotifyTemplate.exists?(it, channel:) }
   end
 
@@ -351,10 +364,8 @@ def programmes_to_send_clinic_invitation_for(
   end
 
   def find_clinic_template_name(type, team:)
-    template_names = [
-      :"clinic_#{type}_#{team.organisation.ods_code.downcase}",
-      :"clinic_#{type}"
-    ]
+    ods_code = team.organisation.ods_code.downcase
+    template_names = ["clinic_#{type}_#{ods_code}", "clinic_#{type}"]
 
     template_names.find { NotifyTemplate.exists?(it, channel: :email) }
   end