flipper 0.16.0 → 1.4.0

data/spec/fixtures/flipper_pstore_1679087600.json

@@ -0,0 +1,46 @@
+{
+  "version": 1,
+  "features": {
+    "search": {
+      "boolean": null,
+      "actors": [
+        "john",
+        "another",
+        "testing"
+      ],
+      "percentage_of_actors": null,
+      "percentage_of_time": null,
+      "groups": [
+        "admins"
+      ]
+    },
+    "new_pricing": {
+      "boolean": "true",
+      "actors": [],
+      "percentage_of_actors": null,
+      "percentage_of_time": null,
+      "groups": []
+    },
+    "google_analytics_tag": {
+      "boolean": null,
+      "actors": [],
+      "percentage_of_actors": "100",
+      "percentage_of_time": null,
+      "groups": []
+    },
+    "help_scout_tag": {
+      "boolean": null,
+      "actors": [],
+      "percentage_of_actors": null,
+      "percentage_of_time": "50",
+      "groups": []
+    },
+    "nope": {
+      "boolean": null,
+      "actors": [],
+      "percentage_of_actors": null,
+      "percentage_of_time": null,
+      "groups": []
+    }
+  }
+}

data/spec/flipper/actor_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Actor do
   it 'initializes with and knows flipper_id' do
     actor = described_class.new("User;235")
@@ -45,4 +43,14 @@ RSpec.describe Flipper::Actor do
       expect(actor1.==(actor2)).to be(false)
     end
   end
+
+  describe '#hash' do
+    it 'returns a hash-value based on the flipper id' do
+      h = {
+        described_class.new("User;123") => true
+      }
+      expect(h).to have_key(described_class.new("User;123"))
+      expect(h).not_to have_key(described_class.new("User;456"))
+    end
+  end
 end

data/spec/flipper/adapter_builder_spec.rb

@@ -0,0 +1,72 @@
+RSpec.describe Flipper::AdapterBuilder do
+  describe "#initialize" do
+    it "instance_eval's block with no arg" do
+      called = false
+      self_in_block = nil
+
+      described_class.new do
+        called = true
+        self_in_block = self
+      end
+
+      expect(self_in_block).to be_instance_of(described_class)
+      expect(called).to be(true)
+    end
+
+    it "evals block with arg" do
+      called = false
+      self_outside_block = self
+      self_in_block = nil
+
+      described_class.new do |arg|
+        called = true
+        self_in_block = self
+        expect(arg).to be_instance_of(described_class)
+      end
+
+      expect(self_in_block).to be(self_outside_block)
+      expect(called).to be(true)
+    end
+  end
+
+  describe "#use" do
+    it "wraps the store adapter with the given adapter" do
+      subject.use(Flipper::Adapters::Memoizable)
+      subject.use(Flipper::Adapters::Strict, :warn)
+
+      memoizable_adapter = subject.to_adapter
+      strict_adapter = memoizable_adapter.adapter
+      memory_adapter = strict_adapter.adapter
+
+      expect(memoizable_adapter).to be_instance_of(Flipper::Adapters::Memoizable)
+      expect(strict_adapter).to be_instance_of(Flipper::Adapters::Strict)
+      expect(strict_adapter.handler).to be(:warn)
+      expect(memory_adapter).to be_instance_of(Flipper::Adapters::Memory)
+    end
+
+    it "passes block to adapter initializer" do
+      expected_block = lambda {}
+      adapter_class = double('adapter class')
+
+      subject.use(adapter_class, &expected_block)
+
+      expect(adapter_class).to receive(:new) { |&block| expect(block).to be(expected_block) }.and_return(:adapter)
+      expect(subject.to_adapter).to be(:adapter)
+    end
+  end
+
+  describe "#store" do
+    it "defaults to memory adapter" do
+      expect(subject.to_adapter).to be_instance_of(Flipper::Adapters::Memory)
+    end
+
+    it "only saves one store" do
+      require "flipper/adapters/pstore"
+      subject.store(Flipper::Adapters::PStore)
+      expect(subject.to_adapter).to be_instance_of(Flipper::Adapters::PStore)
+
+      subject.store(Flipper::Adapters::Memory)
+      expect(subject.to_adapter).to be_instance_of(Flipper::Adapters::Memory)
+    end
+  end
+end

