test_track_rails_client 4.0.0.alpha26 → 4.0.0.alpha27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 596ff103f610714c46450cfe9fd4af2ebad9801d
-  data.tar.gz: 16a03db5fd2c1e88e59b3e9faa3e1ab2c9048fb5
+  metadata.gz: 25d6337d0be0cd4ab5f7bb3206ac57abcf4751a9
+  data.tar.gz: 607743ae3522be134d2842a65e854e0ea698efd1
 SHA512:
-  metadata.gz: 30875ae214ce8afe195a4bc11036d42689c7ff5a8b520921180eb9ae5e9599141520d90c5e97058b65389b62267a13c9185729b72f30e86e7af0be8319c5e1fd
-  data.tar.gz: 9991fc8a58eb4f94243632279ba2304979acd46270048d01ba32ec1cd3622844eead1b9e26d4945991b2245c0034c09b7dee4affa4126b6538178270c177ec44
+  metadata.gz: f3580d4074be4b74748b652abb5559b7147fb26bc1e65e81ee012a3524df94452d68d7283440f56a2b566e597507febff35bed687e34383a6c7653a4a8e33398
+  data.tar.gz: 940014bb4d6506d5f1dabf26924a5d76239b7924f153565170a3444862a8e40651fe5a7962769030c150feef132cc43dfe701cbe14ddc220ae431772b75062b2

data/README.md

