Global IdV feature flag / new "IdV Unavailable" page by matthinz · Pull Request #7970 · 18F/identity-idp

matthinz · 2023-03-10T20:29:12Z

🎫 Ticket

🛠 Summary of changes

Provide a way to disable IdV independent of vendor status flags

There was a desire to be able to keep our existing VendorStatus infrastructure, but also provide a means for on-call engineers to completely disable identity verification independent of that.

So now, in addition to marking a required vendor as :full_outage, setting idv_available: false will disable IdV completely.

In code, FeatureManagement.idv_available? should be the preferred way of establishing whether identity verification is available to end users.

Add a new page explaining that Idv is down

The new page (see screenshots below) includes language related to identity verification, and so is not appropriate to be used as a generic error page. There are instances where the old vendor outage page were being used by non-IdV code—these are unmodified.

📜 Testing Plan

Provide a checklist of steps to confirm the changes.

Set idv_available: false in your config and restart your server
Try to verify
Get an error message

👀 Screenshots

With Service Provider:

English

Spanish

French

Without Service Provider:

English

Spanish

French

config/routes.rb

app/controllers/concerns/idv/unavailable_concern.rb

config/locales/idv/en.yml

config/routes.rb

app/controllers/idv/doc_auth_controller.rb

app/controllers/concerns/idv/unavailable_concern.rb

config/application.yml.default

matthinz · 2023-03-13T21:45:26Z

@aduth I’m leaning toward this approach to avoid adding code to ApplicationController:

Add a route (/errors/idv_unavailable) that non-IdV code (e.g. registration) can redirect to if needed.
Wire up routes under /verify to show the error screen (and return a 503) when idv is unavailable (as this PR already does)

This way users can hit refresh during IdV to 🤞 try and fix their issue, but we still have flexibility to redirect the user to a friendly "idv unavailable" from other parts of the app.

app/controllers/idv/unavailable_controller.rb

app/controllers/idv_controller.rb

app/views/idv/unavailable.html.erb

config/routes.rb

app/controllers/idv/unavailable_controller.rb

Tie feature to vendor availability as well as config.

Return a 503 service unavailable whenever IdV is unavailable.

The unused i18n detector was getting tripped up by the ternary conditional in here.

There's not really a route to this action by default.

Did not end up implementing this

Rather than bolting more functionality onto ApplicationController: - Add a new route at `/errors/idv_unavailable` for non-IdV parts of the app to redirect to - Take over `/verify/*` and show the unavailable message when it is.

When IdV becomes available again, try and send the user back where they were.

… more helpful and detailed error message when identity verification is unavailable.

We're not longer using this bit of VendorStatus.

Keep `redirect_from` analytics param for this case. (503 responses will log with the event `path` set to the currnet location)

Use `show` for the action that shows the error, and move view to the more conventional `idv/unavailable/show.html.erb`.

For both use cases (fixed path at /errors/idv_unavailable AND catchall for /verify/* when idv is down), just use the "show" action. Also, only return 503 Service Unavailable if idv is actually unavailable.

5XX errors will trigger nuisance alerts in monitoring tools. An error message that we have purposefully put in place should be regarded as "OK".

aduth · 2023-03-20T18:17:49Z

It appears that the spec failing in the build is relevant to the changes.

This was leftover from an earlier version of this PR.

matthinz · 2023-03-20T18:28:54Z

I'm gonna mark this as a "work in progress" for now, as there is some overlap here with #8011 that I'd like to iron out after that lands.

matthinz · 2023-03-30T22:27:41Z

I'm going to close this in favor of a new PR, since this has gone stale w/r/t main.

matthinz commented Mar 10, 2023

View reviewed changes

config/routes.rb Outdated Show resolved Hide resolved

matthinz commented Mar 10, 2023

View reviewed changes

app/controllers/concerns/idv/unavailable_concern.rb Outdated Show resolved Hide resolved

matthinz commented Mar 10, 2023

View reviewed changes

app/controllers/concerns/idv/unavailable_concern.rb Outdated Show resolved Hide resolved

matthinz requested a review from a team March 10, 2023 20:33

soniaconnolly reviewed Mar 11, 2023

View reviewed changes

config/locales/idv/en.yml Outdated Show resolved Hide resolved

config/routes.rb Outdated Show resolved Hide resolved

aduth reviewed Mar 13, 2023

View reviewed changes

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

app/controllers/concerns/idv/unavailable_concern.rb Outdated Show resolved Hide resolved

config/application.yml.default Outdated Show resolved Hide resolved

mitchellhenke force-pushed the main branch from 69c4ff8 to 3f7e670 Compare March 14, 2023 17:22

mitchellhenke force-pushed the matthinz/8710-who-needs-idv branch from e990ee3 to b24a680 Compare March 14, 2023 17:50

matthinz force-pushed the matthinz/8710-who-needs-idv branch 2 times, most recently from 9917262 to 62ec030 Compare March 14, 2023 23:43

aduth reviewed Mar 15, 2023

View reviewed changes

jmhooper reviewed Mar 15, 2023

View reviewed changes

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

matthinz added 17 commits March 15, 2023 10:01

Route + controller for outage page

d964d3b

View for outage page

ec70d3c

Wire up exit button

2b68a8b

Add idv_available config && feature

569f314

Tie feature to vendor availability as well as config.

Return error when IDV is unavailable

c6e8dd9

Return a 503 service unavailable whenever IdV is unavailable.

Update translations

2156ac2

Remove unused spec file

57b9496

Make French be in French:wq

a790712

Be less clever in erb

7e8f83d

The unused i18n detector was getting tripped up by the ternary conditional in here.

Fix borked rename

6607faa

Remove unused tests

66cbfb0

Don't rely on route to test IdvController::unavailable

5dd2ac2

There's not really a route to this action by default.

Revert formatting changes to routes.rb

2bba983

Superstition: reload routes on cleanup to avoid poisoning other tests

f0ecbf4

Remove stray to_h method

db215ca

Did not end up implementing this

Don't use raise + concern for unavailable error

434bf49

Rather than bolting more functionality onto ApplicationController: - Add a new route at `/errors/idv_unavailable` for non-IdV parts of the app to redirect to - Take over `/verify/*` and show the unavailable message when it is.

Attempt to redirect user back from outage page

081451e

When IdV becomes available again, try and send the user back where they were.

matthinz added 11 commits March 15, 2023 10:01

changelog: User-Facing Improvements, Identity verification, Provide a…

1797426

… more helpful and detailed error message when identity verification is unavailable.

Remove from, from_idv from VendorStatus

bfc1934

We're not longer using this bit of VendorStatus.

Log when we hit IDV unavailable screen from the create account page

f0825fe

Keep `redirect_from` analytics param for this case. (503 responses will log with the event `path` set to the currnet location)

Remove unneeded VendorStatus test

5e1a073

Fix #track_event test

0137f4c

Remove unused translations

f18d53f

Clean up unavailable actions / views / etc.

ac1b7c5

Use `show` for the action that shows the error, and move view to the more conventional `idv/unavailable/show.html.erb`.

Hoist constant up to class level

ac4f9fc

Remove unused action on IdvController

98f82b6

Fixup: unavailable view

4b39a0a

Don't use separate actions for idv unavailable message

e116e8e

For both use cases (fixed path at /errors/idv_unavailable AND catchall for /verify/* when idv is down), just use the "show" action. Also, only return 503 Service Unavailable if idv is actually unavailable.

matthinz force-pushed the matthinz/8710-who-needs-idv branch from 62ec030 to e116e8e Compare March 15, 2023 18:16

matthinz added 3 commits March 15, 2023 11:25

Spell "unavailable" correctly

6aa9f06

Use StatusPageComponent for IdV unavailable message

7689c7a

Return 200 OK from unavailable error page

82fb5d5

5XX errors will trigger nuisance alerts in monitoring tools. An error message that we have purposefully put in place should be regarded as "OK".

matthinz mentioned this pull request Mar 16, 2023

LG-8867: New page to inform user of GPO only #8011

Merged

Refactor redirect in UnavailableController out to before_action

3e23672

Remove irrelevant test

ec9d077

This was leftover from an earlier version of this PR.

matthinz added the status - work in progress label Mar 20, 2023

matthinz closed this Mar 30, 2023

matthinz deleted the matthinz/8710-who-needs-idv branch March 30, 2023 22:27

matthinz mentioned this pull request Mar 30, 2023

LG-8710: New IDV unavailable screen #8106

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Global IdV feature flag / new "IdV Unavailable" page#7970

Global IdV feature flag / new "IdV Unavailable" page#7970
matthinz wants to merge 33 commits intomainfrom
matthinz/8710-who-needs-idv

matthinz commented Mar 10, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matthinz commented Mar 13, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aduth commented Mar 20, 2023

Uh oh!

matthinz commented Mar 20, 2023

Uh oh!

matthinz commented Mar 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

matthinz commented Mar 10, 2023

🎫 Ticket

🛠 Summary of changes

📜 Testing Plan

👀 Screenshots

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matthinz commented Mar 13, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aduth commented Mar 20, 2023

Uh oh!

matthinz commented Mar 20, 2023

Uh oh!

matthinz commented Mar 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants