Skip to content

LG-504 Create a health checker for account reset notifications#2387

Merged
stevegsa merged 1 commit intomasterfrom
stevegsa-account-reset-health-checker
Jul 30, 2018
Merged

LG-504 Create a health checker for account reset notifications#2387
stevegsa merged 1 commit intomasterfrom
stevegsa-account-reset-health-checker

Conversation

@stevegsa
Copy link
Contributor

@stevegsa stevegsa commented Jul 27, 2018

Why: When a user requests an account reset we tell them their request will be processed in 24 hours. We have to be sure that the asyncronous processing of the grant notifications are occurring on a timely basis.

How: Add a health checker to the health_controller. Search for a single record in account_reset_requests where the request was not serviced in 26 hours (24 hours + a 2 hour buffer to service the requests). Return a bad health status if such a record is found. The table has an index that is optimized for this type of query while factoring in timestamps, cancellations, and requests already granted.

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**: When a user requests an account reset we tell them their request will be processed in 24 hours. We have to be sure that the asyncronous processing of the grant notifications are occurring on a timely basis.

**How**: Add a health checker to the health_controller.  Search for a single record in account_reset_requests where the request was not serviced in 26 hours (24 hours + a 2 hour buffer to service the requests).  Return a bad health status if such a record is found.  The table has an index that is optimized for this type of query while factoring in timestamps, cancellations, and requests already granted.
def find_request_not_serviced_within_26_hours
records = AccountResetRequest.where(
sql, tvalue: Time.zone.now - Figaro.env.account_reset_wait_period_days.to_i.days - 2.hours
).order('requested_at ASC').limit(1)
Copy link
Contributor

Choose a reason for hiding this comment

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

Style: this works just fine since we only do this once in a while. Another pattern I've seen is to select 1 so we aren't sending a lot of data over the network. We only care about existence.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes. I like!

@stevegsa stevegsa merged commit 0825840 into master Jul 30, 2018
@brodygov brodygov deleted the stevegsa-account-reset-health-checker branch August 16, 2018 16:06
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