FFS-2110: Update flow to read/write indexing data to CbvApplicant (#438)

app/app/controllers/api/invitations_controller.rb

@@ -4,14 +4,14 @@ class Api::InvitationsController < ApplicationController
   before_action :authenticate
 
   def create
-    @cbv_flow_invitation = CbvInvitationService.new(event_logger).invite(cbv_flow_invitation_params, @current_user, delivery_method: nil)
+    @cbv_flow_invitation = CbvInvitationService.new(event_logger)
+      .invite(cbv_flow_invitation_params, @current_user, delivery_method: nil)
 
-    if @cbv_flow_invitation.errors.any?
-      return render json: @cbv_flow_invitation.errors, status: :unprocessable_entity
+    errors = @cbv_flow_invitation.errors
+    if errors.any?
+      return render json: errors_to_json(errors), status: :unprocessable_entity
     end
 
-    @cbv_client = CbvClient.create_from_invitation(@cbv_flow_invitation)
-
     render json: {
       url: @cbv_flow_invitation.to_url,
       expiration_date: @cbv_flow_invitation.expires_at,
@@ -21,31 +21,56 @@ def create
 
   # can these be inferred from the model?
   def cbv_flow_invitation_params
+    if (applicant_attributes = params.delete(:agency_partner_metadata))
+      params[:cbv_applicant_attributes] = applicant_attributes.merge(client_agency_id: params[:client_agency_id])
+    end
+    params[:email_address] = @current_user.email
+
     params.permit(
-      :first_name,
-      :middle_name,
       :language,
-      :last_name,
-      :client_id_number,
-      :case_number,
       :email_address,
-      :snap_application_date,
-      :agency_id_number,
-      :beacon_id,
+      :client_agency_id,
       :user_id,
-      :client_agency_id
+      cbv_applicant_attributes: [
+        :first_name,
+        :middle_name,
+        :last_name,
+        :client_agency_id,
+        :client_id_number,
+        :case_number,
+        :snap_application_date,
+        :agency_id_number,
+        :beacon_id
+      ]
     )
   end
 
-  def client_agency_id
-    cbv_flow_invitation_params[:client_agency_id]
-  end
-
   private
 
   def authenticate
     authenticate_or_request_with_http_token do |token, options|
       @current_user = User.find_by_access_token(token)
     end
   end
+
+  def errors_to_json(errors)
+    # Generates a Hash of attribute => error_message and translates the
+    # internal names of objects (cbv_applicant) to the external names
+    # (agency_partner_metadata)
+    errors.map do |error|
+      next if error.attribute == :cbv_applicant
+
+      error_message = error.message
+
+      case error
+      when ActiveModel::NestedError
+        prefix, attribute_name = error.attribute.to_s.split(".")
+        prefix = "agency_partner_metadata" if prefix == "cbv_applicant"
+
+        [ "#{prefix}.#{attribute_name}", error_message ]
+      else
+        [ error.attribute, error_message ]
+      end
+    end.compact.to_h
+  end
 end

app/app/controllers/api/pinwheel_controller.rb

@@ -48,6 +48,7 @@ def user_action
     base_attributes = {
       timestamp: Time.now.to_i,
       cbv_flow_id: @cbv_flow.id,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     }
     event_name = user_action_params[:event_name]
@@ -87,6 +88,7 @@ def token_params
   def track_event
     event_logger.track("ApplicantBeganLinkingEmployer", request, {
       cbv_flow_id: @cbv_flow.id,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id,
       response_type: token_params[:response_type]
     })

app/app/controllers/caseworker/cbv_flow_invitations_controller.rb

@@ -14,23 +14,24 @@ def new
   end
 
   def create
-    invitation_params = base_params.merge(client_agency_specific_params)
     # handle errors from the mail service
     begin
       @cbv_flow_invitation = CbvInvitationService.new(event_logger).invite(
-        invitation_params,
+        invitation_params.deep_merge(client_agency_id: client_agency_id, cbv_applicant_attributes: { client_agency_id: client_agency_id }),
         current_user,
         delivery_method: :email
       )
     rescue => e
       Rails.logger.error("Error inviting applicant: #{e.message}")
       flash[:alert] = t(".invite_failed",
-                        email_address: cbv_flow_invitation_params[:email_address],
+                        email_address: invitation_params[:email_address],
                         error_message: e.message)
       return redirect_to caseworker_dashboard_path(client_agency_id: params[:client_agency_id])
     end
 
     if @cbv_flow_invitation.errors.any?
+      @cbv_flow_invitation.errors.delete(:cbv_applicant)
+
       error_count = @cbv_flow_invitation.errors.size
       error_header = "#{helpers.pluralize(error_count, 'error')} occurred"
 
@@ -44,11 +45,8 @@ def create
       return render :new, status: :unprocessable_entity
     end
 
-    # hydrate the cbv_client with the invitation if there are no cbv_flow_invitation errors
-    @cbv_client = CbvClient.create_from_invitation(@cbv_flow_invitation)
-
     flash[:slim_alert] = {
-      message: t(".invite_success", email_address: cbv_flow_invitation_params[:email_address]),
+      message: t(".invite_success", email_address: invitation_params[:email_address]),
       type: "success"
     }
     redirect_to caseworker_dashboard_path(client_agency_id: params[:client_agency_id])
@@ -69,40 +67,20 @@ def ensure_valid_params!
     end
   end
 
-  def base_params
-    cbv_flow_invitation_params.slice(
-      :first_name,
-      :middle_name,
-      :language,
-      :last_name,
-      :email_address,
-      :snap_application_date,
-    ).merge(client_agency_id: client_agency_id)
-  end
-
-  def client_agency_specific_params
-    case client_agency_id
-    when "ma"
-      cbv_flow_invitation_params.slice(:agency_id_number, :beacon_id)
-    when "nyc"
-      cbv_flow_invitation_params.slice(:client_id_number, :case_number)
-    else
-      {}
-    end
-  end
-
-  def cbv_flow_invitation_params
+  def invitation_params
     params.fetch(:cbv_flow_invitation, {}).permit(
-      :first_name,
-      :middle_name,
       :language,
-      :last_name,
-      :client_id_number,
-      :case_number,
       :email_address,
-      :snap_application_date,
-      :agency_id_number,
-      :beacon_id,
+      cbv_applicant_attributes: [
+        :first_name,
+        :middle_name,
+        :last_name,
+        :client_id_number,
+        :case_number,
+        :snap_application_date,
+        :agency_id_number,
+        :beacon_id
+      ]
     )
   end
 

app/app/controllers/cbv/base_controller.rb

@@ -47,7 +47,7 @@ def ensure_cbv_flow_not_yet_complete
   def current_agency
     return unless @cbv_flow.present? && @cbv_flow.client_agency_id.present?
 
-    @current_site ||= agency_config[@cbv_flow.client_agency_id]
+    @current_agency ||= agency_config[@cbv_flow.client_agency_id]
   end
 
   def next_path
@@ -110,6 +110,7 @@ def track_timeout_event
   def track_expired_event(invitation)
     event_logger.track("ApplicantLinkExpired", request, {
       invitation_id: invitation.id,
+      cbv_applicant_id: invitation.cbv_applicant_id,
       timestamp: Time.now.to_i
     })
   rescue => ex
@@ -121,6 +122,7 @@ def track_invitation_clicked_event(invitation, cbv_flow)
       timestamp: Time.now.to_i,
       invitation_id: invitation.id,
       cbv_flow_id: cbv_flow.id,
+      cbv_applicant_id: cbv_flow.cbv_applicant_id,
       client_agency_id: cbv_flow.client_agency_id,
       seconds_since_invitation: (Time.now - invitation.created_at).to_i
     })