data/spec/flipper/adapter_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Adapter do
   let(:source_flipper) { build_flipper }
   let(:destination_flipper) { build_flipper }
@@ -8,6 +6,7 @@ RSpec.describe Flipper::Adapter do
       boolean: nil,
       groups: Set.new,
       actors: Set.new,
+      expression: nil,
       percentage_of_actors: nil,
       percentage_of_time: nil,
     }
@@ -16,7 +15,7 @@ RSpec.describe Flipper::Adapter do
   describe '.default_config' do
     it 'returns default config' do
       adapter_class = Class.new do
-        include Flipper::Adapter # rubocop:disable RSpec/DescribedClass
+        include Flipper::Adapter
       end
       expect(adapter_class.default_config).to eq(default_config)
     end
@@ -25,16 +24,16 @@ RSpec.describe Flipper::Adapter do
   describe '#default_config' do
     it 'returns default config' do
       adapter_class = Class.new do
-        include Flipper::Adapter # rubocop:disable RSpec/DescribedClass
+        include Flipper::Adapter
       end
       expect(adapter_class.new.default_config).to eq(default_config)
     end
   end
 
   describe '#import' do
-    it 'returns nothing' do
+    it 'returns true' do
       result = destination_flipper.import(source_flipper)
-      expect(result).to be(nil)
+      expect(result).to be(true)
     end
 
     it 'can import from one adapter to another' do
@@ -116,5 +115,52 @@ RSpec.describe Flipper::Adapter do
       destination_flipper.import(source_flipper)
       expect(destination_flipper.features.map(&:key)).to eq([])
     end
+
+    it 'can import an export' do
+      source_flipper.enable(:search)
+      source_flipper.enable(:google_analytics, Flipper::Actor.new("User;1"))
+
+      destination_flipper.import(source_flipper.export)
+
+      feature = destination_flipper[:search]
+      expect(feature.boolean_value).to be(true)
+
+      feature = destination_flipper[:google_analytics]
+      expect(feature.actors_value).to eq(Set["User;1"])
+    end
+  end
+
+  describe "#export" do
+    it "exports features" do
+      source_flipper.enable(:search)
+      export = source_flipper.export
+      expect(export.features.dig("search", :boolean)).to eq("true")
+    end
+
+    it "exports with arguments" do
+      source_flipper.enable(:search)
+      export = source_flipper.export(format: :json, version: 1)
+      expect(export.features.dig("search", :boolean)).to eq("true")
+    end
+  end
+
+  describe "#adapter_stack" do
+    it "returns the adapter name for a simple adapter" do
+      adapter = Flipper::Adapters::Memory.new
+      expect(adapter.adapter_stack).to eq("memory")
+    end
+
+    it "returns the chain for wrapped adapters" do
+      memory = Flipper::Adapters::Memory.new
+      memoizable = Flipper::Adapters::Memoizable.new(memory)
+      expect(memoizable.adapter_stack).to eq("memoizable -> memory")
+    end
+
+    it "returns the chain for deeply nested adapters" do
+      memory = Flipper::Adapters::Memory.new
+      strict = Flipper::Adapters::Strict.new(memory)
+      memoizable = Flipper::Adapters::Memoizable.new(strict)
+      expect(memoizable.adapter_stack).to eq("memoizable -> strict -> memory")
+    end
   end
 end

data/spec/flipper/adapters/actor_limit_spec.rb

