Enable back button through document capture by matthinz · Pull Request #9292 · 18F/identity-idp

matthinz · 2023-09-29T23:28:22Z

🎫 Tickets

🛠 Summary of changes

Enables the use of the browser back button for early steps of the IdV flow including:

Welcome
Agreement
Hybrid handoff (+ Link sent)
Document capture

To do this, the PR updates how early IdV steps evaluate whether the user can access them. Instead of checking whether e.g. the Welcome step has already been visited, we now check whether the user has completed document capture.

There is also a tweak to how the agreement step uses Idv::ConsentForm so that the consent checkbox stays checked when navigating back to it.

The user can navigate freely among the first few steps of the flow as long as they have not submitted DocumentCapture.

If they choose UploadPhotos at HybridHandoff, they can click the browser back button from standard DocumentCapture and go back to HybridHandoff or prior steps.
If they choose Send Link at HybridHandoff, they are sent a link to complete DocumentCapture on a mobile device and are shown LinkSent, which initiates polling to wait for DocumentCapture to be complete on mobile. The user can click the browser back button (not the back link on the page) and go forward again and polling restarts when they use the forward button to return to Link Sent. When they return to Link Sent, it will pick up a completed DocumentCapture and proceed to the Ssn step.
If the user clicks Link Sent again instead of using the browser forward button, and submits the previous DocumentCapture page on mobile it does seem to work. I think it probably uses the same DocumentCaptureSession for subsequent links. I got surprise-rate limited the first time I tried it (since I'm doing a bunch of testing), and I think it rate limited me on what should have been a successful attempt (but that's separate from this branch).

📜 Testing Plan

Provide a checklist of steps to confirm the changes.

Begin IdV. Practice going back and forward between the welcome, agreement, and hybrid handoff steps
Proceed through document capture to the SSN screen
Go back to the welcome step and confirm you are redirected back to the SSN screen

app/views/idv/agreement/show.html.erb

app/forms/idv/consent_form.rb

app/controllers/idv/welcome_controller.rb

soniaconnolly · 2023-10-04T22:53:56Z

Trying this out. Going back and forth between HybridHandoff, Agreement, and Welcome works as described. The Agreement box stays checked after I submit Agreement. 🎉 If I check the Agreement box but don't submit and go back to Welcome and then go forward again, it is unchecked, which is surprising as a user but makes some sense as a developer.

Since your comment says we prevent people from going back once they submit DocumentCapture, I tried submitting HybridHandoff, but not uploading any documents on DocumentCapture, and then going back. HybridHandoff automatically redirects to DocumentCapture, but I can go back past that to Agreement. I think we need to edit the HybridHandoff before_actions in this PR too.

The Agreement before_action needs editing similar to the Welcome one - I was able to go back from Ssn page to Agreement. I was also able to go back from Phone to Welcome, as already noted in a comment.

matthinz · 2023-10-06T20:33:03Z

Current plan is to hold on landing this until hybrid handoff back button situation is resolved (see LG-11218).

changelog: User-Facing Improvements, Identity verification, Enable browser back button for early idv steps

- Keep consent checkbox checked on back - Clear consent checkbox after re-submitting welcome

Reviewed this with the team and there was a desire to keep this box checked after the user had checked it.

Co-authored-by Matt Hinz <matt.hinz@gsa.gov>

…not complete

Once verify info is completed, all steps before and including it should be inaccessible

Since we don't have back button for hybrid_handoff worked out yet, don't allow users to go back to agreement or welcome once they submit hybrid_handoff.

This reverts commit 6ee321689ea3d555c6f60b9424ef810b9974c3cb.

It turns out that polling continues if you go back from LinkSent and return, so it's safe to enable the back button for hybrid handoff. Co-authored-by: Doug Price <douglas.price@gsa.gov>

soniaconnolly · 2023-10-11T23:15:45Z

Current plan is to hold on landing this until hybrid handoff back button situation is resolved (see LG-11218).

@solipet and I added code to handle hybrid handoff.

…back-button

jmhooper

Nice work!

app/controllers/concerns/idv_step_concern.rb

matthinz · 2023-10-18T17:59:30Z

