flipper 1.0.0 → 1.1.0

data/spec/flipper/gate_values_spec.rb

@@ -80,13 +80,13 @@ RSpec.describe Flipper::GateValues do
   it 'raises argument error for percentage of time value that cannot be converted to an integer' do
     expect do
       described_class.new(percentage_of_time: ['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a number))
   end
 
   it 'raises argument error for percentage of actors value that cannot be converted to an int' do
     expect do
       described_class.new(percentage_of_actors: ['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a number))
   end
 
   it 'raises argument error for actors value that cannot be converted to a set' do

data/spec/flipper/gates/expression_spec.rb

@@ -0,0 +1,108 @@
+RSpec.describe Flipper::Gates::Expression do
+  let(:feature_name) { :search }
+
+  subject do
+    described_class.new
+  end
+
+  def context(expression, properties: {})
+    Flipper::FeatureCheckContext.new(
+      feature_name: feature_name,
+      values: Flipper::GateValues.new(expression: expression),
+      actors: [Flipper::Types::Actor.new(Flipper::Actor.new(1, properties))]
+    )
+  end
+
+  describe '#enabled?' do
+    context 'for nil value' do
+      it 'returns false' do
+        expect(subject.enabled?(nil)).to eq(false)
+      end
+    end
+
+    context 'for empty value' do
+      it 'returns false' do
+        expect(subject.enabled?({})).to eq(false)
+      end
+    end
+
+    context "for not empty value" do
+      it 'returns true' do
+        expect(subject.enabled?({"Boolean" => [true]})).to eq(true)
+      end
+    end
+  end
+
+  describe '#open?' do
+    context 'for expression that evaluates to true' do
+      it 'returns true' do
+        expression = Flipper.boolean(true).eq(true)
+        expect(subject.open?(context(expression.value))).to be(true)
+      end
+    end
+
+    context 'for expression that evaluates to false' do
+      it 'returns false' do
+        expression = Flipper.boolean(true).eq(false)
+        expect(subject.open?(context(expression.value))).to be(false)
+      end
+    end
+
+    context 'for properties that have string keys' do
+      it 'returns true when expression evalutes to true' do
+        expression = Flipper.property(:type).eq("User")
+        context = context(expression.value, properties: {"type" => "User"})
+        expect(subject.open?(context)).to be(true)
+      end
+
+      it 'returns false when expression evaluates to false' do
+        expression = Flipper.property(:type).eq("User")
+        context = context(expression.value, properties: {"type" => "Org"})
+        expect(subject.open?(context)).to be(false)
+      end
+    end
+
+    context 'for properties that have symbol keys' do
+      it 'returns true when expression evalutes to true' do
+        expression = Flipper.property(:type).eq("User")
+        context = context(expression.value, properties: {type: "User"})
+        expect(subject.open?(context)).to be(true)
+      end
+
+      it 'returns false when expression evaluates to false' do
+        expression = Flipper.property(:type).eq("User")
+        context = context(expression.value, properties: {type: "Org"})
+        expect(subject.open?(context)).to be(false)
+      end
+    end
+  end
+
+  describe '#protects?' do
+    it 'returns true for Flipper::Expression' do
+      expression = Flipper.number(20).eq(20)
+      expect(subject.protects?(expression)).to be(true)
+    end
+
+    it 'returns true for Hash' do
+      expression = Flipper.number(20).eq(20)
+      expect(subject.protects?(expression.value)).to be(true)
+    end
+
+    it 'returns false for other things' do
+      expect(subject.protects?(false)).to be(false)
+    end
+  end
+
+  describe '#wrap' do
+    it 'returns self for Flipper::Expression' do
+      expression = Flipper.number(20).eq(20)
+      expect(subject.wrap(expression)).to be(expression)
+    end
+
+    it 'returns Flipper::Expression for Hash' do
+      expression = Flipper.number(20).eq(20)
+      expect(subject.wrap(expression.value)).to be_instance_of(Flipper::Expression)
+      expect(subject.wrap(expression.value)).to eq(expression)
+    end
+  end
+end

data/spec/flipper/identifier_spec.rb

@@ -2,12 +2,11 @@ require 'flipper/identifier'
 
 RSpec.describe Flipper::Identifier do
   describe '#flipper_id' do
-    class User < Struct.new(:id)
-      include Flipper::Identifier
-    end
-
     it 'uses class name and id' do
-      expect(User.new(5).flipper_id).to eq('User;5')
+      class BlahBlah < Struct.new(:id)
+        include Flipper::Identifier
+      end
+      expect(BlahBlah.new(5).flipper_id).to eq('BlahBlah;5')
     end
   end
 end

data/spec/flipper/instrumentation/statsd_subscriber_spec.rb

@@ -1,6 +1,5 @@
 require 'flipper/adapters/instrumented'
 require 'flipper/instrumentation/statsd'
-require 'statsd'
 
 begin
   require 'active_support/isolated_execution_state'
@@ -78,4 +77,19 @@ RSpec.describe Flipper::Instrumentation::StatsdSubscriber do
     flipper[:stats].disable(user)
     assert_timer 'flipper.adapter.memory.disable'
   end
+
+  context 'when client is nil' do
+    before do
+      described_class.client = nil
+    end
+
+    it 'does not raise error' do
+      expect { flipper[:stats].enable(user) }.not_to raise_error
+    end
+
+    it 'does not update metrics' do
+      flipper[:stats].enable(user)
+      expect(socket.buffer).to be_empty
+    end
+  end
 end

data/spec/flipper/middleware/memoizer_spec.rb

@@ -196,6 +196,73 @@ RSpec.describe Flipper::Middleware::Memoizer do
     end
   end
 
+  context 'with preload block' do
+    let(:app) do
+      app = lambda do |_env|
+        flipper[:stats].enabled?
+        flipper[:stats].enabled?
+        flipper[:shiny].enabled?
+        flipper[:shiny].enabled?
+        [200, {}, []]
+      end
+
+      described_class.new(app, preload: ->(request) {
+        case request.path
+        when "/true"
+          true
+        when "/specific"
+          [:stats]
+        else
+          false
+        end
+      })
+    end
+
+    include_examples 'flipper middleware'
+
+    it 'eagerly caches known features for duration of request if block returns true' do
+      flipper[:stats].enable
+      flipper[:shiny].enable
+
+      # clear the log of operations
+      adapter.reset
+
+      get '/true', {}, 'flipper' => flipper
+
+      expect(adapter.operations.size).to be(1)
+      expect(adapter.count(:get_all)).to be(1)
+      expect(adapter.count(:get)).to be(0)
+    end
+
+    it 'does not eagerly cache known features if block returns false' do
+      flipper[:stats].enable
+      flipper[:shiny].enable
+
+      # clear the log of operations
+      adapter.reset
+
+      get '/false', {}, 'flipper' => flipper
+
+      expect(adapter.operations.size).to be(2)
+      expect(adapter.count(:get_all)).to be(0)
+      expect(adapter.count(:get)).to be(2)
+    end
+
+    it 'eagerly caches specified features for duration of request if block returns array of specified features' do
+      flipper[:stats].enable
+      flipper[:shiny].enable
+
+      # clear the log of operations
+      adapter.reset
+
+      get '/specific', {}, 'flipper' => flipper
+
+      expect(adapter.operations.size).to be(2)
+      expect(adapter.count(:get_multi)).to be(1)
+      expect(adapter.count(:get)).to be(1)
+    end
+  end
+
   context 'with multiple instances' do
     let(:app) do
       # ensure scoped for builder block, annoying...

data/spec/flipper/serializers/gzip_spec.rb

@@ -0,0 +1,13 @@
+require 'flipper/serializers/gzip'
+
+RSpec.describe Flipper::Serializers::Gzip do
+  it "serializes and deserializes" do
+    serialized = described_class.serialize("my data")
+    expect(described_class.deserialize(serialized)).to eq("my data")
+  end
+
+  it "doesn't fail with nil" do
+    expect(described_class.serialize(nil)).to be(nil)
+    expect(described_class.deserialize(nil)).to be(nil)
+  end
+end

data/spec/flipper/serializers/json_spec.rb

@@ -0,0 +1,13 @@
+require 'flipper/serializers/json'
+
+RSpec.describe Flipper::Serializers::Json do
+  it "serializes and deserializes" do
+    serialized = described_class.serialize("my data")
+    expect(described_class.deserialize(serialized)).to eq("my data")
+  end
+
+  it "doesn't fail with nil" do
+    expect(described_class.serialize(nil)).to be(nil)
+    expect(described_class.deserialize(nil)).to be(nil)
+  end
+end

data/spec/flipper/typecast_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe Flipper::Typecast do
     nil => 0,
     '' => 0,
     0 => 0,
-    0.0 => 0,
+    0.0 => 0.0,
     1 => 1,
     1.1 => 1.1,
     '0.01' => 0.01,
@@ -65,9 +65,9 @@ RSpec.describe Flipper::Typecast do
     '99' => 99,
     '99.9' => 99.9,
   }.each do |value, expected|
-    context "#to_percentage for #{value.inspect}" do
+    context "#to_number for #{value.inspect}" do
       it "returns #{expected}" do
-        expect(described_class.to_percentage(value)).to be(expected)
+        expect(described_class.to_number(value)).to be(expected)
       end
     end
   end
@@ -99,14 +99,14 @@ RSpec.describe Flipper::Typecast do
 
   it 'raises argument error for bad integer percentage' do
     expect do
-      described_class.to_percentage(['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
+      described_class.to_number(['asdf'])
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a number))
   end
 
   it 'raises argument error for bad float percentage' do
     expect do
-      described_class.to_percentage(['asdf.0'])
-    end.to raise_error(ArgumentError, %(["asdf.0"] cannot be converted to a percentage))
+      described_class.to_number(['asdf.0'])
+    end.to raise_error(ArgumentError, %(["asdf.0"] cannot be converted to a number))
   end
 
   it 'raises argument error for set value that cannot be converted to a set' do
@@ -127,6 +127,30 @@ RSpec.describe Flipper::Typecast do
       expect(result["search"]).not_to be(hash["search"])
     end
 
+    it "converts does not convert expressions" do
+      hash = {
+        "search" => {
+          boolean: nil,
+          expression: {"Equal"=>[{"Property"=>["plan"]}, "basic"]},
+          groups: ['a', 'b'],
+          actors: ['User;1'],
+          percentage_of_actors: nil,
+          percentage_of_time: nil,
+        },
+      }
+      result = described_class.features_hash(hash)
+      expect(result).to eq({
+        "search" => {
+          boolean: nil,
+          expression: {"Equal"=>[{"Property"=>["plan"]}, "basic"]},
+          groups: Set['a', 'b'],
+          actors: Set['User;1'],
+          percentage_of_actors: nil,
+          percentage_of_time: nil,
+        },
+      })
+    end
+
     it "converts gate value arrays to sets" do
       hash = {
         "search" => {
@@ -193,4 +217,16 @@ RSpec.describe Flipper::Typecast do
       })
     end
   end
+
+  it "converts to and from json" do
+    source = {"foo" => "bar"}
+    output = described_class.to_json(source)
+    expect(described_class.from_json(output)).to eq(source)
+  end
+
+  it "converts to and from gzip" do
+    source = "foo bar"
+    output = described_class.to_gzip(source)
+    expect(described_class.from_gzip(output)).to eq(source)
+  end
 end

data/spec/flipper/types/actor_spec.rb

@@ -11,12 +11,19 @@ RSpec.describe Flipper::Types::Actor do
       attr_reader :flipper_id
 
       def initialize(flipper_id)
-        @flipper_id = flipper_id
+        @flipper_id = flipper_id.to_s
       end
 
       def admin?
         true
       end
+
+      def flipper_properties
+        {
+          "flipper_id" => flipper_id,
+          "admin" => admin?,
+        }
+      end
     end
   end
 
@@ -87,6 +94,15 @@ RSpec.describe Flipper::Types::Actor do
     expect(actor.admin?).to eq(true)
   end
 
+  it 'proxies flipper_properties to actor' do
+    actor = actor_class.new(10)
+    actor = described_class.new(actor)
+    expect(actor.flipper_properties).to eq({
+      "flipper_id" => "10",
+      "admin" => true,
+    })
+  end
+
   it 'exposes actor' do
     actor = actor_class.new(10)
     actor_type_instance = described_class.new(actor)
@@ -104,6 +120,7 @@ RSpec.describe Flipper::Types::Actor do
       actor = actor_class.new(10)
       actor_type_instance = described_class.new(actor)
       expect(actor_type_instance.respond_to?(:admin?)).to eq(true)
+      expect(actor_type_instance.respond_to?(:flipper_properties)).to eq(true)
     end
 
     it 'returns false if does not respond to method and actor does not respond to method' do

data/spec/flipper_integration_spec.rb

@@ -8,17 +8,24 @@ RSpec.describe Flipper do
   let(:dev_group)   { flipper.group(:devs) }
 
   let(:admin_actor) do
-    double 'Non Flipper Thing', flipper_id: 1,  admin?: true, dev?: false
+    double 'Non Flipper Thing', flipper_id: 1,  admin?: true, dev?: false, flipper_properties: {"admin" => true, "dev" => false}
   end
   let(:dev_actor) do
-    double 'Non Flipper Thing', flipper_id: 10, admin?: false, dev?: true
+    double 'Non Flipper Thing', flipper_id: 10, admin?: false, dev?: true, flipper_properties: {"admin" => false, "dev" => true}
   end
 
   let(:admin_truthy_actor) do
-    double 'Non Flipper Thing', flipper_id: 1,  admin?: 'true-ish', dev?: false
+    double 'Non Flipper Thing', flipper_id: 1,  admin?: 'true-ish', dev?: false, flipper_properties: {"admin" => "true-ish", "dev" => false}
   end
   let(:admin_falsey_actor) do
-    double 'Non Flipper Thing', flipper_id: 1,  admin?: nil, dev?: false
+    double 'Non Flipper Thing', flipper_id: 1,  admin?: nil, dev?: false, flipper_properties: {"admin" => nil, "dev" => false}
+  end
+
+  let(:basic_plan_actor) do
+    double 'Non Flipper Thing', flipper_id: 1, flipper_properties: {"plan" => "basic"}
+  end
+  let(:premium_plan_actor) do
+    double 'Non Flipper Thing', flipper_id: 10, flipper_properties: {"plan" => "premium"}
   end
 
   let(:pitt)        { Flipper::Actor.new(1) }
@@ -70,10 +77,12 @@ RSpec.describe Flipper do
 
       it 'enables feature for flipper actor in group' do
         expect(feature.enabled?(Flipper::Types::Actor.new(admin_actor))).to eq(true)
+        expect(feature.enabled?(admin_actor)).to eq(true)
       end
 
       it 'does not enable for flipper actor not in group' do
         expect(feature.enabled?(Flipper::Types::Actor.new(dev_actor))).to eq(false)
+        expect(feature.enabled?(dev_actor)).to eq(false)
       end
 
       it 'does not enable feature for all' do
@@ -257,10 +266,12 @@ RSpec.describe Flipper do
 
       it 'disables feature for flipper actor in group' do
         expect(feature.enabled?(Flipper::Types::Actor.new(admin_actor))).to eq(false)
+        expect(feature.enabled?(admin_actor)).to eq(false)
       end
 
       it 'does not disable feature for flipper actor in other groups' do
         expect(feature.enabled?(Flipper::Types::Actor.new(dev_actor))).to eq(true)
+        expect(feature.enabled?(dev_actor)).to eq(true)
       end
 
       it 'adds feature to set of features' do
@@ -379,6 +390,7 @@ RSpec.describe Flipper do
 
       it 'returns true for truthy block values' do
         expect(feature.enabled?(Flipper::Types::Actor.new(admin_truthy_actor))).to eq(true)
+        expect(feature.enabled?(admin_truthy_actor)).to eq(true)
       end
 
       it 'returns true if any actor is in enabled group' do
@@ -394,6 +406,7 @@ RSpec.describe Flipper do
 
       it 'returns false for falsey block values' do
         expect(feature.enabled?(Flipper::Types::Actor.new(admin_falsey_actor))).to eq(false)
+        expect(feature.enabled?(admin_falsey_actor)).to eq(false)
       end
     end
 
@@ -549,4 +562,89 @@ RSpec.describe Flipper do
       expect(feature.enabled?(dev_actor)).to eq(false)
     end
   end
+
+  context "for expression" do
+    it "works" do
+      feature.enable Flipper.property(:plan).eq("basic")
+
+      expect(feature.enabled?).to be(false)
+      expect(feature.enabled?(basic_plan_actor)).to be(true)
+      expect(feature.enabled?(premium_plan_actor)).to be(false)
+      expect(feature.enabled?(admin_actor)).to be(false)
+    end
+
+    it "works for true expression with no actor" do
+      feature.enable Flipper.boolean(true)
+      expect(feature.enabled?).to be(true)
+    end
+
+    it "works for multiple actors" do
+      feature.enable Flipper.property(:plan).eq("basic")
+
+      expect(feature.enabled?(basic_plan_actor, premium_plan_actor)).to be(true)
+      expect(feature.enabled?(premium_plan_actor, basic_plan_actor)).to be(true)
+      expect(feature.enabled?(premium_plan_actor, admin_actor)).to be(false)
+    end
+  end
+
+  context "for Any" do
+    it "works" do
+      expression = Flipper.any(
+        Flipper.property(:plan).eq("basic"),
+        Flipper.property(:plan).eq("plus"),
+      )
+      feature.enable expression
+
+      expect(feature.enabled?(basic_plan_actor)).to be(true)
+      expect(feature.enabled?(premium_plan_actor)).to be(false)
+    end
+  end
+
+  context "for All" do
+    it "works" do
+      true_actor = Flipper::Actor.new("User;1", {
+        "plan" => "basic",
+        "age" => 21,
+      })
+      false_actor = Flipper::Actor.new("User;1", {
+        "plan" => "basic",
+        "age" => 20,
+      })
+      expression = Flipper.all(
+        Flipper.property(:plan).eq("basic"),
+        Flipper.property(:age).eq(21)
+      )
+      feature.enable expression
+
+      expect(feature.enabled?(true_actor)).to be(true)
+      expect(feature.enabled?(false_actor)).to be(false)
+    end
+
+    it "works when nested" do
+      admin_actor = Flipper::Actor.new("User;1", {
+        "admin" => true,
+      })
+      true_actor = Flipper::Actor.new("User;1", {
+        "plan" => "basic",
+        "age" => 21,
+      })
+      false_actor = Flipper::Actor.new("User;1", {
+        "plan" => "basic",
+        "age" => 20,
+      })
+      expression = Flipper.any(
+        Flipper.property(:admin).eq(true),
+        Flipper.all(
+          Flipper.property(:plan).eq("basic"),
+          Flipper.property(:age).eq(21)
+        )
+      )
+
+      feature.enable expression
+
+      expect(feature.enabled?(admin_actor)).to be(true)
+      expect(feature.enabled?(true_actor)).to be(true)
+      expect(feature.enabled?(false_actor)).to be(false)
+    end
+  end
 end

data/spec/flipper_spec.rb

@@ -64,7 +64,12 @@ RSpec.describe Flipper do
 
   describe "delegation to instance" do
     let(:group) { Flipper::Types::Group.new(:admins) }
-    let(:actor) { Flipper::Actor.new("1") }
+    let(:actor) {
+      Flipper::Actor.new("1", {
+        "plan" => "basic",
+      })
+    }
+    let(:expression) { Flipper.property(:plan).eq("basic") }
 
     before do
       described_class.configure do |config|
@@ -88,6 +93,37 @@ RSpec.describe Flipper do
       expect(described_class.instance.enabled?(:search)).to be(false)
     end
 
+    it 'delegates expression to instance' do
+      expect(described_class.expression(:search)).to be(nil)
+
+      expression = Flipper.property(:plan).eq("basic")
+      Flipper.instance.enable_expression :search, expression
+
+      expect(described_class.expression(:search)).to eq(expression)
+    end
+
+    it 'delegates enable_expression to instance' do
+      described_class.enable_expression(:search, expression)
+      expect(described_class.instance.enabled?(:search, actor)).to be(true)
+    end
+
+    it 'delegates disable_expression to instance' do
+      described_class.disable_expression(:search)
+      expect(described_class.instance.enabled?(:search, actor)).to be(false)
+    end
+
+    it 'delegates add_expression to instance' do
+      described_class.add_expression(:search, expression)
+      expect(described_class.instance.enabled?(:search, actor)).to be(true)
+    end
+
+    it 'delegates remove_expression to instance' do
+      described_class.enable_expression(:search, Flipper.any(expression))
+      expect(described_class.instance.enabled?(:search, actor)).to be(true)
+      described_class.remove_expression(:search, expression)
+      expect(described_class.instance.enabled?(:search, actor)).to be(false)
+    end
+
     it 'delegates enable_actor to instance' do
       described_class.enable_actor(:search, actor)
       expect(described_class.instance.enabled?(:search, actor)).to be(true)
@@ -192,6 +228,10 @@ RSpec.describe Flipper do
       expect(described_class.memoizing?).to eq(described_class.adapter.memoizing?)
     end
 
+    it 'delegates read_only? to instance' do
+      expect(described_class.read_only?).to eq(described_class.adapter.read_only?)
+    end
+
     it 'delegates sync stuff to instance and does nothing' do
       expect(described_class.sync).to be(nil)
       expect(described_class.sync_secret).to be(nil)
@@ -326,4 +366,52 @@ RSpec.describe Flipper do
       expect(described_class.instance_variable_get('@groups_registry')).to eq(registry)
     end
   end
+
+  describe ".constant" do
+    it "returns Flipper::Expression::Constant instance" do
+      expect(described_class.constant(false)).to eq(Flipper::Expression::Constant.new(false))
+      expect(described_class.constant("string")).to eq(Flipper::Expression::Constant.new("string"))
+    end
+  end
+
+  describe ".property" do
+    it "returns Flipper::Expressions::Property expression" do
+      expect(Flipper.property("name")).to eq(Flipper::Expression.build(Property: "name"))
+    end
+  end
+
+  describe ".boolean" do
+    it "returns Flipper::Expressions::Boolean expression" do
+      expect(described_class.boolean(true)).to eq(Flipper::Expression.build(Boolean: true))
+      expect(described_class.boolean(false)).to eq(Flipper::Expression.build(Boolean: false))
+    end
+  end
+
+  describe ".random" do
+    it "returns Flipper::Expressions::Random expression" do
+      expect(Flipper.random(100)).to eq(Flipper::Expression.build(Random: 100))
+    end
+  end
+
+  describe ".any" do
+    let(:age_expression) { Flipper.property(:age).gte(21) }
+    let(:plan_expression) { Flipper.property(:plan).eq("basic") }
+
+    it "returns Flipper::Expressions::Any instance" do
+      expect(Flipper.any(age_expression, plan_expression)).to eq(
+        Flipper::Expression.build({Any: [age_expression, plan_expression]})
+      )
+    end
+  end
+
+  describe ".all" do
+    let(:age_expression) { Flipper.property(:age).gte(21) }
+    let(:plan_expression) { Flipper.property(:plan).eq("basic") }
+
+    it "returns Flipper::Expressions::All instance" do
+      expect(Flipper.all(age_expression, plan_expression)).to eq(
+        Flipper::Expression.build({All: [age_expression, plan_expression]})
+      )
+    end
+  end
 end