@@ -0,0 +1,75 @@
+require "flipper/adapters/actor_limit"
+
+RSpec.describe Flipper::Adapters::ActorLimit do
+  it_should_behave_like 'a flipper adapter' do
+    let(:limit) { 5 }
+    let(:adapter) { Flipper::Adapters::ActorLimit.new(Flipper::Adapters::Memory.new, limit) }
+
+    subject { adapter }
+
+    describe '#enable' do
+      it "fails when limit exceeded" do
+        5.times { |i| feature.enable Flipper::Actor.new("User;#{i}") }
+
+        expect {
+          feature.enable Flipper::Actor.new("User;6")
+        }.to raise_error(Flipper::Adapters::ActorLimit::LimitExceeded)
+      end
+
+      it "allows exceeding limit when in sync mode" do
+        5.times { |i| feature.enable Flipper::Actor.new("User;#{i}") }
+
+        described_class.with_sync_mode do
+          expect {
+            feature.enable Flipper::Actor.new("User;6")
+          }.not_to raise_error
+        end
+      end
+    end
+  end
+
+  describe '.sync_mode' do
+    after do
+      described_class.sync_mode = nil
+    end
+
+    it 'defaults to nil/falsy' do
+      expect(described_class.sync_mode).to be_falsy
+    end
+
+    it 'can be set and read' do
+      described_class.sync_mode = true
+      expect(described_class.sync_mode).to be true
+    end
+  end
+
+  describe '.with_sync_mode' do
+    after do
+      described_class.sync_mode = nil
+    end
+
+    it 'sets sync_mode to true within block' do
+      described_class.with_sync_mode do
+        expect(described_class.sync_mode).to be true
+      end
+    end
+
+    it 'restores previous value after block' do
+      expect(described_class.sync_mode).to be_falsy
+      described_class.with_sync_mode { }
+      expect(described_class.sync_mode).to be_falsy
+    end
+
+    it 'restores previous value even on exception' do
+      expect {
+        described_class.with_sync_mode { raise "boom" }
+      }.to raise_error("boom")
+      expect(described_class.sync_mode).to be_falsy
+    end
+
+    it 'returns the block result' do
+      result = described_class.with_sync_mode { 42 }
+      expect(result).to eq(42)
+    end
+  end
+end

data/spec/flipper/adapters/dual_write_spec.rb

@@ -0,0 +1,82 @@
+require 'flipper/adapters/dual_write'
+require 'flipper/adapters/operation_logger'
+require 'active_support/notifications'
+
+RSpec.describe Flipper::Adapters::DualWrite do
+  let(:local_adapter) do
+    Flipper::Adapters::OperationLogger.new Flipper::Adapters::Memory.new
+  end
+  let(:remote_adapter) do
+    Flipper::Adapters::OperationLogger.new Flipper::Adapters::Memory.new
+  end
+  let(:local) { Flipper.new(local_adapter) }
+  let(:remote) { Flipper.new(remote_adapter) }
+  let(:sync) { Flipper.new(subject) }
+
+  subject do
+    described_class.new(local_adapter, remote_adapter)
+  end
+
+  it_should_behave_like 'a flipper adapter'
+
+  it 'only uses local for #features' do
+    subject.features
+  end
+
+  it 'only uses local for #get' do
+    subject.get sync[:search]
+  end
+
+  it 'only uses local for #get_multi' do
+    subject.get_multi [sync[:search]]
+  end
+
+  it 'only uses local for #get_all' do
+    subject.get_all
+  end
+
+  it 'updates remote and local for #add' do
+    subject.add sync[:search]
+    expect(remote_adapter.count(:add)).to be(1)
+    expect(local_adapter.count(:add)).to be(1)
+  end
+
+  it 'updates remote and local for #remove' do
+    subject.remove sync[:search]
+    expect(remote_adapter.count(:remove)).to be(1)
+    expect(local_adapter.count(:remove)).to be(1)
+  end
+
+  it 'updates remote and local for #clear' do
+    subject.clear sync[:search]
+    expect(remote_adapter.count(:clear)).to be(1)
+    expect(local_adapter.count(:clear)).to be(1)
+  end
+
+  it 'updates remote and local for #enable' do
+    feature = sync[:search]
+    subject.enable feature, feature.gate(:boolean), Flipper::Types::Boolean.new(true)
+    expect(remote_adapter.count(:enable)).to be(1)
+    expect(local_adapter.count(:enable)).to be(1)
+  end
+
+  it 'updates remote and local for #disable' do
+    feature = sync[:search]
+    subject.disable feature, feature.gate(:boolean), Flipper::Types::Boolean.new(false)
+    expect(remote_adapter.count(:disable)).to be(1)
+    expect(local_adapter.count(:disable)).to be(1)
+  end
+
+  describe '#adapter_stack' do
+    it 'returns the tree representation' do
+      expect(subject.adapter_stack).to eq("dual_write(local: operation_logger -> memory, remote: operation_logger -> memory)")
+    end
+
+    it 'shows nested adapters in the tree' do
+      memory = Flipper::Adapters::Memory.new
+      strict = Flipper::Adapters::Strict.new(Flipper::Adapters::Memory.new)
+      adapter = described_class.new(memory, strict)
+      expect(adapter.adapter_stack).to eq("dual_write(local: memory, remote: strict -> memory)")
+    end
+  end
+end

