Module: LaunchDarkly::Evaluation

Included in:
LDClient
Defined in:
lib/ldclient-rb/evaluation.rb

Defined Under Namespace

Classes: EvaluationError

Constant Summary collapse

BUILTINS = 
[:key, :ip, :country, :email, :firstName, :lastName, :avatar, :name, :anonymous]
NUMERIC_VERSION_COMPONENTS_REGEX = 
Regexp.new("^[0-9.]*")
DATE_OPERAND = 
lambda do |v|
  if v.is_a? String
    begin
      DateTime.rfc3339(v).strftime("%Q").to_i
    rescue => e
      nil
    end
  elsif v.is_a? Numeric
    v
  else
    nil
  end
end
SEMVER_OPERAND = 
lambda do |v|
  if v.is_a? String
    for _ in 0..2 do
      begin
        return Semantic::Version.new(v)
      rescue ArgumentError
        v = addZeroVersionComponent(v)
      end
    end
  end
  nil
end
OPERATORS = 
{
  in:
    lambda do |a, b|
      a == b
    end,
  endsWith:
    lambda do |a, b|
      (a.is_a? String) && (a.end_with? b)
    end,
  startsWith:
    lambda do |a, b|
      (a.is_a? String) && (a.start_with? b)
    end,
  matches:
    lambda do |a, b|
      (b.is_a? String) && !(Regexp.new b).match(a).nil?
    end,
  contains:
    lambda do |a, b|
      (a.is_a? String) && (a.include? b)
    end,
  lessThan:
    lambda do |a, b|
      (a.is_a? Numeric) && (a < b)
    end,
  lessThanOrEqual:
    lambda do |a, b|
      (a.is_a? Numeric) && (a <= b)
    end,
  greaterThan:
    lambda do |a, b|
      (a.is_a? Numeric) && (a > b)
    end,
  greaterThanOrEqual:
    lambda do |a, b|
      (a.is_a? Numeric) && (a >= b)
    end,
  before:
    comparator(DATE_OPERAND) { |n| n < 0 },
  after:
    comparator(DATE_OPERAND) { |n| n > 0 },
  semVerEqual:
    comparator(SEMVER_OPERAND) { |n| n == 0 },
  semVerLessThan:
    comparator(SEMVER_OPERAND) { |n| n < 0 },
  semVerGreaterThan:
    comparator(SEMVER_OPERAND) { |n| n > 0 }
}

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.addZeroVersionComponent(v) ⇒ Object 



37
38
39
40
41
 
# File 'lib/ldclient-rb/evaluation.rb', line 37

def self.addZeroVersionComponent(v)
  NUMERIC_VERSION_COMPONENTS_REGEX.match(v) { |m|
    m[0] + ".0" + v[m[0].length..-1]
  }
end

.comparator(converter) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/ldclient-rb/evaluation.rb', line 43

def self.comparator(converter)
  lambda do |a, b|
    av = converter.call(a)
    bv = converter.call(b)
    if !av.nil? && !bv.nil?
      yield av <=> bv
    else
      return false
    end
  end
end

Instance Method Details

#bucket_user(user, key, bucket_by, salt) ⇒ Object 



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ldclient-rb/evaluation.rb', line 253

def bucket_user(user, key, bucket_by, salt)
  return nil unless user[:key]

  id_hash = bucketable_string_value(user_value(user, bucket_by))
  if id_hash.nil?
    return 0.0
  end

  if user[:secondary]
    id_hash += "." + user[:secondary]
  end

  hash_key = "%s.%s.%s" % [key, salt, id_hash]

  hash_val = (Digest::SHA1.hexdigest(hash_key))[0..14]
  hash_val.to_i(16) / Float(0xFFFFFFFFFFFFFFF)
end

#bucketable_string_value(value) ⇒ Object 



271
272
273
274
275
 
# File 'lib/ldclient-rb/evaluation.rb', line 271

def bucketable_string_value(value)
  return value if value.is_a? String
  return value.to_s if value.is_a? Integer
  nil
end

#clause_match_user(clause, user) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/ldclient-rb/evaluation.rb', line 215

def clause_match_user(clause, user)
  val = user_value(user, clause[:attribute])
  return false if val.nil?

  op = OPERATORS[clause[:op].to_sym]

  if op.nil?
    raise EvaluationError, "Unsupported operator #{clause[:op]} in evaluation"
  end

  if val.is_a? Enumerable
    val.each do |v|
      return maybe_negate(clause, true) if match_any(op, v, clause[:values])
    end
    return maybe_negate(clause, false)
  end

  maybe_negate(clause, match_any(op, val, clause[:values]))
end

#eval_internal(flag, user, store, events) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/ldclient-rb/evaluation.rb', line 136

