LG-7185: Send email reminders for in-person proofing enrollments

app/jobs/in_person/email_reminder_job.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module InPerson
+  class EmailReminderJob < ApplicationJob
+    EMAIL_TYPE_EARLY = 'early'
+    EMAIL_TYPE_LATE = 'late'
+
+    queue_as :low
+
+    include GoodJob::ActiveJobExtensions::Concurrency
+
+    good_job_control_concurrency_with(
+      total_limit: 1,
+      key: 'in_person_email_reminder_job',
+    )
+
+    discard_on GoodJob::ActiveJobExtensions::Concurrency::ConcurrencyExceededError
+
+    def perform(_now)
+      return true unless IdentityConfig.store.in_person_proofing_enabled
+
+      # send late emails first in case of job failure
+      late_enrollments = InPersonEnrollment.needs_late_email_reminder(
+        late_benchmark,
+        final_benchmark,
+      )
+      send_emails_for_enrollments(enrollments: late_enrollments, email_type: EMAIL_TYPE_LATE)
+
+      early_enrollments = InPersonEnrollment.needs_early_email_reminder(
+        early_benchmark,
+        late_benchmark,
+      )
+      send_emails_for_enrollments(enrollments: early_enrollments, email_type: EMAIL_TYPE_EARLY)
+    end
+
+    private
+
+    def analytics(user: AnonymousUser.new)
+      Analytics.new(user: user, request: nil, session: {}, sp: nil)
+    end
+
+    def send_emails_for_enrollments(enrollments:, email_type:)
+      enrollments.each do |enrollment|
+        send_reminder_email(enrollment.user, enrollment)
+      rescue StandardError => err
+        NewRelic::Agent.notice_error(err)
+        analytics(user: enrollment.user).idv_in_person_email_reminder_job_exception(
+          enrollment_id: enrollment.id,
+          exception_class: err.class.to_s,
+          exception_message: err.message,
+        )
+      else
+        analytics(user: enrollment.user).idv_in_person_email_reminder_job_email_initiated(
+          email_type: email_type,
+          enrollment_id: enrollment.id,
+        )
+        if email_type == EMAIL_TYPE_EARLY
+          enrollment.update!(early_reminder_sent: true)
+        elsif email_type == EMAIL_TYPE_LATE
+          enrollment.update!(late_reminder_sent: true)
+        end
+      end
+    end
+
+    def calculate_interval(benchmark)
+      days_until_expired = IdentityConfig.store.in_person_enrollment_validity_in_days.days
+      (Time.zone.now - days_until_expired) + benchmark.days
+    end
+
+    def early_benchmark
+      calculate_interval(IdentityConfig.store.in_person_email_reminder_early_benchmark_in_days)
+    end
+
+    def late_benchmark
+      calculate_interval(IdentityConfig.store.in_person_email_reminder_late_benchmark_in_days)
+    end
+
+    def final_benchmark
+      calculate_interval(IdentityConfig.store.in_person_email_reminder_final_benchmark_in_days)
+    end
+
+    def send_reminder_email(user, enrollment)
+      user.confirmed_email_addresses.each do |email_address|
+        # rubocop:disable IdentityIdp/MailLaterLinter
+        UserMailer.with(
+          user: user,
+          email_address: email_address,
+        ).in_person_ready_to_verify_reminder(
+          enrollment: enrollment,
+        ).deliver_later
+        # rubocop:enable IdentityIdp/MailLaterLinter
+      end
+    end
+  end
+end

app/mailers/user_mailer.rb

@@ -295,13 +295,13 @@ def in_person_ready_to_verify_reminder(enrollment:)
       )
       @header = t(
         'user_mailer.in_person_ready_to_verify_reminder.heading',
-        days_remaining: @presenter.days_remaining,
+        count: @presenter.days_remaining,
       )
       mail(
         to: email_address.email,
         subject: t(
           'user_mailer.in_person_ready_to_verify_reminder.subject',
-          days_remaining: @presenter.days_remaining,
+          count: @presenter.days_remaining,
         ),
       )
     end

app/models/in_person_enrollment.rb

@@ -22,6 +22,28 @@ class InPersonEnrollment < ApplicationRecord
   before_save(:on_status_updated, if: :will_save_change_to_status?)
   before_create(:set_unique_id, unless: :unique_id)
 