data/spec/flipper/adapters/failover_spec.rb

@@ -0,0 +1,141 @@
+require 'dalli'
+require 'flipper/adapters/failover'
+require 'net/http'
+require 'pstore'
+require 'redis'
+
+RSpec.describe Flipper::Adapters::Failover do
+  subject { described_class.new(primary, secondary, options) }
+
+  let(:primary) { Flipper::Adapters::Memory.new }
+  let(:secondary) { Flipper::Adapters::Memory.new }
+  let(:options) { {} }
+  let(:flipper) { Flipper.new(subject) }
+
+  context 'when the primary is a functioning adapter' do
+    it_should_behave_like 'a flipper adapter'
+
+    it 'should not call the secondary' do
+      expect(secondary).not_to receive(:features)
+      subject.features
+    end
+
+    it 'should not write to secondary' do
+      expect(secondary).not_to receive(:add)
+      expect(secondary).not_to receive(:enable)
+
+      flipper[:flag].enable
+    end
+
+    context 'when dual_write is enabled' do
+      let(:options) { { dual_write: true } }
+
+      it_should_behave_like 'a flipper adapter'
+
+      it 'writes to both primary and secondary' do
+        expect(primary).to receive(:add).and_call_original
+        expect(primary).to receive(:enable).and_call_original
+
+        expect(secondary).to receive(:add)
+        expect(secondary).to receive(:enable)
+
+        flipper[:flag].enable
+      end
+    end
+  end
+
+  context 'when primary fails during read operations' do
+    before do
+      allow(primary).to receive(:features).and_raise(Redis::ConnectionError)
+      allow(primary).to receive(:get).and_raise(Dalli::NetworkError)
+    end
+
+    it 'fails over to the secondary adapter for reads' do
+      expect(secondary).to receive(:features)
+      subject.features
+
+      flipper[:flag].enable
+      expect(secondary).to receive(:get).and_call_original
+      flipper[:flag].enabled?
+    end
+
+    context 'when dual_write is enabled' do
+      let(:options) { { dual_write: true } }
+
+      it_should_behave_like 'a flipper adapter'
+    end
+  end
+
+  context 'when primary fails during write operations' do
+    before do
+      allow(primary).to receive(:add).and_raise(PStore::Error)
+    end
+
+    let(:options) { { dual_write: true } }
+
+    it 'fails and does not write to secondary adapter' do
+      expect(secondary).not_to receive(:add)
+      expect(secondary).not_to receive(:enable)
+
+      expect { flipper[:flag].enable }.to raise_error(PStore::Error)
+    end
+  end
+
+  context 'when primary is instrumented and fails' do
+    before do
+      allow(memory_adapter).to receive(:get).and_raise(Net::ReadTimeout)
+    end
+
+    let(:memory_adapter) { Flipper::Adapters::Memory.new }
+    let(:primary) do
+      Flipper::Adapters::Instrumented.new(
+        memory_adapter,
+        instrumenter: instrumenter,
+      )
+    end
+    let(:instrumenter) { Flipper::Instrumenters::Memory.new }
+
+    it 'logs the raised exception' do
+      flipper[:flag].enabled?
+
+      expect(instrumenter.events.count).to be 1
+
+      payload = instrumenter.events[0].payload
+      expect(payload.keys).to include(:exception, :exception_object)
+      expect(payload[:exception_object]).to be_a Net::ReadTimeout
+    end
+  end
+
+  context 'when adapter raises a SyntaxError' do
+    before do
+      allow(primary).to receive(:features).and_raise(SyntaxError)
+    end
+
+    it 'does not rescue this type by default' do
+      expect {
+        subject.features
+      }.to raise_error(SyntaxError)
+    end
+
+    context 'when Failover adapter is configured to catch SyntaxError' do
+      let(:options) { { errors: [ SyntaxError ] } }
+
+      it 'fails over to secondary adapter' do
+        expect(secondary).to receive(:features)
+        subject.features
+      end
+    end
+  end
+
+  describe '#adapter_stack' do
+    it 'returns the tree representation' do
+      expect(subject.adapter_stack).to eq("failover(primary: memory, secondary: memory)")
+    end
+
+    it 'shows nested adapters in the tree' do
+      strict_primary = Flipper::Adapters::Strict.new(primary)
+      adapter = described_class.new(strict_primary, secondary)
+      expect(adapter.adapter_stack).to eq("failover(primary: strict -> memory, secondary: memory)")
+    end
+  end
+end

