test_track_rails_client 4.0.0.alpha7 → 4.0.0.alpha8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 783a76b4acdaebee2ff453ba5513d49e804c985c
-  data.tar.gz: 4f36e75ebc4a144a02daf0fcd3d53d48deb8bcc2
+  metadata.gz: 3c421a570a50e10dbfdff7420aafa19964ee4c01
+  data.tar.gz: 901a202cbb0db2717ba240b6466f6408ddb1b3c4
 SHA512:
-  metadata.gz: 7725742abb3fa4099ef8e2c4571b820a8b28bb987f0d6e7b111d92c1e7f5de5049311a69217ca576ba56c947cacbeb97966d077c930a4b8a1d17576f7e4bcaf1
-  data.tar.gz: 3155aa14210aca6d48bd44c02a7e71be22d0dac81bc6472c9299459e8969527346ae9f98dd0fe7d3e909ba6acb4aec2b7345868b4d318cea1f3947f05c0a4ab2
+  metadata.gz: 684fa6562e8a88bd4092bbd2cf0f5527f84c4c4e55b307c5ca9ec88f4d965cfb193aec37fb20a08aefda96588fbc34597f9b1b91198bf3390c3dde7c09484505
+  data.tar.gz: 63edb85ee37e5eba3d15fc2f926eca2aae470bf0f927d2b5cde366206edc48f8b12ebc685849343fd06fb66a54a53aa101e51606e02c4869923bad91694c750c

data/README.md

@@ -21,13 +21,15 @@ If you're looking to do client-side assignment, then check out our [JS client](h
 
 ## Installation
 
-Install the gem:
+### Install the gem:
 
 ```ruby
 # Gemfile
 gem 'test_track_rails_client'
 ```
 
+### Create an app in the TestTrack server
+
 In every environment (local included) cut an App record via the **TestTrack server** rails console:
 
 ```ruby
@@ -40,6 +42,8 @@ README](https://github.com/Betterment/test_track/blob/master/README.md#user-cont
 for additional information on configuring seed apps for local
 development.
 
+### Set up ENV vars
+
 Set up ENV vars in every environment:
 
 * `MIXPANEL_TOKEN` - By default, TestTrack reports to Mixpanel. If you're using a [custom analytics provider](#custom-analytics) you can omit this.
@@ -51,15 +55,28 @@ Set up ENV vars in every environment:
   * `example.org`
   * etc
 
+### Prepare your controllers
 
-Mix `TestTrack::Controller` into any controllers needing access to TestTrack:
+Mix `TestTrack::Controller` into any controllers needing access to TestTrack and configure it with the name of your `:current_user` method.
 
 ```ruby
 class MyController < ApplicationController
   include TestTrack::Controller
+
+  self.test_track_identity = :current_user
 end
 ```
 
+If your app doesn't support authentication, set
+`self.test_track_identity` to `:none`.
+
+### Prepare your identity models (optional)
+
+If your app supports authentication, You'll need to configure your
+`User` model as a [TestTrack Identity](#varying-app-behavior-from-within-a-model)
+
+### Set up the Chrome extension (optional)
+
 If you'd like to be able to use the [TestTrack Chrome Extension](https://github.com/Betterment/test_track_chrome_extension) which makes it easy for you and your team to change assignments via your browser, you **must** set up the TestTrack JS client.
 
 1. `testTrack.bundle.min` in your `application.js` file after your reference to jQuery
@@ -239,51 +256,9 @@ if test_track_visitor.ab :dark_deployed_feature, context: 'signup'
 end
 ```
 
-### Varying app behavior in an offline context
-
-The `OfflineSession` class can be used to load a test track visitor when there is no access to browser cookies. It is perfect for use in a process being run from either a job queue or a scheduler. The visitor object that is yielded to the block is the same as the visitor in a controller context; it has both the `vary` and `ab` methods.
-
-An `OfflineSession` can be established in one of two ways:
-
-1. with an `identifier_type`:
-```ruby
-OfflineSession.with_visitor_for(:myapp_user_id, 1234) do |test_track_visitor|
-  test_track_visitor.vary :name_of_split, context: 'background_job' do |v|
-    v.when :variant_1, :variant_2 do
-      # Do something
-    end
-    v.when :variant_3 do
-      # Do another thing
-    end
-    v.default :variant_4 do
-      # Do something else
-    end
-  end
-end
-```
-
-2. with a `TestTrack::Visitor#id`:
-```ruby
-OfflineSession.with_visitor_id(1234) do |test_track_visitor|
-  test_track_visitor.vary :name_of_split, context: 'background_job' do |v|
-    v.when :variant_1, :variant_2 do
-      # Do something
-    end
-    v.when :variant_3 do
-      # Do another thing
-    end
-    v.default :variant_4 do
-      # Do something else
-    end
-  end
-end
-```
-
 ### Varying app behavior from within a model
 
