flipper 0.22.2 → 0.23.0

data/spec/flipper/adapters/failover_spec.rb

@@ -0,0 +1,129 @@
+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
+end

data/spec/flipper/adapters/http_spec.rb

@@ -1,7 +1,5 @@
-require 'helper'
 require 'flipper/adapters/http'
 require 'flipper/adapters/pstore'
-require 'flipper/spec/shared_adapter_specs'
 require 'rack/handler/webrick'
 
 FLIPPER_SPEC_API_PORT = ENV.fetch('FLIPPER_SPEC_API_PORT', 9001).to_i
@@ -159,6 +157,19 @@ RSpec.describe Flipper::Adapters::Http do
       stub_request(:post, /app.com/)
         .to_return(status: 503, body: "{}", headers: {})
 
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      feature = Flipper::Feature.new(:search, adapter)
+      gate = feature.gate(:boolean)
+      thing = gate.wrap(true)
+      expect {
+        adapter.enable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error, "Failed with status: 503")
+    end
+
+    it "doesn't raise json error if body cannot be parsed" do
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: "barf", headers: {})
+
       adapter = described_class.new(url: 'http://app.com/flipper')
       feature = Flipper::Feature.new(:search, adapter)
       gate = feature.gate(:boolean)
@@ -167,6 +178,30 @@ RSpec.describe Flipper::Adapters::Http do
         adapter.enable(feature, gate, thing)
       }.to raise_error(Flipper::Adapters::Http::Error)
     end
+
+    it "includes response information if available when raising error" do
+      api_response = {
+        "code" => "error",
+        "message" => "This feature has reached the limit to the number of " +
+                     "actors per feature. Check out groups as a more flexible " +
+                     "way to enable many actors.",
+        "more_info" => "https://www.flippercloud.io/docs",
+      }
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: JSON.dump(api_response), headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      feature = Flipper::Feature.new(:search, adapter)
+      gate = feature.gate(:boolean)
+      thing = gate.wrap(true)
+      error_message = "Failed with status: 503\n\nThis feature has reached the " +
+                      "limit to the number of actors per feature. Check out " +
+                      "groups as a more flexible way to enable many actors.\n" +
+                      "https://www.flippercloud.io/docs"
+      expect {
+        adapter.enable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error, error_message)
+    end
   end
 
   describe "#disable" do
@@ -202,7 +237,8 @@ RSpec.describe Flipper::Adapters::Http do
     let(:feature) { flipper[:feature_panel] }
 
     before do
