LG-14010 - More detailed error page for Socure errors by jmax-gsa · Pull Request #11560 · 18F/identity-idp

jmax-gsa · 2024-11-26T15:29:39Z

Added plumbing and UX display for categorized Socure errors.

changelog Upcoming Features, Socure, Added nice error displays

🎫 Ticket

Link to the relevant ticket:
LG-14010

🛠 Summary of changes

Passed the Socure errors through from the original DocV response back through the document capture result, then added a presenter and updated error page to display it all nicely.

📜 Testing Plan

This test procedure requires a sandbox set up to use Socure. See jmax
or Doug to coordinate use of one.

SSM into the sandbox and modify the file
/srv/idp/current/app/services/doc_auth/socure/responses/docv_result_response.rb. Insert
the following lines after line 36:

    # KLUDGE
    parsed_body['documentVerification']['decision']['value'] = 'reject'
    parsed_body['documentVerification']['reasonCodes'] = ['I848']

Exit the SSM sesion and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 1 error page.
Cancel out of IdV and return to your account page.
SSM into the sandbox and modify the above file once again. Change the error code from 'I848' to 'I849'.
Exit the SSM session and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 2 error page.
Cancel out of IdV and return to your account page.
SSM into the sandbox and modify the above file once again. Change the error code from 'I849' to 'R827'.
Exit the SSM session and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 3 error page.
Cancel out of IdV and return to your account page.
SSM into the sandbox and modify the above file once again. Change the error code from 'R827' to 'I808'.
Exit the SSM session and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 4 error page.
Cancel out of IdV and return to your account page.
SSM into the sandbox and modify the above file once again. Change the error code from 'I808' to 'R845'.
Exit the SSM session and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 5 error page.
Cancel out of IdV and return to your account page.
SSM into the sandbox and modify the above file once again. Change the error code from 'R845' to 'I856'.
Exit the SSM session and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 6 error page.
Cancel out of IdV and return to your account page.
SSM into the sandbox and modify the above file once again. This
time, remove the error code line completely and replace it with
raise "Some error"
Exit the SSM session and reboot Puma
Connect to the IDP, create an account, and begin IdV. Verify that
you end up on the Category 7 error page.
Cancel out of IdV, return to your account page, and log out.

👀 Screenshots

If relevant, include a screenshot or screen capture of the changes.

Category 1 error page

Category 2 error page

Category 3 error page

Category 4 error page

Category 5 error page

Category 6 errpr page

Category 7 error page

amirbey · 2024-11-27T20:28:21Z

app/controllers/concerns/idv/document_capture_concern.rb

    end

+    def make_error_hash(message)
+      Rails.logger.info("make_error_hash: stored_result: #{stored_result.inspect}")


are we intending to log this?

amirbey · 2024-11-27T20:40:12Z

app/controllers/concerns/idv/document_capture_concern.rb

-    def failure(message, extra = nil)
-      flash[:error] = message
-      form_response_params = { success: false, errors: { message: message } }
+    def failure(message = nil, extra = nil)


it appear that failure is only called once passing message as nil. i understand this is following the pattern for defining the failure method throughout the application; however, could it be worth eliminating this failure method definition and instead of calling it use the below

FormResponse.new(
{
success: false,
errors: make_error_hash(message),
extra: extra}
}.compact
)

amirbey · 2024-11-27T20:49:47Z

app/controllers/concerns/idv/document_capture_concern.rb

+      error_hash = { message: message || I18n.t('doc_auth.errors.general.network_error') }
+
+      if stored_result&.errors&.has_key?(:socure)
+        error_hash[:socure] = stored_result.errors[:socure]
+      end
+
+      error_hash


Suggested change

error_hash = { message: message || I18n.t('doc_auth.errors.general.network_error') }

if stored_result&.errors&.has_key?(:socure)

error_hash[:socure] = stored_result.errors[:socure]

end

error_hash

{

message: message || I18n.t('doc_auth.errors.general.network_error'),

socure: stored_result&.errors&.dig(:socure)

}.compact

