test_track_rails_client 4.0.1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a4e66371e5bfdda4c10e9f0e7ee91fb458bb67e58e624bb2c9349f6d7bfd6a7
-  data.tar.gz: e07a71f4d00429b0ccbb7722c2f247ab23f87e622b04011d4c80c2812a1a5d6e
+  metadata.gz: 1362a616d6ae5b12bf8a7d3a1af3180f069453ffeb87b65863b6833fd544bbfa
+  data.tar.gz: 53a48cb3d727a1b288f0bf49d27438529a6c0a04745096fe89e01e917e847f7d
 SHA512:
-  metadata.gz: ce33a99b61265af0eb5fbc2a8b978d5e383c28e00f294cf2331759690bd6eec296d10d96b6b4e61e51f89488ffebf103eceb67cb4334b840478903bdb8d8f4b0
-  data.tar.gz: 97dc832aa1656acfd345223dfae3f43208e0a6eeb42ef440fe616cdfd631b4c5dd03b627452fe243fce794bae6c210dea32045bdcc67487a6216acadd1b7922f
+  metadata.gz: 100b8fd232c2e51a0bdf7879a7a797852cfa94ebb0ab6236f2eb62fc0c2a15946717f1cb981c25ac278c5173a4da2fba81c52f0c24d2f76f32dd1ef10ea13b2d
+  data.tar.gz: 8719fbe5e2034c70a4b0b4aea2be8fdd251c7e0b0313fac7c5f184ed5797e3fce517434e447e09f06bb1081b476826e788d9408f61f593c3ecef685e5260ba68

data/README.md

@@ -48,6 +48,7 @@ Set up ENV vars in every environment:
 
 * `MIXPANEL_TOKEN` - By default, TestTrack reports to Mixpanel. If you're using a [custom analytics provider](#analytics) you can omit this.
 * `TEST_TRACK_API_URL` - Set this to the URL of your TestTrack instance with your app credentials, e.g. `http://[myapp]:[your new app password]@[your-app-domain]/`
+* `TEST_TRACK_PUBLIC_API_URL` - (optional) If public traffic to TestTrack should use a different host name, set this variable. By default this will use `TEST_TRACK_API_URL` without any credentials
 
   [your-app-domain] can be
   * `testtrack.test`

data/app/jobs/test_track/application_job.rb

@@ -0,0 +1,4 @@
+module TestTrack
+  class ApplicationJob < TestTrack.job_base_class_name.constantize
+  end
+end

data/app/jobs/test_track/assignment_event_job.rb