-The `TestTrack::Identity` concern can be included in a model and it will add two methods to the model: `test_track_vary` and `test_track_ab`. Behind the scenes, these methods check to see if they are being used within a web context of a controller that includes `TestTrack::Controller` or not. If called in a web context they will use the `test_track_visitor` that the controller has and participate in the existing session, if not, they will standup an `OfflineSession`.
-
-Because these methods may need to stand up an `OfflineSession` the consuming model needs to provide both the identifier type and which column should be used as the identifier value via the `test_track_identifier` method so that the `OfflineSession` can grab the correct visitor.
+The `TestTrack::Identity` concern can be included in a model and it will add two methods to the model: `test_track_vary` and `test_track_ab`.
 
 ```ruby
 class User
@@ -293,8 +268,6 @@ class User
 end
 ```
 
-N.B. If you call `test_track_vary` and `test_track_ab` on a model in a web context, but that model is not the currently authenticated model, an `OfflineSession` will be created instead of participating in the existing session.
-
 ## Tracking visitor logins
 
 The `test_track_visitor.log_in!` is used to ensure a consistent experience across devices. For instance, when a user logs in to your app on their mobile device we can log in to Test Track in order to grab their existing split assignments instead of treating them like a new visitor.
@@ -317,7 +290,7 @@ The `test_track_visitor.sign_up!` method tells TestTrack when a new identifier h
 test_track_visitor.sign_up!(:myapp_user_id, 2345)
 ```
 
-## Testing splits
+## Testing your split-dependent application code with RSpec
 
 Add this line to your `rails_helper.rb`:
 
@@ -384,6 +357,14 @@ easier and more conventional, though, and takes care of differentiating
 between expiriment assignments and feature gate experiences, which are
 no longer recorded server-side.
 
+You also must add `self.test_track_identity = :current_user` (or
+whatever your controller uses as a sign-in identity) to your
+TestTrack-enabled controllers, or set it to `:none` if your app doesn't
+support authentication.
+
+If your app supports authentication, You'll need to configure your
+user model as a [TestTrack Identity](#varying-app-behavior-from-within-a-model)
+
 ### From 2.0 to 3.0
 
 TestTrack Rails Client no longer manages your Mixpanel cookie. The analytics plugin now provides a callback on `sign_up!` that will allow you to implement this functionality within your application. Please see the [analytics documentation](#analytics) for more details.

data/app/controllers/concerns/test_track/controller.rb

@@ -2,6 +2,8 @@ module TestTrack::Controller
   extend ActiveSupport::Concern
 
   included do
+    class_attribute :test_track_identity
+
     helper_method :test_track_session, :test_track_visitor
     helper TestTrack::ApplicationHelper
     around_action :manage_test_track_session

data/app/models/test_track/ab_configuration.rb

@@ -19,7 +19,9 @@ class TestTrack::ABConfiguration
   private
 
   def build_variant_hash
-    notify_because_ab("configures split with more than 2 variants") if split_variants && split_variants.size > 2
+    if split_variants && split_variants.size > 2 # rubocop:disable Style/SafeNavigation
+      notify_because_ab("configures split with more than 2 variants")
+    end
     { true: true_variant, false: false_variant }
   end
 

data/app/models/test_track/lazy_visitor_by_identity.rb

@@ -0,0 +1,38 @@
+class TestTrack::LazyVisitorByIdentity
+  def initialize(identity)
+    @identity = identity
+  end
+
+  def loaded?
+    @visitor.present?
+  end
+
+  def id_loaded?
+    loaded?
+  end
+
+  private
+
+  def method_missing(method, *args, &block) # rubocop:disable Style/MethodMissing
+    __visitor__.send(method, *args, &block)
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    super || __visitor__.respond_to?(method, include_private)
+  end
+
+  def __visitor__
+    @visitor ||= __load_visitor__
+  end
+
+  def __load_visitor__
+    remote_visitor = TestTrack::Remote::Visitor.from_identifier(
+      @identity.test_track_identifier_type,
+      @identity.test_track_identifier_value
+    )
+    TestTrack::Visitor.new(
+      id: remote_visitor.id,
+      assignments: remote_visitor.assignments
+    )
+  end
+end

data/app/models/test_track/session.rb

@@ -11,34 +11,19 @@ class TestTrack::Session
   def manage
     yield
   ensure
-    manage_cookies!
-    manage_response_headers!
-    notify_unsynced_assignments! if sync_assignments?
-  end
-
-  def visitor_dsl_for(identity)
-    if has_matching_identity?(identity)
-      visitor_dsl
-    else
-      TestTrack::VisitorDSL.new(visitors_by_identity[identity])
+    if current_visitor.id_loaded?
+      manage_cookies!
+      manage_response_headers!
     end
+    visitors.notify_unsynced_assignments!
   end
 
-  def visitors_by_identity
-    @visitors_by_identity ||= Hash.new do |visitors_by_identity, identity|
-      remote_visitor = TestTrack::Remote::Visitor.from_identifier(
-        identity.test_track_identifier_type,
-        identity.test_track_identifier_value
-      )
-      visitors_by_identity[identity] = TestTrack::Visitor.new(
-        id: remote_visitor.id,
-        assignments: remote_visitor.assignments
-      )
-    end
+  def visitor_dsl_for(identity)
+    TestTrack::VisitorDSL.new(visitors.for_identity(identity))
   end
 
   def visitor_dsl
-    @visitor_dsl ||= TestTrack::VisitorDSL.new(visitor)
+    TestTrack::VisitorDSL.new(current_visitor)
   end
 
   def state_hash
@@ -46,50 +31,55 @@ class TestTrack::Session
       url: TestTrack.url,
       cookieDomain: cookie_domain,
       cookieName: visitor_cookie_name,
-      registry: visitor.split_registry,
-      assignments: visitor.assignment_json
+      registry: current_visitor.split_registry,
+      assignments: current_visitor.assignment_json
     }
   end
 
   def log_in!(identity, forget_current_visitor: nil)
-    identifier_type = identity.test_track_identifier_type
-    identifier_value = identity.test_track_identifier_value
-
-    @visitor = TestTrack::Visitor.new if forget_current_visitor
-    visitor.link_identifier!(identifier_type, identifier_value)
-
-    identities << identity if identity.present?
+    visitors.forget_unauthenticated! if forget_current_visitor
+    visitors.authenticate!(identity)
     true
   end
 
   def sign_up!(identity)
-    identifier_type = identity.test_track_identifier_type
-    identifier_value = identity.test_track_identifier_value
-
-    visitor.link_identifier!(identifier_type, identifier_value)
-    identities << identity if identity.present?
-
-    TestTrack.analytics.sign_up!(visitor.id)
-
+    visitors.authenticate!(identity)
+    TestTrack.analytics.sign_up!(current_visitor.id)
     true
   end
 
-  def has_matching_identity?(identity)
-    identities.include?(identity)
-  end
-
   private
 
   attr_reader :controller
 
-  def visitor
-    @visitor ||= TestTrack::Visitor.new(id: visitor_id)
+  def current_identity
+    raise <<~ERROR unless controller.class.test_track_identity&.is_a?(Symbol)
+      Your controller (or controller base class) must set test_track_identity for
+      TestTrack to work properly. e.g.:
+
+        self.test_track_identity = :current_user
+
+      If your app doesn't support authentication, set it to `:none`.
+    ERROR
+    identity = controller.class.test_track_identity
+    controller.send(identity) unless identity == :none
   end
 
-  def visitor_id
+  def unauthenticated_visitor_id
     cookies[visitor_cookie_name] || request_headers[visitor_request_header_name]
   end
 
+  def visitors
+    @visitors ||= TestTrack::SessionVisitorRepository.new(
+      current_identity: current_identity,
+      unauthenticated_visitor_id: unauthenticated_visitor_id
+    )
+  end
+
+  def current_visitor
+    visitors.current
+  end
+
   def set_cookie(name, value)
     cookies[name] = {
       value: value,
@@ -131,7 +121,7 @@ class TestTrack::Session
   end
 
   def manage_cookies!
-    set_cookie(visitor_cookie_name, visitor.id)
+    set_cookie(visitor_cookie_name, current_visitor.id)
   end
 
   def request
@@ -155,26 +145,7 @@ class TestTrack::Session
   end
 
   def manage_response_headers!
-    response_headers[visitor_response_header_name] = visitor.id if visitor.id_overridden_by_existing_visitor?
-  end
-
-  def notify_unsynced_assignments!
-    payload = {
-      visitor_id: visitor.id,
-      assignments: visitor.unsynced_assignments
-    }
-    ActiveSupport::Notifications.instrument('test_track.notify_unsynced_assignments', payload) do
-      ##
-      # This block creates an unbounded number of threads up to 1 per request.
-      # This can potentially cause issues under high load, in which case we should move to a thread pool/work queue.
-      new_thread_with_request_store do
-        TestTrack::UnsyncedAssignmentsNotifier.new(payload).notify
-      end
-    end
-  end
-
-  def sync_assignments?
-    visitor.loaded? && visitor.unsynced_assignments.present?
+    response_headers[visitor_response_header_name] = current_visitor.id if current_visitor.id_overridden_by_existing_visitor?
   end
 
   def visitor_cookie_name
@@ -192,21 +163,4 @@ class TestTrack::Session
   def fully_qualified_cookie_domain_enabled?
     ENV['TEST_TRACK_FULLY_QUALIFIED_COOKIE_DOMAIN_ENABLED'] == '1'
   end
-
-  def new_thread_with_request_store
-    Thread.new(RequestStore.store) do |original_store|
-      begin
-        RequestStore.begin!
-        RequestStore.store.merge!(original_store)
-        yield
-      ensure
-        RequestStore.end!
-        RequestStore.clear!
-      end
-    end
-  end
-
-  def identities
-    @identities ||= TestTrack::SessionIdentityCollection.new(controller)
-  end
 end

data/app/models/test_track/session_visitor_repository.rb

@@ -0,0 +1,52 @@
+class TestTrack::SessionVisitorRepository
+  attr_reader :current_identity, :unauthenticated_visitor_id
+
+  def initialize(current_identity:, unauthenticated_visitor_id:)
+    @current_identity = current_identity
+    @unauthenticated_visitor_id = unauthenticated_visitor_id
+  end
+
+  def current
+    if current_identity
+      for_identity(current_identity)
+    else
+      unauthenticated
+    end
+  end
+
+  def for_identity(identity)
+    identity_visitor_map[identity] ||= TestTrack::LazyVisitorByIdentity.new(identity)
+  end
+
+  def forget_unauthenticated!
+    @unauthenticated = TestTrack::Visitor.new
+  end
+
+  def authenticate!(identity)
+    @current_identity = identity
+    identity_visitor_map[identity] = unauthenticated
+    unauthenticated.link_identity!(identity)
+  end
+
+  def all
+    identity_visitor_map.values.to_set << current
+  end
+
+  def notify_unsynced_assignments!
+    all.each do |visitor|
+      if visitor.loaded? && visitor.unsynced_assignments.present?
+        TestTrack::ThreadedVisitorNotifier.new(visitor).notify
+      end
+    end
+  end
+
+  private
+
+  def unauthenticated
+    @unauthenticated ||= TestTrack::Visitor.new(id: unauthenticated_visitor_id)
+  end
+
+  def identity_visitor_map
+    @identity_visitor_map ||= {}
+  end
+end

data/app/models/test_track/threaded_visitor_notifier.rb

@@ -0,0 +1,34 @@
+class TestTrack::ThreadedVisitorNotifier
+  attr_reader :visitor
+
+  def initialize(visitor)
+    @visitor = visitor
+  end
+
+  def notify
+    payload = {
+      visitor_id: visitor.id,
+      assignments: visitor.unsynced_assignments
+    }
+    ActiveSupport::Notifications.instrument('test_track.notify_unsynced_assignments', payload) do
+      new_thread_with_request_store do
+        TestTrack::UnsyncedAssignmentsNotifier.new(payload).notify
+      end
+    end
+  end
+
+  private
+
+  def new_thread_with_request_store
+    Thread.new(RequestStore.store) do |original_store|
+      begin
+        RequestStore.begin!
+        RequestStore.store.merge!(original_store)
+        yield
+      ensure
+        RequestStore.end!
+        RequestStore.clear!
+      end
+    end
+  end
+end

data/app/models/test_track/visitor.rb

@@ -6,6 +6,7 @@ class TestTrack::Visitor
   def initialize(opts = {})
     opts = opts.dup
     @id = opts.delete(:id)
+    @loaded = true if opts[:assignments]
     @assignments = opts.delete(:assignments)
     unless id
       @id = SecureRandom.uuid
@@ -65,17 +66,17 @@ class TestTrack::Visitor
     @split_registry ||= TestTrack::Remote::SplitRegistry.to_hash
   end
 
-  def link_identifier!(identifier_type, identifier_value)
-    identifier_opts = { identifier_type: identifier_type, visitor_id: id, value: identifier_value.to_s }
+  def link_identity!(identity)
+    opts = identifier_opts(identity)
     begin
-      identifier = TestTrack::Remote::Identifier.create!(identifier_opts)
+      identifier = TestTrack::Remote::Identifier.create!(opts)
       merge!(identifier.visitor)
     rescue *TestTrack::SERVER_ERRORS => e
       Rails.logger.error "TestTrack failed to link identifier, retrying. #{e}"
 
       # If at first you don't succeed, async it - we may not display 100% consistent UX this time,
       # but subsequent requests will be better off
-      TestTrack::Remote::Identifier.delay.create!(identifier_opts)
+      TestTrack::Remote::Identifier.delay.create!(opts)
     end
   end
 
@@ -83,8 +84,12 @@ class TestTrack::Visitor
     @tt_offline
   end
 
+  def id_loaded?
+    true
+  end
+
   def loaded?
-    !offline? && @remote_visitor.present?
+    !offline? && @loaded
   end
 
   def id_overridden_by_existing_visitor?
@@ -93,12 +98,28 @@ class TestTrack::Visitor
 
   private
 
+  def identifier_opts(identity)
+    {
+      identifier_type: identity.test_track_identifier_type,
+      visitor_id: id,
+      value: identity.test_track_identifier_value.to_s
+    }
+  end
+
   def assignments
-    @assignments ||= (remote_visitor && remote_visitor.assignments) || []
+    @assignments ||= remote_visitor&.assignments || []
   end
 
   def remote_visitor
-    @remote_visitor ||= TestTrack::Remote::Visitor.find(id) unless tt_offline?
+    @remote_visitor ||= _remote_visitor
+  end
+
+  def _remote_visitor
+    unless tt_offline?
+      TestTrack::Remote::Visitor.find(id).tap do |_|
+        @loaded = true
+      end
+    end
   rescue *TestTrack::SERVER_ERRORS => e
     Rails.logger.error "TestTrack failed to load remote visitor. #{e}"
     @tt_offline = true

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "4.0.0.alpha7" # rubocop:disable Style/MutableConstant
+  VERSION = "4.0.0.alpha8" # rubocop:disable Style/MutableConstant
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_track_rails_client
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha7
+  version: 4.0.0.alpha8
 platform: ruby
 authors:
 - Ryan O'Neill
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-01 00:00:00.000000000 Z
+date: 2018-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: airbrake
@@ -268,6 +268,7 @@ files:
 - app/models/test_track/fake/visitor_detail.rb
 - app/models/test_track/fake_server.rb
 - app/models/test_track/identity_session_locator.rb
+- app/models/test_track/lazy_visitor_by_identity.rb
 - app/models/test_track/misconfiguration_notifier.rb
 - app/models/test_track/notify_assignment_job.rb
 - app/models/test_track/offline_session.rb
@@ -283,7 +284,8 @@ files:
 - app/models/test_track/remote/visitor.rb
 - app/models/test_track/remote/visitor_detail.rb
 - app/models/test_track/session.rb
-- app/models/test_track/session_identity_collection.rb
+- app/models/test_track/session_visitor_repository.rb
+- app/models/test_track/threaded_visitor_notifier.rb
 - app/models/test_track/unsynced_assignments_notifier.rb
 - app/models/test_track/variant_calculator.rb
 - app/models/test_track/vary_dsl.rb

data/app/models/test_track/session_identity_collection.rb

@@ -1,29 +0,0 @@
-class TestTrack::SessionIdentityCollection
-  def initialize(controller)
-    @controller = controller
-  end
-
-  def include?(identity)
-    found_identity = identities[identity.test_track_identifier_type] || authenticated_resource_for_identity(identity)
-    found_identity.present? && found_identity == identity
-  end
-
-  def <<(identity)
-    identities[identity.test_track_identifier_type] = identity
-  end
-
-  private
-
-  attr_reader :controller
-
-  def identities
-    @identities ||= {}
-  end
-
-  def authenticated_resource_for_identity(identity)
-    authenticated_resource_method_name = "current_#{identity.class.model_name.element}"
-
-    # pass true to `respond_to?` to include private methods
-    controller.respond_to?(authenticated_resource_method_name, true) && controller.send(authenticated_resource_method_name)
-  end
-end