+  def self.is_pending_and_established_between(early_benchmark, late_benchmark)
+    where(status: :pending).
+      and(
+        where(enrollment_established_at: late_benchmark...(early_benchmark.end_of_day)),
+      ).
+      order(enrollment_established_at: :asc)
+  end
+
+  def self.needs_early_email_reminder(early_benchmark, late_benchmark)
+    self.is_pending_and_established_between(
+      early_benchmark,
+      late_benchmark,
+    ).where(early_reminder_sent: false)
+  end
+
+  def self.needs_late_email_reminder(early_benchmark, late_benchmark)
+    self.is_pending_and_established_between(
+      early_benchmark,
+      late_benchmark,
+    ).where(late_reminder_sent: false)
+  end
+
   # Find enrollments that need a status check via the USPS API
   def self.needs_usps_status_check(check_interval)
     where(status: :pending).

app/presenters/idv/in_person/ready_to_verify_presenter.rb

@@ -39,7 +39,7 @@ def service_provider
       end
 
       def sp_name
-        service_provider ? service_provider.friendly_name : ''
+        service_provider ? service_provider.friendly_name : APP_NAME
       end
 
       private

app/services/analytics_events.rb

@@ -3094,6 +3094,25 @@ def idv_in_person_usps_proofing_results_job_exception(
     )
   end
 
+  # Tracks exceptions that are raised when running InPerson::EmailReminderJob
+  # @param [String] enrollment_id
+  # @param [String] exception_class
+  # @param [String] exception_message
+  def idv_in_person_email_reminder_job_exception(
+    enrollment_id:,
+    exception_class: nil,
+    exception_message: nil,
+    **extra
+  )
+    track_event(
+      'InPerson::EmailReminderJob: Exception raised when attempting to send reminder email',
+      enrollment_id: enrollment_id,
+      exception_class: exception_class,
+      exception_message: exception_message,
+      **extra,
+    )
+  end
+
   # Tracks individual enrollments that are updated during GetUspsProofingResultsJob
   # @param [String] enrollment_code
   # @param [String] enrollment_id
@@ -3132,6 +3151,22 @@ def idv_in_person_usps_proofing_results_job_email_initiated(
     )
   end
 
+  # Tracks emails that are initiated during InPerson::EmailReminderJob
+  # @param [String] email_type early or late
+  # @param [String] enrollment_id
+  def idv_in_person_email_reminder_job_email_initiated(
+    email_type:,
+    enrollment_id:,
+    **extra
+  )
+    track_event(
+      'InPerson::EmailReminderJob: Reminder email initiated',
+      email_type: email_type,
+      enrollment_id: enrollment_id,
+      **extra,
+    )
+  end
+
   # Tracks users visiting the recovery options page
   def account_reset_recovery_options_visit
     track_event('Account Reset: Recovery Options Visited')

config/application.yml.default

@@ -120,6 +120,9 @@ idv_send_link_attempt_window_in_minutes: 10
 idv_send_link_max_attempts: 5
 ie11_support_end_date: '2022-12-31'
 idv_sp_required: false
+in_person_email_reminder_early_benchmark_in_days: 11
+in_person_email_reminder_final_benchmark_in_days: 1
+in_person_email_reminder_late_benchmark_in_days: 4
 in_person_proofing_enabled: false
 in_person_enrollment_validity_in_days: 30
 in_person_results_delay_in_hours: 1

config/initializers/job_configurations.rb

@@ -110,6 +110,12 @@
         cron: IdentityConfig.store.get_usps_proofing_results_job_cron,
         args: -> { [Time.zone.now] },
       },
