Skip to content

Namespace platform authenticator params in analytics controller#2622

Merged
jmhooper merged 3 commits intomasterfrom
jmhooper-generalize-anlytics-controller
Oct 24, 2018
Merged

Namespace platform authenticator params in analytics controller#2622
jmhooper merged 3 commits intomasterfrom
jmhooper-generalize-anlytics-controller

Conversation

@jmhooper
Copy link
Contributor

Why: The analytics controller is meant to function as an general
controller for capture analytics for the frontend. Prior to this commit
it was primarily handling the platform authenticator analytics event.

How: This commit makes the controller more general so that it communicates
that it should be built out to handle more events and moves the platform
auth event into a namespace so that the API can be extended to include
more events. Additionally, care was given to make sure that the current
implementation is supported so that we don't drop events while running
instances running this code alongside instances running the new code.

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**: The analytics controller is meant to function as an general
controller for capture anayltics for the frontend. Prior to this commit
it was primarily handling the platform authenticator analytics event.

**How**: This commit makes the controller more general so that it communicates
that it should be built out to handle more events and moves the platform
auth event into a namespace so that the API can be extended to include
more events. Additionally, care was given to make sure that the current
implementation is supported so that we don't drop events while running
instances running this code alongside instances running the new code.
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.

.

@@ -0,0 +1,20 @@
module RequestHelper
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these changes just piggybacking on this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I added a helper to authenticate a user in the specs. The analytics request specs require you be authed.

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.

LOOKS GREAT!

@jmhooper jmhooper merged commit ed72ba7 into master Oct 24, 2018
jmhooper added a commit that referenced this pull request Oct 24, 2018
**Why**: #2622 namespaced the API we used to communicate to analytics
wether platform authenticators were supported. That commit supported the
old API to allow new and old servers to run alongside each other. This
commit tears down that API.
jmhooper added a commit that referenced this pull request Nov 26, 2018
**Why**: #2622 namespaced the API we used to communicate to analytics
wether platform authenticators were supported. That commit supported the
old API to allow new and old servers to run alongside each other. This
commit tears down that API.
@jmhooper jmhooper deleted the jmhooper-generalize-anlytics-controller branch February 15, 2019 18:00
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.

3 participants