flipper 0.23.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a41bf1dd43734d1d6c6b56a46ea393af74164d46aadd7671994bdcc10e4eb646
-  data.tar.gz: e935dc1375a66156f0d0f7ba967269d184b8babaf119333c614943643f760ed7
+  metadata.gz: 896d9fb7468ffbc19e1200a6abe2a5c3992fae7abb3d4211fd29829364fb1a42
+  data.tar.gz: e157fa74da897e4ad56b3548cd438adc0ddbc0e2fec89e4d8214dd4ca2b2596e
 SHA512:
-  metadata.gz: 82d249a9f90b96fcf88713890a2df5a7fa5f05927b7a1903630e276507ee709b5426b91fba46aa6ef034e15dc6b50b35781d61b56afe512a46673e4de3eb559d
-  data.tar.gz: c986d6fb7c1a773ab56e6b7cb35734648485562690799dff901578b2c31566f5582bb8390268228f48eda9fba6797f8b72bd7fd385e45a9a04155c14a4c8b95f
+  metadata.gz: c99039ff6cc5dc62953289d9343bcee6b2d2935e52b4cc7b33f5134c266a3ac99180d713220432cbde7e2cb57a90d42e41249eb0bcf55f20eb60a9e0cc379208
+  data.tar.gz: 9f3b2dea4b9137b20f86d359a5dd5eb3b220655364dc9baf498faecbd42ddca286f6d94e91694b203d21cce8c0a986ed421e6f7436ec0fd956d9e590698ec59c

data/.github/workflows/ci.yml

@@ -15,13 +15,17 @@ jobs:
           --health-retries 5
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7']
+        ruby: ['2.6', '2.7', '3.0', '3.1']
         rails: ['5.2', '6.0.0', '6.1.0', '7.0.0']
         exclude:
-          - ruby: "2.5"
-            rails: "7.0.0"
           - ruby: "2.6"
             rails: "7.0.0"
+          - ruby: "3.0"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "6.0.0"
     env:
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
@@ -43,7 +47,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
       - name: Install libpq-dev

data/.github/workflows/examples.yml

@@ -16,8 +16,18 @@ jobs:
           --health-retries 5
     strategy:
       matrix:
-        ruby: ['2.5', '2.6', '2.7']
-        rails: ['5.2', '6.0.0', '6.1.0']
+        ruby: ['2.6', '2.7', '3.0', '3.1']
+        rails: ['5.2', '6.0.0', '6.1.0', '7.0.0']
+        exclude:
+          - ruby: "2.6"
+            rails: "7.0.0"
+          - ruby: "3.0"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "5.2"
+          - ruby: "3.1"
+            rails: "6.0.0"
+
     env:
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
@@ -39,7 +49,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
       - name: Set up Ruby ${{ matrix.ruby }}
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
       - name: Install libpq-dev

data/Changelog.md

