flipper 0.20.0.beta1 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b11913845dd63e7156086ce778927c1986694c48472dbb5b779155318c6eeab6
-  data.tar.gz: bc1bf62134ccd35ef86a5373f8105a9d511e3061e5666e55b0183fd20437a74f
+  metadata.gz: df90e63870767caa4d32363658e4515d0822a1453cc3a5325d7dbf932c326b59
+  data.tar.gz: 125256e9cdee5bd0e2bfe065203140eb7fa015cac56043711c7eb45bd5421aa8
 SHA512:
-  metadata.gz: ec24f067db0fc80d5d3e9f00ce1b87b51d5111f89e9d35842d044347dbbbfc836663e972e7eb0c640713e375938e10a7d70769af27c87aea82270eba29432ca0
-  data.tar.gz: fb56eb175c3067f1b301d5875818b0c0a372f6e11da7e68c88337ab2660c8a7cfa20c027e8862cfc9aca126c5bd4b424dc962b846e2c812932400cc0f9592855
+  metadata.gz: 9598a0a2f62b5c160a8a7c81b50ed9d2bd06f6e70898037c8321f9060780875347552b66919c62b5deb40647f734efa6bef1382b0e9fb1caefe2c8f4b5eaec01
+  data.tar.gz: 8bb413f54398cf90e9aafc7feba144a2e15343e8a75e28ca197d52505ae4771659b3fc7bfafec899388e71c76832859396d86fa52438ba22327f6b6522ade3a5

data/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redis
+        ports: ['6379:6379']
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7']
+    env:
+      RAILS_VERSION: 6.0.0
+      SQLITE3_VERSION: 1.4.1
+      REDIS_URL: redis://localhost:6379/0
+    steps:
+      - name: Setup memcached
+        uses: KeisukeYamashita/memcached-actions@v1
+      - name: Start MongoDB
+        uses: supercharge/mongodb-github-action@1.3.0
+        with:
+          mongodb-version: 4.0
+      - name: Check out repository code
+        uses: actions/checkout@v2
+      - name: Do some action caching
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gem-
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install libpq-dev
+        run: sudo apt-get -yqq install libpq-dev
+      - name: Install bundler
+        run: gem install bundler
+      - name: Run bundler
+        run: bundle install --jobs 4 --retry 3
+      - name: Run Rake
+        run: bundle exec rake

data/Changelog.md

@@ -1,3 +1,22 @@
+## 0.20.2
+
+### Additions/Changes
+
+* Http adapter now raises error when enable/disable/add/remove/clear fail.
+* Cloud adapter sends some extra info like hostname, ruby version, etc. for debugging and decision making.
+
+## 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/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/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/http.rb

@@ -35,12 +35,6 @@ module Flipper
         end
       end
 
-      def add(feature)
-        body = JSON.generate(name: feature.key)
-        response = @client.post('/features', body)
-        response.is_a?(Net::HTTPOK)
-      end
-
       def get_multi(features)
         csv_keys = features.map(&:key).join(',')
         response = @client.get("/features?keys=#{csv_keys}")
@@ -87,51 +81,61 @@ module Flipper
         parsed_response['features'].map { |feature| feature['key'] }.to_set
       end
 
+      def add(feature)
+        body = JSON.generate(name: feature.key)
+        response = @client.post('/features', body)
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
+      end
+
       def remove(feature)
         response = @client.delete("/features/#{feature.key}")
-        response.is_a?(Net::HTTPNoContent)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
       end
 
       def enable(feature, gate, thing)
         body = request_body_for_gate(gate, thing.value.to_s)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-        response.is_a?(Net::HTTPOK)
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
       end
 
       def disable(feature, gate, thing)
         body = request_body_for_gate(gate, thing.value.to_s)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
-        response =
-          case gate.key
-          when :percentage_of_actors, :percentage_of_time
-            @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-          else
-            @client.delete("/features/#{feature.key}/#{gate.key}#{query_string}", body)
-          end
-        response.is_a?(Net::HTTPOK)
+        response = case gate.key
+        when :percentage_of_actors, :percentage_of_time
+          @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
+        else
+          @client.delete("/features/#{feature.key}/#{gate.key}#{query_string}", body)
+        end
+        raise Error, response unless response.is_a?(Net::HTTPOK)
+        true
       end
 
       def clear(feature)
         response = @client.delete("/features/#{feature.key}/clear")
-        response.is_a?(Net::HTTPNoContent)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
       end
 
       private
 
       def request_body_for_gate(gate, value)
         data = case gate.key
-               when :boolean
-                 {}
-               when :groups
-                 { name: value }
-               when :actors
-                 { flipper_id: value }
-               when :percentage_of_actors, :percentage_of_time
-                 { percentage: value }
-               else
-                 raise "#{gate.key} is not a valid flipper gate key"
-               end
+        when :boolean
+          {}
+        when :groups
+          { name: value }
+        when :actors
+          { flipper_id: value }
+        when :percentage_of_actors, :percentage_of_time
+          { percentage: value }
+        else
+          raise "#{gate.key} is not a valid flipper gate key"
+        end
         JSON.generate(data)
       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.

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

@@ -19,7 +19,7 @@ module Flipper
         # Public: Initializes a new interval synchronizer.
         #
         # synchronizer - The Synchronizer to call when the interval has passed.
-        # interval - The Integer number of milliseconds between invocations of
+        # interval - The Integer number of seconds between invocations of
         #            the wrapped synchronizer.
         def initialize(synchronizer, interval: nil)
           @synchronizer = synchronizer

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/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.20.0.beta1'.freeze
+  VERSION = '0.20.2'.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/http_spec.rb

@@ -76,9 +76,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get(flipper[:feature_panel])
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -88,9 +88,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get_multi([flipper[:feature_panel]])
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -100,9 +100,9 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.get_all
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     end
   end
 
@@ -112,9 +112,75 @@ RSpec.describe Flipper::Adapters::Http do
         .to_return(status: 503, body: "", headers: {})
 
       adapter = described_class.new(url: 'http://app.com/flipper')
-      expect do
+      expect {
         adapter.features
-      end.to raise_error(Flipper::Adapters::Http::Error)
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#add" do
+    it "raises error when not successful" do
+      stub_request(:post, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.add(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#remove" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.remove(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#clear" do
+    it "raises error when not successful" do
+      stub_request(:delete, /app.com/)
+        .to_return(status: 503, body: "{}", headers: {})
+
+      adapter = described_class.new(url: 'http://app.com/flipper')
+      expect {
+        adapter.clear(Flipper::Feature.new(:search, adapter))
+      }.to raise_error(Flipper::Adapters::Http::Error)
+    end
+  end
+
+  describe "#enable" do
+    it "raises error when not successful" 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)
+    end
+  end
+
+  describe "#disable" do
+    it "raises error when not successful" do
+      stub_request(:delete, /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(false)
+      expect {
+        adapter.disable(feature, gate, thing)
+      }.to raise_error(Flipper::Adapters::Http::Error)
     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_spec.rb

@@ -217,9 +217,9 @@ RSpec.describe Flipper do
       expect(described_class.memoizing?).to eq(described_class.adapter.memoizing?)
     end
 
-    it 'delegates sync stuff to instance and errors for OSS' do
-      expect { described_class.sync }.to raise_error(NoMethodError)
-      expect { described_class.sync_secret }.to raise_error(NoMethodError)
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.20.0.beta1
+  version: 0.20.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/workflows/ci.yml"
 - CODE_OF_CONDUCT.md
 - Changelog.md
 - Dockerfile
@@ -55,6 +56,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 +106,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
@@ -166,9 +169,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -178,6 +181,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