@@ -369,6 +369,24 @@ mixpanel.init('YOUR MIXPANEL TOKEN', {
 });
 ```
 
+## Misconfiguration notifications
+
+TestTrack provides hooks to easily integrate with your preferred error catching tool to receive notifications when we detect a misconfiguration in split usage. TestTrack has built-in support for `Airbrake`. By default, if you've included the `airbrake` gem, TestTrack will use `Airbrake` as a misconfiguration notifier backend. If you wish to use another tool, you can set the `misconfiguration_notifier` attribute on `TestTrack` with your custom client. You should do this in a Rails initializer.
+
+```ruby
+# config/initializers/test_track.rb
+TestTrack.misconfiguration_notifier = MyCustomMisconfigurationNotifier.new
+```
+
+Your client must implement the following methods:
+
+```ruby
+# Called when a Split misconfiguration is detected
+#
+# @param string message describing the misconfiguration
+def notify(message)
+```
+
 ## Upgrading
 
 ### From 3.0 to 4.0

data/Rakefile

@@ -33,7 +33,7 @@ task :vendor_deps do
   sh 'cp', 'bower_components/test_track_js_client/dist/testTrack.bundle.min.js', 'app/assets/javascripts'
 
   # Download testtrack-cli
-  TEST_TRACK_CLI_VERSION = 'v0.9.7'.freeze
+  TEST_TRACK_CLI_VERSION = 'v1.0.0'.freeze
 
   FileUtils.module_eval do
     mkdir_p 'vendor/bin/testtrack-cli'

data/app/controllers/tt/api/{v1/application_controller.rb → application_controller.rb}

@@ -1,4 +1,4 @@
-class Tt::Api::V1::ApplicationController < ActionController::Base
+class Tt::Api::ApplicationController < ActionController::Base
   before_action :return_json
 
   private

data/app/controllers/tt/api/v1/assignments_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::AssignmentsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::AssignmentsController < Tt::Api::ApplicationController
   def create
     head :no_content
   end

data/app/controllers/tt/api/v1/identifier_types_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::IdentifierTypesController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::IdentifierTypesController < Tt::Api::ApplicationController
   def create
     head :no_content
   end

data/app/controllers/tt/api/v1/identifier_visitors_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::IdentifierVisitorsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::IdentifierVisitorsController < Tt::Api::ApplicationController
   def show
     @visitor = TestTrack::FakeServer.visitor
   end

data/app/controllers/tt/api/v1/identifiers_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::IdentifiersController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::IdentifiersController < Tt::Api::ApplicationController
   def create
     @visitor = TestTrack::FakeServer.visitor
   end

data/app/controllers/tt/api/v1/resets_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::ResetsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::ResetsController < Tt::Api::ApplicationController
   def update
     TestTrack::FakeServer.reset!(seed)
     head :no_content

data/app/controllers/tt/api/v1/split_configs_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::SplitConfigsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::SplitConfigsController < Tt::Api::ApplicationController
   def create
     head :no_content
   end

data/app/controllers/tt/api/v1/split_details_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::SplitDetailsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::SplitDetailsController < Tt::Api::ApplicationController
   def show
     @split_detail = TestTrack::FakeServer.split_details(params[:id])
   end

data/app/controllers/tt/api/v1/visitor_details_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::VisitorDetailsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::VisitorDetailsController < Tt::Api::ApplicationController
   def show
     render json: TestTrack::FakeServer.visitor_details
   end

data/app/controllers/tt/api/v1/visitors_controller.rb

@@ -1,4 +1,4 @@
-class Tt::Api::V1::VisitorsController < Tt::Api::V1::ApplicationController
+class Tt::Api::V1::VisitorsController < Tt::Api::ApplicationController
   def show
     @visitor = TestTrack::FakeServer.visitor
   end

data/app/models/test_track/ab_configuration.rb

@@ -42,7 +42,7 @@ class TestTrack::ABConfiguration
   end
 
   def split
-    split_registry && split_registry[split_name]
+    split_registry && split_registry['splits'][split_name] && split_registry['splits'][split_name]['weights']
   end
 
   def split_variants
@@ -58,6 +58,6 @@ class TestTrack::ABConfiguration
   end
 
   def misconfiguration_notifier
-    @misconfiguration_notifier ||= TestTrack::MisconfigurationNotifier.new
+    @misconfiguration_notifier ||= TestTrack.misconfiguration_notifier
   end
 end

data/app/models/test_track/fake/split_registry.rb

@@ -5,13 +5,17 @@ class TestTrack::Fake::SplitRegistry
     @instance ||= new
   end
 
+  def self.reset!
+    @instance = nil
+  end
+
   def to_h
-    @to_h ||= splits_with_deterministic_weights
+    @to_h ||= split_registry_with_deterministic_weights
   end
 
   def splits
-    to_h.map do |split, registry|
-      Split.new(split, registry)
+    to_h['splits'].map do |split_name, registry|
+      Split.new(split_name, registry['weights'])
     end
   end
 
@@ -63,8 +67,8 @@ class TestTrack::Fake::SplitRegistry
     ENV["TEST_TRACK_SCHEMA_FILE_PATH"] || Rails.root.join('db', 'test_track_schema.yml').to_s
   end
 
-  def splits_with_deterministic_weights
-    split_hash.each_with_object({}) do |(split_name, weighting_registry), split_registry|
+  def split_registry_with_deterministic_weights
+    splits = split_hash.each_with_object({}) do |(split_name, weighting_registry), result|
       default_variant = weighting_registry.keys.sort.first
 
       adjusted_weights = { default_variant => 100 }
@@ -72,7 +76,8 @@ class TestTrack::Fake::SplitRegistry
         adjusted_weights[variant] = 0
       end
 
-      split_registry[split_name] = adjusted_weights
+      result[split_name] = { 'weights' => adjusted_weights, 'feature_gate' => split_name.end_with?('_enabled') }
     end
+    { 'splits' => splits, 'experience_sampling_weight' => 1 }
   end
 end

data/app/models/test_track/fake/visitor.rb

@@ -9,6 +9,7 @@ class TestTrack::Fake::Visitor
 
   def self.reset!
     @instance = nil
+    TestTrack::Fake::SplitRegistry.reset!
   end
 
   def initialize(id)
@@ -26,7 +27,7 @@ class TestTrack::Fake::Visitor
   private
 
   def _assignments
-    split_registry.keys.map do |split_name|
+    split_registry['splits'].keys.map do |split_name|
       variant = TestTrack::VariantCalculator.new(visitor: self, split_name: split_name).variant
       Assignment.new(split_name, variant, false, "the_context")
     end

data/app/models/test_track/fake_server.rb

@@ -1,9 +1,5 @@
 class TestTrack::FakeServer
   class << self
-    def split_registry
-      TestTrack::Fake::SplitRegistry.instance.splits
-    end
-
     def split_details(name)
       TestTrack::Fake::SplitDetail.new(name).details
     end

data/app/models/test_track/misconfiguration_notifier.rb

@@ -1,13 +1,32 @@
-class TestTrack::MisconfigurationNotifier
-  def notify(msg)
-    raise msg if Rails.env.development?
+module TestTrack::MisconfigurationNotifier
+  class Wrapper
+    attr_reader :underlying
 
-    Rails.logger.error(msg)
+    def initialize(underlying = Null.new)
+      @underlying = underlying
+    end
+
+    def notify(msg)
+      raise msg if Rails.env.development?
+
+      Rails.logger.error(msg)
+
+      underlying.notify(msg)
+    end
+  end
+
+  class Null
+    def notify(_); end
+  end
 
-    if Airbrake.respond_to?(:notify_or_ignore)
-      Airbrake.notify_or_ignore(StandardError.new, error_message: msg)
-    else
-      Airbrake.notify(StandardError.new, error_message: msg)
+  class Airbrake
+    def notify(msg)
+      raise "Aibrake was configured but not found" unless defined?(::Airbrake)
+      if ::Airbrake.respond_to?(:notify_or_ignore)
+        ::Airbrake.notify_or_ignore(StandardError.new, error_message: msg)
+      else
+        ::Airbrake.notify(StandardError.new, error_message: msg)
+      end
     end
   end
 end

data/app/models/test_track/notify_assignment_job.rb

@@ -12,7 +12,7 @@ class TestTrack::NotifyAssignmentJob
   end
 
   def perform
-    tracking_result = track
+    tracking_result = maybe_track
     unless assignment.feature_gate?
       TestTrack::Remote::AssignmentEvent.create!(
         visitor_id: visitor_id,
@@ -25,9 +25,30 @@ class TestTrack::NotifyAssignmentJob
 
   private
 
-  def track
+  def maybe_track
     return "failure" unless TestTrack.enabled?
+    return "success" if skip_analytics_event?
     result = TestTrack.analytics.track(TestTrack::AnalyticsEvent.new(visitor_id, assignment))
     result ? "success" : "failure"
   end
+
+  def skip_analytics_event?
+    assignment.feature_gate? && skip_experience_event?
+  end
+
+  def skip_experience_event?
+    skip_all_experience_events? || !sample_event?
+  end
+
+  def skip_all_experience_events?
+    experience_sampling_weight.zero?
+  end
+
+  def experience_sampling_weight
+    @experience_sampling_weight ||= TestTrack::Remote::SplitRegistry.experience_sampling_weight
+  end
+
+  def sample_event?
+    Kernel.rand(experience_sampling_weight).zero?
+  end
 end

data/app/models/test_track/remote/split_registry.rb

@@ -3,35 +3,45 @@ class TestTrack::Remote::SplitRegistry
 
   CACHE_KEY = 'test_track_split_registry'.freeze
 
-  collection_path '/api/v1/split_registry'
+  collection_path '/api/v2/split_registry'
 
-  def self.fake_instance_attributes(_)
-    ::TestTrack::Fake::SplitRegistry.instance.to_h
-  end
+  class << self
+    def fake_instance_attributes(_)
+      ::TestTrack::Fake::SplitRegistry.instance.to_h
+    end
 
-  def self.instance
-    # TODO: FakeableHer needs to make this faking a feature of `get`
-    if faked?
-      new(fake_instance_attributes(nil))
-    else
-      get('/api/v1/split_registry')
+    def instance
+      # TODO: FakeableHer needs to make this faking a feature of `get`
+      if faked?
+        new(fake_instance_attributes(nil))
+      else
+        get('/api/v2/split_registry')
+      end
     end
-  end
 
-  def self.reset
-    Rails.cache.delete(CACHE_KEY)
-  end
+    def reset
+      Rails.cache.delete(CACHE_KEY)
+    end
+
+    def to_hash
+      if faked?
+        instance.attributes.freeze
+      else
+        fetch_cache { instance.attributes }.freeze
+      end
+    rescue *TestTrack::SERVER_ERRORS => e
+      Rails.logger.error "TestTrack failed to load split registry. #{e}"
+      fetch_cache { nil } # cache the missing registry for 5 seconds if we can't get one
+    end
+
+    def experience_sampling_weight
+      to_hash.fetch('experience_sampling_weight')
+    end
+
+    private
 
-  def self.to_hash
-    if faked?
-      instance.attributes.freeze
-    else
-      Rails.cache.fetch(CACHE_KEY, expires_in: 5.seconds) {
-        instance.attributes
-      }.freeze
+    def fetch_cache(&block)
+      Rails.cache.fetch(CACHE_KEY, expires_in: 5.seconds, &block)
     end
-  rescue *TestTrack::SERVER_ERRORS => e
-    Rails.logger.error "TestTrack failed to load split registry. #{e}"
-    nil # if we can't get a split registry
   end
 end

data/app/models/test_track/session.rb

@@ -31,7 +31,7 @@ class TestTrack::Session
       url: TestTrack.url,
       cookieDomain: cookie_domain,
       cookieName: visitor_cookie_name,
-      registry: current_visitor.split_registry,
+      registry: current_visitor.v1_split_registry,
       assignments: current_visitor.assignment_json
     }
   end

data/app/models/test_track/variant_calculator.rb

@@ -31,7 +31,8 @@ class TestTrack::VariantCalculator
   end
 
   def weighting
-    @weighting ||= split_registry[split_name] || raise("TestTrack split '#{split_name}' not found. Need to write/run a migration?")
+    @weighting ||= (split_registry['splits'][split_name] && split_registry['splits'][split_name]['weights']) ||
+      raise("TestTrack split '#{split_name}' not found. Need to write/run a migration?")
   end
 
   def assignment_bucket

data/app/models/test_track/vary_dsl.rb

@@ -34,7 +34,7 @@ class TestTrack::VaryDSL
   delegate :split_name, to: :assignment
 
   def split
-    split_registry && split_registry[split_name]
+    split_registry && split_registry['splits'][split_name] && split_registry['splits'][split_name]['weights']
   end
 
   def split_variants
@@ -46,7 +46,7 @@ class TestTrack::VaryDSL
   end
 
   def misconfiguration_notifier
-    @misconfiguration_notifier ||= TestTrack::MisconfigurationNotifier.new
+    @misconfiguration_notifier ||= TestTrack.misconfiguration_notifier
   end
 
   def variant_behaviors

data/app/models/test_track/visitor.rb

@@ -67,6 +67,12 @@ class TestTrack::Visitor
     @split_registry ||= TestTrack::Remote::SplitRegistry.to_hash
   end
 
+  def v1_split_registry
+    @v1_split_registry ||= split_registry && split_registry['splits'].each_with_object({}) do |(k, v), result|
+      result[k] = v['weights']
+    end
+  end
+
   def link_identity!(identity)
     opts = identifier_opts(identity)
     begin
@@ -154,6 +160,6 @@ class TestTrack::Visitor
     app_name = URI.parse(TestTrack.private_url).user
     split_name = split_name.to_s
     prefixed = "#{app_name}.#{split_name}"
-    split_registry.key?(prefixed) ? prefixed : split_name
+    split_registry['splits'].key?(prefixed) ? prefixed : split_name
   end
 end

data/config/routes.rb

@@ -3,8 +3,6 @@ Rails.application.routes.draw do
     namespace :tt do
       namespace :api do
         namespace :v1 do
-          resource :split_registry, only: :show
-
           resource :assignment, only: :create
 
           resource :identifier, only: :create

data/lib/test_track.rb

@@ -21,16 +21,36 @@ module TestTrack
 
   class << self
     def analytics
-      @analytics ||= wrapper(mixpanel)
+      @analytics ||= analytics_wrapper(mixpanel)
     end
 
     def analytics=(client)
-      @analytics = client.is_a?(TestTrack::Analytics::SafeWrapper) ? client : wrapper(client)
+      @analytics = client.is_a?(TestTrack::Analytics::SafeWrapper) ? client : analytics_wrapper(client)
+    end
+
+    def misconfiguration_notifier
+      @misconfiguration_notifier ||= TestTrack::MisconfigurationNotifier::Wrapper.new(default_notifier)
+    end
+
+    def misconfiguration_notifier=(notifier)
+      @misconfiguration_notifier = if notifier.is_a?(TestTrack::MisconfigurationNotifier::Wrapper)
+                                     notifier
+                                   else
+                                     TestTrack::MisconfigurationNotifier::Wrapper.new(notifier)
+                                   end
     end
 
     private
 
-    def wrapper(client)
+    def default_notifier
+      if defined?(::Airbrake)
+        TestTrack::MisconfigurationNotifier::Airbrake.new
+      else
+        TestTrack::MisconfigurationNotifier::Null.new
+      end
+    end
+
+    def analytics_wrapper(client)
       TestTrack::Analytics::SafeWrapper.new(client)
     end
 

data/lib/test_track_rails_client/assignment_helper.rb

@@ -2,16 +2,18 @@ module TestTrackRailsClient::AssignmentHelper
   def stub_test_track_assignments(assignment_registry) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     raise "Cannot stub test track assignments when TestTrack is enabled" if TestTrack.enabled?
 
-    split_registry = TestTrack::Fake::SplitRegistry.instance.to_h.dup
+    split_registry = TestTrack::Fake::SplitRegistry.instance.to_h.deep_dup
     assignments = []
     app_name = URI.parse(TestTrack.private_url).user
 
     assignment_registry.each do |split_name, variant|
       prefixed_split_name = "#{app_name}.#{split_name}"
-      if split_registry.key?(prefixed_split_name)
+      if split_registry['splits'].key?(prefixed_split_name)
         assignments << { split_name: prefixed_split_name, variant: variant.to_s, unsynced: false }
       else
-        split_registry[split_name] = { variant => 100 } unless split_registry[split_name]
+        unless split_registry['splits'][split_name]
+          split_registry['splits'][split_name.to_s] = { weights: { variant.to_s => 100 }, feature_gate: false }
+        end
         assignments << { split_name: split_name.to_s, variant: variant.to_s, unsynced: false }
       end
     end

data/lib/test_track_rails_client/engine.rb

@@ -1,8 +1,17 @@
 require 'delayed_job'
-require 'airbrake'
+
+begin
+  require 'airbrake'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
 unless defined?(Delayed::Plugins::Airbrake) && Delayed::Worker.plugins.include?(Delayed::Plugins::Airbrake)
-  require 'delayed-plugins-airbrake'
+  begin
+    require 'delayed-plugins-airbrake'
+  rescue LoadError # rubocop:disable Lint/HandleExceptions
+  end
 end
+
 require 'test_track'
 
 module TestTrackRailsClient

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "4.0.0.alpha26" # rubocop:disable Style/MutableConstant
+  VERSION = "4.0.0.alpha27" # 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.alpha26
+  version: 4.0.0.alpha27
 platform: ruby
 authors:
 - Ryan O'Neill
@@ -13,36 +13,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: airbrake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: delayed-plugins-airbrake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement
@@ -255,7 +227,7 @@ files:
 - Rakefile
 - app/assets/javascripts/testTrack.bundle.min.js
 - app/controllers/concerns/test_track/controller.rb
-- app/controllers/tt/api/v1/application_controller.rb
+- app/controllers/tt/api/application_controller.rb
 - app/controllers/tt/api/v1/assignments_controller.rb
 - app/controllers/tt/api/v1/identifier_types_controller.rb
 - app/controllers/tt/api/v1/identifier_visitors_controller.rb
@@ -263,7 +235,6 @@ files:
 - app/controllers/tt/api/v1/resets_controller.rb
 - app/controllers/tt/api/v1/split_configs_controller.rb
 - app/controllers/tt/api/v1/split_details_controller.rb
-- app/controllers/tt/api/v1/split_registries_controller.rb
 - app/controllers/tt/api/v1/visitor_details_controller.rb
 - app/controllers/tt/api/v1/visitors_controller.rb
 - app/helpers/test_track/application_helper.rb
@@ -310,7 +281,6 @@ files:
 - app/views/tt/api/v1/identifier_visitors/show.json.jbuilder
 - app/views/tt/api/v1/identifiers/create.json.jbuilder
 - app/views/tt/api/v1/split_details/show.json.jbuilder
-- app/views/tt/api/v1/split_registries/show.json.jbuilder
 - app/views/tt/api/v1/visitors/_show.json.jbuilder
 - app/views/tt/api/v1/visitors/show.json.jbuilder
 - config/initializers/test_track_api.rb

data/app/controllers/tt/api/v1/split_registries_controller.rb

@@ -1,5 +0,0 @@
-class Tt::Api::V1::SplitRegistriesController < Tt::Api::V1::ApplicationController
-  def show
-    @active_splits = TestTrack::FakeServer.split_registry
-  end
-end

data/app/views/tt/api/v1/split_registries/show.json.jbuilder

@@ -1,3 +0,0 @@
-@active_splits.each do |split|
-  json.set! split.name, split.registry
-end