this seems simpler to me, just a suggestion

amirbey · 2024-11-27T21:11:19Z

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


        def initialize(http_response:, biometric_comparison_required: false)
          @http_response = http_response
+


Suggested change

amirbey · 2024-11-27T21:14:59Z

app/views/idv/shared/_error.html.erb

+   else
+     icon_name = :warning
+   end
+
+   troubleshooting_heading = local_assigns.fetch(:troubleshooting_heading) do
+     if local_assigns.fetch(:type, :error) == :error
+       troubleshooting_heading = t('idv.troubleshooting.headings.need_assistance')
+     else
+       troubleshooting_heading = t('components.troubleshooting_options.default_heading')
+     end
+   end
+ %>


is there a reason to change this and add new lines? 🤔

amirbey · 2024-11-27T21:20:20Z

app/controllers/concerns/idv/socure_errors_concern.rb

+      @presenter = socure_errors_presenter(handle_stored_result)
+    end
+
+    def goto_in_person


having the controller action inside of the concern feels a bit buried 🤔 i didn't realize this was a controller action until I saw the routes file 😬

verify_info_controller#update has a pattern worth considering

amirbey · 2024-11-27T21:22:47Z

app/controllers/concerns/idv/document_capture_concern.rb

      FormResponse.new(**form_response_params)
    end

+    def make_error_hash(message)


Suggested change

def make_error_hash(message)

def error_hash(message)

amirbey · 2024-11-27T21:26:25Z

app/presenters/socure_error_presenter.rb

+    if remapped_error(error_code) == 'underage' # special handling because it says 'Login.gov'
+      I18n.t('doc_auth.errors.underage', app_name: APP_NAME)
+    else
+      # i18n-tasks-use t('doc_auth.errors.unreadable_id')
+      # i18n-tasks-use t('doc_auth.errors.unaccepted_id_type')
+      # i18n-tasks-use t('doc_auth.errors.expired_id')
+      # i18n-tasks-use t('doc_auth.errors.low_resolution')
+      # i18n-tasks-use t('doc_auth.errors.id_not_found')
+      I18n.t("doc_auth.errors.#{remapped_error(error_code)}")
+    end


Suggested change

if remapped_error(error_code) == 'underage' # special handling because it says 'Login.gov'

I18n.t('doc_auth.errors.underage', app_name: APP_NAME)

else

# i18n-tasks-use t('doc_auth.errors.unreadable_id')

# i18n-tasks-use t('doc_auth.errors.unaccepted_id_type')

# i18n-tasks-use t('doc_auth.errors.expired_id')

# i18n-tasks-use t('doc_auth.errors.low_resolution')

# i18n-tasks-use t('doc_auth.errors.id_not_found')

I18n.t("doc_auth.errors.#{remapped_error(error_code)}")

end

remapped_error_code = remapped_error(error_code)

if remapped_error_code == 'underage' # special handling because it says 'Login.gov'

I18n.t('doc_auth.errors.underage', app_name: APP_NAME)

else

# i18n-tasks-use t('doc_auth.errors.unreadable_id')

# i18n-tasks-use t('doc_auth.errors.unaccepted_id_type')

# i18n-tasks-use t('doc_auth.errors.expired_id')

# i18n-tasks-use t('doc_auth.errors.low_resolution')

# i18n-tasks-use t('doc_auth.errors.id_not_found')

I18n.t("doc_auth.errors.#{remapped_error_code}")

end

amirbey · 2024-11-27T21:57:26Z

config/routes.rb

+      get '/hybrid_mobile/socure/document_capture_errors' => 'hybrid_mobile/socure/document_capture#errors', as: :hybrid_mobile_socure_document_capture_errors
+      get '/hybrid_mobile/socure/document_capture_goto_in_person' => 'hybrid_mobile/socure/document_capture#goto_in_person', as: :hybrid_mobile_socure_document_capture_goto_in_person


Suggested change

