growthbook 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a5a979e06c6d8d34b1b8caede098ba6fae05c0e8f6fe82b9b70da2fbd906959
-  data.tar.gz: 55f4d754a3584f5602c5d45f3f3e285cbb18d35a0ed0cdfcaf103b4dd269e81d
+  metadata.gz: 28649218e25654a513fd965aeed205a4208341c265ea9e06d1b2f6efe9a4b1eb
+  data.tar.gz: 165ef4c260ec96a6c77b47acdfdd218039a7067156b0669d7b44adbf4c30382b
 SHA512:
-  metadata.gz: 86d3828e8bf6af502fb71d61ad3aa8c092cda8cec3034b72ae6a24baec26f8b377b471ebcd1f3a85a58b4bd5f45dd08f2fc82a285d413414022c785c41190c2c
-  data.tar.gz: d996803716a5c0348278f6e3a067b55bf523fa0abb8c7d09671d61c644e659cdac21104afc0faeb31e7a0054c8b3831966e00462b71ef0f53226a20b291be2d6
+  metadata.gz: aa1bd7678e81a58d64a51a4f9d035c76cb9ee75ae91584b17c6ff92338e543be58935da3542f77c6e3c6d1cc5fcf030eb804a09d547fd8533511474d6c638f4a
+  data.tar.gz: 9600cc883324faa2c7dcbbf4aa26e8469f0952057f3cf4b449c38cb59c0e6cd37eea246943f99750f3d54a1259fdebb622a14ec4b951a957cecf8bd924d107c0

data/lib/growthbook/context.rb

@@ -187,13 +187,17 @@ module Growthbook
       Growthbook::Conditions.eval_condition(@attributes, condition)
     end
 
-    def get_experiment_result(experiment, variation_index = 0, in_experiment = false)
-      variation_index = 0 if variation_index.negative? || variation_index >= experiment.variations.length
+    def get_experiment_result(experiment, variation_index = -1, hash_used = false)
+      in_experiment = true
+      if variation_index.negative? || variation_index >= experiment.variations.length
+        variation_index = 0
+        in_experiment = false
+      end
 
       hash_attribute = experiment.hash_attribute || 'id'
       hash_value = get_attribute(hash_attribute)
 
-      Growthbook::InlineExperimentResult.new(in_experiment, variation_index,
+      Growthbook::InlineExperimentResult.new(hash_used, in_experiment, variation_index,
                                              experiment.variations[variation_index], hash_attribute, hash_value)
     end
 

data/lib/growthbook/inline_experiment_result.rb

@@ -14,6 +14,10 @@ module Growthbook
     # @return [Any]
     attr_reader :value
 
+    # If the variation was randomly assigned based on user attribute hashes
+    # @return [Bool]
+    attr_reader :hash_used
+
     # The attribute used to split traffic
     # @return [String]
     attr_reader :hash_attribute
@@ -23,6 +27,7 @@ module Growthbook
     attr_reader :hash_value
 
     def initialize(
+      hash_used,
       in_experiment,
       variation_id,
       value,
@@ -30,6 +35,7 @@ module Growthbook
       hash_value
     )
 
+      @hash_used = hash_used
       @in_experiment = in_experiment
       @variation_id = variation_id
       @value = value
@@ -40,6 +46,7 @@ module Growthbook
     def to_json(*_args)
       res = {}
       res['inExperiment'] = @in_experiment
+      res['hashUsed'] = @hash_used
       res['variationId'] = @variation_id
       res['value'] = @value
       res['hashAttribute'] = @hash_attribute

data/spec/cases.json

@@ -1707,6 +1707,7 @@
           "value": "c",
           "variationId": 2,
           "inExperiment": true,
+          "hashUsed": true,
           "hashAttribute": "id",
           "hashValue": "123"
         },
@@ -1742,6 +1743,7 @@
           "value": "a",
           "variationId": 0,
           "inExperiment": true,
+          "hashUsed": true,
           "hashAttribute": "id",
           "hashValue": "456"
         },
@@ -1777,6 +1779,7 @@
           "value": "b",
           "variationId": 1,
           "inExperiment": true,
+          "hashUsed": true,
           "hashAttribute": "id",
           "hashValue": "fds"
         },
@@ -1824,6 +1827,7 @@
           "value": false,
           "variationId": 1,
           "inExperiment": true,
+          "hashUsed": true,
           "hashAttribute": "anonId",
           "hashValue": "123"
         }
@@ -2011,6 +2015,47 @@
         "off": false,
         "source": "force"
       }