app/app/controllers/cbv/employer_searches_controller.rb

@@ -31,6 +31,7 @@ def search_params
   def track_clicked_popular_payroll_providers_event
     event_logger.track("ApplicantClickedPopularPayrollProviders", request, {
       timestamp: Time.now.to_i,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     })
@@ -41,6 +42,7 @@ def track_clicked_popular_payroll_providers_event
   def track_clicked_popular_app_employers_event
     event_logger.track("ApplicantClickedPopularAppEmployers", request, {
       timestamp: Time.now.to_i,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     })
@@ -53,6 +55,7 @@ def track_accessed_search_event
 
     event_logger.track("ApplicantAccessedSearchPage", request, {
       timestamp: Time.now.to_i,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     })
@@ -65,6 +68,7 @@ def track_applicant_searched_event
 
     event_logger.track("ApplicantSearchedForEmployer", request, {
       timestamp: Time.now.to_i,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id,
       num_results: @employers.length,

app/app/controllers/cbv/entries_controller.rb

@@ -3,6 +3,7 @@ def show
     event_logger.track("ApplicantViewedAgreement", request, {
       timestamp: Time.now.to_i,
       client_agency_id: @cbv_flow.client_agency_id,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     })
@@ -13,6 +14,7 @@ def create
       event_logger.track("ApplicantAgreed", request, {
         timestamp: Time.now.to_i,
         client_agency_id: @cbv_flow.client_agency_id,
+        cbv_applicant_id: @cbv_flow.cbv_applicant_id,
         cbv_flow_id: @cbv_flow.id,
         invitation_id: @cbv_flow.cbv_flow_invitation_id
       })

app/app/controllers/cbv/missing_results_controller.rb

@@ -8,6 +8,7 @@ def show
   def track_missing_results_event
     event_logger.track("ApplicantAccessedMissingResultsPage", request, {
       timestamp: Time.now.to_i,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     })

app/app/controllers/cbv/payment_details_controller.rb

@@ -126,6 +126,7 @@ def track_viewed_event
     return if @pinwheel_account.nil?
 
     event_logger.track("ApplicantViewedPaymentDetails", request, {
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id,
       pinwheel_account_id: @pinwheel_account.id,
@@ -142,6 +143,7 @@ def track_saved_event
     comment_data = @cbv_flow.additional_information[params[:user][:account_id]]
 
     event_logger.track("ApplicantSavedPaymentDetails", request, {
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id,
       additional_information_length: comment_data ? comment_data["comment"].length : 0

app/app/controllers/cbv/successes_controller.rb

@@ -8,6 +8,7 @@ def show
   def track_accessed_success_event
     event_logger.track("ApplicantAccessedSuccessPage", request, {
       timestamp: Time.now.to_i,
+      cbv_applicant_id: @cbv_flow.cbv_applicant_id,
       cbv_flow_id: @cbv_flow.id,
       invitation_id: @cbv_flow.cbv_flow_invitation_id
     })

app/app/controllers/cbv/summaries_controller.rb

@@ -24,6 +24,7 @@ def show
         event_logger.track("ApplicantDownloadedIncomePDF", request, {
           timestamp: Time.now.to_i,
           client_agency_id: @cbv_flow.client_agency_id,
+          cbv_applicant_id: @cbv_flow.cbv_applicant_id,
           cbv_flow_id: @cbv_flow.id,
           invitation_id: @cbv_flow.cbv_flow_invitation_id,
           locale: I18n.locale
@@ -101,7 +102,7 @@ def transmit_to_caseworker
       time_now = Time.now
       beginning_date = (Date.parse(@payments_beginning_at).strftime("%b") rescue @payments_beginning_at)
       ending_date = (Date.parse(@payments_ending_at).strftime("%b%Y") rescue @payments_ending_at)
-      @file_name = "IncomeReport_#{@cbv_flow.cbv_flow_invitation.agency_id_number}_" \
+      @file_name = "IncomeReport_#{@cbv_flow.cbv_applicant.agency_id_number}_" \
         "#{beginning_date}-#{ending_date}_" \
         "Conf#{@cbv_flow.confirmation_code}_" \
         "#{time_now.strftime('%Y%m%d%H%M%S')}"
@@ -166,16 +167,16 @@ def generate_csv
     pinwheel_account = PinwheelAccount.find_by(cbv_flow_id: @cbv_flow.id)
 
     data = {
-      client_id: @cbv_flow.cbv_flow_invitation.agency_id_number,
-      first_name: @cbv_flow.cbv_flow_invitation.first_name,
-      last_name: @cbv_flow.cbv_flow_invitation.last_name,
-      middle_name: @cbv_flow.cbv_flow_invitation.middle_name,
+      client_id: @cbv_flow.cbv_applicant.agency_id_number,
+      first_name: @cbv_flow.cbv_applicant.first_name,
+      last_name: @cbv_flow.cbv_applicant.last_name,
+      middle_name: @cbv_flow.cbv_applicant.middle_name,
       client_email_address: @cbv_flow.cbv_flow_invitation.email_address,
-      beacon_userid: @cbv_flow.cbv_flow_invitation.beacon_id,
-      app_date: @cbv_flow.cbv_flow_invitation.snap_application_date.strftime("%m/%d/%Y"),
+      beacon_userid: @cbv_flow.cbv_applicant.beacon_id,
+      app_date: @cbv_flow.cbv_applicant.snap_application_date.strftime("%m/%d/%Y"),
       report_date_created: pinwheel_account.created_at.strftime("%m/%d/%Y"),
-      report_date_start: @cbv_flow.cbv_flow_invitation.paystubs_query_begins_at.strftime("%m/%d/%Y"),
-      report_date_end: @cbv_flow.cbv_flow_invitation.snap_application_date.strftime("%m/%d/%Y"),
+      report_date_start: @cbv_flow.cbv_applicant.paystubs_query_begins_at.strftime("%m/%d/%Y"),
+      report_date_end: @cbv_flow.cbv_applicant.snap_application_date.strftime("%m/%d/%Y"),
       confirmation_code: @cbv_flow.confirmation_code,
       consent_timestamp: @cbv_flow.consented_to_authorized_use_at.strftime("%m/%d/%Y %H:%M:%S"),
       pdf_filename: "#{@file_name}.pdf",
@@ -191,6 +192,7 @@ def track_transmitted_event(cbv_flow, payments)
     event_logger.track("ApplicantSharedIncomeSummary", request, {
       timestamp: Time.now.to_i,
       client_agency_id: cbv_flow.client_agency_id,
+      cbv_applicant_id: cbv_flow.cbv_applicant_id,
       cbv_flow_id: cbv_flow.id,
       invitation_id: cbv_flow.cbv_flow_invitation_id,
       account_count: cbv_flow.pinwheel_accounts.count,
@@ -209,6 +211,7 @@ def track_accessed_income_summary_event(cbv_flow, payments)
       timestamp: Time.now.to_i,
       client_agency_id: cbv_flow.client_agency_id,
       cbv_flow_id: cbv_flow.id,
+      cbv_applicant_id: cbv_flow.cbv_applicant_id,
       invitation_id: cbv_flow.cbv_flow_invitation_id,
       account_count: cbv_flow.pinwheel_accounts.count,
       paystub_count: payments.count,

app/app/controllers/help_controller.rb

@@ -12,16 +12,19 @@ def show
 
     cbv_flow = session[:cbv_flow_id] ? CbvFlow.find_by(id: session[:cbv_flow_id]) : nil
 
-    event_logger.track("ApplicantViewedHelpTopic", request, {
-      topic: @help_topic,
-      cbv_flow_id: session[:cbv_flow_id],
-      invitation_id: cbv_flow&.cbv_flow_invitation_id,
-      client_agency_id: current_agency&.id,
-      flow_started_seconds_ago: cbv_flow ? (Time.now - cbv_flow.created_at).to_i : nil,
-      language: I18n.locale
-    }.compact)
-  rescue => ex
-    Rails.logger.error "Unable to track event (ApplicantViewedHelpTopic): #{ex}"
+    begin
+      event_logger.track("ApplicantViewedHelpTopic", request, {
+        topic: @help_topic,
+        cbv_applicant_id: cbv_flow&.cbv_applicant_id,
+        cbv_flow_id: session[:cbv_flow_id],
+        invitation_id: cbv_flow&.cbv_flow_invitation_id,
+        client_agency_id: current_agency&.id,
+        flow_started_seconds_ago: cbv_flow ? (Time.now - cbv_flow.created_at).to_i : nil,
+        language: I18n.locale
+      })
+    rescue => ex
+      Rails.logger.error "Unable to track event (ApplicantViewedHelpTopic): #{ex}"
+    end
   end
 
   private