Implement logic needs consent status request scheduled/not scheduled

This adds the logic where if a child is eligible for the programme and
hasn't been sent any consent requests and has parent contact details:
- If part of a session where consent requests are scheduled to go out in
  the future, the programme status becomes `needs_consent_request_scheduled`.
- If not assigned to a session with a request scheduled, the programme
  status becomes `needs_consent_request_not_scheduled`.

Jira-Issue: MAV-5882

Author: jhenderson

app/components/app_patient_search_form_component.rb

@@ -2,11 +2,7 @@
 
 class AppPatientSearchFormComponent < ViewComponent::Base
   # Remove these statuses once implemented.
-  HIDDEN_PROGRAMME_STATUSES = %w[
-    needs_consent_request_failed
-    needs_consent_request_not_scheduled
-    needs_consent_request_scheduled
-  ].freeze
+  HIDDEN_PROGRAMME_STATUSES = %w[needs_consent_request_failed].freeze
 
   def initialize(
     form,

app/components/app_patient_session_consent_component.html.erb

@@ -21,6 +21,10 @@
       <p><%= patient.full_name %> is ready for the vaccinator.</p>
     <% elsif consent_status_value == :no_contact_details %>
       <p>We cannot send consent requests because we have no parent contact details.</p>
+    <% elsif consent_status_value == :request_not_scheduled %>
+      <p>No consent request is scheduled to be sent because the child has not been added to a scheduled session.</p>
+    <% elsif consent_status_value == :request_scheduled %>
+      <p>A consent request will be sent on <%= session.send_consent_requests_at.to_fs(:long) %>.</p>
     <% end %>
 
     <div class="nhsuk-button-group">

app/components/app_patient_session_consent_component.rb

@@ -63,7 +63,9 @@ def consent_status_generator
         patient:,
         consents:,
         vaccination_records:,
-        parents:
+        parents:,
+        sessions: [session],
+        consent_notifications:
       )
   end
 
@@ -76,19 +78,14 @@ def triage_status_generator
         consents:,
         triages:,
         vaccination_records:,
-        parents:
+        parents:,
+        sessions: [session],
+        consent_notifications:
       )
   end
 
   def latest_consent_request
-    @latest_consent_request ||=
-      patient
-        .consent_notifications
-        .request
-        .has_all_programmes_of([programme])
-        .for_academic_year(academic_year)
-        .order(sent_at: :desc)
-        .first
+    @latest_consent_request ||= consent_notifications.first
   end
 
   def consents
@@ -116,8 +113,14 @@ def vaccination_records
       patient.vaccination_records.for_programme(programme).order_by_performed_at
   end
 
+  SEND_CONSENT_REQUEST_STATUSES = %i[
+    no_response
+    request_scheduled
+    request_not_scheduled
+  ].freeze
+
   def can_send_consent_request?
-    consent_status_value == :no_response &&
+    consent_status_value.in?(SEND_CONSENT_REQUEST_STATUSES) &&
       patient.send_notifications?(team: @session.team) &&
       session.can_receive_consent? && patient.parents.any?(&:contactable?)
   end
@@ -134,4 +137,13 @@ def who_refused
   def show_health_answers?
     grouped_consents.any?(&:response_given?)
   end
+
+  def consent_notifications
+    patient
+      .consent_notifications
+      .request
+      .has_all_programmes_of([programme])
+      .for_academic_year(academic_year)
+      .order(sent_at: :desc)
+  end
 end

app/components/app_patient_session_triage_component.rb

@@ -14,6 +14,13 @@ def initialize(
     @current_user = current_user
     @triage_form = triage_form || default_triage_form
     @parents = patient.parents
+    @patient_locations =
+      patient.patient_locations.includes(
+        location: [
+          :location_programme_year_groups,
+          { team_locations: { sessions: :session_programme_year_groups } }
+        ]
+      )
   end
 
   def render?
@@ -28,7 +35,8 @@ def render?
               :programme,
               :current_user,
               :triage_form,
-              :parents
+              :parents,
+              :patient_locations
 
   delegate :academic_year, :team, to: :session
 
@@ -77,7 +85,9 @@ def triage_status_generator
         consents:,
         triages:,
         vaccination_records:,
-        parents:
+        parents:,
+        sessions: [session],
+        consent_notifications:
       )
   end
 
