Initial 526 form 4142 benefits intake API work

app/models/form526_submission.rb

@@ -77,6 +77,7 @@ class Form526Submission < ApplicationRecord
   # MAX_PENDING_TIME aligns with the farthest out expectation given in the LH BI docs,
   # plus 1 week to accomodate for edge cases and our sidekiq jobs
   MAX_PENDING_TIME = 3.weeks
+  ZSF_DD_TAG_SERVICE = 'disability-application'
 
   # used to track in APMs between systems such as Lighthouse
   # example: can be used as a search parameter in Datadog

app/models/form_submission_attempt.rb

@@ -25,14 +25,15 @@ class FormSubmissionAttempt < ApplicationRecord
 
     event :fail do
       after do
+        form_type = form_submission.form_type
+        log_info = { form_submission_id:,
+                     benefits_intake_uuid: form_submission&.benefits_intake_uuid,
+                     form_type:,
+                     user_account_uuid: form_submission.user_account_id }
         if should_send_simple_forms_email
-          Rails.logger.info({
-                              message: 'Preparing to send Form Submission Attempt error email',
-                              form_submission_id:,
-                              benefits_intake_uuid: form_submission.benefits_intake_uuid,
-                              form_type: form_submission.form_type
-                            })
-          simple_forms_enqueue_result_email(:error)
+          simple_forms_api_email(log_info)
+        elsif form_type == CentralMail::SubmitForm4142Job::FORM4142_FORMSUBMISSION_TYPE
+          form526_form4142_email(log_info)
         end
       end
 
@@ -80,6 +81,41 @@ def log_status_change
 
   private
 
+  def simple_forms_api_email(log_info)
+    Rails.logger.info('Preparing to send Form Submission Attempt error email', log_info)
+    simple_forms_enqueue_result_email(:error)
+  end
+
+  def queue_form526_form4142_email(form526_submission_id, log_info)
+    Rails.logger.info('Queuing Form526:Form4142 failure email to VaNotify',
+                      log_info.merge({ form526_submission_id: }))
+    jid = EVSS::DisabilityCompensationForm::Form4142DocumentUploadFailureEmail.perform_async(
+      form526_submission_id
+    )
+    Rails.logger.info('Queuing Form526:Form4142 failure email to VaNotify completed',
+                      log_info.merge({ jid:, form526_submission_id: }))
+  end
+
+  def form526_form4142_email(log_info)
+    if Flipper.enabled?(CentralMail::SubmitForm4142Job::POLLED_FAILURE_EMAIL)
+      queue_form526_form4142_email(Form526Submission.find_by(saved_claim_id:).id, log_info)
+    else
+      Rails.logger.info(
+        'Would queue EVSS::DisabilityCompensationForm::Form4142DocumentUploadFailureEmail, but flipper is off.',
+        log_info.merge({ form526_submission_id: })
+      )
+    end
+  rescue => e
+    cl = caller_locations.first
+    call_location = ZeroSilentFailures::Monitor::CallLocation.new(
+      CentralMail::SubmitForm4142Job::FORM4142_DD_ZSF_FUNCTION, cl.path, cl.lineno
+    )
+    ZeroSilentFailures::Monitor.new(Form526Submission::ZSF_DD_TAG_SERVICE).log_silent_failure(
+      log_info.merge({ error_class: e.class, error_message: e.message }),
+      log_info[:user_account_uuid], call_location:
+    )
+  end
+
   def should_send_simple_forms_email
     simple_forms_form_number && Flipper.enabled?(:simple_forms_email_notifications)
   end

app/sidekiq/central_mail/submit_form4142_job.rb

@@ -9,6 +9,12 @@
 # TODO: Update Namespace once we are 100% done with CentralMail here
 module CentralMail
   class SubmitForm4142Job < EVSS::DisabilityCompensationForm::Job
+    INITIAL_FAILURE_EMAIL = :form526_send_4142_failure_notification
+    POLLING_FLIPPER_KEY = :disability_526_form4142_polling_records
+    POLLED_FAILURE_EMAIL = :disability_526_form4142_polling_record_failure_email
+
+    FORM4142_FORMSUBMISSION_TYPE = "#{Form526Submission::FORM_526}_#{Form526Submission::FORM_4142}".freeze
+    FORM4142_DD_ZSF_FUNCTION = 'Form 526 Flow - Form 4142 failure email queuing'
     extend Logging::ThirdPartyTransaction::MethodWrapper
 
     # this is required to make instance variables available to logs via
@@ -131,20 +137,39 @@ def lighthouse_service
       @lighthouse_service ||= BenefitsIntakeService::Service.new(with_upload_location: true)
     end
 
