flipper 0.22.0 → 0.23.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5ccee45a49e10626a3168f1d4ac5b833a7a353be908044a9e056a8a38977e11
-  data.tar.gz: e4835d28c5db82466369bd78a002454c882e1c731ff171e352bbee3b53df1102
+  metadata.gz: a41bf1dd43734d1d6c6b56a46ea393af74164d46aadd7671994bdcc10e4eb646
+  data.tar.gz: e935dc1375a66156f0d0f7ba967269d184b8babaf119333c614943643f760ed7
 SHA512:
-  metadata.gz: efc365c24401b44a56f0c3818dd3d85868b89859ec22ee9119e3ac2764043a90d966d5a4a079e3aab231f07df017017cea09ab1f351edcdaa90a97837ee38614
-  data.tar.gz: 42e748dfb24633faca15dde30f1062b349e29c72bbf014382a22a9ad06cea214ea4fa679fc5e69d4e4b8e259a1c98863e9a29bf1f302fcee319a3729f8ee85a5
+  metadata.gz: 82d249a9f90b96fcf88713890a2df5a7fa5f05927b7a1903630e276507ee709b5426b91fba46aa6ef034e15dc6b50b35781d61b56afe512a46673e4de3eb559d
+  data.tar.gz: c986d6fb7c1a773ab56e6b7cb35734648485562690799dff901578b2c31566f5582bb8390268228f48eda9fba6797f8b72bd7fd385e45a9a04155c14a4c8b95f

data/.codeclimate.yml

@@ -1,2 +1,3 @@
 exclude_patterns:
   - "lib/flipper/ui/public"
+  - "spec/"

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
@@ -51,8 +56,3 @@ jobs:
         run: |
           bundle install --jobs 4 --retry 3
           bundle exec rake
-      - name: Run Examples with Rails ${{ matrix.rails }}
-        env:
-          FLIPPER_CLOUD_TOKEN: ${{ secrets.FLIPPER_CLOUD_TOKEN }}
-          RAILS_VERSION: ${{ matrix.rails }}
-        run: script/examples

data/.github/workflows/examples.yml

@@ -0,0 +1,57 @@
+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:
+      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']
+        rails: ['5.2', '6.0.0', '6.1.0']
+    env:
+      SQLITE3_VERSION: 1.4.1
+      REDIS_URL: redis://localhost:6379/0
+      CI: true
+    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 }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Set up Ruby ${{ matrix.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: Bundle install with Rails ${{ matrix.rails }}
+        env:
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: bundle install --jobs 4 --retry 3
+      - name: Run Examples with Rails ${{ matrix.rails }}
+        env:
+          FLIPPER_CLOUD_TOKEN: ${{ secrets.FLIPPER_CLOUD_TOKEN }}
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: script/examples

data/.rspec

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

data/Changelog.md

@@ -1,6 +1,48 @@
+## 0.23.1
+
+### Additions/Changes
+
+* Relax dalli version constraint (https://github.com/jnunemaker/flipper/pull/596)
+
+### Bug Fixes
+
+* Fix railtie initialization to mount middleware after config/intializers/* (https://github.com/jnunemaker/flipper/pull/586)
+
+## 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
+
+* Allow adding multiple actors at once in flipper-ui via comma separation (configurable via `Flipper::UI.configuration.actors_separator`) (https://github.com/jnunemaker/flipper/pull/556)
+
+### Bug Fixes
+
+* Fix railtie initialization to avoid altering middleware order (https://github.com/jnunemaker/flipper/pull/563)
+
+## 0.22.1
+
+### Additions/Changes
+
+* Remove Octicons and replace with a pure CSS status circle (https://github.com/jnunemaker/flipper/pull/547)
+* Rescue unique errors in AR and Sequel when setting value (https://github.com/jnunemaker/flipper/commit/87f5a98bce7baad7a27b75b5bce3256967769f27)
+* Add a Content-Security-Policy to flipper-ui (https://github.com/jnunemaker/flipper/pull/552)
+* Fix Synchronizer issue that occurs for ActiveRecord adapter (https://github.com/jnunemaker/flipper/pull/554)
+
 ## 0.22.0
 
-## Additions/Changes
+### Additions/Changes
 
 * Enable log subscriber by default in Rails (https://github.com/jnunemaker/flipper/pull/525)
 * Remove memoizer from API and UI (https://github.com/jnunemaker/flipper/pull/527). If you are using the UI or API without configuring the default instance of Flipper, you'll need to enable memoization if you want it. For examples, see the examples/ui and examples/api directories.
@@ -16,7 +58,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
 
@@ -31,7 +73,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
@@ -40,6 +82,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/docker-compose.yml

@@ -1,34 +1,37 @@
-# postgres:
-#   container_name: flipper_postgres
-#   image: postgres:9.4
-redis:
-  container_name: flipper_redis
-  image: redis:2.8
-mongo:
-  container_name: flipper_mongo
-  image: mongo:3.3
-memcached:
-  container_name: flipper_memcached
-  image: memcached:1.4.33
-app:
-  container_name: flipper_app
-  build: .
-  dockerfile: Dockerfile
-  volumes:
-    - .:/srv/app
-  volumes_from:
-    - bundle_cache
-  links:
-    # - postgres
-    - redis
-    - mongo
-    - memcached
-  environment:
-    - REDIS_URL=redis://redis:6379
-    - MONGODB_HOST=mongo
-    - MEMCACHED_URL=memcached:11211
-bundle_cache:
-  container_name: flipper_bundle_cache
-  image: busybox
-  volumes:
-    - /bundle_cache
+version: "2.4"
+services:
+  # postgres:
+  #   container_name: flipper_postgres
+  #   image: postgres:9.4
+  redis:
+    container_name: flipper_redis
+    image: redis:6.2.5
+  mongo:
+    container_name: flipper_mongo
+    image: mongo:4.4.8
+  memcached:
+    container_name: flipper_memcached
+    image: memcached:1.4.33
+  app:
+    container_name: flipper_app
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/srv/app
+    volumes_from:
+      - bundle_cache
+    links:
+      # - postgres
+      - redis
+      - mongo
+      - memcached
+    environment:
+      - REDIS_URL=redis://redis:6379
+      - MONGODB_HOST=mongo
+      - MEMCACHED_URL=memcached:11211
+  bundle_cache:
+    container_name: flipper_bundle_cache
+    image: busybox
+    volumes:
+      - /bundle_cache

data/docs/README.md

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

data/examples/instrumentation_last_accessed_at.rb

@@ -0,0 +1,37 @@
+# Quick example of how to keep track of when a feature was last checked.
+require 'bundler/setup'
+require 'securerandom'
+require 'active_support/notifications'
+require 'flipper'
+
+class FlipperSubscriber
+  def self.stats
+    @stats ||= {}
+  end
+
+  def call(name, start, finish, id, payload)
+    if payload[:operation] == :enabled?
+      feature_name = payload.fetch(:feature_name)
+      self.class.stats[feature_name] = Time.now
+    end
+  end
+
+  ActiveSupport::Notifications.subscribe(/feature_operation.flipper/, new)
+end
+
+Flipper.configure do |config|
+  config.default {
+    Flipper.new(config.adapter, instrumenter: ActiveSupport::Notifications)
+  }
+end
+
+Flipper.enabled?(:search)
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:booyeah)
+Flipper.enabled?(:hooray)
+sleep 1
+Flipper.enabled?(:hooray)
+
+pp FlipperSubscriber.stats

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