95915 Add pega notification email workflow - IVC CHAMPVA forms (#19795)

* added email trigger for Pega alert

* updated template

* updated unit test

* more spec-ing

* updated test

config/settings.yml

@@ -1364,6 +1364,7 @@ vanotify:
     ivc_champva:
       api_key: fake_secret
       failure_email_threshold_days: 7
+      pega_inbox_address: fake_email_address
       template_id:
         form_10_10d_email: form_10_10d_email
         form_10_10d_failure_email: form_10_10d_failure_email

modules/ivc_champva/app/controllers/ivc_champva/v1/pega_controller.rb

@@ -77,7 +77,8 @@ def send_email(form_uuid, form)
             form_number: form.form_number,
             file_count: fetch_forms_by_uuid(form_uuid).where('file_name LIKE ?', '%supporting_doc%').count,
             pega_status: form.pega_status,
-            created_at: form.created_at.strftime('%B %d, %Y')
+            created_at: form.created_at.strftime('%B %d, %Y'),
+            form_uuid: form.form_uuid
           }
 
         ActiveRecord::Base.transaction do

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

@@ -29,9 +29,10 @@ def perform # rubocop:disable Metrics/MethodLength
             template_id = "#{form[:form_number]}-FAILURE"
             send_failure_email(form, template_id)
             if Flipper.enabled?(:champva_enhanced_monitor_logging, @current_user)
-              additional_context = { form_id: form[:form_number] }
+              additional_context = { form_id: form[:form_number], form_uuid: form[:form_uuid] }
               monitor.log_silent_failure_avoided(additional_context)
               monitor.track_missing_status_email_sent(form[:form_number])
+              send_zsf_notification_to_pega(form)
             end
           end
         end
@@ -44,33 +45,56 @@ def perform # rubocop:disable Metrics/MethodLength
       Rails.logger.error e.backtrace.join("\n")
     end
 
-    def fetch_forms_by_uuid(form_uuid)
-      @fetch_forms_by_uuid ||= IvcChampvaForm.where(form_uuid:)
+    def construct_email_payload(form, template_id)
+      { email: form.email,
+        first_name: form.first_name,
+        last_name: form.last_name,
+        form_number: form.form_number,
+        file_count: nil,
+        pega_status: form.pega_status,
+        created_at: form.created_at.strftime('%B %d, %Y'),
+        template_id: template_id,
+        form_uuid: form.form_uuid }
     end
 
+    # Sends an email to user notifying them of their submission's failure
+    #
+    # @param form [IvcChampvaForm] form object in question
+    # @param template_id [string] key for template to use in `IvcChampva::Email::EMAIL_TEMPLATE_MAP`
     def send_failure_email(form, template_id)
-      form_data =
-        {
-          email: form.email,
-          first_name: form.first_name,
-          last_name: form.last_name,
-          form_number: form.form_number,
-          file_count: nil,
-          pega_status: form.pega_status,
-          created_at: form.created_at.strftime('%B %d, %Y'),
-          template_id: template_id
-        }
+      form_data = construct_email_payload(form, template_id)
       ActiveRecord::Base.transaction do
         if IvcChampva::Email.new(form_data).send_email
           fetch_forms_by_uuid(form[:form_uuid]).update_all(email_sent: true) # rubocop:disable Rails/SkipsModelValidations
         else
-          additional_context = { form_id: form[:form_number] }
+          additional_context = { form_id: form[:form_number], form_uuid: form[:form_uuid] }
           monitor.log_silent_failure(additional_context)
           raise ActiveRecord::Rollback, 'Pega Status Update/Action Required Email send failure'
         end
       end
     end
 
+    # Fires off a notification email to Pega so they know a user has been
+    # notified of a failed submission.
+    #
+    # @param form_data [hash] hash of form details (see `send_failure_email`)
+    # @param form [IvcChampvaForm] form object in question
+    def send_zsf_notification_to_pega(form)
+      form_data = construct_email_payload(form, 'PEGA-TEAM-ZSF')
+      form_data = form_data.merge({
+                                    email: Settings.vanotify.services.ivc_champva.pega_inbox_address
+                                  })
+      if IvcChampva::Email.new(form_data).send_email
+        monitor.track_send_zsf_notification_to_pega(form_data[:form_uuid])
+      else
+        monitor.track_failed_send_zsf_notification_to_pega(form_data[:form_uuid])
+      end
+    end
+
+    def fetch_forms_by_uuid(form_uuid)
+      @fetch_forms_by_uuid ||= IvcChampvaForm.where(form_uuid:)
+    end
+
     ##
     # retreive a monitor for tracking
     #

modules/ivc_champva/app/services/ivc_champva/email.rb

@@ -35,7 +35,8 @@ def send_email
             'last_name' => data[:last_name],
             'file_count' => data[:file_count],
             'pega_status' => data[:pega_status],