-    def upload_to_lighthouse
-      Rails.logger.info(
-        'Successful Form4142 Submission to Lighthouse',
-        { benefits_intake_uuid: lighthouse_service.uuid, submission_id: @submission_id }
-      )
-
-      payload = {
-        upload_url: lighthouse_service.location,
+    def payload_hash(lighthouse_service_location)
+      {
+        upload_url: lighthouse_service_location,
         file: { file: @pdf_path, file_name: @pdf_path.split('/').last },
         metadata: generate_metadata.to_json,
         attachments: []
       }
+    end
 
+    def upload_to_lighthouse
+      log_info = { benefits_intake_uuid: lighthouse_service.uuid, submission_id: @submission_id }
+
+      Rails.logger.info(
+        'Successful Form4142 Upload Intake UUID acquired from Lighthouse',
+        log_info
+      )
+
+      payload = payload_hash(lighthouse_service.location)
       lighthouse_service.upload_doc(**payload)
+
+      if Flipper.enabled?(POLLING_FLIPPER_KEY)
+        form526_submission = Form526Submission.find(@submission_id)
+        form_submission    = FormSubmission.create(
+          form_type: FORM4142_FORMSUBMISSION_TYPE, # form526_form4142
+          benefits_intake_uuid: lighthouse_service.uuid,
+          form_data: '{}', # we have this already in the Form526Submission.form['form4142']
+          user_account: form526_submission.user_account,
+          saved_claim: form526_submission.saved_claim
+        )
+        FormSubmissionAttempt.create(form_submission:)
+        log_info[:form_submission_id] = form_submission.id
+      end
+      Rails.logger.info('Successful Form4142 Submission to Lighthouse', log_info)
     end
 
     def generate_metadata

app/sidekiq/evss/disability_compensation_form/form4142_document_upload_failure_email.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require 'va_notify/service'
+require 'zero_silent_failures/monitor'
 
 module EVSS
   module DisabilityCompensationForm
     class Form4142DocumentUploadFailureEmail < Job
       STATSD_METRIC_PREFIX = 'api.form_526.veteran_notifications.form4142_upload_failure_email'
+      ZSF_DD_TAG_FUNCTION  = 'Form 526 Flow - Form 4142 failure email sending'
 
       # retry for one day
       sidekiq_options retry: 14
@@ -17,6 +19,13 @@ class Form4142DocumentUploadFailureEmail < Job
         timestamp = Time.now.utc
         form526_submission_id = msg['args'].first
 
+        log_info = { job_id:, timestamp:, form526_submission_id:, error_class:, error_message: }
+
+        Rails.logger.warn(
+          'Form4142DocumentUploadFailureEmail retries exhausted',
+          log_info
+        )
+
         # Job status records are upserted in the JobTracker module
         # when the retryable_error_handler is called
         form_job_status = Form526JobStatus.find_by(job_id:)
@@ -28,23 +37,11 @@ class Form4142DocumentUploadFailureEmail < Job
             form526_submission_id:
           }
         }
+
         form_job_status.update(
           status: Form526JobStatus::STATUS[:exhausted],
           bgjob_errors: bgjob_errors.merge(new_error)
         )
-
-        Rails.logger.warn(
-          'Form4142DocumentUploadFailureEmail retries exhausted',
-          {
-            job_id:,
-            timestamp:,
-            form526_submission_id:,
-            error_class:,
-            error_message:
-          }
-        )
-
-        StatsD.increment("#{STATSD_METRIC_PREFIX}.exhausted")
       rescue => e
         Rails.logger.error(
           'Failure in Form4142DocumentUploadFailureEmail#sidekiq_retries_exhausted',
@@ -59,19 +56,33 @@ class Form4142DocumentUploadFailureEmail < Job
           }
         )
         raise e
+      ensure
+        StatsD.increment("#{STATSD_METRIC_PREFIX}.exhausted")
+        cl = caller_locations.first
+        call_location = ZeroSilentFailures::Monitor::CallLocation.new(ZSF_DD_TAG_FUNCTION, cl.path, cl.lineno)
+        user_account_id = begin
+          Form526Submission.find(form526_submission_id).user_account_id
+        rescue
+          nil
+        end
+        ZeroSilentFailures::Monitor.new(Form526Submission::ZSF_DD_TAG_SERVICE).log_silent_failure(
+          log_info,
+          user_account_id,
+          call_location:
+        )
       end
 
       def perform(form526_submission_id)
         form526_submission = Form526Submission.find(form526_submission_id)
 
         with_tracking('Form4142DocumentUploadFailureEmail', form526_submission.saved_claim_id, form526_submission_id) do
-          @notify_client ||= VaNotify::Service.new(Settings.vanotify.services.benefits_disability.api_key)
+          notify_client = VaNotify::Service.new(Settings.vanotify.services.benefits_disability.api_key)
 
           email_address = form526_submission.veteran_email_address
           first_name = form526_submission.get_first_name
           date_submitted = form526_submission.format_creation_time_for_mailers
 