@@ -1,3 +1,34 @@
+## Unreleased
+
+### Additions/Changes
+
+* Added a prompt in Flipper UI for the 'Delete' button to prevent accidental delete of features (https://github.com/jnunemaker/flipper/pull/625)
+* Added failsafe adapter (https://github.com/jnunemaker/flipper/pull/626)
+* Removed previously deprecated options and settings. Those upgrading from `<0.21` should upgrade to `~>0.24` first and fix any deprecation warnings when initializing Flipper. (https://github.com/jnunemaker/flipper/pull/627)
+* ActiveRecord: base class for internal models (https://github.com/jnunemaker/flipper/pull/629)
+* Remove use of `Rack::BodyProxy` in the memoizer middleware (https://github.com/jnunemaker/flipper/pull/631)
+
+## 0.24.1
+
+### Additions/Changes
+
+* flipper-api: `exclude_gates` parameter to exclude gate data in GETs (https://github.com/jnunemaker/flipper/pull/572).
+* Make it possible to disable internal memoization (https://github.com/jnunemaker/flipper/pull/612).
+* Add Flipper::Actor#hash so actors can be hash keys (https://github.com/jnunemaker/flipper/pull/616).
+* Pretty Up `rails routes` again and make rack-protection dependency less strict (https://github.com/jnunemaker/flipper/pull/619).
+* Add kwargs for method_missing using ruby 3.0 (https://github.com/jnunemaker/flipper/pull/620).
+* Relax the rack-protection dependency (https://github.com/jnunemaker/flipper/commit/c1cb9cd78140c2b09123687642558101e6e5d37d).
+
+## 0.24.0
+
+### Additions/Changes
+
+* Add Ruby 3.0 and 3.1 to the CI matrix and fix groups block arity check for ruby 3 (https://github.com/jnunemaker/flipper/pull/601)
+* Removed support for Ruby 2.5 (which was end of line 9 months ago)
+* Add (alpha) client side instrumentation of events to cloud (https://github.com/jnunemaker/flipper/pull/602)
+* Fix deprecated uses of Redis#pipelined (https://github.com/jnunemaker/flipper/pull/603). redis-rb >= 3 now required.
+* Fix Flipper UI Rack application when `Rack::Session::Pool` is used to build it (https://github.com/jnunemaker/flipper/pull/606).
+
 ## 0.23.1
 
 ### Additions/Changes

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5
+FROM ruby:3.0
 
 RUN apt-get update && apt-get install -y \
   # build-essential \

data/Gemfile

@@ -6,7 +6,7 @@ Dir['flipper-*.gemspec'].each do |gemspec|
   gemspec(name: "flipper-#{plugin}", development_group: plugin)
 end
 
-gem 'pry'
+gem 'debug'
 gem 'rake', '~> 12.3.3'
 gem 'shotgun', '~> 0.9'
 gem 'statsd-ruby', '~> 1.2.1'

data/lib/flipper/actor.rb

@@ -12,5 +12,9 @@ module Flipper
       self.class.eql?(other.class) && @flipper_id == other.flipper_id
     end
     alias_method :==, :eql?
+
+    def hash
+      flipper_id.hash
+    end
   end
 end

data/lib/flipper/adapters/failsafe.rb

@@ -0,0 +1,76 @@
+module Flipper
+  module Adapters
+    class Failsafe
+      include ::Flipper::Adapter
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Build a new Failsafe instance.
+      #
+      # adapter   - Flipper adapter to guard.
+      # options   - Hash of options:
+      #             :errors - Array of exception types for which to fail safe
+
+      def initialize(adapter, options = {})
+        @adapter = adapter
+        @errors = options.fetch(:errors, [StandardError])
+        @name = :failsafe
+      end
+
+      def features
+        @adapter.features
+      rescue *@errors
+        Set.new
+      end
+
+      def add(feature)
+        @adapter.add(feature)
+      rescue *@errors
+        false
+      end
+
+      def remove(feature)
+        @adapter.remove(feature)
+      rescue *@errors
+        false
+      end
+
+      def clear(feature)
+        @adapter.clear(feature)
+      rescue *@errors
+        false
+      end
+
+      def get(feature)
+        @adapter.get(feature)
+      rescue *@errors
+        {}
+      end
+
+      def get_multi(features)
+        @adapter.get_multi(features)
+      rescue *@errors
+        {}
+      end
+
+      def get_all
+        @adapter.get_all
+      rescue *@errors
+        {}
+      end
+
+      def enable(feature, gate, thing)
+        @adapter.enable(feature, gate, thing)
+      rescue *@errors
+        false
+      end
+
+      def disable(feature, gate, thing)
+        @adapter.disable(feature, gate, thing)
+      rescue *@errors
+        false
+      end
+    end
+  end
+end

data/lib/flipper/dsl.rb

@@ -17,10 +17,12 @@ module Flipper
     # adapter - The adapter that this DSL instance should use.
     # options - The Hash of options.
     #           :instrumenter - What should be used to instrument all the things.
+    #           :memoize - Should adapter be wrapped by memoize adapter or not.
     def initialize(adapter, options = {})
       @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
-      memoized = Adapters::Memoizable.new(adapter)
-      @adapter = memoized
+      memoize = options.fetch(:memoize, true)
+      adapter = Adapters::Memoizable.new(adapter) if memoize
+      @adapter = adapter
       @memoized_features = {}
     end
 

data/lib/flipper/errors.rb

@@ -12,15 +12,6 @@ module Flipper
   # Raised when attempting to declare a group name that has already been used.
   class DuplicateGroup < Error; end
 
-  # Raised when default instance not configured but there is an attempt to
-  # use it.
-  class DefaultNotSet < Flipper::Error
-    def initialize(message = nil)
-      warn "Flipper::DefaultNotSet is deprecated and will be removed in 1.0"
-      super
-    end
-  end
-
   # Raised when an invalid value is set to a configuration property
   class InvalidConfigurationValue < Flipper::Error
     def initialize(message = nil)
@@ -28,12 +19,4 @@ module Flipper
       super(message || default)
     end
   end
-
-  # Raised when accessing a configuration property that has been deprecated
-  class ConfigurationDeprecated < Flipper::Error
-    def initialize(message = nil)
-      default = "The configuration property has been deprecated"
-      super(message || default)
-    end
-  end
 end

data/lib/flipper/middleware/memoizer.rb

@@ -25,11 +25,6 @@ module Flipper
           raise 'Flipper::Middleware::Memoizer no longer initializes with a flipper instance or block. Read more at: https://git.io/vSo31.'
         end
 
-        if opts[:preload_all]
-          warn "Flipper::Middleware::Memoizer: `preload_all` is deprecated, use `preload: true`"
-          opts[:preload] = true
-        end
-
         @app = app
         @opts = opts
         @env_key = opts.fetch(:env_key, 'flipper')
@@ -74,14 +69,9 @@ module Flipper
         when Array then flipper.preload(@opts[:preload])
         end
 
-        response = @app.call(env)
-        response[2] = Rack::BodyProxy.new(response[2]) do
-          flipper.memoize = false
-        end
-        reset_on_body_close = true
-        response
+        @app.call(env)
       ensure
-        flipper.memoize = false if flipper && !reset_on_body_close
+        flipper.memoize = false if flipper
       end
     end
   end

data/lib/flipper/types/actor.rb

@@ -23,8 +23,14 @@ module Flipper
         super || @thing.respond_to?(*args)
       end
 
-      def method_missing(name, *args, &block)
-        @thing.send name, *args, &block
+      if RUBY_VERSION >= '3.0'
+        def method_missing(name, *args, **kwargs, &block)
+          @thing.send name, *args, **kwargs, &block
+        end
+      else
+        def method_missing(name, *args, &block)
+          @thing.send name, *args, &block
+        end
       end
     end
   end

data/lib/flipper/types/group.rb

@@ -14,7 +14,7 @@ module Flipper
 
         if block_given?
           @block = block
-          @single_argument = @block.arity.abs == 1
+          @single_argument = call_with_no_context?(@block)
         else
           @block = ->(_thing, _context) { false }
           @single_argument = false
@@ -28,6 +28,13 @@ module Flipper
           @block.call(thing, context)
         end
       end
+
+      NO_PARAMS_IN_RUBY_3 = [[:req], [:rest]]
+      def call_with_no_context?(block)
+        return true if block.parameters == NO_PARAMS_IN_RUBY_3
+
+        block.arity.abs == 1
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.23.1'.freeze
+  VERSION = '0.25.0'.freeze
 end

data/spec/flipper/actor_spec.rb

@@ -43,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/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/dsl_spec.rb

@@ -6,9 +6,19 @@ RSpec.describe Flipper::DSL do
   let(:adapter) { Flipper::Adapters::Memory.new }
 
   describe '#initialize' do
-    it 'sets adapter' do
-      dsl = described_class.new(adapter)
-      expect(dsl.adapter).not_to be_nil
+    context 'when using default memoize strategy' do
+      it 'wraps the given adapter with Flipper::Adapters::Memoizable' do
+        dsl = described_class.new(adapter)
+        expect(dsl.adapter.class).to be(Flipper::Adapters::Memoizable)
+        expect(dsl.adapter.adapter).to be(adapter)
+      end
+    end
+
+    context 'when disabling memoization' do
+      it 'uses the given adapter directly' do
+        dsl = described_class.new(adapter, memoize: false)
+        expect(dsl.adapter).to be(adapter)
+      end
     end
 
     it 'defaults instrumenter to noop' do

data/spec/flipper/middleware/memoizer_spec.rb

@@ -38,26 +38,6 @@ RSpec.describe Flipper::Middleware::Memoizer do
       expect(called).to eq(true)
     end
 
-    it 'disables local cache after body close' do
-      app = ->(_env) { [200, {}, []] }
-      middleware = described_class.new(app)
-      body = middleware.call(env).last
-
-      expect(flipper.memoizing?).to eq(true)
-      body.close
-      expect(flipper.memoizing?).to eq(false)
-    end
-
-    it 'clears local cache after body close' do
-      app = ->(_env) { [200, {}, []] }
-      middleware = described_class.new(app)
-      body = middleware.call(env).last
-
-      flipper.adapter.cache['hello'] = 'world'
-      body.close
-      expect(flipper.adapter.cache).to be_empty
-    end
-
     it 'clears the local cache with a successful request' do
       flipper.adapter.cache['hello'] = 'world'
       get '/', {}, 'flipper' => flipper

data/spec/spec_helper.rb

@@ -9,7 +9,7 @@ require 'bundler'
 
 Bundler.setup(:default)
 
-require 'pry'
+require 'debug'
 require 'webmock/rspec'
 WebMock.disable_net_connect!(allow_localhost: true)
 
@@ -22,6 +22,7 @@ Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.before(:example) do
+    Flipper::Cloud::Registry.default.clear if defined?(Flipper::Cloud)
     Flipper.unregister_groups
     Flipper.configuration = nil
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.25.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -57,6 +57,7 @@ files:
 - lib/flipper/adapter.rb
 - lib/flipper/adapters/dual_write.rb
 - lib/flipper/adapters/failover.rb
+- lib/flipper/adapters/failsafe.rb
 - lib/flipper/adapters/http.rb
 - lib/flipper/adapters/http/client.rb
 - lib/flipper/adapters/http/error.rb
@@ -110,6 +111,7 @@ files:
 - spec/flipper/adapter_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/failover_spec.rb
+- spec/flipper/adapters/failsafe_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb
@@ -188,6 +190,7 @@ test_files:
 - spec/flipper/adapter_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/failover_spec.rb
+- spec/flipper/adapters/failsafe_spec.rb
 - spec/flipper/adapters/http_spec.rb
 - spec/flipper/adapters/instrumented_spec.rb
 - spec/flipper/adapters/memoizable_spec.rb