Skip to content

Make user_access_key_overrides fasterer#2458

Merged
jgsmith-usds merged 1 commit intomasterfrom
make-user-access-key-overrides-fasterer
Aug 30, 2018
Merged

Make user_access_key_overrides fasterer#2458
jgsmith-usds merged 1 commit intomasterfrom
make-user-access-key-overrides-fasterer

Conversation

@jgsmith-usds
Copy link
Copy Markdown
Contributor

Why:
Fasterer is one of our linters to make sure we
are writing efficient code.

How:
Rather than make a method that returns the value
of an instance attribute, we use an attribute reader.

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**:
Fasterer is one of our linters to make sure we
are writing efficient code.

**How**:
Rather than make a method that returns the value
of an instance attribute, we use an attribute reader.
@jgsmith-usds jgsmith-usds requested a review from jmhooper August 27, 2018 15:22
@jgsmith-usds jgsmith-usds merged commit 9383044 into master Aug 30, 2018
@jgsmith-usds jgsmith-usds deleted the make-user-access-key-overrides-fasterer branch August 30, 2018 14:58
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.

2 participants