Add ab_record_extra_info to allow record extra info to alternative and display on dashboard. (#460)

Author: tranngocsam

lib/split/alternative.rb

@@ -8,6 +8,7 @@ class Alternative
     attr_accessor :name
     attr_accessor :experiment_name
     attr_accessor :weight
+    attr_accessor :recorded_info
 
     include Zscore
 
@@ -127,10 +128,37 @@ def z_score(goal = nil)
       z_score = Split::Zscore.calculate(p_a, n_a, p_c, n_c)
     end
 
+    def extra_info
+      data = Split.redis.hget(key, 'recorded_info')
+      if data && data.length > 1
+        begin
+          JSON.parse(data)
+        rescue
+          {}
+        end
+      else
+        {}
+      end
+    end
+
+    def record_extra_info(k, value = 1)
+      @recorded_info = self.extra_info || {}
+
+      if value.kind_of?(Numeric)
+        @recorded_info[k] ||= 0
+        @recorded_info[k] += value
+      else
+        @recorded_info[k] = value
+      end
+
+      Split.redis.hset key, 'recorded_info', (@recorded_info || {}).to_json
+    end
+
     def save
       Split.redis.hsetnx key, 'participant_count', 0
       Split.redis.hsetnx key, 'completed_count', 0
       Split.redis.hsetnx key, 'p_winner', p_winner
+      Split.redis.hsetnx key, 'recorded_info', (@recorded_info || {}).to_json
     end
 
     def validate!
@@ -140,7 +168,7 @@ def validate!
     end
 
     def reset
-      Split.redis.hmset key, 'participant_count', 0, 'completed_count', 0
+      Split.redis.hmset key, 'participant_count', 0, 'completed_count', 0, 'recorded_info', nil
       unless goals.empty?
         goals.each do |g|
           field = "completed_count:#{g}"

lib/split/dashboard/views/_experiment.erb

@@ -5,6 +5,25 @@
 <% end %>
 
 <% experiment.calc_winning_alternatives %>
+<%
+  extra_columns = []
+  experiment.alternatives.each do |alternative|
+    extra_info = alternative.extra_info || {}
+    extra_columns += extra_info.keys
+  end
+
+  extra_columns.uniq!
+  summary_texts = {}
+  extra_columns.each do |column|
+    extra_infos = experiment.alternatives.map(&:extra_info).select{|extra_info| extra_info && extra_info[column] }
+    if extra_infos[0][column].kind_of?(Numeric)
+      summary_texts[column] = extra_infos.inject(0){|sum, extra_info| sum += extra_info[column]}
+    else
+      summary_texts[column] = "N/A"
+    end
+  end
+%>
+
 
 <div class="<%= experiment_class %>" data-name="<%= experiment.name %>" data-complete="<%= experiment.has_winner? %>">
   <div class="experiment-header">
@@ -32,6 +51,9 @@
       <th>Non-finished</th>
       <th>Completed</th>
       <th>Conversion Rate</th>
+      <% extra_columns.each do |column| %>
+        <th><%= column %></th>
+      <% end %>
       <th>
         <form>
           <select id="dropdown-<%=experiment.jstring(goal)%>" name="dropdown-<%=experiment.jstring(goal)%>">
@@ -82,6 +104,9 @@
             });
           });
         </script>
+        <% extra_columns.each do |column| %>
+          <td><%= alternative.extra_info && alternative.extra_info[column] %></td>
+        <% end %>
         <td>
           <div class="box-<%=experiment.jstring(goal)%> confidence-<%=experiment.jstring(goal)%>">
             <span title='z-score: <%= round(alternative.z_score(goal), 3) %>'><%= confidence_level(alternative.z_score(goal)) %></span>
@@ -90,7 +115,7 @@
           <div class="box-<%=experiment.jstring(goal)%> probability-<%=experiment.jstring(goal)%>">
             <span title="p_winner: <%= round(alternative.p_winner(goal), 3) %>"><%= number_to_percentage(round(alternative.p_winner(goal), 3)) %>%</span>
           </div>
-        </td>        
+        </td>
         <td>
           <% if experiment.has_winner? %>
             <% if experiment.winner.name == alternative.name %>
@@ -118,6 +143,11 @@
       <td><%= total_unfinished %></td>
       <td><%= total_completed %></td>
       <td>N/A</td>
+      <% extra_columns.each do |column| %>
+        <td>
+          <%= summary_texts[column] %>
+        </td>
+      <% end %>
       <td>N/A</td>
       <td>N/A</td>
     </tr>

lib/split/helper.rb

@@ -76,6 +76,26 @@ def ab_finished(metric_descriptor, options = {:reset => true})
       Split.configuration.db_failover_on_db_error.call(e)
     end
 
+    def ab_record_extra_info(metric_descriptor, key, value = 1)
+      return if exclude_visitor? || Split.configuration.disabled?
+      metric_descriptor, goals = normalize_metric(metric_descriptor)
+      experiments = Metric.possible_experiments(metric_descriptor)
+
+      if experiments.any?
+        experiments.each do |experiment|
+          alternative_name = ab_user[experiment.key]
+
+          if alternative_name
+            alternative = experiment.alternatives.find{|alt| alt.name == alternative_name}
+            alternative.record_extra_info(key, value) if alternative
+          end
+        end
+      end
+    rescue => e
+      raise unless Split.configuration.db_failover
+      Split.configuration.db_failover_on_db_error.call(e)
+    end
+
     def override_present?(experiment_name)
       override_alternative(experiment_name)
     end

spec/alternative_spec.rb

@@ -274,4 +274,35 @@
       expect(control.z_score(goal2)).to eq('N/A')
     end
   end
+
+  describe "extra_info" do
+    it "reads saved value of recorded_info in redis" do
+      saved_recorded_info = {"key_1" => 1, "key_2" => "2"}
+      Split.redis.hset "#{alternative.experiment_name}:#{alternative.name}", 'recorded_info', saved_recorded_info.to_json
+      extra_info = alternative.extra_info
+
+      expect(extra_info).to eql(saved_recorded_info)
+    end
+  end
+
+  describe "record_extra_info" do
+    it "saves key" do
+      alternative.record_extra_info("signup", 1)
+      expect(alternative.extra_info["signup"]).to eql(1)
+    end
+
+    it "adds value to saved key's value second argument is number" do
+      alternative.record_extra_info("signup", 1)
+      alternative.record_extra_info("signup", 2)
+      expect(alternative.extra_info["signup"]).to eql(3)
+    end
+
+    it "sets saved's key value to the second argument if it's a string" do
+      alternative.record_extra_info("signup", "Value 1")
+      expect(alternative.extra_info["signup"]).to eql("Value 1")
+
+      alternative.record_extra_info("signup", "Value 2")
+      expect(alternative.extra_info["signup"]).to eql("Value 2")
+    end
+  end
 end