@@ -89,7 +99,9 @@ def consent_status_generator
         patient:,
         consents:,
         vaccination_records:,
-        parents:
+        parents:,
+        sessions: [session],
+        consent_notifications:
       )
   end
 
@@ -118,4 +130,12 @@ def latest_triage
   def default_triage_form
     TriageForm.new(patient:, session:, programme:, current_user:)
   end
+
+  def consent_notifications
+    patient
+      .consent_notifications
+      .request
+      .has_all_programmes_of([programme])
+      .for_academic_year(academic_year)
+  end
 end

app/forms/triage_form.rb

@@ -130,7 +130,9 @@ def consent_status_generator
         patient:,
         consents: patient.consents,
         vaccination_records: [],
-        parents: []
+        parents: [],
+        sessions: [],
+        consent_notifications: []
       )
   end
 

app/lib/patient_status_updater.rb

@@ -51,7 +51,13 @@ def update_programme_statuses!
             :patient_locations,
             :triages,
             :vaccination_records,
-            :parents
+            :parents,
+            :consent_notifications,
+            patient_locations: {
+              location: [
+                { team_locations: { sessions: :session_programme_year_groups } }
+              ]
+            }
           ).to_a
 
         batch.each(&:assign)
@@ -182,4 +188,23 @@ def programme_types_per_session_id_and_year_group
           hash[session_id][year_group] << programme_type
         end
   end
+
+  # We preload this association separately because including it in the nested
+  # `patient_locations` preload (see includes above) caused the updater process
+  # to be killed, even with very small batches. The likely cause is memory pressure
+  # from eager loading a deeply nested association graph.
+  #
+  # Preloading it here for the distinct `Location` records in each batch keeps
+  # `StatusGenerator::Programme` query-free without incurring the cost of the
+  # larger nested preload.
+  def preload_location_programme_year_groups(batch)
+    locations = batch.flat_map(&:patient_locations).map(&:location).uniq
+
+    ActiveRecord::Associations::Preloader.new(
+      records: locations,
+      associations: {
+        location_programme_year_groups: :location_year_group
+      }
+    ).call
+  end
 end

app/lib/status_generator/consent.rb

@@ -7,14 +7,18 @@ def initialize(
     patient:,
     consents:,
     vaccination_records:,
-    parents:
+    parents:,
+    sessions:,
+    consent_notifications:
   )
     @programme_type = programme_type
     @academic_year = academic_year
     @patient = patient
     @consents = consents
     @vaccination_records = vaccination_records
     @parents = parents
+    @sessions = sessions
+    @consent_notifications = consent_notifications
   end
 
   def programme
@@ -32,6 +36,10 @@ def status
       :conflicts
     elsif status_should_be_no_contact_details?
       :no_contact_details
+    elsif status_should_be_request_scheduled?
+      :request_scheduled
+    elsif status_should_be_request_not_scheduled?
+      :request_not_scheduled
     elsif status_should_be_no_response?
       :no_response
     else
@@ -62,7 +70,9 @@ def disease_types
               :patient,
               :consents,
               :vaccination_records,
-              :parents
+              :parents,
+              :sessions,
+              :consent_notifications
 
   def vaccinated?
     return @vaccinated if defined?(@vaccinated)
@@ -131,6 +141,20 @@ def status_should_be_no_contact_details?
     parents.none?(&:contactable?)
   end
 
+  def status_should_be_request_scheduled?
+    return false if vaccinated?
+
+    parents_contactable? && consent_notifications.empty? &&
+      sessions.any? { consent_request_scheduled_in_future?(it) }
+  end
+
+  def status_should_be_request_not_scheduled?
+    return false if vaccinated?
+
+    parents_contactable? && consent_notifications.empty? &&
+      (sessions.empty? || sessions.any? { consent_request_not_scheduled?(it) })
+  end
+
   def agreed_vaccine_methods
     @agreed_vaccine_methods ||=
       consents_for_status.map(&:vaccine_methods).inject(&:intersection)
