growthbook 1.3.0 → 2.0.0

data/lib/growthbook/context.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'set'
+
 module Growthbook
   # Context object passed into the GrowthBook constructor.
   class Context # rubocop:disable Metrics/ClassLength
@@ -33,6 +35,9 @@ module Growthbook
     # @return [Hash[String, Any]] Forced feature values
     attr_reader :forced_features
 
+    # @return [Hash[String, Array]] Saved groups, used by the $inGroup/$notInGroup operators
+    attr_reader :saved_groups
+
     # @return [Growthbook::StickyBucketService] Sticky bucket service for sticky bucketing
     attr_reader :sticky_bucket_service
 
@@ -57,6 +62,7 @@ module Growthbook
       @enabled = true
       @impressions = {}
       @sticky_bucket_assignment_docs = {}
+      @saved_groups = {}
 
       features = {}
       attributes = {}
@@ -90,6 +96,8 @@ module Growthbook
           @sticky_bucket_service = value
         when :sticky_bucket_identifier_attributes
           @sticky_bucket_identifier_attributes = value
+        when :saved_groups, :savedGroups
+          @saved_groups = value || {}
         else
           warn("Unknown context option: #{key}")
         end
@@ -158,7 +166,7 @@ module Growthbook
 
         return 'cyclic' if parent_res.source == 'cyclicPrerequisite'
 
-        next if Growthbook::Conditions.eval_condition({ 'value' => parent_res.value }, parent_condition['condition'])
+        next if parent_condition_passes?(parent_res.value, parent_condition['condition'])
         return 'gate' if parent_condition['gate']
 
         return 'fail'
@@ -176,6 +184,9 @@ module Growthbook
 
       return get_feature_result(key.to_s, nil, 'cyclicPrerequisite', nil, nil) if stack.include?(key.to_s)
 
+      # Work on a copy so sibling prerequisite evaluations don't pollute each
+      # other's path (matches the by-value stack semantics of the other SDKs)
+      stack = stack.dup
       stack.add(key.to_s)
 
       feature.rules.each do |rule|
@@ -212,7 +223,7 @@ module Growthbook
           )
           next unless included_in_rollout
 
-          return get_feature_result(key.to_s, rule.force, 'force', nil, nil)
+          return get_feature_result(key.to_s, rule.force, 'force', nil, nil, rule.id)
         end
         # Experiment rule
         next unless rule.experiment?
@@ -224,7 +235,7 @@ module Growthbook
 
         next unless result.in_experiment && !result.passthrough
 
-        return get_feature_result(key.to_s, result.value, 'experiment', exp, result)
+        return get_feature_result(key.to_s, result.value, 'experiment', exp, result, rule.id)
       end
 
       # Fallback
@@ -261,8 +272,8 @@ module Growthbook
       return get_experiment_result(exp, -1, hash_used: false, feature_id: feature_id) unless exp.active
 
       # 6. Get hash_attribute/value and return if empty
-      hash_attribute, hash_value_raw = get_hash_attribute(exp.hash_attribute, exp.fallback_attribute)
-      hash_value = hash_value_raw.to_s
+      hash_attribute, hash_value_raw = get_hash_attribute(exp.hash_attribute, experiment_fallback_attribute(exp))
+      hash_value = hash_string(hash_value_raw)
       return get_experiment_result(exp, -1, hash_used: false, feature_id: feature_id) if hash_value.empty?
 
       assigned = -1
@@ -368,10 +379,20 @@ module Growthbook
       new_hash
     end
 
+    # A malformed prerequisite condition never matches, rather than raising into the app
+    def parent_condition_passes?(parent_value, condition)
+      Growthbook::Conditions.eval_condition({ 'value' => parent_value }, condition || {}, @saved_groups)
+    rescue StandardError
+      false
+    end
+
+    # A condition that raises, such as a malformed one, fails rather than breaking evaluation
     def condition_passes?(condition)
       return false if condition.nil?
 
-      Growthbook::Conditions.eval_condition(@attributes, condition)
+      Growthbook::Conditions.eval_condition(@attributes, condition, @saved_groups)
+    rescue StandardError
+      false
     end
 
     def get_experiment_result(experiment, variation_index = -1, hash_used: false, feature_id: '', bucket: nil, sticky_bucket_used: false)
