flipper 0.22.2 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11758f40e5798d6592a7f810a32a501593f7a2a59322f8261b8d366c1686fc25
-  data.tar.gz: b0f7713f289ef976328f12c31d3e9249251cb2bb196c7b324dcd952eafe00c88
+  metadata.gz: c7754b40752e0c255308fedfb6ef7784e7e9b3cf4ba0035a289a02074e61e4e7
+  data.tar.gz: 7e0add2ac95c2dc929a97fef218ece9fbc904c911ffe6f4ac1d3ccbc36befab9
 SHA512:
-  metadata.gz: 35d55048b48cb80c10f8242cef4494224858d9bcbd7e8fb934fb12c6348ebb5538d239dad5eddfbf13fcc6cefe1e4e9eddaffecd053628d1390081b4bdf79857
-  data.tar.gz: bf145e26dbf12f788d708a4a1b50b3684ce8d53b32a148ee8fde1b697e008ddd0a903a81f20a83b2b78bc270faa9470255e4700e1e8d08b01c905ae4906a8040
+  metadata.gz: 3e5b7b82f89f1cdbb93f0a07d6909aea686214e9ce6a7c1daf4661f900da5e3dfe3176ed89ffe1bb63b8317788bce1a662ad27b2e88b01bebb77856213be7f4d
+  data.tar.gz: e8d25c0ed393a34f4f7ec93b2d2ec8707f009ba35e83ef606d4850c7031bb7e923af83c2472fd2d6d00004d6561f410156021b7892dab20883dd0c6fe2efcb15

data/.github/workflows/ci.yml

@@ -16,7 +16,12 @@ jobs:
     strategy:
       matrix:
         ruby: ['2.5', '2.6', '2.7']
-        rails: ['5.2', '6.0.0', '6.1.0']
+        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"
     env:
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0

data/.github/workflows/examples.yml

@@ -2,6 +2,7 @@ name: Examples
 on: [push, pull_request]
 jobs:
   test:
+    if: github.repository_owner == 'jnunemaker'
     name: Test on ruby ${{ matrix.ruby }} and rails ${{ matrix.rails }}
     runs-on: ubuntu-latest
     services:

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Changelog.md

