Skip to content

[LG-499] Rake task copies phone info to new table#2415

Merged
jgsmith-usds merged 1 commit intomasterfrom
jgs/lg-499-rake-task-to-update-phone-configurations-table
Aug 8, 2018
Merged

[LG-499] Rake task copies phone info to new table#2415
jgsmith-usds merged 1 commit intomasterfrom
jgs/lg-499-rake-task-to-update-phone-configurations-table

Conversation

@jgsmith-usds
Copy link
Contributor

Why:
We want to make sure all phone configurations are present in
the new table before we start reading data from the table.

How:
We use a rake task that processes users in batches to make
sure a phone configuration row exists for the user.

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.

@jgsmith-usds jgsmith-usds requested a review from stevegsa August 7, 2018 18:31
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm open to other ideas for naming the task. It's a migration of data from one table to another, but this could also confuse folk looking for rails migrations.

Copy link
Contributor

Choose a reason for hiding this comment

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

Assuming this is a one-time only task, I don't think the name matters a whole lot, but in the past, I've seen namespaces like adhoc used for one-off tasks.

What do you think about creating an issue to assign the running of this task to someone, and include the command to run?

Would there be a reason to keep this code around after the task is run? If not, another issue to remove the code from this PR after the task is run?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need confirmation_sent_at?

Copy link
Contributor

Choose a reason for hiding this comment

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

is this line necessary?

Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about naming this CopyPhonesToPhoneConfigurations for more accuracy?

Copy link
Contributor

Choose a reason for hiding this comment

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

What do you think about naming this call for consistency with our other service objects?

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we use create_phone_configuration! to catch any validation errors?

@jgsmith-usds jgsmith-usds force-pushed the jgs/lg-499-rake-task-to-update-phone-configurations-table branch from 72b098c to f9d11f4 Compare August 8, 2018 15:04
**Why**:
We want to make sure all phone configurations are present in
the new table before we start reading data from the table.

**How**:
We use a rake task that processes users in batches to make
sure a phone configuration row exists for the user.
@jgsmith-usds jgsmith-usds force-pushed the jgs/lg-499-rake-task-to-update-phone-configurations-table branch from f9d11f4 to 37242df Compare August 8, 2018 16:31
Copy link
Contributor

@stevegsa stevegsa left a comment

Choose a reason for hiding this comment

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

LGTM

@jgsmith-usds jgsmith-usds merged commit 4c6cf8b into master Aug 8, 2018
@jgsmith-usds jgsmith-usds deleted the jgs/lg-499-rake-task-to-update-phone-configurations-table branch August 8, 2018 19:50
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.

3 participants