-          @notify_client.send_email(
+          notify_response = notify_client.send_email(
             email_address:,
             template_id: mailer_template_id,
             personalisation: {
@@ -80,30 +91,36 @@ def perform(form526_submission_id)
             }
           )
 
-          log_mailer_dispatch(form526_submission_id)
+          log_mailer_dispatch(form526_submission_id, notify_response)
         end
       rescue => e
         retryable_error_handler(e)
       end
 
       private
 
+      def zsf_monitor
+        @zsf_monitor ||= ZeroSilentFailures::Monitor.new(Form526Submission::ZSF_DD_TAG_SERVICE)
+      end
+
       def retryable_error_handler(error)
         # Needed to log the error properly in the Sidekiq::Form526JobStatusTracker::JobTracker,
         # which is included near the top of this job's inheritance tree in EVSS::DisabilityCompensationForm::JobStatus
         super(error)
         raise error
       end
 
-      def log_mailer_dispatch(form526_submission_id)
-        Rails.logger.info(
-          'Form4142DocumentUploadFailureEmail notification dispatched',
-          {
-            form526_submission_id:,
-            timestamp: Time.now.utc
-          }
-        )
+      def log_mailer_dispatch(form526_submission_id, email_response = {})
+        log_info = { form526_submission_id:, timestamp: Time.now.utc }
+        Rails.logger.info('Form4142DocumentUploadFailureEmail notification dispatched', log_info)
 
+        cl = caller_locations.first
+        call_location = ZeroSilentFailures::Monitor::CallLocation.new(ZSF_DD_TAG_FUNCTION, cl.path, cl.lineno)
+        zsf_monitor.log_silent_failure_avoided(
+          log_info.merge(email_confirmation_id: email_response&.id),
+          Form526Submission.find(form526_submission_id).user_account_id,
+          call_location:
+        )
         StatsD.increment("#{STATSD_METRIC_PREFIX}.success")
       end
 

config/features.yml

@@ -436,6 +436,14 @@ features:
     actor_type: user
     description: Manage dependent removal from view dependent page
     enable_in_development: true
+  disability_526_form4142_polling_records:
+    actor_type: user
+    description: enables creation of, and tracking of, sent form 4142 documents, from the 526 flow, to the Lighthouse Benefits Intake API
+    enable_in_development: true
+  disability_526_form4142_polling_record_failure_email:
+    actor_type: user
+    description: enables failure email when explicit failure is detected downstream
+    enable_in_development: true
   contention_classification_claim_linker:
     actor_type: user
     description: enables sending 526 claim id and vbms submitted claim id to Contention Classification service for linking/monitoring.

spec/factories/users.rb

@@ -22,7 +22,7 @@
       verified_at { nil }
       sec_id { '123498767' }
       participant_id { Faker::Number.number(digits: 8) }
-      birls_id { Faker::Number.number(digits: 10) }
+      birls_id { Faker::Number.number(digits: 9) }
       icn { '123498767V234859' }
       mhv_icn { nil }
       multifactor { false }

spec/models/form_submission_attempt_spec.rb

@@ -60,6 +60,52 @@
 
           expect(SimpleFormsApi::NotificationEmail).not_to have_received(:new)
         end
+
+        context 'is a form526_form4142 form' do
+          let(:vanotify_client) { instance_double(VaNotify::Service) }
+          let!(:email_klass) { EVSS::DisabilityCompensationForm::Form4142DocumentUploadFailureEmail }
+          let!(:form526_submission) { create(:form526_submission) }
+          let!(:form526_form4142_form_submission) do
+            create(:form_submission, saved_claim_id: form526_submission.saved_claim_id,
+                                     form_type: CentralMail::SubmitForm4142Job::FORM4142_FORMSUBMISSION_TYPE)
+          end
+          let!(:form_submission_attempt) do
+            FormSubmissionAttempt.create(form_submission: form526_form4142_form_submission)
+          end
+
+          it 'sends an 4142 error email when it is not a SimpleFormsApi form and flippers are on' do
+            Flipper.enable(CentralMail::SubmitForm4142Job::POLLING_FLIPPER_KEY)
+            Flipper.enable(CentralMail::SubmitForm4142Job::POLLED_FAILURE_EMAIL)
+
+            allow(VaNotify::Service).to receive(:new).and_return(vanotify_client)
+            allow(vanotify_client).to receive(:send_email).and_return(OpenStruct.new(id: 'some_id'))
+
+            with_settings(Settings.vanotify.services.benefits_disability, { api_key: 'test_service_api_key' }) do
+              expect do
+                form_submission_attempt.fail!
+                email_klass.drain
+              end.to trigger_statsd_increment("#{email_klass::STATSD_METRIC_PREFIX}.success")
+                .and change(Form526JobStatus, :count).by(1)
+
+              job_tracking = Form526JobStatus.last
+              expect(job_tracking.form526_submission_id).to eq(form526_submission.id)
+              expect(job_tracking.job_class).to eq(email_klass.class_name)
+            end
+          end
+
+          it 'does not send an 4142 error email when it is not a SimpleFormsApi form and flippers are off' do
+            Flipper.disable(CentralMail::SubmitForm4142Job::POLLING_FLIPPER_KEY)
+            Flipper.disable(CentralMail::SubmitForm4142Job::POLLED_FAILURE_EMAIL)
+
+            with_settings(Settings.vanotify.services.benefits_disability, { api_key: 'test_service_api_key' }) do
+              expect do
+                form_submission_attempt.fail!
+                email_klass.drain
+              end.to not_trigger_statsd_increment("#{email_klass::STATSD_METRIC_PREFIX}.success")
+                .and not_change(Form526JobStatus, :count)
+            end
+          end
+        end
       end
     end