-            'date_submitted' => data[:created_at]
+            'date_submitted' => data[:created_at],
+            'form_uuid' => data[:form_uuid]
           },
           Settings.vanotify.services.ivc_champva.api_key
         )

modules/ivc_champva/lib/ivc_champva/monitor.rb

@@ -42,5 +42,23 @@ def track_missing_status_email_sent(form_id)
                     "#{STATS_KEY}.form_missing_status_email_sent",
                     call_location: caller_locations.first, **additional_context)
     end
+
+    def track_send_zsf_notification_to_pega(form_uuid)
+      additional_context = {
+        form_uuid:
+      }
+      track_request('info', "IVC ChampVA Forms - alerted Pega of ZSF email sent for submission #{form_uuid}",
+                    "#{STATS_KEY}.send_zsf_notification_to_pega",
+                    call_location: caller_locations.first, **additional_context)
+    end
+
+    def track_failed_send_zsf_notification_to_pega(form_uuid)
+      additional_context = {
+        form_uuid:
+      }
+      track_request('warn', "IVC ChampVA Forms - could not alert Pega of ZSF email sent for submission #{form_uuid}",
+                    "#{STATS_KEY}.failed_send_zsf_notification_to_pega",
+                    call_location: caller_locations.first, **additional_context)
+    end
   end
 end

modules/ivc_champva/spec/jobs/missing_form_status_job_spec.rb

@@ -5,11 +5,16 @@
 RSpec.describe 'IvcChampva::MissingFormStatusJob', type: :job do
   let!(:one_week_ago) { 1.week.ago.utc }
   let!(:forms) { create_list(:ivc_champva_form, 3, pega_status: nil, created_at: one_week_ago) }
+  let!(:job) { IvcChampva::MissingFormStatusJob.new }
 
   before do
     allow(Settings.ivc_forms.sidekiq.missing_form_status_job).to receive(:enabled).and_return(true)
     allow(StatsD).to receive(:gauge)
     allow(StatsD).to receive(:increment)
+
+    allow(IvcChampva::Email).to receive(:new).and_return(double(send_email: true))
+    allow(job).to receive(:monitor).and_return(double(track_send_zsf_notification_to_pega: nil,
+                                                      track_failed_send_zsf_notification_to_pega: nil))
   end
 
   it 'sends the count of forms to DataDog' do
@@ -25,4 +30,27 @@
 
     IvcChampva::MissingFormStatusJob.new.perform
   end
+
+  context 'when send_zsf_notification_to_pega is successful' do
+    it 'logs a successful notification send to Pega' do
+      job.send_zsf_notification_to_pega(forms[0])
+
+      # Expect our monitor to track the successful send
+      expect(job.monitor).to have_received(:track_send_zsf_notification_to_pega).with(forms[0].form_uuid)
+    end
+  end
+
+  context 'when send_zsf_notification_to_pega fails' do
+    before do
+      # Sending the email should fail in this case
+      allow(IvcChampva::Email).to receive(:new).and_return(double(send_email: false))
+    end
+
+    it 'logs a failed notification send to Pega' do
+      job.send_zsf_notification_to_pega(forms[0])
+
+      # Expect our monitor to track the failed send
+      expect(job.monitor).to have_received(:track_failed_send_zsf_notification_to_pega).with(forms[0].form_uuid)
+    end
+  end
 end

modules/ivc_champva/spec/services/email_spec.rb

@@ -37,7 +37,8 @@
             'last_name' => data[:last_name],
             'file_count' => data[:file_count],
             'pega_status' => data[:pega_status],
-            'date_submitted' => data[:created_at]
+            'date_submitted' => data[:created_at],
+            'form_uuid' => data[:form_uuid]
           },
           Settings.vanotify.services.ivc_champva.api_key
         )

modules/ivc_champva/spec/services/monitor_spec.rb

@@ -53,5 +53,31 @@
         monitor.track_missing_status_email_sent(payload[:form_id])
       end
     end
+
+    describe '#track_send_zsf_notification_to_pega' do
+      it 'logs sidekiq success' do
+        payload = {
+          form_uuid: '12345678-1234-5678-1234-567812345678'
+        }
+
+        expect(monitor).to receive(:track_send_zsf_notification_to_pega).with(
+          payload[:form_uuid]
+        )
+        monitor.track_send_zsf_notification_to_pega(payload[:form_uuid])
+      end
+    end
+
+    describe '#track_failed_send_zsf_notification_to_pega' do
+      it 'logs sidekiq success' do
+        payload = {
+          form_uuid: '12345678-1234-5678-1234-567812345678'
+        }
+
+        expect(monitor).to receive(:track_failed_send_zsf_notification_to_pega).with(
+          payload[:form_uuid]
+        )
+        monitor.track_failed_send_zsf_notification_to_pega(payload[:form_uuid])
+      end
+    end
   end
 end