LG-15166: Store doc auth vendor in Idv::Session #11742

lmgeorge · 2025-01-13T22:00:31Z

🎫 Ticket

Link to the relevant ticket:
LG-15166

🛠 Summary of changes

Why

Currently, we compute the vendor for remote document verification
using DocAuthRouter, which requires downstream business logic to
depend on context that may or may not be available. In order to
eliminate calls to DocAuthRouter in places like Idv::ProofingComponents,
we first need to start storing the vendor directly in Idv::Session.

How

Add a new key doc_auth_vendor to Idv::Session.
Set the new key after successful document capture. If the user opted
for in person proofing, it will be usps (managed directly in Idv::InPerson::StateIdController), otherwise we use the
existing Idv::DocAuthVendorConcern#doc_auth_vendor method.
Clear Idv::Session#doc_auth_vendor if the following steps are undone: link_sent,
document_capture, and socure_document_capture, and ipp_state_id.

Additional notes

The doc_auth_vendor key is only being written to and not read in this PR. (LG-15168: Update ProofingComponents to only require Idv::Session will add code that reads this key from the session.

matthinz · 2025-01-14T00:16:27Z

spec/controllers/idv/socure/document_capture_controller_spec.rb

@@ -355,6 +355,7 @@
    end

    it 'returns FOUND (302) and redirects to SSN' do
+      expect(subject.idv_session.doc_auth_vendor).to_not be_nil


Can you add similar checks to idv/document_capture_controller_spec.rb and idv/link_sent_controller_spec.rb?

Hmmm, I didn't include this check in the other specs since I thought the behavior was sufficiently covered in spec/policies/idv/flow_policy_spec.rb. Thoughts?

I think the flow policy spec updates do a good job of verifying that other steps don't mess with this value inappropriately. But I think what we want to test here is "after the user does the thing that we expect will set doc_auth_vendor, it is actually set".

extract_pii_from_doc is in the DocumentCaptureConcern, so you could add a test for that method, but I think that it makes sense to add a small assertion to each of the three paths (doc capture, link sent, and verify info for IPP) that the doc auth vendor is set as expected.

Got it, should be fairly straightforward to add those checks.

matthinz · 2025-01-14T00:16:49Z

app/controllers/concerns/idv/document_capture_concern.rb

@@ -39,6 +39,7 @@ def error_hash(message)
    def extract_pii_from_doc(user, store_in_session: false)
      if defined?(idv_session) # hybrid mobile does not have idv_session


I definitely forgot about the hybrid flow, but I think this will work, since LinkSentController includes DocumentCaptureConcern and calls extract_pii_from_doc. However, I think we should have spec coverage for that.

Good point. Working on that now.

Added! (diff)

matthinz · 2025-01-14T00:20:55Z

app/services/idv/session.rb

@@ -20,7 +21,7 @@ module Idv
  # @attr phone_for_mobile_flow [String, nil]
  # @attr previous_phone_step_params [Array]
  # @attr previous_ssn [String, nil]
-  # @attr profile_id [String, nil]
+  # @attr profile_id [Integer, nil]


matthinz · 2025-01-14T00:21:22Z

app/services/idv/session.rb

@@ -76,6 +77,7 @@ class Session
      skip_doc_auth_from_how_to_verify
      skip_hybrid_handoff
      socure_docv_wait_polling_started_at
+      source_check_vendor


HELLO FELLOW ALPHABETIZER

matthinz · 2025-01-14T00:28:31Z

app/controllers/concerns/idv/document_capture_concern.rb

@@ -58,6 +59,14 @@ def selfie_requirement_met?
        stored_result.selfie_check_performed?
    end

+    def resolve_doc_auth_vendor(user)
+      if user.establishing_in_person_enrollment || user.pending_in_person_enrollment
+        Idp::Constants::Vendors::USPS


I think there are some edge cases that this will get mixed up on:

User starts IPP, backs out, and goes down the remote doc auth path

User starts IPP, abandons, then starts a new verification, selecting remote this time

In this case, we know the user has not chosen IPP for doc auth, so I don't think we should write it here. We likely want to set this to 'usps' somewhere else later on--perhaps on submission of the "Verify your info" screen?

That's a good point and I hadn't thought about that.

Instead of doing this, converted to updating in Idv::InPerson::StateIdController#update. (Figuring this out was a bit of pain since it's a "hidden" step.)

Adds a new key, `doc_auth_vendor`, to Idv::Session. This is part 1 to eliminate issues with 50/50 state handling. [skip changelog]

**Why** * Currently, we compute the vendor for remote document verification using DocAuthRouter, which requires downstream business logic to depend on context that may or may not be available. In order to eliminate calls to DocAuthRouter in places like Idv::ProofingComponents, we first need to start storing the vendor directly in Idv::Session. **How** * Add a new key `doc_auth_vendor` to Idv::Session. * Set the new key after successful document capture. If the user opted for in person proofing, it will be `usps`, otherwise we use the existing `Idv::DocumentCaptureConcern#doc_auth_vendor` method. * Clear `doc_auth_vendor` if the following steps are undone: link_sent, document_capture, and socure_document_capture. changelog: Internal, IdV flow, Simplify creation of Idv::ProofingComponents

…oller

n1zyy

I don't think I have all of the historical context here that other reviewers do, so I wouldn't mind making sure they are onboard first, but having reviewed this it looks good to me. One small question where I think I'm just missing context.

n1zyy · 2025-01-15T20:35:58Z

app/services/doc_auth/socure/responses/docv_result_response.rb

@@ -81,7 +81,7 @@ def extra_attributes
            liveness_checking_required: @biometric_comparison_required,
            issue_year: state_id_issued&.year,
            doc_auth_success: successful_result?,
-            vendor: 'Socure',
+            vendor: 'Socure', # TODO: Replace with Idp::Constants::Vendors::SOCURE


Can we not do this today due to the case difference?

Yeah. If there are any queries that match on the case exactly then they would break. I'll write a ticket to follow up on this.

n1zyy · 2025-01-15T20:41:38Z

spec/controllers/idv/document_capture_controller_spec.rb

@@ -188,13 +193,7 @@

    context 'socure is the default vendor but facial match is required' do
      let(:idv_vendor) { Idp::Constants::Vendors::SOCURE }
-      let(:vot) { 'Pb' }


Off-topic, but I read this as the chemical substance for Lead 100% of the time, so good riddance to it.

lmgeorge requested review from n1zyy and a team January 13, 2025 22:00

lmgeorge marked this pull request as ready for review January 13, 2025 23:08

matthinz reviewed Jan 14, 2025

View reviewed changes

lmgeorge requested a review from a team January 15, 2025 17:22

lmgeorge added 7 commits January 15, 2025 12:24

LG-15166: Add new key to Idv::Session

ebcb031

Adds a new key, `doc_auth_vendor`, to Idv::Session. This is part 1 to eliminate issues with 50/50 state handling. [skip changelog]

sorted the attributes and doc strings

28f0782

Add minimal specs

312a759

For IPP, update idv_session.doc_auth_vendor in InPerson::StateIdContr…

2ca526d

…oller

PR feedback: capture edge cases and expand coverage

4ef3cb7

Layout fixes, updating some language, and removing old cruft

dc210ce

lmgeorge force-pushed the lmgeorge/LG-15166 branch from 8e42632 to dc210ce Compare January 15, 2025 17:36

n1zyy approved these changes Jan 15, 2025

View reviewed changes

matthinz approved these changes Jan 16, 2025

View reviewed changes

lmgeorge merged commit e149549 into main Jan 17, 2025
2 checks passed

lmgeorge deleted the lmgeorge/LG-15166 branch January 17, 2025 17:29

jmdembe mentioned this pull request Jan 21, 2025

Deploy RC 445 to Production #11778

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LG-15166: Store doc auth vendor in Idv::Session #11742

LG-15166: Store doc auth vendor in Idv::Session #11742

lmgeorge commented Jan 13, 2025 •

edited

Loading

matthinz Jan 14, 2025

lmgeorge Jan 14, 2025

matthinz Jan 14, 2025

lmgeorge Jan 14, 2025

lmgeorge Jan 15, 2025

matthinz Jan 14, 2025

lmgeorge Jan 14, 2025

lmgeorge Jan 14, 2025

matthinz Jan 14, 2025

matthinz Jan 14, 2025

matthinz Jan 14, 2025

lmgeorge Jan 14, 2025

lmgeorge Jan 14, 2025

n1zyy left a comment

n1zyy Jan 15, 2025

lmgeorge Jan 17, 2025

n1zyy Jan 15, 2025

		@@ -39,6 +39,7 @@ def error_hash(message)
		def extract_pii_from_doc(user, store_in_session: false)
		if defined?(idv_session) # hybrid mobile does not have idv_session

LG-15166: Store doc auth vendor in Idv::Session #11742

LG-15166: Store doc auth vendor in Idv::Session #11742

Conversation

lmgeorge commented Jan 13, 2025 • edited Loading

🎫 Ticket

🛠 Summary of changes

Additional notes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

n1zyy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lmgeorge commented Jan 13, 2025 •

edited

Loading