-      stub_request(:get, %r{\Ahttp://app.com*}).to_return(body: fixture_file('feature.json'))
+      stub_request(:get, %r{\Ahttp://app.com*}).
+        to_return(body: fixture_file('feature.json'))
     end
 
     it 'allows client to set request headers' do

data/spec/flipper/adapters/instrumented_spec.rb

@@ -1,7 +1,5 @@
-require 'helper'
 require 'flipper/adapters/instrumented'
 require 'flipper/instrumenters/memory'
-require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::Instrumented do
   let(:instrumenter) { Flipper::Instrumenters::Memory.new }

data/spec/flipper/adapters/memoizable_spec.rb

@@ -1,7 +1,5 @@
-require 'helper'
 require 'flipper/adapters/memoizable'
 require 'flipper/adapters/operation_logger'
-require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::Memoizable do
   let(:features_key) { described_class::FeaturesKey }

data/spec/flipper/adapters/memory_spec.rb

@@ -1,6 +1,3 @@
-require 'helper'
-require 'flipper/spec/shared_adapter_specs'
-
 RSpec.describe Flipper::Adapters::Memory do
   let(:source) { {} }
   subject { described_class.new(source) }

data/spec/flipper/adapters/operation_logger_spec.rb

@@ -1,6 +1,4 @@
-require 'helper'
 require 'flipper/adapters/operation_logger'
-require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::OperationLogger do
   let(:operations) { [] }

data/spec/flipper/adapters/pstore_spec.rb

@@ -1,6 +1,4 @@
-require 'helper'
 require 'flipper/adapters/pstore'
-require 'flipper/spec/shared_adapter_specs'
 
 RSpec.describe Flipper::Adapters::PStore do
   subject do

data/spec/flipper/adapters/read_only_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/adapters/read_only'
 
 RSpec.describe Flipper::Adapters::ReadOnly do

data/spec/flipper/adapters/sync/feature_synchronizer_spec.rb

@@ -1,4 +1,3 @@
-require "helper"
 require "flipper/adapters/memory"
 require "flipper/adapters/operation_logger"
 require "flipper/adapters/sync/feature_synchronizer"

data/spec/flipper/adapters/sync/interval_synchronizer_spec.rb

@@ -1,10 +1,10 @@
-require "helper"
 require "flipper/adapters/sync/interval_synchronizer"
 
 RSpec.describe Flipper::Adapters::Sync::IntervalSynchronizer do
   let(:events) { [] }
-  let(:synchronizer) { -> { events << described_class.now } }
+  let(:synchronizer) { -> { events << now } }
   let(:interval) { 10 }
+  let(:now) { subject.send(:now) }
 
   subject { described_class.new(synchronizer, interval: interval) }
 
@@ -15,19 +15,18 @@ RSpec.describe Flipper::Adapters::Sync::IntervalSynchronizer do
   end
 
   it "only invokes wrapped synchronizer every interval seconds" do
-    now = described_class.now
     subject.call
     events.clear
 
     # move time to one millisecond less than last sync + interval
     1.upto(interval) do |i|
-      allow(described_class).to receive(:now).and_return(now + i - 1)
+      allow(subject).to receive(:now).and_return(now + i - 1)
       subject.call
     end
     expect(events.size).to be(0)
 
     # move time to last sync + interval in milliseconds
-    allow(described_class).to receive(:now).and_return(now + interval)
+    allow(subject).to receive(:now).and_return(now + interval)
     subject.call
     expect(events.size).to be(1)
   end

data/spec/flipper/adapters/sync/synchronizer_spec.rb

@@ -1,4 +1,3 @@
-require "helper"
 require "flipper/adapters/memory"
 require "flipper/instrumenters/memory"
 require "flipper/adapters/sync/synchronizer"

data/spec/flipper/adapters/sync_spec.rb

@@ -1,7 +1,5 @@
-require 'helper'
 require 'flipper/adapters/sync'
 require 'flipper/adapters/operation_logger'
-require 'flipper/spec/shared_adapter_specs'
 require 'active_support/notifications'
 
 RSpec.describe Flipper::Adapters::Sync do

data/spec/flipper/configuration_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/configuration'
 
 RSpec.describe Flipper::Configuration do

data/spec/flipper/dsl_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/dsl'
 
 RSpec.describe Flipper::DSL do

data/spec/flipper/feature_check_context_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::FeatureCheckContext do
   let(:feature_name) { :new_profiles }
   let(:values) { Flipper::GateValues.new({}) }

data/spec/flipper/feature_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/feature'
 require 'flipper/instrumenters/memory'
 

data/spec/flipper/gate_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Gate do
   let(:feature_name) { :stats }
 

data/spec/flipper/gate_values_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/gate_values'
 
 RSpec.describe Flipper::GateValues do

data/spec/flipper/gates/actor_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Gates::Actor do
   let(:feature_name) { :search }
 

data/spec/flipper/gates/boolean_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Gates::Boolean do
   let(:feature_name) { :search }
 

data/spec/flipper/gates/group_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Gates::Group do
   let(:feature_name) { :search }
 

data/spec/flipper/gates/percentage_of_actors_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Gates::PercentageOfActors do
   let(:feature_name) { :search }
 

data/spec/flipper/gates/percentage_of_time_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Gates::PercentageOfTime do
   let(:feature_name) { :search }
 

data/spec/flipper/identifier_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/identifier'
 
 RSpec.describe Flipper::Identifier do

data/spec/flipper/instrumentation/log_subscriber_spec.rb

@@ -1,5 +1,4 @@
 require 'logger'
-require 'helper'
 require 'flipper/adapters/instrumented'
 require 'flipper/instrumentation/log_subscriber'
 

data/spec/flipper/instrumentation/statsd_subscriber_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/adapters/instrumented'
 require 'flipper/instrumentation/statsd'
 require 'statsd'

data/spec/flipper/instrumenters/memory_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/instrumenters/memory'
 
 RSpec.describe Flipper::Instrumenters::Memory do
@@ -22,5 +21,23 @@ RSpec.describe Flipper::Instrumenters::Memory do
       event = described_class::Event.new(name, payload, block_result)
       expect(instrumenter.events).to eq([event])
     end
+
+    context 'when an error is raised' do
+      subject do
+        instrumenter.instrument(:name) { raise IOError }
+      end
+
+      let(:instrumenter) { described_class.new }
+
+      it 'captures and propagates the error' do
+        expect { subject }.to raise_error(IOError)
+
+        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 IOError
+      end
+    end
   end
 end

data/spec/flipper/instrumenters/noop_spec.rb

@@ -1,20 +1,26 @@
-require 'helper'
-
 RSpec.describe Flipper::Instrumenters::Noop do
   describe '.instrument' do
     context 'with name' do
       it 'yields block' do
-        yielded = false
-        described_class.instrument(:foo) { yielded = true }
-        expect(yielded).to eq(true)
+        expect { |block|
+          described_class.instrument(:foo, &block)
+        }.to yield_control
       end
     end
 
     context 'with name and payload' do
+      let(:payload) { { pay: :load } }
+
       it 'yields block' do
-        yielded = false
-        described_class.instrument(:foo, pay: :load) { yielded = true }
-        expect(yielded).to eq(true)
+        expect { |block|
+          described_class.instrument(:foo, payload, &block)
+        }.to yield_control
+      end
+
+      it 'yields the payload' do
+        described_class.instrument(:foo, payload) do |block_payload|
+          expect(block_payload).to eq payload
+        end
       end
     end
   end

data/spec/flipper/middleware/memoizer_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'rack/test'
 require 'active_support/cache'
 require 'active_support/cache/dalli_store'
@@ -362,7 +361,6 @@ RSpec.describe Flipper::Middleware::Memoizer do
       end.to_app
     end
 
-
     context 'and unless option' do
       before do
         options[:unless] = ->(request) { request.path.start_with?("/assets") }

data/spec/flipper/middleware/setup_env_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Middleware::SetupEnv do
   context 'with flipper instance' do
     let(:app) do

data/spec/flipper/railtie_spec.rb

@@ -1,32 +1,30 @@
-require 'helper'
 require 'rails'
 require 'flipper/railtie'
 
 RSpec.describe Flipper::Railtie do
   let(:application) do
-    app = Class.new(Rails::Application).new(
+    Class.new(Rails::Application).new(
       railties: [Flipper::Railtie],
-      ordered_railties: [Flipper::Railtie]
-    )
-    app.config.eager_load = false
-    app.config.logger = ActiveSupport::Logger.new($stdout)
-    app.run_load_hooks!
+    ).tap do |app|
+      app.config.eager_load = false
+      app.run_load_hooks!
+    end
   end
 
   before do
-    Rails.application = nil
+    ActiveSupport::Dependencies.autoload_paths = ActiveSupport::Dependencies.autoload_paths.dup
+    ActiveSupport::Dependencies.autoload_once_paths = ActiveSupport::Dependencies.autoload_once_paths.dup
   end
 
-  subject do
-    application.initialize!
-    application
-  end
+  let(:config) { application.config.flipper }
+
+  subject { application.initialize! }
 
   describe 'initializers' do
     it 'sets defaults' do
-      expect(application.config.flipper.env_key).to eq("flipper")
-      expect(application.config.flipper.memoize).to be(true)
-      expect(application.config.flipper.preload).to be(true)
+      expect(config.env_key).to eq("flipper")
+      expect(config.memoize).to be(true)
+      expect(config.preload).to be(true)
     end
 
     it "configures instrumentor on default instance" do
@@ -36,19 +34,19 @@ RSpec.describe Flipper::Railtie do
     end
 
     it 'uses Memoizer middleware if config.memoize = true' do
-      expect(subject.middleware.last).to eq(Flipper::Middleware::Memoizer)
+      expect(subject.middleware).to include(Flipper::Middleware::Memoizer)
     end
 
     it 'does not use Memoizer middleware if config.memoize = false' do
       # load but don't initialize
-      application.config.flipper.memoize = false
+      config.memoize = false
 
-      expect(subject.middleware.last).not_to eq(Flipper::Middleware::Memoizer)
+      expect(subject.middleware).not_to include(Flipper::Middleware::Memoizer)
     end
 
     it 'passes config to memoizer' do
       # load but don't initialize
-      application.config.flipper.update(
+      config.update(
         env_key: 'my_flipper',
         preload: [:stats, :search]
       )

data/spec/flipper/registry_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/registry'
 
 RSpec.describe Flipper::Registry do

data/spec/flipper/typecast_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/typecast'
 
 RSpec.describe Flipper::Typecast do

data/spec/flipper/types/actor_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/types/actor'
 
 RSpec.describe Flipper::Types::Actor do

data/spec/flipper/types/boolean_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/types/boolean'
 
 RSpec.describe Flipper::Types::Boolean do

data/spec/flipper/types/group_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/types/group'
 
 RSpec.describe Flipper::Types::Group do

data/spec/flipper/types/percentage_of_actors_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/types/percentage_of_actors'
 
 RSpec.describe Flipper::Types::PercentageOfActors do

data/spec/flipper/types/percentage_of_time_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/types/percentage_of_time'
 
 RSpec.describe Flipper::Types::PercentageOfTime do

data/spec/flipper/types/percentage_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/types/percentage_of_actors'
 
 RSpec.describe Flipper::Types::Percentage do

data/spec/flipper_integration_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/feature'
 
 RSpec.describe Flipper do

data/spec/flipper_spec.rb

@@ -1,4 +1,3 @@
-require 'helper'
 require 'flipper/cloud'
 
 RSpec.describe Flipper do

data/spec/{helper.rb → spec_helper.rb}

@@ -14,8 +14,9 @@ require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 
 require 'flipper'
-require 'flipper/ui'
 require 'flipper/api'
+require 'flipper/spec/shared_adapter_specs'
+require 'flipper/ui'
 
 Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 

data/spec/support/spec_helpers.rb

@@ -1,4 +1,4 @@
-require 'climate_control'
+require 'ice_age'
 require 'json'
 require 'rack/test'
 
@@ -31,7 +31,7 @@ module SpecHelpers
   end
 
   def api_error_code_reference_url
-    'https://github.com/jnunemaker/flipper/tree/master/docs/api#error-code-reference'
+    'https://flippercloud.io/docs/api#error-code-reference'
   end
 
   def api_not_found_response
@@ -58,10 +58,6 @@ module SpecHelpers
     }
   end
 
-  def with_modified_env(options, &block)
-    ClimateControl.modify(options, &block)
-  end
-
   def silence
     # Store the original stderr and stdout in order to restore them later
     original_stderr = $stderr