flipper 0.19.1 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77bf46fd4c4a3bc04f7cfd38cbd48083dbd72855a809df63ab33a429bf8dc902
-  data.tar.gz: 43bbedd3cb73e09b6323c9841dd4cec1ac5298a7c42ff68affab032dd7f63fc4
+  metadata.gz: 3419ab68fa52334e5a6f71463c213a039f819439dc71c836c8c3b70b4c80270b
+  data.tar.gz: d6ade104432d5f5eaab36f00ccd0b559ee9bd9af4772a224cb9f70d26f578062
 SHA512:
-  metadata.gz: 98f7becbf89ad1fe63f7c6425b4600e80b27d1af7136fe61c1e3ce0a449dfce01e1720a00d3eee1e3cc08e4fedee055f9b9991c49d6c025e601337fc7ac1c10f
-  data.tar.gz: f219af56cf0c3ae7ec6b43cf1a774b4e62c9e4b73ad8b5a8b88ae1c8556ee49c2051191e332c456d448fbca810f623f2add81f9d6040ec30fced90cdb48ab651
+  metadata.gz: 48bc857cb049418b020bc1216de81238df104321b62c7ff3b3967dfdc8dfedf18a1779d58c84db233cc67d9058a1b7beb295e671739a232f8384cf324879b950
+  data.tar.gz: b5e0c90341f3b0a4f61a72ee26810ccdec216f32bd7e07b022f15ca04b075eb44a53bd392afdb91d7a868d3c724c96b2a962a37ed54fd5614a3a5f385e0ac147

data/Changelog.md