@@ -381,7 +402,7 @@ module Growthbook
         in_experiment = false
       end
 
-      hash_attribute, hash_value = get_hash_attribute(experiment.hash_attribute, experiment.fallback_attribute)
+      hash_attribute, hash_value = get_hash_attribute(experiment.hash_attribute, experiment_fallback_attribute(experiment))
       meta = experiment.meta ? experiment.meta[variation_index] : {}
 
       result = Growthbook::InlineExperimentResult.new(
@@ -405,8 +426,8 @@ module Growthbook
       result
     end
 
-    def get_feature_result(key, value, source, experiment, experiment_result)
-      res = Growthbook::FeatureResult.new(value, source, experiment, experiment_result)
+    def get_feature_result(key, value, source, experiment, experiment_result, rule_id = '')
+      res = Growthbook::FeatureResult.new(value, source, experiment, experiment_result, rule_id)
 
       track_feature_usage(key, res)
 
@@ -427,20 +448,45 @@ module Growthbook
       nil
     end
 
+    # Returns the hash attribute and its raw value ('' when missing). Like JS,
+    # only a non-empty string or a finite, non-zero number identifies a user;
+    # anything else counts as missing, and then the fallback attribute is tried
+    # with the same rule.
     def get_hash_attribute(attr, fallback_attr)
-      attr ||= 'id'
+      attr = 'id' if attr.nil? || attr == ''
 
       val = get_attribute(attr)
+      val = '' unless hashable?(val)
 
       # If no match, try fallback
-      if (val.nil? || val == '') && fallback_attr && @sticky_bucket_service
+      if val == '' && fallback_attr && hashable?(get_attribute(fallback_attr))
         val = get_attribute(fallback_attr)
-        attr = fallback_attr unless val.nil? || val == ''
+        attr = fallback_attr
       end
 
       [attr, val]
     end
 
+    def hashable?(value)
+      return value != '' if value.is_a?(String)
+      return value != 0 && value.to_f.finite? if value.is_a?(Integer) || value.is_a?(Float)
+
+      false
+    end
+
+    # Formats a hash value like JS String(): 1.0 as "1"
+    def hash_string(value)
+      return value if value.is_a?(String)
+      return Growthbook::Util.js_number_to_s(value) if value.is_a?(Integer) || value.is_a?(Float)
+
+      ''
+    end
+
+    # Experiments only use their fallback attribute with sticky bucketing, like JS
+    def experiment_fallback_attribute(experiment)
+      experiment.fallback_attribute if @sticky_bucket_service && !experiment.disable_sticky_bucketing
+    end
+
     def get_attribute(key)
       return '' if key.nil?
 
@@ -459,10 +505,11 @@ module Growthbook
 
     def included_in_rollout?(seed:, hash_attribute:, fallback_attribute:, hash_version:, range:, coverage:)
       return true if range.nil? && coverage.nil?
+      return false if range.nil? && coverage&.zero?
 
       _, hash_value_raw = get_hash_attribute(hash_attribute, fallback_attribute)
 
-      hash_value = hash_value_raw.to_s
+      hash_value = hash_string(hash_value_raw)
 
       return false if hash_value.empty?
 
@@ -470,17 +517,20 @@ module Growthbook
       return false if n.nil?
 
       return Growthbook::Util.in_range?(n, range) if range
-      return n <= coverage if coverage
+      # Half-open, like in_range?, so a coverage of k/10000 includes exactly k hash buckets
+      return n < coverage if coverage
 
       true
     end
 
     def filtered_out?(filters)
       filters.any? do |filter|
-        hash_value = get_attribute(filter['attribute'] || 'id').to_s
+        _, hash_value_raw = get_hash_attribute(filter['attribute'], nil)
+        hash_value = hash_string(hash_value_raw)
 
+        # Like JS, a user without a hash value is filtered out
         if hash_value.empty?
-          false
+          true
         else
           n = Growthbook::Util.get_hash(seed: filter['seed'] || '', value: hash_value, version: filter['hashVersion'] || 2)
 
@@ -522,7 +572,7 @@ module Growthbook
 
       @sticky_bucket_identifier_attributes.each do |attr|
         _, hash_value = get_hash_attribute(attr, nil)
-        attributes[attr] = hash_value if hash_value
+        attributes[attr] = hash_string(hash_value)
       end
       attributes
     end
@@ -530,13 +580,13 @@ module Growthbook
     def _get_sticky_bucket_assignments(attr = nil, fallback = nil)
       merged = {}
 
-      _, hash_value = get_hash_attribute(attr, nil)
-      key = "#{attr}||#{hash_value}"
+      attr, hash_value = get_hash_attribute(attr, nil)
+      key = "#{attr}||#{hash_string(hash_value)}"
       merged = @sticky_bucket_assignment_docs[key]['assignments'] if @sticky_bucket_assignment_docs.key?(key)
 
       if fallback
         _, hash_value = get_hash_attribute(fallback, nil)
-        key = "#{fallback}||#{hash_value}"
+        key = "#{fallback}||#{hash_string(hash_value)}"
         if @sticky_bucket_assignment_docs.key?(key)
           @sticky_bucket_assignment_docs[key]['assignments'].each do |k, v|
             merged[k] = v unless merged.key?(k)

data/lib/growthbook/feature_repository.rb

@@ -15,10 +15,14 @@ module Growthbook
     # Parsed features JSON
     attr_reader :features_json
 
+    # Parsed saved groups JSON (used by the $inGroup/$notInGroup operators)
+    attr_reader :saved_groups_json
+
     def initialize(endpoint:, decryption_key:)
       @endpoint = endpoint
       @decryption_key = decryption_key
       @features_json = {}
+      @saved_groups_json = {}
     end
 
     def fetch
@@ -56,7 +60,11 @@ module Growthbook
     end
 
     def parsed_plain_text_response
-      @features_json = parsed_response['features'] unless parsed_response.nil?
+      parsed = parsed_response
+      return nil if parsed.nil?
+
+      @saved_groups_json = parsed['savedGroups'] || {}
+      @features_json = parsed['features']
     rescue StandardError
       nil
     end
@@ -65,12 +73,26 @@ module Growthbook
       k = decryption_key
       return nil if k.nil?
 
-      decrypted_str = Growthbook::DecryptionUtil.decrypt(parsed_response['encryptedFeatures'], key: k)
+      parsed = parsed_response
+      return nil if parsed.nil?
+
+      @saved_groups_json = decrypted_saved_groups(parsed, k)
+
+      decrypted_str = Growthbook::DecryptionUtil.decrypt(parsed['encryptedFeatures'], key: k)
       @features_json = JSON.parse(decrypted_str) unless decrypted_str.nil?
     rescue StandardError
       nil
     end
 
+    def decrypted_saved_groups(parsed, key)
+      if parsed['encryptedSavedGroups']
+        decrypted = Growthbook::DecryptionUtil.decrypt(parsed['encryptedSavedGroups'], key: key)
+        return JSON.parse(decrypted) unless decrypted.nil?
+      end
+
+      parsed['savedGroups'] || {}
+    end
+
     def parsed_response
       res = response
       return {} if res.nil?

data/lib/growthbook/feature_result.rb

@@ -27,14 +27,20 @@ module Growthbook
     # @return [Growthbook::InlineExperimentResult, nil]
     attr_reader :experiment_result
 
+    # The id of the rule (if any) that was used to assign the value
+    # @return [String]
+    attr_reader :rule_id
+
     def initialize(
       value,
       source,
       experiment,
-      experiment_result
+      experiment_result,
+      rule_id = ''
     )
 
-      on = !value.nil? && value != 0 && value != '' && value != false
+      # JS truthiness: [], {} and "off" are on
+      on = !value.nil? && value != 0 && value != '' && value != false && !(value.is_a?(Float) && value.nan?)
 
       @value = value
       @on = on
@@ -42,6 +48,7 @@ module Growthbook
       @source = source
       @experiment = experiment
       @experiment_result = experiment_result
+      @rule_id = rule_id || ''
     end
 
     def to_json(*_args)
@@ -50,6 +57,7 @@ module Growthbook
       json['off'] = @off
       json['value'] = @value
       json['source'] = @source
+      json['ruleId'] = @rule_id
 
       if @experiment
         json['experiment'] = @experiment.to_json

data/lib/growthbook/feature_rule.rb

@@ -3,6 +3,9 @@
 module Growthbook
   # Internal class that overrides the default value of a Feature based on a set of requirements.
   class FeatureRule
+    # @return [String , nil] Unique identifier for this rule
+    attr_reader :id
+
     # @return [Hash , nil] Optional targeting condition
     attr_reader :condition
 
@@ -69,7 +72,11 @@ module Growthbook
     # @return [Array<Hash>] Array of prerequisite flags
     attr_accessor :parent_conditions
 
+    # @return [Hash, nil] Arbitrary custom fields attached to the rule
+    attr_reader :custom_fields
+
     def initialize(rule)
+      @id = get_option(rule, :id)
       @coverage = get_option(rule, :coverage)
       @force = get_option(rule, :force)
       @variations = get_option(rule, :variations)
@@ -95,6 +102,7 @@ module Growthbook
       @bucket_version = get_option(rule, :bucket_version) || get_option(rule, :bucketVersion) || 0
       @min_bucket_version = get_option(rule, :min_bucket_version) || get_option(rule, :minBucketVersion) || 0
       @parent_conditions = get_option(rule, :parent_conditions) || get_option(rule, :parentConditions) || []
+      @custom_fields = get_option(rule, :custom_fields) || get_option(rule, :customFields)
 
       return unless @disable_sticky_bucketing
 
@@ -123,7 +131,8 @@ module Growthbook
         fallback_attribute: @fallback_attribute,
         disable_sticky_bucketing: @disable_sticky_bucketing,
         bucket_version: @bucket_version,
-        min_bucket_version: @min_bucket_version
+        min_bucket_version: @min_bucket_version,
+        custom_fields: @custom_fields
       )
     end
 