@@ -0,0 +1,71 @@
+module TestTrack
+  class AssignmentEventJob < ApplicationJob
+    attr_reader :visitor_id, :assignment
+
+    def perform(visitor_id:, split_name:, variant:, context:)
+      raise "visitor_id must be present" if visitor_id.blank?
+      raise "split_name must be present" if visitor_id.blank?
+
+      @visitor_id = visitor_id
+      @assignment = build_assignment(visitor_id, split_name, variant, context)
+
+      create_assignment_event!
+    end
+
+    private
+
+    def build_assignment(visitor_id, split_name, variant, context)
+      assignment = Assignment.new(
+        visitor: Visitor.new(id: visitor_id),
+        split_name: split_name
+      )
+      assignment.variant = variant
+      assignment.context = context
+      assignment
+    end
+
+    def create_assignment_event!
+      tracking_result = maybe_track
+      unless assignment.feature_gate?
+        Remote::AssignmentEvent.create!(
+          visitor_id: visitor_id,
+          split_name: assignment.split_name,
+          context: assignment.context,
+          mixpanel_result: tracking_result
+        )
+      end
+    end
+
+    def maybe_track
+      return "failure" unless TestTrack.enabled?
+      return "success" if skip_analytics_event?
+
+      result = TestTrack.analytics.track(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 sample_event?
+      Kernel.rand(experience_sampling_weight).zero?
+    end
+
+    def experience_sampling_weight
+      @experience_sampling_weight ||= split_registry.experience_sampling_weight
+    end
+
+    def split_registry
+      @split_registry ||= SplitRegistry.from_remote
+    end
+  end
+end

data/app/jobs/test_track/identifier_creation_job.rb

@@ -0,0 +1,11 @@
+module TestTrack
+  class IdentifierCreationJob < ApplicationJob
+    def perform(identifier_type:, visitor_id:, value:)
+      Remote::Identifier.create!(
+        identifier_type: identifier_type,
+        visitor_id: visitor_id,
+        value: value
+      )
+    end
+  end
+end

data/app/models/test_track/unsynced_assignments_notifier.rb

@@ -13,21 +13,21 @@ class TestTrack::UnsyncedAssignmentsNotifier
 
   def notify
     assignments.each do |assignment|
-      build_notify_assignment_job(assignment).tap do |job|
-        job.perform
-      rescue *TestTrack::SERVER_ERRORS => e
-        Rails.logger.error "TestTrack failed to notify unsynced assignments, retrying. #{e}"
-        Delayed::Job.enqueue(build_notify_assignment_job(assignment))
-      end
+      TestTrack::AssignmentEventJob.perform_now assignment_job_args(assignment)
+    rescue *TestTrack::SERVER_ERRORS => e
+      Rails.logger.error "TestTrack failed to notify unsynced assignments, retrying. #{e}"
+      TestTrack::AssignmentEventJob.perform_later assignment_job_args(assignment)
     end
   end
 
   private
 
-  def build_notify_assignment_job(assignment)
-    TestTrack::NotifyAssignmentJob.new(
+  def assignment_job_args(assignment)
+    {
       visitor_id: visitor_id,
-      assignment: assignment
-    )
+      context: assignment.context,
+      split_name: assignment.split_name,
+      variant: assignment.variant
+    }
   end
 end

data/app/models/test_track/visitor.rb

@@ -78,7 +78,7 @@ class TestTrack::Visitor
 
       # 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!(opts)
+      TestTrack::IdentifierCreationJob.perform_later(opts)
     end
   end
 

data/app/models/test_track/web_session.rb

@@ -25,7 +25,7 @@ class TestTrack::WebSession
 
   def state_hash
     {
-      url: TestTrack.url,
+      url: TestTrack.public_url,
       cookieDomain: cookie_domain,
       cookieName: visitor_cookie_name,
       splits: current_visitor.split_registry.to_hash,

data/lib/test_track.rb

@@ -20,6 +20,7 @@ module TestTrack
   BUILD_TIMESTAMP_REGEX = /\A\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d(.\d+)?([+-][0-2]\d:[0-5]\d|Z)\z/.freeze
 
   mattr_accessor :enabled_override, :app_name
+  mattr_accessor(:job_base_class_name) { 'ActiveJob::Base' }
 
   class << self
     def analytics
@@ -115,7 +116,15 @@ module TestTrack
     yield(ConfigUpdater.new)
   end
 
-  def url
+  def public_url
+    ENV['TEST_TRACK_PUBLIC_API_URL'] || _uncredentialed_private_url
+  end
+
+  def private_url
+    ENV['TEST_TRACK_API_URL']
+  end
+
+  def _uncredentialed_private_url
     return nil unless private_url
 
     full_uri = URI.parse(private_url)
@@ -124,10 +133,6 @@ module TestTrack
     full_uri.to_s
   end
 
-  def private_url
-    ENV['TEST_TRACK_API_URL']
-  end
-
   def _build_timestamp
     File.read(BUILD_TIMESTAMP_FILE_PATH).chomp.presence if File.exist?(BUILD_TIMESTAMP_FILE_PATH)
   end

data/lib/test_track_rails_client/engine.rb

@@ -1,19 +1,5 @@
-require 'delayed_job'
-
-begin
-  require 'airbrake'
-rescue LoadError
-  # no-op
-end
-
-unless defined?(Delayed::Plugins::Airbrake) && Delayed::Worker.plugins.include?(Delayed::Plugins::Airbrake)
-  begin
-    require 'delayed-plugins-airbrake'
-  rescue LoadError
-    # no-op
-  end
-end
-
+require 'active_job'
+require 'active_model'
 require 'test_track'
 
 module TestTrackRailsClient

data/lib/test_track_rails_client/version.rb

@@ -1,3 +1,3 @@
 module TestTrackRailsClient
-  VERSION = "4.0.1" # rubocop:disable Style/MutableConstant
+  VERSION = "5.0.1" # rubocop:disable Style/MutableConstant
 end

data/vendor/gems/fakeable_her/fakeable_her.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'her'
-  spec.add_dependency 'rails', '>= 4.1', '< 5.2'
+  spec.add_dependency 'activesupport'
 
   spec.add_development_dependency 'appraisal', '~> 2.2.0'
 end

data/vendor/gems/fakeable_her/lib/fakeable_her/model.rb

@@ -1,6 +1,6 @@
 require 'her'
 require 'active_support/concern'
-require 'rails'
+require 'active_support/callbacks'
 
 module FakeableHer
   module Model

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test_track_rails_client
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 5.0.1
 platform: ruby
 authors:
 - Ryan O'Neill
@@ -13,36 +13,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: delayed_job
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
-  name: delayed_job_active_record
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -106,9 +106,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -116,29 +113,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -153,6 +141,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  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: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -279,20 +281,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -344,6 +332,9 @@ files:
 - app/controllers/tt/api/v1/visitor_details_controller.rb
 - app/controllers/tt/api/v1/visitors_controller.rb
 - app/helpers/test_track/application_helper.rb
+- app/jobs/test_track/application_job.rb
+- app/jobs/test_track/assignment_event_job.rb
+- app/jobs/test_track/identifier_creation_job.rb
 - app/models/concerns/test_track/identity.rb
 - app/models/concerns/test_track/remote_model.rb
 - app/models/concerns/test_track/required_options.rb
@@ -463,7 +454,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Rails client for TestTrack