def eval_internal(flag, user, store, events)
  failed_prereq = false
  # Evaluate prerequisites, if any
  if !flag[:prerequisites].nil?
    flag[:prerequisites].each do |prerequisite|
      prereq_flag = store.get(prerequisite[:key])

      if prereq_flag.nil? || !prereq_flag[:on]
        failed_prereq = true
      else
        begin
          prereq_res = eval_internal(prereq_flag, user, store, events)
          variation = get_variation(prereq_flag, prerequisite[:variation])
          events.push(kind: "feature", key: prereq_flag[:key], value: prereq_res, version: prereq_flag[:version], prereqOf: flag[:key])
          if prereq_res.nil? || prereq_res != variation
            failed_prereq = true
          end
        rescue => exn
          @config.logger.error("[LDClient] Error evaluating prerequisite: #{exn.inspect}")
          failed_prereq = true
        end
      end
    end

    if failed_prereq
      return nil
    end
  end
  # The prerequisites were satisfied.
  # Now walk through the evaluation steps and get the correct
  # variation index
  eval_rules(flag, user)
end

#eval_rules(flag, user) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ldclient-rb/evaluation.rb', line 170

def eval_rules(flag, user)
  # Check user target matches
  if !flag[:targets].nil?
    flag[:targets].each do |target|
      if !target[:values].nil?
        target[:values].each do |value|
          return get_variation(flag, target[:variation]) if value == user[:key]
        end
      end
    end
  end

  # Check custom rules
  if !flag[:rules].nil?
    flag[:rules].each do |rule|
      return variation_for_user(rule, user, flag) if rule_match_user(rule, user)
    end
  end

  # Check the fallthrough rule
  if !flag[:fallthrough].nil?
    return variation_for_user(flag[:fallthrough], user, flag)
  end

  # Not even the fallthrough matched-- return the off variation or default
  nil
end

#evaluate(flag, user, store) ⇒ Object

Evaluates a feature flag, returning a hash containing the evaluation result and any events generated during prerequisite evaluation. Raises EvaluationError if the flag is not well-formed Will return nil, but not raise an exception, indicating that the rules (including fallthrough) did not match In that case, the caller should return the default value.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/ldclient-rb/evaluation.rb', line 111

def evaluate(flag, user, store)
  if flag.nil?
    raise EvaluationError, "Flag does not exist"
  end

  if user.nil? || user[:key].nil?
    raise EvaluationError, "Invalid user"
  end

  events = []

  if flag[:on]
    res = eval_internal(flag, user, store, events)

    return { value: res, events: events } if !res.nil?
  end

  if !flag[:offVariation].nil? && flag[:offVariation] < flag[:variations].length
    value = flag[:variations][flag[:offVariation]]
    return { value: value, events: events }
  end

  { value: nil, events: events }
end

#get_variation(flag, index) ⇒ Object 



198
199
200
201
202
203
 
# File 'lib/ldclient-rb/evaluation.rb', line 198

def get_variation(flag, index)
  if index >= flag[:variations].length
    raise EvaluationError, "Invalid variation index"
  end
  flag[:variations][index]
end

#match_any(op, value, values) ⇒ Object 



293
294
295
296
297
298
 
# File 'lib/ldclient-rb/evaluation.rb', line 293

def match_any(op, value, values)
  values.each do |v|
    return true if op.call(value, v)
  end
  return false
end

#maybe_negate(clause, b) ⇒ Object 



289
290
291
 
# File 'lib/ldclient-rb/evaluation.rb', line 289

def maybe_negate(clause, b)
  clause[:negate] ? !b : b
end

#rule_match_user(rule, user) ⇒ Object 



205
206
207
208
209
210
211
212
213
 
# File 'lib/ldclient-rb/evaluation.rb', line 205

def rule_match_user(rule, user)
  return false if !rule[:clauses]

  rule[:clauses].each do |clause|
    return false if !clause_match_user(clause, user)
  end

  return true
end

#user_value(user, attribute) ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/ldclient-rb/evaluation.rb', line 277

def user_value(user, attribute)
  attribute = attribute.to_sym

  if BUILTINS.include? attribute
    user[attribute]
  elsif !user[:custom].nil?
    user[:custom][attribute]
  else
    nil
  end
end

#variation_for_user(rule, user, flag) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/ldclient-rb/evaluation.rb', line 235

def variation_for_user(rule, user, flag)
  if !rule[:variation].nil? # fixed variation
    return get_variation(flag, rule[:variation])
  elsif !rule[:rollout].nil? # percentage rollout
    rollout = rule[:rollout]
    bucket_by = rollout[:bucketBy].nil? ? "key" : rollout[:bucketBy]
    bucket = bucket_user(user, flag[:key], bucket_by, flag[:salt])
    sum = 0;
    rollout[:variations].each do |variate|
      sum += variate[:weight].to_f / 100000.0
      return get_variation(flag, variate[:variation]) if bucket < sum
    end
    nil
  else # the rule isn't well-formed
    raise EvaluationError, "Rule does not define a variation or rollout"
  end
end