vanity 2.2.8 → 2.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32b2be75e4a14bf3ce84ba1a49f3ae8b86e6fcf6
-  data.tar.gz: 40c8689393515ddd853df28130eace503b1327cb
+  metadata.gz: ca984620557d326a44e57c76e179701e43c784aa
+  data.tar.gz: 3a27cad8226fbdf3e56709291b1ed2afc1793acd
 SHA512:
-  metadata.gz: 91931eacb3c34fdf4e9caa8c1ca98b62f0e3cbfd521a58ace103eec63177d28fcfe64646db79d25bb1daeac93dda0814c02dc8d665d2509ccaed30a00c230493
-  data.tar.gz: 1604cd40d0e73ac1e26a0ba5eebbeaba98e5efa03e23bb50dde6d279325302e8881852808470c3b170b98345d6f36f6d457fdebd4f578404c7b5620f3a1650fb
+  metadata.gz: 1e3a77b2540e8726b77bc6f5ec80226f39b7f499abd271d2e5bc20c51131998472e0dffa0879cdf799e1a4de7e7b6cc052e1ea2e87b85fc09bb584df21e8293c
+  data.tar.gz: 761fb69735eb0b02e8267a24243bb7cf923ccd8880a14ed691ae55f207aa73c4bed6e5c2566e6179aa264c6defacf519462db3c8106830e5a1432f53607d590c

data/CHANGELOG

@@ -1,5 +1,9 @@
 == Unreleased
 