(I'm gonna write a spec to catch the issue Zach described before landing this.)

Add spec to cover the issue Zach identified with `redirect_to && return`

Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>

soniaconnolly

LGTM, with style comments.

spec/controllers/concerns/idv_step_concern_spec.rb

Fewer lets, less indirection, all that good stuff.

matthinz added the status - work in progress label Sep 29, 2023

aduth reviewed Oct 2, 2023

View reviewed changes

app/views/idv/agreement/show.html.erb Outdated Show resolved Hide resolved

zachmargolis reviewed Oct 2, 2023

View reviewed changes

app/forms/idv/consent_form.rb Outdated Show resolved Hide resolved

matthinz force-pushed the matthinz/11041-early-back-button branch 2 times, most recently from de70372 to d34a937 Compare October 4, 2023 20:18

matthinz marked this pull request as ready for review October 4, 2023 21:09

matthinz removed the status - work in progress label Oct 4, 2023

matthinz requested a review from a team October 4, 2023 21:09

soniaconnolly reviewed Oct 4, 2023

View reviewed changes

app/controllers/idv/welcome_controller.rb Outdated Show resolved Hide resolved

matthinz force-pushed the matthinz/11041-early-back-button branch from 1cd0804 to 9863fab Compare October 6, 2023 20:31

matthinz added the status - do not merge label Oct 6, 2023

matthinz and others added 17 commits October 10, 2023 16:57

Allow going back to the welcome step

660afdf

changelog: User-Facing Improvements, Identity verification, Enable browser back button for early idv steps

Allow going back to agreement step

9069a21

- Keep consent checkbox checked on back - Clear consent checkbox after re-submitting welcome

Update WelcomeController spec

3d65d9e

Update AgreementController spec

c5ee3f8

Update agreement view spec

3b8533e

Update redo document capture feature spec

cb88b04

Don't reset consent flag when proceeding from welcome step

2010e77

Reviewed this with the team and there was a desire to keep this box checked after the user had checked it.

Prevent accessing welcome step after completing document capture

0227ac8

Update idv end-to-end spec

e419c25

Clean up ial2_consent_given vs idv_consent_given

6cd44b8

Add document_capture_complete? method in idv_session

efd55ca

Co-authored-by Matt Hinz <matt.hinz@gsa.gov>

Move and rename before_action that confirms that document capture is …

bf2a947

…not complete

Add before action to agreement_controller, add specs, add pii_from_user

d71df45

Update redo_document_capture_spec.rb

3a45aab

Once verify info is completed, all steps before and including it should be inaccessible

Check for document_capture started as well as completed

f265ad2

Since we don't have back button for hybrid_handoff worked out yet, don't allow users to go back to agreement or welcome once they submit hybrid_handoff.

Add changes to GettingStarted

40b6af7

Revert "Check for document_capture started as well as completed"

9b3e861

This reverts commit 6ee321689ea3d555c6f60b9424ef810b9974c3cb.

soniaconnolly and others added 2 commits October 10, 2023 16:59

Revert changes to getting_started for document capture not started

8abd90a

Enable back button for hybrid handoff

4e8e344

It turns out that polling continues if you go back from LinkSent and return, so it's safe to enable the back button for hybrid handoff. Co-authored-by: Doug Price <douglas.price@gsa.gov>

soniaconnolly force-pushed the matthinz/11041-early-back-button branch from 375e298 to 4e8e344 Compare October 11, 2023 00:00

soniaconnolly added 2 commits October 11, 2023 08:35

Make test controller anonymous in new idv_step_concern specs

6ed0aaf

lint

32a8b58

soniaconnolly requested review from a team and jmhooper October 11, 2023 23:15

Merge remote-tracking branch 'origin/main' into matthinz/11041-early-…

76e4573

…back-button

soniaconnolly mentioned this pull request Oct 13, 2023

LG-10271: SPIKE to look at improving back button. #9166

Closed

soniaconnolly added 2 commits October 16, 2023 08:35

Merge remote-tracking branch 'origin/main' into matthinz/11041-early-…

6e60f00

…back-button

Redirect from PhoneQuestion directly to DocumentCapture on 'no phone'

b8e2d7c

matthinz changed the title ~~LG-11041: Enable back button for welcome/agreement~~ LG-11041/LG-11218: Enable back button for welcome/agreement/hybrid handoff Oct 16, 2023

matthinz changed the title ~~LG-11041/LG-11218: Enable back button for welcome/agreement/hybrid handoff~~ Enable back button for welcome/agreement/hybrid handoff Oct 16, 2023

matthinz changed the title ~~Enable back button for welcome/agreement/hybrid handoff~~ Enable back button through document capture Oct 16, 2023

matthinz removed the status - do not merge label Oct 16, 2023

jmhooper approved these changes Oct 18, 2023

View reviewed changes

zachmargolis reviewed Oct 18, 2023

View reviewed changes

app/controllers/concerns/idv_step_concern.rb Outdated Show resolved Hide resolved

matthinz and others added 2 commits October 18, 2023 13:30

Add (failing) spec for confirm_hybrid_handoff needed

a5c4f32

Add spec to cover the issue Zach identified with `redirect_to && return`

Update app/controllers/concerns/idv_step_concern.rb

20b2411

Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>

matthinz force-pushed the matthinz/11041-early-back-button branch from 9e72483 to 20b2411 Compare October 18, 2023 20:31

Also cover the "hybrid flow unavailable" case

03315ae

soniaconnolly approved these changes Oct 18, 2023

View reviewed changes

spec/controllers/concerns/idv_step_concern_spec.rb Outdated Show resolved Hide resolved

Clean up spec a little bit

0978b0b

Fewer lets, less indirection, all that good stuff.

matthinz merged commit a40a973 into main Oct 18, 2023

matthinz deleted the matthinz/11041-early-back-button branch October 18, 2023 22:12

soniaconnolly mentioned this pull request Oct 19, 2023

Deploy RC 325 to Prod #9418

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable back button through document capture#9292

Enable back button through document capture#9292
matthinz merged 28 commits intomainfrom
matthinz/11041-early-back-button

matthinz commented Sep 29, 2023 •

edited by soniaconnolly

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soniaconnolly commented Oct 4, 2023

Uh oh!

matthinz commented Oct 6, 2023

Uh oh!

soniaconnolly commented Oct 11, 2023

Uh oh!

jmhooper left a comment

Uh oh!

Uh oh!

matthinz commented Oct 18, 2023

Uh oh!

soniaconnolly left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

matthinz commented Sep 29, 2023 • edited by soniaconnolly Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎫 Tickets

🛠 Summary of changes

📜 Testing Plan

Uh oh!

Uh oh!

Uh oh!

Uh oh!

soniaconnolly commented Oct 4, 2023

Uh oh!

matthinz commented Oct 6, 2023

Uh oh!

soniaconnolly commented Oct 11, 2023

Uh oh!

jmhooper left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

matthinz commented Oct 18, 2023

Uh oh!

soniaconnolly left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

matthinz commented Sep 29, 2023 •

edited by soniaconnolly

Loading