@@ -1,3 +1,16 @@
+## 0.23.0
+
+### Additions/Changes
+
+* Allow some HTML in banner and descriptions (https://github.com/jnunemaker/flipper/pull/570).
+* Moved some cloud headers to http client (https://github.com/jnunemaker/flipper/pull/567).
+* Update flipper-ui jquery and bootstrap versions (https://github.com/jnunemaker/flipper/issues/565 and https://github.com/jnunemaker/flipper/pull/566).
+* Moved docs to www.flippercloud.io/docs (https://github.com/jnunemaker/flipper/pull/574).
+* PStore adapter now defaults to thread safe and no longer supports `.thread_safe` (https://github.com/jnunemaker/flipper/commit/4048704fefe41b716015294a19a0b94546637630).
+* Add failover adapter (https://github.com/jnunemaker/flipper/pull/584).
+* Improve http adapter error message (https://github.com/jnunemaker/flipper/pull/587).
+* Rails 7 support (mostly in https://github.com/jnunemaker/flipper/pull/592).
+
 ## 0.22.2
 
 ### Additions/Changes
@@ -35,7 +48,7 @@
 * Added cloud recommendation to flipper-ui. Can be disabled with `Flipper::UI.configure { |config| config.cloud_recommendation = false }`. Just want to raise awareness that more is available if people want it (https://github.com/jnunemaker/flipper/pull/504)
 * Added default `flipper_id` implementation via `Flipper::Identifier` and automatically included it in ActiveRecord and Sequel models (https://github.com/jnunemaker/flipper/pull/505)
 * Deprecate superflous sync_method setting (https://github.com/jnunemaker/flipper/pull/511)
-* Flipper is now pre-configured when used with Rails. By default, it will [memoize and preload all features for each request](docs/Optimization.md#memoization). (https://github.com/jnunemaker/flipper/pull/506)
+* Flipper is now pre-configured when used with Rails. By default, it will [memoize and preload all features for each request](https://flippercloud.io/docs/optimization#memoization). (https://github.com/jnunemaker/flipper/pull/506)
 
 ### Upgrading
 
@@ -50,7 +63,7 @@ You should be able to upgrade to 0.21 without any breaking changes. However, if
     - end
     ```
 
-2. `Flipper::Middleware::Memoizer` will be enabled by default.
+2. `Flipper::Middleware::Memoizer` will be enabled by default -- including preloading. **Note**: You may want to disable preloading (see below) if you have > 100 features.
 
     ```diff
     # config/initializers/flipper.rb
@@ -59,6 +72,9 @@ You should be able to upgrade to 0.21 without any breaking changes. However, if
     + Rails.application.configure do
     +   # Uncomment to configure which features to preload on all requests
     +   # config.flipper.preload = [:stats, :search, :some_feature]
+    +   #
+    +   # Or, you may want to disable preloading entirely:
+    +   # config.flipper.preload = false
     + end
     ```
 

data/Gemfile

@@ -13,11 +13,11 @@ gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
 gem 'rack-test', '~> 0.6.3'
 gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.4.1'}"
-gem 'rails', "~> #{ENV['RAILS_VERSION'] || '6.0.0'}"
+gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.0.0'}"
 gem 'minitest', '~> 5.8'
 gem 'minitest-documentation'
 gem 'webmock', '~> 3.0'
-gem 'climate_control'
+gem 'ice_age'
 gem 'redis-namespace'
 gem 'webrick'
 

data/README.md

@@ -1,5 +1,7 @@
 [![Flipper Mark](docs/images/banner.jpg)](https://www.flippercloud.io)
 
+[Website](https://flippercloud.io) | [Documentation](https://flippercloud.io/docs) | [Examples](examples) | [Twitter](https://twitter.com/flipper_cloud)
+
 # Flipper
 
 > Beautiful, performant feature flags for Ruby.
@@ -19,7 +21,7 @@ Add this line to your application's Gemfile:
 
     gem 'flipper'
 
-You'll also want to pick a storage [adapter](#adapters), for example:
+You'll also want to pick a storage [adapter](https://flippercloud.io/docs/adapters), for example:
 
     gem 'flipper-active_record'
 
@@ -31,6 +33,10 @@ Or install it yourself with:
 
     $ gem install flipper
 
+## Subscribe & Ship
+
+[💌  Subscribe](https://buttondown.email/flipper) - I'll send you short and sweet emails when we release new versions.
+
 ## Getting Started
 
 Use `Flipper#enabled?` in your app to check if a feature is enabled.
@@ -46,74 +52,25 @@ end
 
 All features are disabled by default, so you'll need to explicitly enable them.
 
-#### Enable a feature for everyone
-
 ```ruby
+# Enable a feature for everyone
 Flipper.enable :search
-```
 
-#### Enable a feature for a specific actor
-
-```ruby
+# Enable a feature for a specific actor
 Flipper.enable_actor :search, current_user
-```
-
-#### Enable a feature for a group of actors
 
-First tell Flipper about your groups:
-
-```ruby
-# config/initializers/flipper.rb
-Flipper.register(:admin) do |actor|
-  actor.respond_to?(:admin?) && actor.admin?
-end
-```
-
-Then enable the feature for that group:
-
-```ruby
+# Enable a feature for a group of actors
 Flipper.enable_group :search, :admin
-```
-
-#### Enable a feature for a percentage of actors
 
-```ruby
+# Enable a feature for a percentage of actors
 Flipper.enable_percentage_of_actors :search, 2
 ```
 
-
-Read more about enabling and disabling features with [Gates](docs/Gates.md). Check out the [examples directory](examples/) for more, and take a peek at the [DSL](lib/flipper/dsl.rb) and [Feature](lib/flipper/feature.rb) classes for code/docs.
-
-## Adapters
-
-Flipper is built on adapters for maximum flexibility. Regardless of what data store you are using, Flipper can performantly store data in it.
-
-Pick one of our [supported adapters](docs/Adapters.md#officially-supported) and follow the installation instructions:
-
-* [Active Record](docs/active_record/README.md)
-* [Sequel](docs/sequel/README.md)
-* [Redis](docs/redis/README.md)
-* [Mongo](docs/mongo/README.md)
-* [Moneta](docs/moneta/README.md)
-* [Rollout](docs/rollout/README.md)
-
-Or [roll your own](docs/Adapters.md#roll-your-own). We even provide automatic (rspec and minitest) tests for you, so you know you've built your custom adapter correctly.
-
-Read more about [Adapters](docs/Adapters.md).
-
-## Flipper UI
-
-If you prefer a web UI to an IRB console, you can setup the [Flipper UI](docs/ui/README.md).
-
-It's simple and pretty.
-
-![Flipper UI Screenshot](docs/ui/images/feature.png)
-
-
+Read more about [getting started with Flipper](https://flippercloud.io/docs) and [enabling features](https://flippercloud.io/docs/features).
 
 ## Flipper Cloud
 
-Or, (even better than OSS + UI) use [Flipper Cloud](https://www.flippercloud.io) which comes with:
+Like Flipper and want more? Check out [Flipper Cloud](https://www.flippercloud.io), which comes with:
 
 * **everything in one place** — no need to bounce around from different application UIs or IRB consoles.
 * **permissions** — grant access to everyone in your organization or lockdown each project to particular people.
@@ -127,21 +84,11 @@ Or, (even better than OSS + UI) use [Flipper Cloud](https://www.flippercloud.io)
 
 Cloud is super simple to integrate with Rails ([demo app](https://github.com/fewerandfaster/flipper-rails-demo)), Sinatra or any other framework.
 
-## Advanced
-
-A few miscellaneous docs with more info for the hungry.
-
-* [Instrumentation](docs/Instrumentation.md) - ActiveSupport::Notifications and Statsd
-* [Optimization](docs/Optimization.md) - Memoization middleware and Cache adapters
-* [API](docs/api/README.md) - HTTP API interface
-* [Caveats](docs/Caveats.md) - Flipper beware! (see what I did there)
-* [Docker-Compose](docs/DockerCompose.md) - Using docker-compose in contributing
-
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Run the tests (`bundle exec rake`)
+3. Run the tests (`bundle exec rake`). Check out [Docker-Compose](docs/DockerCompose.md) if you need help getting all the adapters running.
 4. Commit your changes (`git commit -am 'Added some feature'`)
 5. Push to the branch (`git push origin my-new-feature`)
 6. Create new Pull Request
@@ -158,6 +105,7 @@ A few miscellaneous docs with more info for the hungry.
 |---|---|---|
 | ![@jnunemaker](https://avatars3.githubusercontent.com/u/235?s=64) | [@jnunemaker](https://github.com/jnunemaker) | most things |
 | ![@bkeepers](https://avatars3.githubusercontent.com/u/173?s=64) | [@bkeepers](https://github.com/bkeepers) | most things |
+| ![@dpep](https://avatars3.githubusercontent.com/u/918804?s=64) | [@dpep](https://github.com/dpep) | tbd |
 | ![@alexwheeler](https://avatars3.githubusercontent.com/u/3260042?s=64) | [@alexwheeler](https://github.com/alexwheeler) | api |
 | ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64) | [@thetimbanks](https://github.com/thetimbanks) | ui |
 | ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64) | [@lazebny](https://github.com/lazebny) | docker |

data/docs/README.md

@@ -0,0 +1 @@
+See [flippercloud.io](https://flippercloud.io/docs) for extensive docs.

data/lib/flipper/adapters/dual_write.rb

@@ -34,33 +34,27 @@ module Flipper
       end
 
       def add(feature)
-        result = @remote.add(feature)
-        @local.add(feature)
-        result
+        @remote.add(feature).tap { @local.add(feature) }
       end
 
       def remove(feature)
-        result = @remote.remove(feature)
-        @local.remove(feature)
-        result
+        @remote.remove(feature).tap { @local.remove(feature) }
       end
 
       def clear(feature)
-        result = @remote.clear(feature)
-        @local.clear(feature)
-        result
+        @remote.clear(feature).tap { @local.clear(feature) }
       end
 
       def enable(feature, gate, thing)
-        result = @remote.enable(feature, gate, thing)
-        @local.enable(feature, gate, thing)
-        result
+        @remote.enable(feature, gate, thing).tap do
+          @local.enable(feature, gate, thing)
+        end
       end
 
       def disable(feature, gate, thing)
-        result = @remote.disable(feature, gate, thing)
-        @local.disable(feature, gate, thing)
-        result
+        @remote.disable(feature, gate, thing).tap do
+          @local.disable(feature, gate, thing)
+        end
       end
     end
   end

data/lib/flipper/adapters/failover.rb

@@ -0,0 +1,83 @@
+module Flipper
+  module Adapters
+    class Failover
+      include ::Flipper::Adapter
+
+      # Public: The name of the adapter.
+      attr_reader :name
+
+      # Public: Build a new failover instance.
+      #
+      # primary   - The primary flipper adapter.
+      # secondary - The secondary flipper adapter which services reads when
+      #             the primary adapter is unavailable.
+      # options   - Hash of options:
+      #             :dual_write - Boolean, whether to update secondary when
+      #                           primary is updated
+      #             :errors - Array of exception types for which to failover
+
+      def initialize(primary, secondary, options = {})
+        @name = :failover
+        @primary = primary
+        @secondary = secondary
+
+        @dual_write = options.fetch(:dual_write, false)
+        @errors = options.fetch(:errors, [ StandardError ])
+      end
+
+      def features
+        @primary.features
+      rescue *@errors
+        @secondary.features
+      end
+
+      def get(feature)
+        @primary.get(feature)
+      rescue *@errors
+        @secondary.get(feature)
+      end
+
+      def get_multi(features)
+        @primary.get_multi(features)
+      rescue *@errors
+        @secondary.get_multi(features)
+      end
+
+      def get_all
+        @primary.get_all
+      rescue *@errors
+        @secondary.get_all
+      end
+
+      def add(feature)
+        @primary.add(feature).tap do
+          @secondary.add(feature) if @dual_write
+        end
+      end
+
+      def remove(feature)
+        @primary.remove(feature).tap do
+          @secondary.remove(feature) if @dual_write
+        end
+      end
+
+      def clear(feature)
+        @primary.clear(feature).tap do
+          @secondary.clear(feature) if @dual_write
+        end
+      end
+
+      def enable(feature, gate, thing)
+        @primary.enable(feature, gate, thing).tap do
+          @secondary.enable(feature, gate, thing) if @dual_write
+        end
+      end
+
+      def disable(feature, gate, thing)
+        @primary.disable(feature, gate, thing).tap do
+          @secondary.disable(feature, gate, thing) if @dual_write
+        end
+      end
+    end
+  end
+end

data/lib/flipper/adapters/http/client.rb

@@ -70,9 +70,19 @@ module Flipper
         end
 
         def build_request(http_method, uri, headers, options)
+          request_headers = {
+            "Client-Language" => "ruby",
+            "Client-Language-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            "Client-Platform" => RUBY_PLATFORM,
+            "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            "Client-Pid" => Process.pid.to_s,
+            "Client-Thread" => Thread.current.object_id.to_s,
+            "Client-Hostname" => Socket.gethostname,
+          }.merge(headers)
+
           body = options[:body]
           request = http_method.new(uri.request_uri)
-          request.initialize_http_header(headers) if headers
+          request.initialize_http_header(request_headers)
           request.body = body if body
 
           if @basic_auth_username && @basic_auth_password

data/lib/flipper/adapters/http/error.rb

@@ -1,3 +1,5 @@
+require "json"
+
 module Flipper
   module Adapters
     class Http
@@ -6,7 +8,23 @@ module Flipper
 
         def initialize(response)
           @response = response
-          super("Failed with status: #{response.code}")
+          message = "Failed with status: #{response.code}"
+
+          begin
+            data = JSON.parse(response.body)
+
+            if error_message = data["message"]
+              message << "\n\n#{data["message"]}"
+            end
+
+            if more_info = data["more_info"]
+              message << "\n#{data["more_info"]}"
+            end
+          rescue => exception
+            # welp we tried
+          end
+
+          super(message)
         end
       end
     end

data/lib/flipper/adapters/memoizable.rb

@@ -45,24 +45,20 @@ module Flipper
 
       # Public
       def add(feature)
-        result = @adapter.add(feature)
-        expire_features_set
-        result
+        @adapter.add(feature).tap { expire_features_set }
       end
 
       # Public
       def remove(feature)
-        result = @adapter.remove(feature)
-        expire_features_set
-        expire_feature(feature)
-        result
+        @adapter.remove(feature).tap do
+          expire_features_set
+          expire_feature(feature)
+        end
       end
 
       # Public
       def clear(feature)
-        result = @adapter.clear(feature)
-        expire_feature(feature)
-        result
+        @adapter.clear(feature).tap { expire_feature(feature) }
       end
 
       # Public
@@ -124,16 +120,12 @@ module Flipper
 
       # Public
       def enable(feature, gate, thing)
-        result = @adapter.enable(feature, gate, thing)
-        expire_feature(feature)
-        result
+        @adapter.enable(feature, gate, thing).tap { expire_feature(feature) }
       end
 
       # Public
       def disable(feature, gate, thing)
-        result = @adapter.disable(feature, gate, thing)
-        expire_feature(feature)
-        result
+        @adapter.disable(feature, gate, thing).tap { expire_feature(feature) }
       end
 
       # Internal: Turns local caching on/off.

data/lib/flipper/adapters/pstore.rb

@@ -17,14 +17,11 @@ module Flipper
       # Public: The path to where the file is stored.
       attr_reader :path
 
-      # Public: PStore's thread_safe option.
-      attr_reader :thread_safe
-
       # Public
-      def initialize(path = 'flipper.pstore', thread_safe = false)
+      def initialize(path = 'flipper.pstore', thread_safe = true)
+        @name = :pstore
         @path = path
         @store = ::PStore.new(path, thread_safe)
-        @name = :pstore
       end
 
       # Public: The set of known features.

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

@@ -7,11 +7,6 @@ module Flipper
         # Private: Number of seconds between syncs (default: 10).
         DEFAULT_INTERVAL = 10
 
-        # Private
-        def self.now
-          Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
-        end
-
         # Public: The Float or Integer number of seconds between invocations of
         # the wrapped synchronizer.
         attr_reader :interval
@@ -46,7 +41,7 @@ module Flipper
         end
 
         def now
-          self.class.now
+          Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
         end
       end
     end

data/lib/flipper/adapters/sync.rb

@@ -58,33 +58,27 @@ module Flipper
       end
 
       def add(feature)
-        result = @remote.add(feature)
-        @local.add(feature)
-        result
+        @remote.add(feature).tap { @local.add(feature) }
       end
 
       def remove(feature)
-        result = @remote.remove(feature)
-        @local.remove(feature)
-        result
+        @remote.remove(feature).tap { @local.remove(feature) }
       end
 
       def clear(feature)
-        result = @remote.clear(feature)
-        @local.clear(feature)
-        result
+        @remote.clear(feature).tap { @local.clear(feature) }
       end
 
       def enable(feature, gate, thing)
-        result = @remote.enable(feature, gate, thing)
-        @local.enable(feature, gate, thing)
-        result
+        @remote.enable(feature, gate, thing).tap do
+          @local.enable(feature, gate, thing)
+        end
       end
 
       def disable(feature, gate, thing)
-        result = @remote.disable(feature, gate, thing)
-        @local.disable(feature, gate, thing)
-        result
+        @remote.disable(feature, gate, thing).tap do
+          @local.disable(feature, gate, thing)
+        end
       end
 
       private

data/lib/flipper/instrumenters/memory.rb

@@ -17,9 +17,13 @@ module Flipper
         # block rather than the one passed to #instrument.
         payload = payload.dup
 
-        result = (yield payload if block_given?)
+        result = yield payload if block_given?
+      rescue Exception => e
+        payload[:exception] = [e.class.name, e.message]
+        payload[:exception_object] = e
+        raise e
+      ensure
         @events << Event.new(name, payload, result)
-        result
       end
 
       def events_by_name(name)

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.22.2'.freeze
+  VERSION = '0.23.0'.freeze
 end

data/spec/flipper/actor_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Actor do
   it 'initializes with and knows flipper_id' do
     actor = described_class.new("User;235")

data/spec/flipper/adapter_spec.rb

@@ -1,5 +1,3 @@
-require 'helper'
-
 RSpec.describe Flipper::Adapter do
   let(:source_flipper) { build_flipper }
   let(:destination_flipper) { build_flipper }

data/spec/flipper/adapters/dual_write_spec.rb

@@ -1,7 +1,5 @@
-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