launchdarkly-server-sdk 5.8.1 → 6.2.0

data/spec/impl/evaluator_spec.rb

@@ -0,0 +1,349 @@
+require "spec_helper"
+require "impl/evaluator_spec_base"
+
+module LaunchDarkly
+  module Impl
+    describe "Evaluator (general)", :evaluator_spec_base => true do
+      subject { Evaluator }
+
+      describe "evaluate" do
+        it "returns off variation if flag is off" do
+          flag = {
+            key: 'feature',
+            on: false,
+            offVariation: 1,
+            fallthrough: { variation: 0 },
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new('b', 1, EvaluationReason::off)
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns nil if flag is off and off variation is unspecified" do
+          flag = {
+            key: 'feature',
+            on: false,
+            fallthrough: { variation: 0 },
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new(nil, nil, EvaluationReason::off)
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns an error if off variation is too high" do
+          flag = {
+            key: 'feature',
+            on: false,
+            offVariation: 999,
+            fallthrough: { variation: 0 },
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new(nil, nil,
+            EvaluationReason::error(EvaluationReason::ERROR_MALFORMED_FLAG))
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns an error if off variation is negative" do
+          flag = {
+            key: 'feature',
+            on: false,
+            offVariation: -1,
+            fallthrough: { variation: 0 },
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new(nil, nil,
+            EvaluationReason::error(EvaluationReason::ERROR_MALFORMED_FLAG))
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns off variation if prerequisite is not found" do
+          flag = {
+            key: 'feature0',
+            on: true,
+            prerequisites: [{key: 'badfeature', variation: 1}],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new('b', 1, EvaluationReason::prerequisite_failed('badfeature'))
+          e = subject.new(get_things( 'badfeature' => nil ), get_nothing, logger)
+          result = e.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "reuses prerequisite-failed reason instances if possible" do
+          flag = {
+            key: 'feature0',
+            on: true,
+            prerequisites: [{key: 'badfeature', variation: 1}],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          Model.postprocess_item_after_deserializing!(FEATURES, flag)  # now there's a cached reason
+          user = { key: 'x' }
+          e = subject.new(get_things( 'badfeature' => nil ), get_nothing, logger)
+          result1 = e.evaluate(flag, user, factory)
+          expect(result1.detail.reason).to eq EvaluationReason::prerequisite_failed('badfeature')
+          result2 = e.evaluate(flag, user, factory)
+          expect(result2.detail.reason).to be result1.detail.reason
+        end
+
+        it "returns off variation and event if prerequisite of a prerequisite is not found" do
+          flag = {
+            key: 'feature0',
+            on: true,
+            prerequisites: [{key: 'feature1', variation: 1}],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c'],
+            version: 1
+          }
+          flag1 = {
+            key: 'feature1',
+            on: true,
+            prerequisites: [{key: 'feature2', variation: 1}], # feature2 doesn't exist
+            fallthrough: { variation: 0 },
+            variations: ['d', 'e'],
+            version: 2
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new('b', 1, EvaluationReason::prerequisite_failed('feature1'))
+          events_should_be = [{
+            kind: 'feature', key: 'feature1', user: user, value: nil, default: nil, variation: nil, version: 2, prereqOf: 'feature0'
+          }]
+          get_flag = get_things('feature1' => flag1, 'feature2' => nil)
+          e = subject.new(get_flag, get_nothing, logger)
+          result = e.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(events_should_be)
+        end
+
+        it "returns off variation and event if prerequisite is off" do
+          flag = {
+            key: 'feature0',
+            on: true,
+            prerequisites: [{key: 'feature1', variation: 1}],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c'],
+            version: 1
+          }
+          flag1 = {
+            key: 'feature1',
+            on: false,
+            # note that even though it returns the desired variation, it is still off and therefore not a match
+            offVariation: 1,
+            fallthrough: { variation: 0 },
+            variations: ['d', 'e'],
+            version: 2
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new('b', 1, EvaluationReason::prerequisite_failed('feature1'))
+          events_should_be = [{
+            kind: 'feature', key: 'feature1', user: user, variation: 1, value: 'e', default: nil, version: 2, prereqOf: 'feature0'
+          }]
+          get_flag = get_things({ 'feature1' => flag1 })
+          e = subject.new(get_flag, get_nothing, logger)
+          result = e.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(events_should_be)
+        end
+
+        it "returns off variation and event if prerequisite is not met" do
+          flag = {
+            key: 'feature0',
+            on: true,
+            prerequisites: [{key: 'feature1', variation: 1}],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c'],
+            version: 1
+          }
+          flag1 = {
+            key: 'feature1',
+            on: true,
+            fallthrough: { variation: 0 },
+            variations: ['d', 'e'],
+            version: 2
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new('b', 1, EvaluationReason::prerequisite_failed('feature1'))
+          events_should_be = [{
+            kind: 'feature', key: 'feature1', user: user, variation: 0, value: 'd', default: nil, version: 2, prereqOf: 'feature0'
+          }]
+          get_flag = get_things({ 'feature1' => flag1 })
+          e = subject.new(get_flag, get_nothing, logger)
+          result = e.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(events_should_be)
+        end
+
+        it "returns fallthrough variation and event if prerequisite is met and there are no rules" do
+          flag = {
+            key: 'feature0',
+            on: true,
+            prerequisites: [{key: 'feature1', variation: 1}],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c'],
+            version: 1
+          }
+          flag1 = {
+            key: 'feature1',
+            on: true,
+            fallthrough: { variation: 1 },
+            variations: ['d', 'e'],
+            version: 2
+          }
+          user = { key: 'x' }
+          detail = EvaluationDetail.new('a', 0, EvaluationReason::fallthrough)
+          events_should_be = [{
+            kind: 'feature', key: 'feature1', user: user, variation: 1, value: 'e', default: nil, version: 2, prereqOf: 'feature0'
+          }]
+          get_flag = get_things({ 'feature1' => flag1 })
+          e = subject.new(get_flag, get_nothing, logger)
+          result = e.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(events_should_be)
+        end
+
+        it "returns an error if fallthrough variation is too high" do
+          flag = {
+            key: 'feature',
+            on: true,
+            fallthrough: { variation: 999 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'userkey' }
+          detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_MALFORMED_FLAG))
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns an error if fallthrough variation is negative" do
+          flag = {
+            key: 'feature',
+            on: true,
+            fallthrough: { variation: -1 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'userkey' }
+          detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_MALFORMED_FLAG))
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns an error if fallthrough has no variation or rollout" do
+          flag = {
+            key: 'feature',
+            on: true,
+            fallthrough: { },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'userkey' }
+          detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_MALFORMED_FLAG))
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "returns an error if fallthrough has a rollout with no variations" do
+          flag = {
+            key: 'feature',
+            on: true,
+            fallthrough: { rollout: { variations: [] } },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'userkey' }
+          detail = EvaluationDetail.new(nil, nil, EvaluationReason::error(EvaluationReason::ERROR_MALFORMED_FLAG))
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        it "matches user from targets" do
+          flag = {
+            key: 'feature',
+            on: true,
+            targets: [
+              { values: [ 'whoever', 'userkey' ], variation: 2 }
+            ],
+            fallthrough: { variation: 0 },
+            offVariation: 1,
+            variations: ['a', 'b', 'c']
+          }
+          user = { key: 'userkey' }
+          detail = EvaluationDetail.new('c', 2, EvaluationReason::target_match)
+          result = basic_evaluator.evaluate(flag, user, factory)
+          expect(result.detail).to eq(detail)
+          expect(result.events).to eq(nil)
+        end
+
+        describe "experiment rollout behavior" do
+          it "sets the in_experiment value if rollout kind is experiment and untracked false" do
+            flag = {
+              key: 'feature',
+              on: true,
+              fallthrough: { rollout: { kind: 'experiment', variations: [ { weight: 100000, variation: 1, untracked: false } ]  } },
+              offVariation: 1,
+              variations: ['a', 'b', 'c']
+            }
+            user = { key: 'userkey' }
+            result = basic_evaluator.evaluate(flag, user, factory)
+            expect(result.detail.reason.to_json).to include('"inExperiment":true')
+            expect(result.detail.reason.in_experiment).to eq(true)
+          end
+
+          it "does not set the in_experiment value if rollout kind is not experiment" do
+            flag = {
+              key: 'feature',
+              on: true,
+              fallthrough: { rollout: { kind: 'rollout', variations: [ { weight: 100000, variation: 1, untracked: false } ]  } },
+              offVariation: 1,
+              variations: ['a', 'b', 'c']
+            }
+            user = { key: 'userkey' }
+            result = basic_evaluator.evaluate(flag, user, factory)
+            expect(result.detail.reason.to_json).to_not include('"inExperiment":true')
+            expect(result.detail.reason.in_experiment).to eq(nil)
+          end
+
+          it "does not set the in_experiment value if rollout kind is experiment and untracked is true" do
+            flag = {
+              key: 'feature',
+              on: true,
+              fallthrough: { rollout: { kind: 'experiment', variations: [ { weight: 100000, variation: 1, untracked: true } ]  } },
+              offVariation: 1,
+              variations: ['a', 'b', 'c']
+            }
+            user = { key: 'userkey' }
+            result = basic_evaluator.evaluate(flag, user, factory)
+            expect(result.detail.reason.to_json).to_not include('"inExperiment":true')
+            expect(result.detail.reason.in_experiment).to eq(nil)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/impl/evaluator_spec_base.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+module LaunchDarkly
+  module Impl
+    module EvaluatorSpecBase
+      def factory
+        EventFactory.new(false)
+      end
+
+      def user
+        {
+          key: "userkey",
+          email: "test@example.com",
+          name: "Bob"
+        }
+      end
+
+      def logger
+        ::Logger.new($stdout, level: ::Logger::FATAL)
+      end
+
+      def get_nothing
+        lambda { |key| raise "should not have requested #{key}" }
+      end
+
+      def get_things(map)
+        lambda { |key|
+          raise "should not have requested #{key}" if !map.has_key?(key)
+          map[key]
+        }
+      end
+
+      def basic_evaluator
+        subject.new(get_nothing, get_nothing, logger)
+      end
+
+      def boolean_flag_with_rules(rules)
+        { key: 'feature', on: true, rules: rules, fallthrough: { variation: 0 }, variations: [ false, true ] }
+      end
+
+      def boolean_flag_with_clauses(clauses)
+        boolean_flag_with_rules([{ id: 'ruleid', clauses: clauses, variation: 1 }])
+      end
+
+      def make_user_matching_clause(user, attr)
+        {
+          attribute: attr.to_s,
+          op: :in,
+          values: [ user[attr.to_sym] ],
+          negate: false
+        }
+      end
+
+      def make_segment(key)
+        {
+          key: key,
+          included: [],
+          excluded: [],
+          salt: 'abcdef',
+          version: 1
+        }
+      end
+
+      def make_segment_match_clause(segment)
+        {
+          op: :segmentMatch,
+          values: [ segment[:key] ],
+          negate: false
+        }
+      end
+    end
+
+    RSpec.configure { |c| c.include EvaluatorSpecBase, :evaluator_spec_base => true }
+  end
+end

data/spec/impl/event_factory_spec.rb

@@ -0,0 +1,108 @@
+require "spec_helper"
+
+describe LaunchDarkly::Impl::EventFactory do
+  subject { LaunchDarkly::Impl::EventFactory }
+
+  describe "#new_eval_event" do
+    let(:event_factory_without_reason) { subject.new(false) }
+    let(:user) { { 'key': 'userA' } }
+    let(:rule_with_experiment_rollout) { 
+      { id: 'ruleid',
+        clauses: [{ attribute: 'key', op: 'in', values: ['userkey'] }],
+        trackEvents: false,
+        rollout: { kind: 'experiment', salt: '', variations: [ { weight: 100000, variation: 0, untracked: false } ] }
+      }
+    }
+
+    let(:rule_with_rollout) { 
+      { id: 'ruleid',
+        trackEvents: false,
+        clauses: [{ attribute: 'key', op: 'in', values: ['userkey'] }],
+        rollout: { salt: '', variations: [ { weight: 100000, variation: 0, untracked: false } ] }
+      }
+    }
+
+    let(:fallthrough_with_rollout) {
+      { rollout: { kind: 'rollout', salt: '', variations: [ { weight: 100000, variation: 0, untracked: false } ], trackEventsFallthrough: false } }
+    }
+
+    let(:rule_reason) { LaunchDarkly::EvaluationReason::rule_match(0, 'ruleid') }
+    let(:rule_reason_with_experiment) { LaunchDarkly::EvaluationReason::rule_match(0, 'ruleid', true) }
+    let(:fallthrough_reason) { LaunchDarkly::EvaluationReason::fallthrough }
+    let(:fallthrough_reason_with_experiment) { LaunchDarkly::EvaluationReason::fallthrough(true) }
+
+    context "in_experiment is true" do
+      it "sets the reason and trackevents: true for rules" do
+        flag = createFlag('rule', rule_with_experiment_rollout)
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, rule_reason_with_experiment)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to eql(true)
+        expect(r[:reason].to_s).to eql("RULE_MATCH(0,ruleid,true)")
+      end
+
+      it "sets the reason and trackevents: true for the fallthrough" do
+        fallthrough_with_rollout[:kind] = 'experiment'
+        flag = createFlag('fallthrough', fallthrough_with_rollout)
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, fallthrough_reason_with_experiment)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to eql(true)
+        expect(r[:reason].to_s).to eql("FALLTHROUGH(true)")
+      end
+    end
+
+    context "in_experiment is false" do
+      it "sets the reason & trackEvents: true if rule has trackEvents set to true" do
+        rule_with_rollout[:trackEvents] = true
+        flag = createFlag('rule', rule_with_rollout)
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, rule_reason)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to eql(true)
+        expect(r[:reason].to_s).to eql("RULE_MATCH(0,ruleid)")
+      end
+
+      it "sets the reason & trackEvents: true if fallthrough has trackEventsFallthrough set to true" do
+        flag = createFlag('fallthrough', fallthrough_with_rollout)
+        flag[:trackEventsFallthrough] = true
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, fallthrough_reason)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to eql(true)
+        expect(r[:reason].to_s).to eql("FALLTHROUGH")
+      end
+
+      it "doesn't set the reason & trackEvents if rule has trackEvents set to false" do
+        flag = createFlag('rule', rule_with_rollout)
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, rule_reason)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to be_nil
+        expect(r[:reason]).to be_nil
+      end
+
+      it "doesn't set the reason & trackEvents if fallthrough has trackEventsFallthrough set to false" do
+        flag = createFlag('fallthrough', fallthrough_with_rollout)
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, fallthrough_reason)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to be_nil
+        expect(r[:reason]).to be_nil
+      end
+
+      it "sets trackEvents true and doesn't set the reason if flag[:trackEvents] = true" do
+        flag = createFlag('fallthrough', fallthrough_with_rollout)
+        flag[:trackEvents] = true
+        detail = LaunchDarkly::EvaluationDetail.new(true, 0, fallthrough_reason)
+        r = subject.new(false).new_eval_event(flag, user, detail, nil, nil)
+        expect(r[:trackEvents]).to eql(true)
+        expect(r[:reason]).to be_nil
+      end
+    end
+  end
+
+  def createFlag(kind, rule)
+    if kind == 'rule'
+      { key: 'feature', on: true, rules: [rule], fallthrough: { variation: 0 }, variations: [ false, true ] }
+    elsif kind == 'fallthrough'
+      { key: 'feature', on: true, fallthrough: rule, variations: [ false, true ] }
+    else
+      { key: 'feature', on: true, fallthrough: { variation: 0 }, variations: [ false, true ] }
+    end
+  end
+end