+      # Queue daily in-person proofing reminder email job
+      email_reminder_job: {
+        class: 'InPerson::EmailReminderJob',
+        cron: cron_24h,
+        args: -> { [Time.zone.today] },
+      },
       # Periodically verify signature on ThreatMetrix javascript
       verify_threat_metrix_js: {
         class: 'ThreatMetrixJsVerificationJob',

config/locales/user_mailer/en.yml

@@ -138,10 +138,14 @@ en:
       subject: You’re ready to verify your identity with %{app_name} in person
     in_person_ready_to_verify_reminder:
       greeting: Hello,
-      heading: You have %{days_remaining} days left to verify your identity in person
+      heading:
+        one: You have %{count} day left to verify your identity in person
+        other: You have %{count} days left to verify your identity in person
       intro: Don’t miss the chance to verify your identity at your local Post Office.
         Complete this step to access %{sp_name}.
-      subject: Verify your identity at a Post Office in the next %{days_remaining} days
+      subject:
+        one: Verify your identity at a Post Office in the next day
+        other: Verify your identity at a Post Office in the next %{count} days
     in_person_verified:
       greeting: Hello,
       intro: You successfully verified your identity at the %{location} Post Office on

config/locales/user_mailer/es.yml

@@ -146,11 +146,15 @@ es:
       subject: Está listo para verificar su identidad con %{app_name} en persona
     in_person_ready_to_verify_reminder:
       greeting: Hola,
-      heading: Tiene %{days_remaining} días para verificar su identidad en persona
+      heading:
+        one: Tiene %{count} día para verificar su identidad en persona
+        other: Tiene %{count} días para verificar su identidad en persona
       intro: No pierda la oportunidad de verificar su identidad en su oficina de
         correos local. Complete este paso para acceder %{sp_name}.
-      subject: Verifique su identidad en una oficina de correos en los próximos
-        %{days_remaining} días
+      subject:
+        one: Verifique su identidad en una oficina de correos en el próximo día
+        other: Verifique su identidad en una oficina de correos en los próximos %{count}
+          días
     in_person_verified:
       greeting: Hola,
       intro: El %{date}, verificó correctamente su identidad en la oficina de correos

config/locales/user_mailer/fr.yml

@@ -149,12 +149,15 @@ fr:
       subject: Vous êtes prêt à vérifier votre identité avec %{app_name} en personne
     in_person_ready_to_verify_reminder:
       greeting: Bonjour,
-      heading: Il vous reste %{days_remaining} jours pour vérifier votre identité en
-        personne
+      heading:
+        one: Il vous reste %{count} jour pour vérifier votre identité en personne
+        other: Il vous reste %{count} jours pour vérifier votre identité en personne
       intro: Ne manquez pas l’occasion de vérifier votre identité dans votre bureau de
         poste de proximité. Complétez cette étape pour accéder à %{sp_name}.
-      subject: Vérifiez votre identité auprès d’un bureau de poste dans les
-        %{days_remaining} prochains jours.
+      subject:
+        one: Vérifiez votre identité auprès d’un bureau de poste dans le prochain jour
+        other: Vérifiez votre identité auprès d’un bureau de poste dans les %{count}
+          prochains jours
     in_person_verified:
       greeting: Bonjour,
       intro: Vous avez vérifié avec succès votre identité au bureau de poste de

db/primary_migrate/20221031203041_add_early_reminder_sent_and_late_reminder_sent_to_in_person_enrollments.rb

@@ -0,0 +1,6 @@
+class AddEarlyReminderSentAndLateReminderSentToInPersonEnrollments < ActiveRecord::Migration[7.0]
+  def change
+    add_column :in_person_enrollments, :early_reminder_sent, :boolean, default: false, comment: "early reminder to complete IPP before deadline sent"
+    add_column :in_person_enrollments, :late_reminder_sent, :boolean, default: false, comment: "late reminder to complete IPP before deadline sent"
+  end
+end

db/schema.rb

@@ -295,6 +295,8 @@
     t.datetime "enrollment_established_at", comment: "When the enrollment was successfully established"
     t.string "issuer", comment: "Issuer associated with the enrollment at time of creation"
     t.boolean "follow_up_survey_sent", default: false
+    t.boolean "early_reminder_sent", default: false, comment: "early reminder to complete IPP before deadline sent"
+    t.boolean "late_reminder_sent", default: false, comment: "late reminder to complete IPP before deadline sent"
     t.index ["profile_id"], name: "index_in_person_enrollments_on_profile_id"
     t.index ["unique_id"], name: "index_in_person_enrollments_on_unique_id", unique: true
     t.index ["user_id", "status"], name: "index_in_person_enrollments_on_user_id_and_status", unique: true, where: "(status = 1)"

lib/identity_config.rb

@@ -199,6 +199,9 @@ def self.build_store(config_map)
     config.add(:idv_send_link_max_attempts, type: :integer)
     config.add(:idv_sp_required, type: :boolean)
     config.add(:ie11_support_end_date, type: :timestamp)
+    config.add(:in_person_email_reminder_early_benchmark_in_days, type: :integer)
+    config.add(:in_person_email_reminder_final_benchmark_in_days, type: :integer)
+    config.add(:in_person_email_reminder_late_benchmark_in_days, type: :integer)
     config.add(:in_person_proofing_enabled, type: :boolean)
     config.add(:in_person_enrollment_validity_in_days, type: :integer)
     config.add(:in_person_results_delay_in_hours, type: :integer)