@@ -1,3 +1,15 @@
+## 0.20.1
+
+### Additions/Changes
+
+* Just a minor tweak to cloud webhook middleware to provide more debugging information about why a hook wasn't successful.
+
+## 0.20.0
+
+### Additions/Changes
+
+* Add support for webhooks to `Flipper::Cloud` (https://github.com/jnunemaker/flipper/pull/489).
+
 ## 0.19.1
 
 ### Additions/Changes

data/Gemfile

@@ -17,6 +17,7 @@ gem 'rails', "~> #{ENV['RAILS_VERSION'] || '6.0.0'}"
 gem 'minitest', '~> 5.8'
 gem 'minitest-documentation'
 gem 'webmock', '~> 3.0'
+gem 'climate_control'
 
 group(:guard) do
   gem 'guard', '~> 2.15'

data/docs/Optimization.md

@@ -7,7 +7,7 @@ One optimization that flipper provides is a memoizing middleware. The memoizing
 You can use the middleware like so for Rails:
 
 ```ruby
-# setup default instance (perhaps in config/initializer/flipper.rb)
+# setup default instance (perhaps in config/initializers/flipper.rb)
 Flipper.configure do |config|
   config.default do
     Flipper.new(...)
@@ -15,7 +15,7 @@ Flipper.configure do |config|
 end
 
 # This assumes you setup a default flipper instance using configure.
-config.middleware.use Flipper::Middleware::Memoizer
+Rails.configuration.middleware.use Flipper::Middleware::Memoizer
 ```
 
 **Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.
@@ -23,8 +23,8 @@ config.middleware.use Flipper::Middleware::Memoizer
 **Also Note**: If you haven't setup a default instance, you can pass the instance to `SetupEnv` as `Memoizer` uses whatever is setup in the `env`:
 
 ```ruby
-config.middleware.use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
-config.middleware.use Flipper::Middleware::Memoizer
+Rails.configuration.middleware.use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
+Rails.configuration.middleware.use Flipper::Middleware::Memoizer
 ```
 
 ### Options
@@ -33,18 +33,18 @@ The Memoizer middleware also supports a few options. Use either `preload` or `pr
 
 * **`:preload`** - An `Array` of feature names (`Symbol`) to preload for every request. Useful if you have features that are used on every endpoint. `preload` uses `Adapter#get_multi` to attempt to load the features in one network call instead of N+1 network calls.
     ```ruby
-    config.middleware.use Flipper::Middleware::Memoizer,
+    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
       preload: [:stats, :search, :some_feature]
     ```
 * **`:preload_all`** - A Boolean value (default: false) of whether or not all features should be preloaded. Using this results in a `preload_all` call with the result of `Adapter#get_all`. Any subsequent feature checks will be memoized and perform no network calls. I wouldn't recommend using this unless you have few features (< 100?) and nearly all of them are used on every request.
     ```ruby
-    config.middleware.use Flipper::Middleware::Memoizer,
+    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
       preload_all: true
     ```
 * **`:unless`** - A block that prevents preloading and memoization if it evaluates to true.
     ```ruby
     # skip preloading and memoizing if path starts with /assets
-    config.middleware.use Flipper::Middleware::Memoizer,
+    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
       unless: ->(request) { request.path.start_with?("/assets") }
     ```
 

data/lib/flipper.rb

@@ -65,7 +65,8 @@ module Flipper
                  :time, :percentage_of_time,
                  :features, :feature, :[], :preload, :preload_all,
                  :adapter, :add, :exist?, :remove, :import,
-                 :memoize=, :memoizing?
+                 :memoize=, :memoizing?,
+                 :sync, :sync_secret # For Flipper::Cloud. Will error for OSS Flipper.
 
   # Public: Use this to register a group by name.
   #

data/lib/flipper/adapters/dual_write.rb

@@ -0,0 +1,67 @@
+module Flipper
+  module Adapters
+    class DualWrite
+      include ::Flipper::Adapter
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Build a new sync instance.
+      #
+      # local - The local flipper adapter that should serve reads.
+      # remote - The remote flipper adapter that writes should go to first (in
+      #          addition to the local adapter).
+      def initialize(local, remote, options = {})
+        @name = :dual_write
+        @local = local
+        @remote = remote
+      end
+
+      def features
+        @local.features
+      end
+
+      def get(feature)
+        @local.get(feature)
+      end
+
+      def get_multi(features)
+        @local.get_multi(features)
+      end
+
+      def get_all
+        @local.get_all
+      end
+
+      def add(feature)
+        result = @remote.add(feature)
+        @local.add(feature)
+        result
+      end
+
+      def remove(feature)
+        result = @remote.remove(feature)
+        @local.remove(feature)
+        result
+      end
+
+      def clear(feature)
+        result = @remote.clear(feature)
+        @local.clear(feature)
+        result
+      end
+
+      def enable(feature, gate, thing)
+        result = @remote.enable(feature, gate, thing)
+        @local.enable(feature, gate, thing)
+        result
+      end
+
+      def disable(feature, gate, thing)
+        result = @remote.disable(feature, gate, thing)
+        @local.disable(feature, gate, thing)
+        result
+      end
+    end
+  end
+end

data/lib/flipper/adapters/operation_logger.rb

@@ -117,6 +117,11 @@ module Flipper
       def reset
         @operations.clear
       end
+
+      def inspect
+        inspect_id = ::Kernel::format "%x", (object_id * 2)
+        %(#<#{self.class}:0x#{inspect_id} @name=#{name.inspect}, @operations=#{@operations.inspect}, @adapter=#{@adapter.inspect}>)
+      end
     end
   end
 end

data/lib/flipper/adapters/sync.rb

@@ -17,7 +17,7 @@ module Flipper
       # Public: Build a new sync instance.
       #
       # local - The local flipper adapter that should serve reads.
-      # remote - The remote flipper adpater that should serve writes and update
+      # remote - The remote flipper adapter that should serve writes and update
       #          the local on an interval.
       # interval - The Float or Integer number of seconds between syncs from
       # remote to local. Default value is set in IntervalSynchronizer.
@@ -34,26 +34,26 @@ module Flipper
           synchronizer = Synchronizer.new(@local, @remote, sync_options)
           IntervalSynchronizer.new(synchronizer, interval: options[:interval])
         end
-        sync
+        synchronize
       end
 
       def features
-        sync
+        synchronize
         @local.features
       end
 
       def get(feature)
-        sync
+        synchronize
         @local.get(feature)
       end
 
       def get_multi(features)
-        sync
+        synchronize
         @local.get_multi(features)
       end
 
       def get_all
-        sync
+        synchronize
         @local.get_all
       end
 
@@ -89,7 +89,7 @@ module Flipper
 
       private
 
-      def sync
+      def synchronize
         @synchronizer.call
       end
     end

data/lib/flipper/adapters/sync/synchronizer.rb

@@ -15,6 +15,7 @@ module Flipper
         #          adapter should be brought in line with.
         # options - The Hash of options.
         #           :instrumenter - The instrumenter used to instrument.
+        #           :raise - Should errors be raised (default: true).
         def initialize(local, remote, options = {})
           @local = local
           @remote = remote

data/lib/flipper/dsl.rb

@@ -273,5 +273,13 @@ module Flipper
     def import(flipper)
       adapter.import(flipper.adapter)
     end
+
+    # Cloud DSL method that does nothing for open source version.
+    def sync
+    end
+
+    # Cloud DSL method that does nothing for open source version.
+    def sync_secret
+    end
   end
 end

data/lib/flipper/middleware/setup_env.rb

@@ -7,7 +7,8 @@ module Flipper
       #
       # app - The app this middleware is included in.
       # flipper_or_block - The Flipper::DSL instance or a block that yields a
-      #                    Flipper::DSL instance to use for all operations.
+      #                    Flipper::DSL instance to use for all operations
+      #                    (optional, default: Flipper).
       #
       # Examples
       #
@@ -19,18 +20,27 @@ module Flipper
       #   # using with a block that yields a flipper instance
       #   use Flipper::Middleware::SetupEnv, lambda { Flipper.new(...) }
       #
-      def initialize(app, flipper_or_block, options = {})
+      #   # using default configured Flipper instance
+      #   Flipper.configure do |config|
+      #     config.default { Flipper.new(...) }
+      #   end
+      #   use Flipper::Middleware::SetupEnv
+      def initialize(app, flipper_or_block = nil, options = {})
         @app = app
         @env_key = options.fetch(:env_key, 'flipper')
 
         if flipper_or_block.respond_to?(:call)
           @flipper_block = flipper_or_block
         else
-          @flipper = flipper_or_block
+          @flipper = flipper_or_block || Flipper
         end
       end
 
       def call(env)
+        dup.call!(env)
+      end
+
+      def call!(env)
         env[@env_key] ||= flipper
         @app.call(env)
       end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.19.1'.freeze
+  VERSION = '0.20.1'.freeze
 end

data/spec/flipper/adapters/dual_write_spec.rb

@@ -0,0 +1,71 @@
+require 'helper'
+require 'flipper/adapters/dual_write'
+require 'flipper/adapters/operation_logger'
+require 'flipper/spec/shared_adapter_specs'
+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), local.boolean
+    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), local.boolean(false)
+    expect(remote_adapter.count(:disable)).to be(1)
+    expect(local_adapter.count(:disable)).to be(1)
+  end
+end

