Skip to content

LG-6625: Hide IPP troubleshooting option for failures#6597

Merged
aduth merged 16 commits intomainfrom
aduth-lg-6625-in-person-failure
Jul 26, 2022
Merged

LG-6625: Hide IPP troubleshooting option for failures#6597
aduth merged 16 commits intomainfrom
aduth-lg-6625-in-person-failure

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Jul 18, 2022

Why: So that the option to proof in person is only extended to those who would be successful in proofing.

Testing Instructions:

  1. Navigate to http://localhost:3000
  2. Sign in
  3. Navigate to http://localhost:3000/verify
  4. Complete proofing flow up to document capture
  5. Use one of YAML document examples for field upload
  6. Click "Submit"
  7. Observe that "Verify your ID in person at a Post Office" only appears for non-"Failed" result

Document Examples:

attention.yml:

failed_alerts:
  - name: Document Classification
    result: Attention

failed.yml:

doc_auth_result: Failed

Screenshots:

Failure Type Screenshot
Attention image
Failure image

aduth added 3 commits July 18, 2022 15:40
**Why**: So that it is available from when response values are checked (e.g. for result type)
Consistency with ApiImageUploadForm, and availability to check if failure type
**Why**: So that the option to proof in person is only extended to those who would be successful in proofing.

changelog: Upcoming Features, In-person proofing, Hide troubleshooting option for document capture failure results
Comment on lines +85 to +87
def doc_auth_result_from_uploaded_file
parsed_data_from_uploaded_file&.[]('doc_auth_result')
end
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our developer docs specify that a YAML test file can include doc_auth_result as a top-level field, but we previously weren't actually passing this along as the extra[:doc_auth_result] value.

https://developers.login.gov/testing/#document-upload

@aduth aduth marked this pull request as ready for review July 26, 2022 14:37
@aduth aduth requested review from a team and sheldon-b July 26, 2022 14:37
submissionError instanceof UploadFormEntriesError
? withProps({
remainingAttempts: submissionError.remainingAttempts,
isFailedResult: submissionError.isFailedResult,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just want to clarify for myself - is isFailedResult for any id upload failure of for the kind that would not trigger an option for in person proofing (ie barcode can't be read)?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way it's being treated here is as a "hard failure", meaning that it's a document which was recognized as unacceptable (fraudulent, etc.). This is one of the results which can be returned from our document authentication vendors. It's also distinct from other non-successful results like "unknown" or "attention". The ticket is making it so that we can continue showing the troubleshooting option for certain unsuccessful results (unknown, attention), but not for failures.

# The authentication test results are unknown. We are not billed for these
UNKNOWN = ResultCode.new(0, 'Unknown', false).freeze
# The authentication test passed.
PASSED = ResultCode.new(1, 'Passed', true).freeze
# The authentication test failed.
FAILED = ResultCode.new(2, 'Failed', true).freeze
# The authentication test was skipped (was not run).
SKIPPED = ResultCode.new(3, 'Skipped', true).freeze
# The authentication test was inconclusive and further investigation is warranted.
CAUTION = ResultCode.new(4, 'Caution', true).freeze
# The authentication test results requires user attention.
ATTENTION = ResultCode.new(5, 'Attention', true).freeze

Copy link
Contributor

@tomas-nava tomas-nava left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approve!

@aduth aduth merged commit a9c7daf into main Jul 26, 2022
@aduth aduth deleted the aduth-lg-6625-in-person-failure branch July 26, 2022 19:44
@solipet solipet mentioned this pull request Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants