flipper 0.24.1 → 0.25.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a73ea66b4ab3342f5cf63a162bf8b0482fdc644dc0fff38fcb2d3fa2b39015be
-  data.tar.gz: a680008dad6bc0affee30e0d150aab5cc869d46d37ac2ae3ce8b7b2f57de9e9b
+  metadata.gz: a830f8560a3b19ddb21ec12dba61ec973a5f0aa134d2f3d6d04371c4cf1ecb98
+  data.tar.gz: '0973ab983f4ae2351023a4b2ec9239434188671bc27bb4c4a95d5bc9d5521471'
 SHA512:
-  metadata.gz: 50d1ff58301b4040e2ac0ed6590c057952f3c926aa88371858cec083be2d5fcdb17920fa120f6c59f9a5625ad2260aa0cdf40c26dfa64239a4790f247287c720
-  data.tar.gz: 40d68ac75fde3051cece778aa09145891ca3cf289abb795c66695f3e3fac569c28e81864d3be386d7ab03d0fd9c1b9c303fca6f5865ef6a2cd4eb9edbdc12eee
+  metadata.gz: 0db89e65773952f1394bf8db244a1b4ca7365f3c962ee051f6140b7365a3785eb6e7870f7adb6bec5032b863e3e28b618d2d7e6f2d093441881c1b5c856a4467
+  data.tar.gz: 4d8226964f2a5d5434ac2aae7ee81062058e8210863c272abf04ffa6f4363345d55ad55b4126ab22b8f5bc937c212561f4584e03d980f7fcc16adb75aa4d4481

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -34,13 +34,13 @@ jobs:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.3.0
+        uses: supercharge/mongodb-github-action@1.7.0
         with:
           mongodb-version: 4.0
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Do some action caching
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}

data/.github/workflows/examples.yml

@@ -36,13 +36,13 @@ jobs:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.3.0
+        uses: supercharge/mongodb-github-action@1.7.0
         with:
           mongodb-version: 4.0
       - name: Check out repository code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Do some action caching
-        uses: actions/cache@v1
+        uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}

data/.github/workflows/release.yml

@@ -0,0 +1,44 @@
+# https://andrewm.codes/blog/automating-ruby-gem-releases-with-github-actions/
+name: release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: flipper
+          bump-minor-pre-major: true
+          version-file: "lib/flipper/version.rb"
+      # Checkout code if release was created
+      - uses: actions/checkout@v2
+        if: ${{ steps.release.outputs.release_created }}
+      # Setup ruby if a release was created
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+        if: ${{ steps.release.outputs.release_created }}
+      # Bundle install
+      - run: bundle install
+        if: ${{ steps.release.outputs.release_created }}
+      # Publish
+      - name: publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          # Make sure to update the secret name
+          # if yours isn't named RUBYGEMS_AUTH_TOKEN
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
+        if: ${{ steps.release.outputs.release_created }}

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/Changelog.md

@@ -1,3 +1,25 @@
+## 0.25.2
+
+* Fix deprecation warnings for Redis >= 4.8.0 (https://github.com/jnunemaker/flipper/pull/660)
+
+## 0.25.1
+
+### Additions/Changes
+
+* ActiveRecord: use provided `gate_class` option when calling `#get_all` (https://github.com/jnunemaker/flipper/pull/647)
+* Relaxed the rack-protection version to support latest (https://github.com/jnunemaker/flipper/commit/f4a41c541ccf14c535a61c6bc6fe7eeabbfc7e71).
+* Configure ActiveRecord adapter immediately upon require of flipper-active_record (https://github.com/jnunemaker/flipper/pull/652)
+
+## 0.25.0
+
+### 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
@@ -7,6 +29,7 @@
 * 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
 

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/examples/instrumentation.rb

@@ -1,5 +1,6 @@
 require 'bundler/setup'
 require 'securerandom'
+require 'active_support/isolated_execution_state'
 require 'active_support/notifications'
 
 class FlipperSubscriber

data/examples/instrumentation_last_accessed_at.rb

@@ -1,6 +1,7 @@
 # Quick example of how to keep track of when a feature was last checked.
 require 'bundler/setup'
 require 'securerandom'
+require 'active_support/isolated_execution_state'
 require 'active_support/notifications'
 require 'flipper'
 

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

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.24.1'.freeze
+  VERSION = '0.25.2'.freeze
 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/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)
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.25.2
 platform: ruby
 authors:
 - John Nunemaker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-13 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - nunemaker@gmail.com
 executables: []
@@ -18,9 +18,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/examples.yml"
+- ".github/workflows/release.yml"
 - ".rspec"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - Changelog.md
 - Dockerfile
@@ -57,6 +60,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 +114,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
@@ -163,7 +168,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/jnunemaker/flipper/blob/master/Changelog.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,8 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Feature flipper for ANYTHING
 test_files:
@@ -188,6 +193,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