get '/hybrid_mobile/socure/document_capture_errors' => 'hybrid_mobile/socure/document_capture#errors', as: :hybrid_mobile_socure_document_capture_errors

get '/hybrid_mobile/socure/document_capture_goto_in_person' => 'hybrid_mobile/socure/document_capture#goto_in_person', as: :hybrid_mobile_socure_document_capture_goto_in_person

get '/hybrid_mobile/socure/errors/warning' => 'hybrid_mobile/socure/document_capture#errors', as: :hybrid_mobile_socure_document_capture_errors

get '/hybrid_mobile/socure/errors/in_person' => 'hybrid_mobile/socure/document_capture#goto_in_person', as: :hybrid_mobile_socure_document_capture_goto_in_person

looking at how we handle errors for other idv checks ... it seems like they generally have a errors controller. what do you think about following this pattern?

amirbey

👍🏿 .... comments to be address in follow up PR

Added plumbing and UX display for categorized Socure errors. changelog Upcoming Features, Socure, Added nice error displays

changelog: Upcoming Features, Socure, Added nice error display for Socure failures

jmax-gsa marked this pull request as ready for review November 26, 2024 16:14

jmax-gsa requested review from amirbey and solipet November 26, 2024 16:14

amirbey reviewed Nov 27, 2024

View reviewed changes

amirbey approved these changes Dec 3, 2024

View reviewed changes

jmax-gsa added 8 commits December 3, 2024 12:44

LG-14010 - More detailed error page for Socure errors

e5ee223

Added plumbing and UX display for categorized Socure errors. changelog Upcoming Features, Socure, Added nice error displays

Lint and changelog

a90c103

changelog: Upcoming Features, Socure, Added nice error display for Socure failures

Feature specs

295832a

Fix network error handling (not complete)

672446c

Show correct page for network errors requesting the capture app url.

0055ba2

Spec for network errors.

cfe26d8

Lint fixes.

1dcb117

Controller spec updates.

ed93a8b

jmax-gsa force-pushed the jmax/LG-14010-display-reasons-to-user-for-failed-docv branch from 713fbc7 to ed93a8b Compare December 3, 2024 18:01

jmax-gsa merged commit 7ea7f12 into main Dec 3, 2024

jmax-gsa deleted the jmax/LG-14010-display-reasons-to-user-for-failed-docv branch December 3, 2024 18:24

matthinz mentioned this pull request Dec 5, 2024

Deploy RC 436 to Production #11600

Merged

AShukla-GSA mentioned this pull request Dec 18, 2024

lg-15193 verify socure rate limit display decrements correctly #11671

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LG-14010 - More detailed error page for Socure errors#11560

LG-14010 - More detailed error page for Socure errors#11560
jmax-gsa merged 8 commits intomainfrom
jmax/LG-14010-display-reasons-to-user-for-failed-docv

jmax-gsa commented Nov 26, 2024 •

edited

Loading

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey Nov 27, 2024 •

edited

Loading

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey Nov 27, 2024 •

edited

Loading

Uh oh!

amirbey Nov 27, 2024

Uh oh!

amirbey left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants


		def initialize(http_response:, biometric_comparison_required: false)
		@http_response = http_response

		get '/hybrid_mobile/socure/document_capture_errors' => 'hybrid_mobile/socure/document_capture#errors', as: :hybrid_mobile_socure_document_capture_errors
		get '/hybrid_mobile/socure/document_capture_goto_in_person' => 'hybrid_mobile/socure/document_capture#goto_in_person', as: :hybrid_mobile_socure_document_capture_goto_in_person

Conversation

jmax-gsa commented Nov 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎫 Ticket

🛠 Summary of changes

📜 Testing Plan

👀 Screenshots

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amirbey Nov 27, 2024

Choose a reason for hiding this comment

Uh oh!

amirbey left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jmax-gsa commented Nov 26, 2024 •

edited

Loading

amirbey Nov 27, 2024 •

edited

Loading

amirbey Nov 27, 2024 •

edited

Loading