+    ],
+    [
+      "include experiments when forced",
+      {
+        "attributes": { "id": "123" },
+        "forcedVariations": {
+          "feature": 1
+        },
+        "features": {
+          "feature": {
+            "defaultValue": 0,
+            "rules": [
+              {
+                "variations": [0, 1, 2, 3]
+              },
+              {
+                "force": 3
+              }
+            ]
+          }
+        }
+      },
+      "feature",
+      {
+        "value": 1,
+        "on": true,
+        "off": false,
+        "source": "experiment",
+        "experiment": {
+          "key": "feature",
+          "variations": [0, 1, 2, 3]
+        },
+        "experimentResult": {
+          "value": 1,
+          "variationId": 1,
+          "inExperiment": true,
+          "hashUsed": false,
+          "hashAttribute": "id",
+          "hashValue": "123"
+        }
+      }
     ]
   ],
   "run": [
@@ -2019,6 +2064,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1] },
       1,
+      true,
       true
     ],
     [
@@ -2026,6 +2072,7 @@
       { "attributes": { "id": "2" } },
       { "key": "my-test", "variations": [0, 1] },
       0,
+      true,
       true
     ],
     [
@@ -2033,6 +2080,7 @@
       { "attributes": { "id": "3" } },
       { "key": "my-test", "variations": [0, 1] },
       0,
+      true,
       true
     ],
     [
@@ -2040,6 +2088,7 @@
       { "attributes": { "id": "4" } },
       { "key": "my-test", "variations": [0, 1] },
       1,
+      true,
       true
     ],
     [
@@ -2047,6 +2096,7 @@
       { "attributes": { "id": "5" } },
       { "key": "my-test", "variations": [0, 1] },
       1,
+      true,
       true
     ],
     [
@@ -2054,6 +2104,7 @@
       { "attributes": { "id": "6" } },
       { "key": "my-test", "variations": [0, 1] },
       1,
+      true,
       true
     ],
     [
@@ -2061,6 +2112,7 @@
       { "attributes": { "id": "7" } },
       { "key": "my-test", "variations": [0, 1] },
       0,
+      true,
       true
     ],
     [
@@ -2068,6 +2120,7 @@
       { "attributes": { "id": "8" } },
       { "key": "my-test", "variations": [0, 1] },
       1,
+      true,
       true
     ],
     [
@@ -2075,6 +2128,7 @@
       { "attributes": { "id": "9" } },
       { "key": "my-test", "variations": [0, 1] },
       0,
+      true,
       true
     ],
     [
@@ -2082,6 +2136,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2089,6 +2144,7 @@
       { "attributes": { "id": "2" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2096,6 +2152,7 @@
       { "attributes": { "id": "3" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       0,
+      true,
       true
     ],
     [
@@ -2103,6 +2160,7 @@
       { "attributes": { "id": "4" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2110,6 +2168,7 @@
       { "attributes": { "id": "5" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2117,6 +2176,7 @@
       { "attributes": { "id": "6" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2124,6 +2184,7 @@
       { "attributes": { "id": "7" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       0,
+      true,
       true
     ],
     [
@@ -2131,6 +2192,7 @@
       { "attributes": { "id": "8" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2138,6 +2200,7 @@
       { "attributes": { "id": "9" } },
       { "key": "my-test", "variations": [0, 1], "weights": [0.1, 0.9] },
       1,
+      true,
       true
     ],
     [
@@ -2145,6 +2208,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      false,
       false
     ],
     [
@@ -2152,6 +2216,7 @@
       { "attributes": { "id": "2" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      true,
       true
     ],
     [
@@ -2159,6 +2224,7 @@
       { "attributes": { "id": "3" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      true,
       true
     ],
     [
@@ -2166,6 +2232,7 @@
       { "attributes": { "id": "4" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      false,
       false
     ],
     [
@@ -2173,6 +2240,7 @@
       { "attributes": { "id": "5" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       1,
+      true,
       true
     ],
     [
@@ -2180,6 +2248,7 @@
       { "attributes": { "id": "6" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      false,
       false
     ],
     [
@@ -2187,6 +2256,7 @@
       { "attributes": { "id": "7" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      true,
       true
     ],
     [
@@ -2194,6 +2264,7 @@
       { "attributes": { "id": "8" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       1,
+      true,
       true
     ],
     [
@@ -2201,6 +2272,7 @@
       { "attributes": { "id": "9" } },
       { "key": "my-test", "variations": [0, 1], "coverage": 0.4 },
       0,
+      false,
       false
     ],
     [
@@ -2208,6 +2280,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       2,
+      true,
       true
     ],
     [
@@ -2215,6 +2288,7 @@
       { "attributes": { "id": "2" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       0,
+      true,
       true
     ],
     [
@@ -2222,6 +2296,7 @@
       { "attributes": { "id": "3" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       0,
+      true,
       true
     ],
     [
@@ -2229,6 +2304,7 @@
       { "attributes": { "id": "4" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       2,
+      true,
       true
     ],
     [
@@ -2236,6 +2312,7 @@
       { "attributes": { "id": "5" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       1,
+      true,
       true
     ],
     [
@@ -2243,6 +2320,7 @@
       { "attributes": { "id": "6" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       2,
+      true,
       true
     ],
     [
@@ -2250,6 +2328,7 @@
       { "attributes": { "id": "7" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       0,
+      true,
       true
     ],
     [
@@ -2257,6 +2336,7 @@
       { "attributes": { "id": "8" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       1,
+      true,
       true
     ],
     [
@@ -2264,6 +2344,7 @@
       { "attributes": { "id": "9" } },
       { "key": "my-test", "variations": [0, 1, 2] },
       0,
+      true,
       true
     ],
     [
@@ -2271,6 +2352,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1] },
       1,
+      true,
       true
     ],
     [
@@ -2278,6 +2360,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test-3", "variations": [0, 1] },
       0,
+      true,
       true
     ],
     [
@@ -2285,6 +2368,7 @@
       { "attributes": { "id": "" } },
       { "key": "my-test", "variations": [0, 1] },
       0,
+      false,
       false
     ],
     [
@@ -2292,6 +2376,7 @@
       { "attributes": {} },
       { "key": "my-test", "variations": [0, 1] },
       0,
+      false,
       false
     ],
     [
@@ -2299,6 +2384,7 @@
       {},
       { "key": "my-test", "variations": [0, 1] },
       0,
+      false,
       false
     ],
     [
@@ -2306,6 +2392,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0] },
       0,
+      false,
       false
     ],
     [
@@ -2313,6 +2400,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1], "force": -8 },
       0,
+      false,
       false
     ],
     [
@@ -2320,6 +2408,7 @@
       { "attributes": { "id": "1" } },
       { "key": "my-test", "variations": [0, 1], "force": 25 },
       0,
+      false,
       false
     ],
     [
@@ -2338,6 +2427,7 @@
         }
       },
       1,
+      true,
       true
     ],
     [
@@ -2356,6 +2446,7 @@
         }
       },
       0,
+      false,
       false
     ],
     [
@@ -2372,6 +2463,7 @@
         "hashAttribute": "companyId"
       },
       1,
+      true,
       true
     ],
     [
@@ -2387,6 +2479,7 @@
         "variations": [0, 1]
       },
       0,
+      false,
       false
     ],
     [
@@ -2402,6 +2495,7 @@
         "variations": [0, 1]
       },
       1,
+      true,
       false
     ],
     [
@@ -2417,6 +2511,7 @@
         "variations": [0, 1]
       },
       1,
+      true,
       true
     ],
     [
@@ -2432,6 +2527,7 @@
         "variations": [0, 1]
       },
       0,
+      false,
       false
     ],
     [
@@ -2448,6 +2544,7 @@
         "variations": [0, 1]
       },
       1,
+      true,
       false
     ],
     [
@@ -2464,6 +2561,7 @@
         "variations": [0, 1]
       },
       0,
+      false,
       false
     ],
     [
@@ -2490,6 +2588,7 @@
         "color": "green",
         "size": "large"
       },
+      true,
       true
     ],
     [
@@ -2503,6 +2602,7 @@
         "variations": [0, 1]
       },
       0,
+      true,
       false
     ],
     [
@@ -2516,6 +2616,7 @@
         "variations": [0, 1]
       },
       0,
+      false,
       false
     ],
     [
@@ -2530,6 +2631,7 @@
         "variations": [0, 1]
       },
       1,
+      true,
       false
     ],
     [
@@ -2544,6 +2646,7 @@
         "force": 1
       },
       1,
+      true,
       false
     ],
     [
@@ -2559,6 +2662,7 @@
         "namespace": ["namespace", 0.1, 1]
       },
       1,
+      true,
       true
     ],
     [
@@ -2574,6 +2678,7 @@
         "namespace": ["namespace", 0, 0.1]
       },
       0,
+      false,
       false
     ]
   ],

data/spec/context_spec.rb

@@ -98,6 +98,7 @@ describe 'context' do
         "hashAttribute" => "id",
         "hashValue" => "123",
         "inExperiment" => true,
+        "hashUsed" => true,
         "value" => 2,
         "variationId" => 0,
       })
@@ -111,6 +112,7 @@ describe 'context' do
           "hashAttribute" => "id",
           "hashValue" => "123",
           "inExperiment" => true,
+          "hashUsed" => true,
           "value" => 2,
           "variationId" => 0,
         }

data/spec/json_spec.rb

@@ -144,7 +144,7 @@ describe 'test suite' do
     # Loop through each test case in the JSON file
     test_cases['run'].each do |test_case|
       # Extract data about the test case
-      test_name, context, experiment, value, in_experiment = test_case
+      test_name, context, experiment, value, in_experiment, hash_used = test_case
 
       # Run the actual test case
       it test_name do
@@ -153,6 +153,7 @@ describe 'test suite' do
         result = gb.run(exp)
         expect(result.value).to eq(value)
         expect(result.in_experiment).to eq(in_experiment)
+        expect(result.hash_used).to eq(hash_used)
       end
     end
   end

metadata

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