data/spec/flipper/adapters/failsafe_spec.rb

@@ -0,0 +1,58 @@
+require 'flipper/adapters/failsafe'
+
+RSpec.describe Flipper::Adapters::Failsafe do
+  subject { described_class.new(memory_adapter, options) }
+
+  let(:memory_adapter) { Flipper::Adapters::Memory.new }
+  let(:options) { {} }
+  let(:flipper) { Flipper.new(subject) }
+
+  it_should_behave_like 'a flipper adapter'
+
+  context 'when disaster strikes' do
+    before do
+      expect(flipper[feature.name].enable).to be(true)
+
+      (subject.methods - Object.methods).each do |method_name|
+        allow(memory_adapter).to receive(method_name).and_raise(IOError)
+      end
+    end
+
+    let(:feature) { Flipper::Feature.new(:my_feature, subject) }
+
+    it { expect(subject.features).to eq(Set.new) }
+    it { expect(feature.add).to eq(false) }
+    it { expect(feature.remove).to eq(false) }
+    it { expect(feature.clear).to eq(false) }
+    it { expect(subject.get(feature)).to eq({}) }
+    it { expect(subject.get_multi([feature])).to eq({}) }
+    it { expect(subject.get_all).to eq({}) }
+    it { expect(feature.enable).to eq(false) }
+    it { expect(feature.disable).to eq(false) }
+
+    context 'when used via Flipper' do
+      it { expect(flipper.features).to eq(Set.new) }
+      it { expect(flipper[feature.name].enabled?).to eq(false) }
+      it { expect(flipper[feature.name].enable).to eq(false) }
+      it { expect(flipper[feature.name].disable).to eq(false) }
+    end
+
+    context 'when there is a syntax error' do
+      let(:test) { flipper[feature.name].enabled? }
+
+      before do
+        expect(memory_adapter).to receive(:get).and_raise(SyntaxError)
+      end
+
+      it 'does not catch this type of error' do
+        expect { test }.to raise_error(SyntaxError)
+      end
+
+      context 'when configured to catch SyntaxError' do
+        let(:options) { { errors: [SyntaxError] } }
+
+        it { expect(test).to eq(false) }
+      end
+    end
+  end
+end

data/spec/flipper/adapters/http/client_spec.rb

@@ -0,0 +1,61 @@
+require "flipper/adapters/http/client"
+
+RSpec.describe Flipper::Adapters::Http::Client do
+  describe "#initialize" do
+    it "requires url" do
+      expect { described_class.new }.to raise_error(KeyError, "key not found: :url")
+    end
+
+    it "sets default headers" do
+      client = described_class.new(url: "http://example.com")
+      expect(client.headers).to eq({
+        'content-type' => 'application/json',
+        'accept' => 'application/json',
+        'user-agent' => "Flipper HTTP Adapter v#{Flipper::VERSION}",
+      })
+    end
+
+    it "adds custom headers" do
+      client = described_class.new(url: "http://example.com", headers: {'custom-header' => 'value'})
+      expect(client.headers).to include('custom-header' => 'value')
+    end
+
+    it "overrides default headers with custom headers" do
+      client = described_class.new(url: "http://example.com", headers: {'content-type' => 'text/plain'})
+      expect(client.headers['content-type']).to eq('text/plain')
+    end
+  end
+
+  describe "#add_header" do
+    it "can add string header" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header("key", "value")
+      expect(client.headers.fetch("key")).to eq("value")
+    end
+
+    it "standardizes key to lowercase" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header("Content-Type", "value")
+      expect(client.headers.fetch("content-type")).to eq("value")
+    end
+
+    it "standardizes key to dashes" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header(:content_type, "value")
+      expect(client.headers.fetch("content-type")).to eq("value")
+    end
+
+    it "can add symbol header" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header(:key, "value")
+      expect(client.headers.fetch("key")).to eq("value")
+    end
+
+    it "overrides existing header" do
+      client = described_class.new(url: "http://example.com")
+      client.add_header("key", "value 1")
+      client.add_header("key", "value 2")
+      expect(client.headers.fetch("key")).to eq("value 2")
+    end
+  end
+end