@@ -162,4 +186,21 @@ def latest_consents
     @latest_consents ||=
       ConsentGrouper.call(consents, programme_type:, academic_year:)
   end
+
+  def parents_contactable? = parents.any?(&:contactable?)
+
+  def consent_request_scheduled_in_future?(session)
+    send_at = session.send_consent_requests_at
+
+    # Not using future? because it doesn't work with Timecop
+    send_at.present? && send_at > Time.current
+  end
+
+  # Treat consent requests as not scheduled when send_consent_requests_at is
+  # missing or has already passed, such as for sessions activated on the
+  # same day they are created.
+  def consent_request_not_scheduled?(session)
+    send_at = session.send_consent_requests_at
+    send_at.nil? || send_at < Time.current
+  end
 end

app/lib/status_generator/programme.rb

@@ -17,7 +17,8 @@ def initialize(
     triages:,
     attendance_record:,
     vaccination_records:,
-    parents:
+    parents:,
+    consent_notifications:
   )
     @programme_type = programme_type
     @academic_year = academic_year
@@ -28,6 +29,8 @@ def initialize(
     @attendance_record = attendance_record
     @vaccination_records = vaccination_records
     @parents = parents
+    @consent_notifications =
+      find_matching_consent_notifications(consent_notifications)
 
     @vaccination_criteria =
       VaccinationCriteria.new(
@@ -172,7 +175,8 @@ def consent_vaccine_methods
               :triages,
               :attendance_record,
               :vaccination_criteria,
-              :parents
+              :parents,
+              :consent_notifications
 
   delegate :vaccinated?,
            :vaccinated_vaccination_record,
@@ -237,11 +241,11 @@ def should_be_needs_consent_request_failed?
   end
 
   def should_be_needs_consent_request_scheduled?
-    false # TODO: Implement this status.
+    is_eligible? && consent_status == :request_scheduled
   end
 
   def should_be_needs_consent_request_not_scheduled?
-    false # TODO: Implement this status.
+    is_eligible? && consent_status == :request_not_scheduled
   end
 
   def should_be_needs_consent_no_contact_details?
@@ -288,6 +292,13 @@ def default_programme_year_groups
     Programme.find(programme_type).default_year_groups
   end
 
+  def find_matching_consent_notifications(notifications)
+    notifications.select do |notification|
+      notification.programme_types.include?(programme_type) &&
+        notification.session&.team_location&.academic_year == academic_year
+    end
+  end
+
   def consent_generator
     @consent_generator ||=
       StatusGenerator::Consent.new(
@@ -296,7 +307,9 @@ def consent_generator
         patient:,
         consents:,
         vaccination_records:,
-        parents:
+        parents:,
+        sessions:,
+        consent_notifications:
       )
   end
 
@@ -309,7 +322,34 @@ def triage_generator
         consents:,
         triages:,
         vaccination_records:,
-        parents:
+        parents:,
+        sessions:,
+        consent_notifications:
       )
   end
+
+  def sessions
+    @sessions ||=
+      patient_locations
+        .reject { it.location.generic_clinic? }
+        .flat_map { sessions_for(it) }
+        .uniq
+  end
+
+  def sessions_for(patient_location)
+    patient_location
+      .location
+      .team_locations
+      .select { it.academic_year == academic_year }
+      .flat_map(&:sessions)
+      .select { it.programme_types.include?(programme_type) }
+      .select { session_in_patient_location_date_range?(it, patient_location) }
+      .reject(&:completed?)
+  end
+
+  def session_in_patient_location_date_range?(session, patient_location)
+    return true if session.dates.empty?
+
+    session.dates.any? { |date| date.in?(patient_location.date_range) }
+  end
 end