data/spec/flipper/adapters/operation_logger_spec.rb

@@ -11,6 +11,15 @@ RSpec.describe Flipper::Adapters::OperationLogger do
 
   it_should_behave_like 'a flipper adapter'
 
+  it 'shows itself when inspect' do
+    subject.features
+    output = subject.inspect
+    expect(output).to match(/OperationLogger/)
+    expect(output).to match(/operation_logger/)
+    expect(output).to match(/@type=:features/)
+    expect(output).to match(/@adapter=#<Flipper::Adapters::Memory/)
+  end
+
   it 'forwards missing methods to underlying adapter' do
     adapter = Class.new do
       def foo

data/spec/flipper/adapters/sync_spec.rb

@@ -175,22 +175,22 @@ RSpec.describe Flipper::Adapters::Sync do
   end
 
   it 'synchronizes for #features' do
-    expect(subject).to receive(:sync)
+    expect(subject).to receive(:synchronize)
     subject.features
   end
 
   it 'synchronizes for #get' do
-    expect(subject).to receive(:sync)
+    expect(subject).to receive(:synchronize)
     subject.get sync[:search]
   end
 
   it 'synchronizes for #get_multi' do
-    expect(subject).to receive(:sync)
+    expect(subject).to receive(:synchronize)
     subject.get_multi [sync[:search]]
   end
 
   it 'synchronizes for #get_all' do
-    expect(subject).to receive(:sync)
+    expect(subject).to receive(:synchronize)
     subject.get_all
   end
 

data/spec/flipper/middleware/setup_env_spec.rb

@@ -56,21 +56,57 @@ RSpec.describe Flipper::Middleware::SetupEnv do
     end
   end
 
-  context 'when flipper instance is nil' do
+  context 'when flipper instance or block are nil but env flipper is configured' do
     let(:app) do
       app = lambda do |env|
         [200, { 'Content-Type' => 'text/html' }, [env['flipper'].object_id.to_s]]
       end
       builder = Rack::Builder.new
-      builder.use described_class, nil
+      builder.use described_class
       builder.run app
       builder
     end
 
-    it 'leaves env flipper alone' do
+    it 'can use env flipper' do
       env_flipper = build_flipper
       get '/', {}, 'flipper' => env_flipper
       expect(last_response.body).to eq(env_flipper.object_id.to_s)
     end
   end
+
+  context 'when flipper instance or block are nil and default Flipper is configured' do
+    let(:app) do
+      Flipper.configure do |config|
+        config.default { flipper }
+      end
+      app = lambda do |env|
+        [200, { 'Content-Type' => 'text/html' }, [env['flipper'].object_id.to_s]]
+      end
+      builder = Rack::Builder.new
+      builder.use described_class
+      builder.run app
+      builder
+    end
+
+    it 'can use env flipper' do
+      get '/', {}, {}
+      expect(last_response.body).to eq(Flipper.object_id.to_s)
+    end
+  end
+
+  context 'when flipper instance or block are nil and default Flipper is NOT configured' do
+    let(:app) do
+      app = lambda do |env|
+        [200, { 'Content-Type' => 'text/html' }, [env['flipper'].enabled?(:search)]]
+      end
+      builder = Rack::Builder.new
+      builder.use described_class
+      builder.run app
+      builder
+    end
+
+    it 'can use env flipper' do
+      expect { get '/' }.to raise_error(Flipper::DefaultNotSet)
+    end
+  end
 end

data/spec/flipper_spec.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'flipper/cloud'
 
 RSpec.describe Flipper do
   describe '.new' do
@@ -215,6 +216,32 @@ RSpec.describe Flipper do
     it 'delegates memoizing? to instance' do
       expect(described_class.memoizing?).to eq(described_class.adapter.memoizing?)
     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)
