growthbook 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28649218e25654a513fd965aeed205a4208341c265ea9e06d1b2f6efe9a4b1eb
-  data.tar.gz: 165ef4c260ec96a6c77b47acdfdd218039a7067156b0669d7b44adbf4c30382b
+  metadata.gz: 9f6c9a059b34fad58095b5e0ea6b3710d7b427617a4cd4f9c7ddc8fdebd2a1da
+  data.tar.gz: c93b9e289a8c950dc3cfa5974062634e7c11f6123e7fd5e94f6ff8c88d262566
 SHA512:
-  metadata.gz: aa1bd7678e81a58d64a51a4f9d035c76cb9ee75ae91584b17c6ff92338e543be58935da3542f77c6e3c6d1cc5fcf030eb804a09d547fd8533511474d6c638f4a
-  data.tar.gz: 9600cc883324faa2c7dcbbf4aa26e8469f0952057f3cf4b449c38cb59c0e6cd37eea246943f99750f3d54a1259fdebb622a14ec4b951a957cecf8bd924d107c0
+  metadata.gz: 0f1c46dac7d0e9dccc8641f67d7dbbe8d2af91ec18a4cf0fdcb13701042e0fad55bbcf35b91c330506816fa59cbb0129a8ae5a7f3fb103b308735268f3638937
+  data.tar.gz: c38fe86529984df54ee57560b01591c99a20b616f02d8296e9e81a7c1fc56d6755096c675e96e94a52c57c5e9e77435b497aed2d4a3ebb4c0cdcbd78f7d8085b

data/lib/growthbook/context.rb

@@ -77,7 +77,7 @@ module Growthbook
         # Rollout or forced value rule
         if rule.is_force?
           unless rule.coverage.nil?
-            hash_value = get_attribute(rule.hash_attribute || 'id')
+            hash_value = get_attribute(rule.hash_attribute || 'id').to_s
             next if hash_value.length.zero?
 
             n = Growthbook::Util.hash(hash_value + key)
@@ -89,7 +89,7 @@ module Growthbook
         next unless rule.is_experiment?
 
         exp = rule.to_experiment(key)
-        result = run(exp)
+        result = _run(exp, key)
 
         next unless result.in_experiment
 
@@ -101,36 +101,55 @@ module Growthbook
     end
 
     def run(exp)
+      _run(exp)
+    end
+
+    def on?(key)
+      eval_feature(key).on
+    end
+
+    def off?(key)
+      eval_feature(key).off
+    end
+
+    def feature_value(key, fallback = nil)
+      value = eval_feature(key).value
+      value.nil? ? fallback : value
+    end
+
+    private
+
+    def _run(exp, feature_id="")
       key = exp.key
 
       # 1. If experiment doesn't have enough variations, return immediately
-      return get_experiment_result(exp) if exp.variations.length < 2
+      return get_experiment_result(exp, -1, false, feature_id) if exp.variations.length < 2
 
       # 2. If context is disabled, return immediately
-      return get_experiment_result(exp) unless @enabled
+      return get_experiment_result(exp, -1, false, feature_id) unless @enabled
 
       # 3. If forced via URL querystring
       if @url
         qsOverride = Util.get_query_string_override(key, @url, exp.variations.length)
-        return get_experiment_result(exp, qsOverride) unless qsOverride.nil?
+        return get_experiment_result(exp, qsOverride, false, feature_id) unless qsOverride.nil?
       end
 
       # 4. If variation is forced in the context, return the forced value
-      return get_experiment_result(exp, @forced_variations[key.to_s]) if @forced_variations.key?(key.to_s)
+      return get_experiment_result(exp, @forced_variations[key.to_s], false, feature_id) if @forced_variations.key?(key.to_s)
 
       # 5. Exclude if not active
-      return get_experiment_result(exp) unless exp.active
+      return get_experiment_result(exp, -1, false, feature_id) unless exp.active
 
       # 6. Get hash_attribute/value and return if empty
       hash_attribute = exp.hash_attribute || 'id'
-      hash_value = get_attribute(hash_attribute)
-      return get_experiment_result(exp) if hash_value.length.zero?
+      hash_value = get_attribute(hash_attribute).to_s
+      return get_experiment_result(exp, -1, false, feature_id) if hash_value.length.zero?
 
       # 7. Exclude if user not in namespace
-      return get_experiment_result(exp) if exp.namespace && !Growthbook::Util.in_namespace(hash_value, exp.namespace)
+      return get_experiment_result(exp, -1, false, feature_id) if exp.namespace && !Growthbook::Util.in_namespace(hash_value, exp.namespace)
 
       # 8. Exclude if condition is false