data/lib/growthbook/fnv.rb

@@ -10,11 +10,14 @@ class FNV
   MOD32   = 4_294_967_296
   MOD64   = 18_446_744_073_709_551_616
 
+  # Hashes UTF-16 code units, like JavaScript's charCodeAt, so a character
+  # above U+FFFF counts as two units
   def fnv1a_32(data)
     hash = INIT32
 
-    data.bytes.each do |byte|
-      hash = hash ^ byte
+    units = data.ascii_only? ? data.bytes : data.encode('UTF-16LE').unpack('v*').map(&:to_i)
+    units.each do |unit|
+      hash = hash ^ unit
       hash = (hash * PRIME32) % MOD32
     end
 

data/lib/growthbook/inline_experiment.rb

@@ -66,12 +66,17 @@ module Growthbook
     # @return [Array<Hash>] Array of prerequisite flags
     attr_accessor :parent_conditions
 
+    # @return [Hash, nil] Arbitrary custom fields attached to the experiment
+    attr_accessor :custom_fields
+
     def initialize(options = {})
       @key = get_option(options, :key, '').to_s
       @variations = get_option(options, :variations, [])
       @weights = get_option(options, :weights)
       @active = get_option(options, :active, true)
       @coverage = get_option(options, :coverage, 1.0)
+      # Serialize coverage whenever it was given, even when it's 1 (like the JS SDK)
+      @coverage_given = !get_option(options, :coverage).nil?
       @ranges = get_option(options, :ranges)
       @condition = get_option(options, :condition)
       @namespace = get_option(options, :namespace)
@@ -88,6 +93,7 @@ module Growthbook
       @bucket_version = get_option(options, :bucket_version) || get_option(options, :bucketVersion) || 0
       @min_bucket_version = get_option(options, :min_bucket_version) || get_option(options, :minBucketVersion) || 0
       @parent_conditions = get_option(options, :parent_conditions) || get_option(options, :parentConditions) || []
+      @custom_fields = get_option(options, :custom_fields) || get_option(options, :customFields)
 
       return unless @disable_sticky_bucketing
 
@@ -100,7 +106,7 @@ module Growthbook
       res['variations'] = @variations
       res['weights'] = @weights unless @weights.nil?
       res['active'] = @active if @active != true && !@active.nil?
-      res['coverage'] = @coverage if @coverage != 1 && !@coverage.nil?
+      res['coverage'] = @coverage if @coverage_given || (@coverage != 1 && !@coverage.nil?)
       res['ranges'] = @ranges
       res['condition'] = @condition
       res['namespace'] = @namespace