+    end
+
+    it 'delegates sync stuff to instance for Flipper::Cloud' do
+      stub = stub_request(:get, "https://www.flippercloud.io/adapter/features").
+        with({
+          headers: {
+            'Flipper-Cloud-Token'=>'asdf',
+          },
+        }).to_return(status: 200, body: '{"features": {}}', headers: {})
+      cloud_configuration = Flipper::Cloud::Configuration.new({
+        token: "asdf",
+        sync_secret: "tasty",
+        sync_method: :webhook,
+      })
+
+      described_class.configure do |config|
+        config.default { Flipper::Cloud::DSL.new(cloud_configuration) }
+      end
+      described_class.sync
+      expect(described_class.sync_secret).to eq("tasty")
+      expect(stub).to have_been_requested
+    end
   end
 
   describe '.register' do

data/spec/support/spec_helpers.rb

@@ -1,3 +1,4 @@
+require 'climate_control'
 require 'json'
 require 'rack/test'
 
@@ -56,6 +57,10 @@ module SpecHelpers
       'more_info' => api_error_code_reference_url,
     }
   end
+
+  def with_modified_env(options, &block)
+    ClimateControl.modify(options, &block)
+  end
 end
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -55,6 +55,7 @@ files:
 - lib/flipper.rb
 - lib/flipper/actor.rb
 - lib/flipper/adapter.rb
+- lib/flipper/adapters/dual_write.rb
 - lib/flipper/adapters/http.rb
 - lib/flipper/adapters/http/client.rb
 - lib/flipper/adapters/http/error.rb
@@ -104,6 +105,7 @@ files:
 - spec/fixtures/feature.json
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
+- spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -178,6 +180,7 @@ test_files:
 - spec/fixtures/feature.json
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_spec.rb
+- spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb