Update missing form status job to inspect batches rather than individual records - IVC CHAMPVA (#21092)

* first pass at implementation

* updated documentation

* updated to use batches

* updated timing

* more tests

* added new tests

* fixing flaky test

Author: michaelclement

modules/ivc_champva/app/jobs/ivc_champva/missing_form_status_job.rb

@@ -12,15 +12,17 @@ class MissingFormStatusJob
     def perform # rubocop:disable Metrics/MethodLength
       return unless Settings.ivc_forms.sidekiq.missing_form_status_job.enabled
 
-      forms = IvcChampvaForm.where(pega_status: nil).where('created_at < ?', 1.minute.ago)
+      batches = get_nil_batches
 
-      return unless forms.any?
+      return unless batches.any?
 
       # Send the count of forms to DataDog
-      StatsD.gauge('ivc_champva.forms_missing_status.count', forms.count)
+      StatsD.gauge('ivc_champva.forms_missing_status.count', batches.count)
 
       current_time = Time.now.utc
-      forms.each do |form|
+
+      batches.each_value do |batch|
+        form = batch[0] # get a representative form from this submission batch
         # Check if we've been missing Pega status for > custom threshold of days:
         elapsed_days = (current_time - form.created_at).to_i / 1.day
         threshold = Settings.vanotify.services.ivc_champva.failure_email_threshold_days.to_i || 7
@@ -106,6 +108,32 @@ def send_zsf_notification_to_pega(form, template_id)
       end
     end
 
+    ##
+    # Returns form submissions with nil pega statuses created more than 1 minute ago
+    # organized in batches that correspond to individual form submissions.
+    #
+    # @return [Hash] hash of batches where the keys are a batch's `form_uuid`
+    #   and the value is a list of `IvcChampvaForm`s with that form_uuid
+    #   e.g.:
+    #     {
+    #       'ad6c9181-530c-4a8f-9fbd-5e8e8a400d4a': [<IvcChampvaForm>, <IvcChampvaForm>]
+    #       'fac6a892-530c-8a40-8afc-9fbd8ad8a40a': [<IvcChampvaForm>]
+    #     }
+    #
+    def get_nil_batches
+      all_nil_statuses = IvcChampvaForm.where(pega_status: nil).where('created_at < ?', 1.minute.ago)
+
+      batches = {}
+
+      # Group all nil results into batches by form UUID
+      all_nil_statuses.map do |el|
+        batch = IvcChampvaForm.where(form_uuid: el.form_uuid)
+        batches[el.form_uuid] = batch
+      end
+
+      batches
+    end
+
     def fetch_forms_by_uuid(form_uuid)
       @fetch_forms_by_uuid ||= IvcChampvaForm.where(form_uuid:)
     end

modules/ivc_champva/spec/jobs/missing_form_status_job_spec.rb

@@ -16,6 +16,7 @@ def days_since_now(created_at)
 
   before do
     allow(Settings.ivc_forms.sidekiq.missing_form_status_job).to receive(:enabled).and_return(true)
+    allow(Flipper).to receive(:enabled?).with(:champva_vanotify_custom_callback, @current_user).and_return(true)
     allow(StatsD).to receive(:gauge)
     allow(StatsD).to receive(:increment)
 
@@ -24,12 +25,14 @@ def days_since_now(created_at)
                                                       track_failed_send_zsf_notification_to_pega: nil))
     # Save the original form creation times so we can restore them later
     @original_creation_times = forms.map(&:created_at)
+    @original_uuids = forms.map(&:form_uuid)
   end
 
   after do
-    # Restore original form creation times for time sensitive tests
+    # Restore original dummy form created_at/form_uuid props in case we've adjusted them
     forms.each_with_index do |form, index|
       form.update(created_at: @original_creation_times[index])
+      form.update(form_uuid: @original_uuids[index])
     end
   end
 
@@ -105,6 +108,30 @@ def days_since_now(created_at)
     expect(StatsD).to have_received(:gauge).with('ivc_champva.forms_missing_status.count', forms.count - 1)
   end
 
+  it 'processes nil forms in batches that belong to the same submission' do
+    # Set shared `form_uuid` so these two now belong to the same batch:
+    forms[0].update(form_uuid: '78444a0b-3ac8-454d-a28d-8d63cddd0d3b')
+    forms[1].update(form_uuid: '78444a0b-3ac8-454d-a28d-8d63cddd0d3b')
+
+    # Perform the job that checks form statuses
+    job.perform
+
+    # Check that we processed batches rather than individual forms:
+    expect(StatsD).to have_received(:gauge).with('ivc_champva.forms_missing_status.count', forms.count - 1)
+  end
+
+  it 'groups nil statuses into batches by uuid' do
+    # Set shared `form_uuid` so these two now belong to the same batch:
+    forms[0].update(form_uuid: '78444a0b-3ac8-454d-a28d-8d63cddd0d3b')
+    forms[1].update(form_uuid: '78444a0b-3ac8-454d-a28d-8d63cddd0d3b')
+
+    # Perform the job that checks form statuses
+    batches = job.get_nil_batches
+
+    expect(batches.count == forms.count - 1).to be true
+    expect(batches['78444a0b-3ac8-454d-a28d-8d63cddd0d3b'].count == 2).to be true
+  end
+
   it 'sends the count of forms to DataDog' do
     IvcChampva::MissingFormStatusJob.new.perform