Merge pull request #6634 from NHSDigital/MAV-6739-notify-purpose-from-template-frontmatter

Improvements to the purpose field on notify log entries

Author: benilovj

app/jobs/email_delivery_job.rb

@@ -103,7 +103,7 @@ def perform(
       subject: rendered[:subject],
       template_id: template.id,
       type: :email,
-      purpose: NotifyLogEntry.purpose_for_template_name(template_name_sym),
+      purpose: template.purpose,
       notify_log_entry_programmes_attributes:
         personalisation.programmes.map do
           { programme_type: it.type, disease_types: it.disease_types }

app/jobs/sms_delivery_job.rb

@@ -93,7 +93,7 @@ def perform(
       sent_by:,
       template_id: template.id,
       type: :sms,
-      purpose: NotifyLogEntry.purpose_for_template_name(template_name_sym),
+      purpose: template.purpose,
       notify_log_entry_programmes_attributes:
         personalisation.programmes.map do
           { programme_type: it.type, disease_types: it.disease_types }

app/lib/notify_template.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
 class NotifyTemplate
+  include ActiveModel::Model
+
+  validates :purpose, presence: true
+  validates :purpose,
+            inclusion: {
+              in: ->(_) { NotifyLogEntry.purposes.keys.map(&:to_sym) }
+            },
+            if: -> { purpose.present? }
+
   class << self
     def find(name, channel:)
       local_templates(channel)[name]
@@ -43,19 +52,21 @@ def scan_templates(channel)
           template = new(name:, channel:, content:)
           next unless template.id
 
+          template.validate!
           hash[name] = template
         end
     end
   end
 
-  attr_reader :name, :channel, :id, :body, :subject
+  attr_reader :name, :channel, :id, :body, :subject, :purpose
 
   def initialize(name:, channel:, content:)
     @name = name.to_sym
     @channel = channel.to_sym
     frontmatter, @body = parse_frontmatter(content)
     @id = frontmatter["template_id"]
     @subject = frontmatter["subject"].to_s
+    @purpose = frontmatter["purpose"]&.to_sym
   end
 
   def render(personalisation)

app/models/notify_log_entry.rb

@@ -7,7 +7,7 @@
 #  id              :bigint           not null, primary key
 #  body            :text
 #  delivery_status :integer          default("sending"), not null
-#  purpose         :integer
+#  purpose         :integer          not null
 #  recipient       :string           not null
 #  subject         :text
 #  type            :integer          not null
@@ -128,6 +128,7 @@ class NotifyLogEntry < ApplicationRecord
          vaccination_deleted: 13
        }
 
+  validates :purpose, presence: true
   validates :recipient, presence: true
   validates :template_id, presence: true
 
@@ -158,40 +159,6 @@ def title
 
   def programmes = notify_log_entry_programmes.map(&:programme)
 
-  def self.purpose_for_template_name(template_name_sym)
-    name = template_name_sym.to_s
-
-    if name.include?("consent") && name.include?("request")
-      :consent_request
-    elsif name.include?("consent") && name.include?("reminder")
-      :consent_reminder
-    elsif name.include?("consent_confirmation")
-      :consent_confirmation
-    elsif name.include?("consent") && name.include?("warning")
-      :consent_warning
-    elsif name.include?("clinic") && name.include?("invitation")
-      :clinic_invitation
-    elsif name.include?("session_school_reminder")
-      :session_reminder
-    elsif name.include?("triage_vaccination_will_happen")
-      :triage_vaccination_will_happen
-    elsif name.include?("triage_vaccination_wont_happen")
-      :triage_vaccination_wont_happen
-    elsif name.include?("triage_vaccination_at_clinic")
-      :triage_vaccination_at_clinic
-    elsif name.include?("triage_delay_vaccination")
-      :triage_delay_vaccination
-    elsif name.include?("vaccination_administered")
-      :vaccination_administered
-    elsif name.include?("vaccination_already_had")
-      :vaccination_already_had
-    elsif name.include?("vaccination_not_administered")
-      :vaccination_not_administered
-    elsif name.include?("vaccination_deleted")
-      :vaccination_deleted
-    end
-  end
-
   private
 
   def template_name

app/views/notify_templates/email/clinic_initial_invitation.text.erb

@@ -1,5 +1,6 @@
 ---
 template_id: "ceea5ff5-2250-4eb2-ab35-4e9e840b2a6f"
+purpose: clinic_invitation
 template_name: clinic_initial_invitation
 subject: "<%= short_patient_name %> has still not had their <%= vaccination %>"
 ---

app/views/notify_templates/email/clinic_initial_invitation_rt5.text.erb

@@ -1,5 +1,6 @@
 ---
 template_id: "17e63d67-53fc-4e9a-a533-74974412aac0"
+purpose: clinic_invitation
 template_name: clinic_initial_invitation_rt5
 subject: "<%= short_patient_name %> has still not had their <%= vaccination %>"
 ---

app/views/notify_templates/email/clinic_initial_invitation_ryg.text.erb

@@ -1,5 +1,6 @@
 ---
 template_id: "5fe4fb4d-6f0a-4149-a80a-232bdfdf4f73"
+purpose: clinic_invitation
 template_name: clinic_initial_invitation_ryg
 subject: "<%= short_patient_name %> has still not had their <%= vaccination %>"
 ---

app/views/notify_templates/email/clinic_subsequent_invitation.text.erb

@@ -1,5 +1,6 @@
 ---
 template_id: "a86a3b3f-a848-41d8-9a6f-d38174981388"
+purpose: clinic_invitation
 template_name: clinic_subsequent_invitation
 subject: "Your child can still get their <%= vaccination %> at a clinic"
 ---

app/views/notify_templates/email/clinic_subsequent_invitation_ryg.text.erb

@@ -1,5 +1,6 @@
 ---
 template_id: "eee59c1b-3af4-4ccd-8653-940887066390"
+purpose: clinic_invitation
 template_name: clinic_subsequent_invitation_ryg
 subject: "Your child can still get their <%= vaccination %> at a clinic"
 ---

app/views/notify_templates/email/consent_clinic_request.text.erb

@@ -1,5 +1,6 @@
 ---
 template_id: "14e88a09-4281-4257-9574-6afeaeb42715"
+purpose: consent_request
 template_name: consent_clinic_request
 subject: "We still need consent for your child’s <%= vaccination %>"
 ---