+== 2.2.9 (2018-02-03)
+
+* Fix race condition using the activerecord adapater when vanity creates experiments or rows in the conversions table (@fcheung)
+
 == 2.2.8 (2017-09-26)
 * Rails 5.1 compatibility (#326, #327, #330, @sebjacobs, @bensheldon, @terracatta)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    vanity (2.2.8)
+    vanity (2.2.9)
       i18n
 
 GEM

data/README.md

@@ -9,13 +9,34 @@ Vanity is an A/B testing framework for Rails that is datastore agnostic.
 
 [![Dashboard](doc/images/sidebar_test.png)](http://github.com/assaf/vanity)
 
-## A/B Testing With Rails
-
-### **Step 1:** Start using Vanity in your Rails application
-
-#### Step 1.1
-
-##### Rails 3 & Rails 4 installation
+<!-- toc -->
+
+- [Installation](#installation)
+- [Setup](#setup)
+  * [Datastore](#datastore)
+    + [Redis Setup](#redis-setup)
+    + [MongoDB Setup](#mongodb-setup)
+    + [SQL Database Setup](#sql-database-setup)
+    + [Forking servers and reconnecting](#forking-servers-and-reconnecting)
+  * [Initialization](#initialization)
+  * [User identification](#user-identification)
+    + [Rails](#rails)
+    + [Other](#other)
+  * [Define a A/B test](#define-a-ab-test)
+  * [Present the different options to your users](#present-the-different-options-to-your-users)
+  * [Measure conversion](#measure-conversion)
+  * [Check the report](#check-the-report)
+    + [Rails report dashboard](#rails-report-dashboard)
+- [Registering participants with Javascript](#registering-participants-with-javascript)
+- [Compatibility](#compatibility)
+- [Testing](#testing)
+- [Updating documentation](#updating-documentation)
+- [Contributing](#contributing)
+- [Credits/License](#creditslicense)
+
+<!-- tocstop -->
+
+## Installation
 
 Add to your Gemfile:
 
@@ -26,14 +47,16 @@ gem "vanity"
 (For support for older versions of Rails and Ruby 1.8, please see the [1.9.x
 branch](https://github.com/assaf/vanity/tree/1-9-stable).)
 
-#### Step 1.2
+## Setup
+
+### Datastore
 
 Choose a datastore that best fits your needs and preferences for storing
 experiment results. Choose one of: Redis, MongoDB or an SQL database. While
 Redis is usually faster, it may add additional complexity to your stack.
 Datastores should be configured using a `config/vanity.yml`.
 
-##### Redis Setup
+#### Redis Setup
 
 Add to your Gemfile:
 
@@ -73,7 +96,7 @@ Vanity.connect!(
 )
 ```
 
-##### MongoDB Setup
+#### MongoDB Setup
 
 Add to your Gemfile:
 
@@ -94,7 +117,7 @@ production:
   database: analytics
 ```
 
-##### SQL Database Setup
+#### SQL Database Setup
 
 Vanity supports multiple SQL stores (like MySQL, MariaDB, Postgres, Sqlite,
 etc.) using ActiveRecord, which is built into Rails. If you're using
@@ -133,7 +156,7 @@ $ rails generate vanity
 $ rake db:migrate
 ```
 
-##### Forking servers and reconnecting
+#### Forking servers and reconnecting
 
 If you're using a forking server (like Passenger or Unicorn), you should
 reconnect after a new worker is created:
@@ -165,7 +188,25 @@ Vanity.connect!(
 )
 ```
 
-#### Step 1.3
+### Initialization
+
+If you're using Rails, this is done automagically. Otherwise, some manual setup is required, for example on an app's booting:
+
+```
+$redis = Redis.new # or from elsewhere
+Vanity.configure do |config|
+  # ... any config
+end
+Vanity.connect!(
+  adapter: :redis,
+  redis: $redis
+)
+Vanity.load!
+```
+
+### User identification
+
+#### Rails
 
 Turn Vanity on, and pass a reference to a method that identifies a user. For
 example:
@@ -179,7 +220,28 @@ end
 For more information, please see the [identity
 documentation](http://vanity.labnotes.org/identity.html).
 
-### **Step 2:** Define your first A/B test
+#### Other
+
+Vanity pulls the identity from a "context" object that responds to `vanity_identity`, so we need to define a `Vanity.context` (this is how the [ActionMailer integration](https://github.com/assaf/vanity/blob/master/lib/vanity/frameworks/rails.rb#L107-L133) works):
+
+```
+class AVanityContext
+  def vanity_identity
+    "123"
+  end
+end
+
+Vanity.context = AVanityContext.new() # Any object that responds to `#vanity_identity`
+```
+
+If you're using plain ruby objects, you could also alias something in your identity model to respond similarly and then set that as the vanity context:
+```
+class User
+  alias_method :vanity_identity, :id
+end
+```
+
+### Define a A/B test
 
 This experiment goes in the file `experiments/price_options.rb`:
 
@@ -200,15 +262,25 @@ metric "Signup (Activation)" do
 end
 ```
 
-### **Step 3:** Present the different options to your users
+### Present the different options to your users
+
+In Rails' templates, this is straightforward:
 
 ```erb
 <h2>Get started for only $<%= ab_test :price_options %> a month!</h2>
 ```
 
-### **Step 4:** Measure conversion
+Outside of templates:
 
-Conversions are created via the `Vanity.track!` method. For example:
+```
+Vanity.ab_test(:invite_subject)
+```
+
+### Measure conversion
+
+Conversions are created via the `Vanity.track!` method. A user should already be added to an experiment, via `ab_test` before this is called - otherwise, the conversion will be tracked, but the user will not be added to the experiment.
+
+For example, in Rails:
 
 ```ruby
 class SignupController < ApplicationController
@@ -224,12 +296,26 @@ class SignupController < ApplicationController
 end
 ```
 
-### **Step 5:** Check the report:
+Outside of an Rails controller, for example in a Rack handler:
+
+```
+identity_object = Identity.new(env['rack.session'])
+Vanity.track!(:click, {
+  # can be any object that responds to `to_s` with a string
+  # that contains the unique identifier or the string identifier itself
+  :identity=>identity_object,
+  :values=>[1] # optional
+})
+```
+
+### Check the report
 
 ```sh
 vanity report --output vanity.html
 ```
 
+#### Rails report dashboard
+
 To view metrics and experiment results with the dashboard in Rails 3 & Rails
 4:
 

data/gemfiles/rails32.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.2.8)
+    vanity (2.2.9)
       i18n
 
 GEM

data/gemfiles/rails41.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: .././
   specs:
-    vanity (2.2.8)
+    vanity (2.2.9)
       i18n
 
 GEM

data/gemfiles/rails42.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ..
   specs:
-    vanity (2.2.8)
+    vanity (2.2.9)
       i18n
 
 GEM

data/gemfiles/rails42_protected_attributes.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ../
   specs:
-    vanity (2.2.8)
+    vanity (2.2.9)
       i18n
 
 GEM

data/gemfiles/rails5.gemfile.lock

@@ -7,7 +7,7 @@ GIT
 PATH
   remote: ../
   specs:
-    vanity (2.2.8)
+    vanity (2.2.9)
       i18n
 
 GEM

data/lib/generators/templates/add_unique_indexes_migration.rb

@@ -0,0 +1,28 @@
+require "vanity/adapters/active_record_adapter"
+
+class AddVanityUniqueIndexes < ActiveRecord::Migration
+  # Helper methods to ensure we're connecting to the right database, see
+  # https://github.com/assaf/vanity/issues/295.
+
+  def connection
+    @connection ||= ActiveRecord::Base.connection
+  end
+  alias_method :default_connection, :connection
+
+  def with_vanity_connection
+    @connection = Vanity::Adapters::ActiveRecordAdapter::VanityRecord.connection
+    yield
+    @connection = default_connection
+  end
+
+  def change
+    with_vanity_connection do
+      remove_index :vanity_experiments, [:experiment_id]
+      add_index :vanity_experiments, [:experiment_id], :unique => true
+
+      remove_index :vanity_conversions, :name => "by_experiment_id_and_alternative", :unique => true
+      add_index :vanity_conversions, [:vanity_experiment_id, :alternative], :name => "by_experiment_id_and_alternative", :unique => true
+    end
+  end
+
+end

data/lib/generators/templates/vanity_migration.rb

@@ -1,3 +1,5 @@
+require "vanity/adapters/active_record_adapter"
+
 class VanityMigration < ActiveRecord::Migration
   # Helper methods to ensure we're connecting to the right database, see
   # https://github.com/assaf/vanity/issues/295.
@@ -36,14 +38,14 @@ class VanityMigration < ActiveRecord::Migration
         t.datetime :created_at
         t.datetime :completed_at
       end
-      add_index :vanity_experiments, [:experiment_id]
+      add_index :vanity_experiments, [:experiment_id], :unique => true
 
       create_table :vanity_conversions do |t|
         t.integer :vanity_experiment_id
         t.integer :alternative
         t.integer :conversions
       end
-      add_index :vanity_conversions, [:vanity_experiment_id, :alternative], :name => "by_experiment_id_and_alternative"
+      add_index :vanity_conversions, [:vanity_experiment_id, :alternative], :name => "by_experiment_id_and_alternative", :unique => true
 
       create_table :vanity_participants do |t|
         t.string :experiment_id

data/lib/generators/vanity/add_unique_indexes_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class Vanity::AddUniqueIndexesGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+  def create_model_file
+    migration_template "add_unique_indexes_migration.rb", "db/migrate/add_vanity_unique_indexes.rb"
+  end
+end

data/lib/vanity/adapters/active_record_adapter.rb

@@ -19,10 +19,20 @@ module Vanity
         end
 
         def self.rails_agnostic_find_or_create_by(method, value)
-          if respond_to? :find_or_create_by
-            find_or_create_by(method => value)
-          else
-            send :"find_or_create_by_#{method}", value
+          retried = false
+          begin
+            if respond_to? :find_or_create_by
+              find_or_create_by(method => value)
+            else
+              send :"find_or_create_by_#{method}", value
+            end
+          rescue ActiveRecord::RecordNotUnique
+            if retried
+              raise
+            else
+              retried = true
+              retry
+            end
           end
         end
       end

data/lib/vanity/version.rb

@@ -1,5 +1,5 @@
 module Vanity
-  VERSION = "2.2.8"
+  VERSION = "2.2.9"
 
   module Version
     version = VERSION.to_s.split(".").map { |i| i.to_i }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vanity
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.2.9
 platform: ruby
 authors:
 - Assaf Arkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -177,7 +177,9 @@ files:
 - gemfiles/rails42_protected_attributes.gemfile.lock
 - gemfiles/rails5.gemfile
 - gemfiles/rails5.gemfile.lock
+- lib/generators/templates/add_unique_indexes_migration.rb
 - lib/generators/templates/vanity_migration.rb
+- lib/generators/vanity/add_unique_indexes_generator.rb
 - lib/generators/vanity/views_generator.rb
 - lib/generators/vanity_generator.rb
 - lib/vanity.rb
@@ -290,7 +292,7 @@ metadata: {}
 post_install_message: To get started run vanity --help
 rdoc_options:
 - "--title"
-- Vanity 2.2.8
+- Vanity 2.2.9
 - "--main"
 - README.md
 - "--webcvs"