-      return get_experiment_result(exp) if exp.condition && !condition_passes(exp.condition)
+      return get_experiment_result(exp, -1, false, feature_id) if exp.condition && !condition_passes(exp.condition)
 
       # 9. Calculate bucket ranges and choose one
       ranges = Growthbook::Util.get_bucket_ranges(
@@ -142,16 +161,16 @@ module Growthbook
       assigned = Growthbook::Util.choose_variation(n, ranges)
 
       # 10. Return if not in experiment
-      return get_experiment_result(exp) if assigned.negative?
+      return get_experiment_result(exp, -1, false, feature_id) if assigned.negative?
 
       # 11. Experiment has a forced variation
-      return get_experiment_result(exp, exp.force) unless exp.force.nil?
+      return get_experiment_result(exp, exp.force, false, feature_id) unless exp.force.nil?
 
       # 12. Exclude if in QA mode
-      return get_experiment_result(exp) if @qa_mode
+      return get_experiment_result(exp, -1, false, feature_id) if @qa_mode
 
       # 13. Build the result object
-      result = get_experiment_result(exp, assigned, true)
+      result = get_experiment_result(exp, assigned, true, feature_id)
 
       # 14. Fire tracking callback
       track_experiment(exp, result)
@@ -160,21 +179,6 @@ module Growthbook
       result
     end
 
-    def on?(key)
-      eval_feature(key).on
-    end
-
-    def off?(key)
-      eval_feature(key).off
-    end
-
-    def feature_value(key, fallback = nil)
-      value = eval_feature(key).value
-      value.nil? ? fallback : value
-    end
-
-    private
-
     def stringify_keys(hash)
       new_hash = {}
       hash.each do |key, value|
@@ -187,7 +191,7 @@ module Growthbook
       Growthbook::Conditions.eval_condition(@attributes, condition)
     end
 
-    def get_experiment_result(experiment, variation_index = -1, hash_used = false)
+    def get_experiment_result(experiment, variation_index = -1, hash_used = false, feature_id = "")
       in_experiment = true
       if variation_index.negative? || variation_index >= experiment.variations.length
         variation_index = 0
@@ -198,7 +202,7 @@ module Growthbook
       hash_value = get_attribute(hash_attribute)
 
       Growthbook::InlineExperimentResult.new(hash_used, in_experiment, variation_index,
-                                             experiment.variations[variation_index], hash_attribute, hash_value)
+                                             experiment.variations[variation_index], hash_attribute, hash_value, feature_id)
     end
 
     def get_feature_result(value, source, experiment = nil, experiment_result = nil)

data/lib/growthbook/inline_experiment_result.rb

@@ -26,13 +26,16 @@ module Growthbook
     # @return [String]
     attr_reader :hash_value
 
+    attr_reader :feature_id
+
     def initialize(
       hash_used,
       in_experiment,
       variation_id,
       value,
       hash_attribute,
-      hash_value
+      hash_value,
+      feature_id
     )
 
       @hash_used = hash_used
@@ -41,6 +44,7 @@ module Growthbook
       @value = value
       @hash_attribute = hash_attribute
       @hash_value = hash_value
+      @feature_id = feature_id
     end
 
     def to_json(*_args)
@@ -51,6 +55,7 @@ module Growthbook
       res['value'] = @value
       res['hashAttribute'] = @hash_attribute
       res['hashValue'] = @hash_value
+      res['featureId'] = @feature_id.to_s
       res
     end
   end

data/spec/cases.json

@@ -1,4 +1,5 @@
 {
+  "specVersion": "0.2.2",
   "evalCondition": [
     [
       "$not - pass",
@@ -1704,6 +1705,7 @@
           "variations": ["a", "b", "c"]
         },
         "experimentResult": {
+          "featureId": "feature",
           "value": "c",
           "variationId": 2,
           "inExperiment": true,
@@ -1740,6 +1742,7 @@
           "variations": ["a", "b", "c"]
         },
         "experimentResult": {
+          "featureId": "feature",
           "value": "a",
           "variationId": 0,
           "inExperiment": true,
@@ -1776,6 +1779,7 @@
           "variations": ["a", "b", "c"]
         },
         "experimentResult": {
+          "featureId": "feature",
           "value": "b",
           "variationId": 1,
           "inExperiment": true,
@@ -1824,6 +1828,7 @@
           "weights": [0.1, 0.9]
         },
         "experimentResult": {
+          "featureId": "feature",
           "value": false,
           "variationId": 1,
           "inExperiment": true,
@@ -1989,6 +1994,42 @@
         "source": "force"
       }
     ],
+    [
+      "handles integer hashAttribute",
+      {
+        "attributes": { "id": 123 },
+        "features": {
+          "feature": {
+            "defaultValue": 0,
+            "rules": [
+              {
+                "variations": [0, 1]
+              }
+            ]
+          }
+        }
+      },
+      "feature",
+      {
+        "value": 1,
+        "on": true,
+        "off": false,
+        "source": "experiment",
+        "experiment": {
+          "key": "feature",
+          "variations": [0, 1]
+        },
+        "experimentResult": {
+          "featureId": "feature",
+          "hashAttribute": "id",
+          "hashValue": 123,
+          "hashUsed": true,
+          "inExperiment": true,
+          "value": 1,
+          "variationId": 1
+        }
+      }
+    ],
     [
       "skip experiment on missing hashAttribute",
       {
@@ -2048,6 +2089,7 @@
           "variations": [0, 1, 2, 3]
         },
         "experimentResult": {
+          "featureId": "feature",
           "value": 1,
           "variationId": 1,
           "inExperiment": true,
@@ -2371,6 +2413,14 @@
       false,
       false
     ],
+    [
+      "null id",
+      { "attributes": { "id": null } },
+      { "key": "my-test", "variations": [0, 1] },
+      0,
+      false,
+      false
+    ],
     [
       "missing id",
       { "attributes": {} },

data/spec/context_spec.rb

@@ -95,6 +95,7 @@ describe 'context' do
       gb.on? :feature1
 
       expect(gb.impressions["feature1"].to_json).to eq({
+        "featureId" => "feature1",
         "hashAttribute" => "id",
         "hashValue" => "123",
         "inExperiment" => true,
@@ -109,6 +110,7 @@ describe 'context' do
           "variations" => [2, 3]
         },
         {
+          "featureId" => "feature1",
           "hashAttribute" => "id",
           "hashValue" => "123",
           "inExperiment" => true,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: growthbook
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - GrowthBook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec