Skip to content

Add separate OtpDeliveryMethodForm for IdV#2440

Merged
jmhooper merged 3 commits intomasterfrom
jmhooper-idv-otp-delivery-preference-form
Aug 21, 2018
Merged

Add separate OtpDeliveryMethodForm for IdV#2440
jmhooper merged 3 commits intomasterfrom
jmhooper-idv-otp-delivery-preference-form

Conversation

@jmhooper
Copy link
Contributor

Why: In the IdV flow, we know the number will be a US number so we
don't have to validate delivery methods against the phone number.
Additionally, we don't need to update the user's delivery preference.
For these reasons it makes more sense for the IdV flow to have it's own
form.

Hi! Before submitting your PR for review, and/or before merging it, please
go through the checklists below. These represent the more critical elements
of our code quality guidelines. The rest of the list can be found in
CONTRIBUTING.md

Controllers

  • When adding a new controller that requires the user to be fully
    authenticated, make sure to add before_action :confirm_two_factor_authenticated
    as the first callback.

Database

  • Unsafe migrations are implemented over several PRs and over several
    deploys to avoid production errors. The strong_migrations gem
    will warn you about unsafe migrations and has great step-by-step instructions
    for various scenarios.

  • Indexes were added if necessary. This article provides a good overview
    of indexes in Rails.

  • Verified that the changes don't affect other apps (such as the dashboard)

  • When relevant, a rake task is created to populate the necessary DB columns
    in the various environments right before deploying, taking into account the users
    who might not have interacted with this column yet (such as users who have not
    set a password yet)

  • Migrations against existing tables have been tested against a copy of the
    production database. See LG-228 Make migrations safer and more resilient #2127 for an example when a migration caused deployment
    issues. In that case, all the migration did was add a new column and an index to
    the Users table, which might seem innocuous.

Encryption

  • The changes are compatible with data that was encrypted with the old code.

Routes

  • GET requests are not vulnerable to CSRF attacks (i.e. they don't change
    state or result in destructive behavior).

Session

  • When adding user data to the session, use the user_session helper
    instead of the session helper so the data does not persist beyond the user's
    session.

Testing

  • Tests added for this feature/bug
  • Prefer feature/integration specs over controller specs
  • When adding code that reads data, write tests for nil values, empty strings,
    and invalid inputs.

**Why**: In the IdV flow, we know the number will be a US number so we
don't have to validate delivery methods against the phone number.
Additionally, we don't need to update the user's delivery preference.
For these reasons it makes more sense for the IdV flow to have it's own
form.
context: 'idv',
selected_delivery_method: @otp_delivery_selection_form.otp_delivery_preference
)
prompt_to_confirm_idv_phone
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pictured here: Me begging for merge conflicts against #2430

Copy link
Contributor

@monfresh monfresh Aug 17, 2018

Choose a reason for hiding this comment

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

Here's a wild idea: what if we got rid of this otp_delivery_selection_form altogether? The only thing it's doing is making sure the method is either "sms" or "voice", and the only way it would not be is if someone deliberately manipulated the HTML on the page before submitting the form. How about if we default to "sms" if something other than "sms" or "voice" is submitted?

Copy link
Contributor

@monfresh monfresh Aug 17, 2018

Choose a reason for hiding this comment

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

Or maybe default to not do anything and display the delivery selection page again.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It makes some changes to the idv session in the other PR. The delivery preference gets saved there instead of added as a url param. We could move that logic to the controller, but idk if we want to?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Actually, I'm looking at my new code now and I do actually already set it in the controller. Hmm, yeah we can try removing it completely.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Though another downside of not have a form is that we don't have a result object to feed to analytics here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@monfresh: Anything to add here?

Copy link
Contributor

Choose a reason for hiding this comment

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

All good. I think we decided to leave this here when we discussed this offline.

result = {
success: false,
errors: { otp_delivery_preference: ['is not included in the list'] },
otp_delivery_preference: '🎷',
Copy link
Contributor

Choose a reason for hiding this comment

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

love the sax

Copy link
Contributor

@monfresh monfresh left a comment

Choose a reason for hiding this comment

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

LGTM

@jmhooper jmhooper merged commit b037a0a into master Aug 21, 2018
@jmhooper jmhooper deleted the jmhooper-idv-otp-delivery-preference-form branch February 15, 2019 19:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants