flipper 0.21.0.rc1 → 0.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04567e721e7189ed3a5a28c91833caa438e89c8dc412708c1d5487ebcf43e09e
-  data.tar.gz: c31948ae275a36a986352ae8d53e858d63e67590a1cae3831013530446008608
+  metadata.gz: 14514238ff1ea823df0cefeb2e1048816b86995d582e6c3dda037d36db344078
+  data.tar.gz: 285650a29a45623ed0468a08736621ccf88a6453eeadd8f42a29740a4a2955bc
 SHA512:
-  metadata.gz: 30e3b27356e2a24948cb4136c59be5a7a0d0b21631102999affa01c3e969dc037e6ff524df3da4ffc0c39ecd8ffbbb1798bda4593fca21f33aeebefb0236caff
-  data.tar.gz: 7cb046ca418ff31219b9d786cd22c0f81de6c37c9efc38a718e9ddcf2c97027de0d1a351ddeeae1a24adf1db081dcb364e0751f4d2881ef126e2a98ff0212b63
+  metadata.gz: 3af99a75cafb349025fd03a6c2bab4bb224f76acd2a0ac820bf6306ded28235b615fc0f891ce8d3df7612eca26d631fc7a51fb6ee738fdfdb614a561b121af04
+  data.tar.gz: bbaa9c0da5be73f4d1ab4ebc284919585878162e2c0151e346d77ad6909fddff7d0da7eff823ad29281d645e521d53e21f1de9184efda072e90e919d465a2c48

data/.github/workflows/ci.yml

@@ -1,10 +1,8 @@
 name: CI
-on:
-  push:
-    branches: [master]
-  pull_request:
+on: [push, pull_request]
 jobs:
-  build:
+  test:
+    name: Test on ruby ${{ matrix.ruby }} and rails ${{ matrix.rails }}
     runs-on: ubuntu-latest
     services:
       redis:
@@ -18,8 +16,8 @@ jobs:
     strategy:
       matrix:
         ruby: ['2.5', '2.6', '2.7']
+        rails: ['5.2', '6.0.0', '6.1.0']
     env:
-      RAILS_VERSION: 6.0.0
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
       CI: true
@@ -36,10 +34,10 @@ jobs:
         uses: actions/cache@v1
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
-            ${{ runner.os }}-gem-
-      - name: Set up Ruby
+            ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Set up Ruby ${{ matrix.ruby }}
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
@@ -47,11 +45,9 @@ jobs:
         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
-      - name: Run Examples
+      - name: Run Rake with Rails ${{ matrix.rails }}
         env:
-          FLIPPER_CLOUD_TOKEN: ${{ secrets.FLIPPER_CLOUD_TOKEN }}
-        run: script/examples
+          RAILS_VERSION: ${{ matrix.rails }}
+        run: |
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.github/workflows/examples.yml

@@ -0,0 +1,56 @@
+name: Examples
+on: [push, pull_request]
+jobs:
+  test:
+    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/Changelog.md

@@ -1,3 +1,21 @@
+## 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
+
+* 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.
+* Fix SQL reserved word use in get_all for ActiveRecord and Sequel (https://github.com/jnunemaker/flipper/pull/536).
+* Handle spaces in names gracefully in UI (https://github.com/jnunemaker/flipper/pull/541).
+
 ## 0.21.0
 
 ### Additions/Changes
@@ -7,6 +25,41 @@
 * 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)
+
+### Upgrading
+
+You should be able to upgrade to 0.21 without any breaking changes. However, if you want to simplify your setup, you can remove some configuration that is now handled automatically:
+
+1. Adapters are configured when on require, so unless you are using caching or other customizations, you can remove adapter configuration.
+
+    ```diff
+    # config/initializers/flipper.rb
+    - Flipper.configure do |config|
+    -   config.default { Flipper.new(Flipper::Adapters::ActiveRecord.new) }
+    - end
+    ```
+
+2. `Flipper::Middleware::Memoizer` will be enabled by default.
+
+    ```diff
+    # config/initializers/flipper.rb
+    - Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
+    -   preload: [:stats, :search, :some_feature]
+    + Rails.application.configure do
+    +   # Uncomment to configure which features to preload on all requests
+    +   # config.flipper.preload = [:stats, :search, :some_feature]
+    + end
+    ```
+
+3. `#flipper_id`, which is used to enable features for specific actors, is now defined by [Flipper::Identifier](lib/flipper/identifier.rb) on all ActiveRecord and Sequel models. You can remove your implementation if it is in the form of `ModelName;id`.
+
+4. When using `flipper-cloud`, The `Flipper::Cloud.app` webhook receiver is now mounted at `/_flipper` by default.
+
+    ```diff
+    # config/routes.rb
+    - mount Flipper::Cloud.app, at: "/_flipper"
+    ```
 
 ## 0.20.4
 
@@ -14,6 +67,7 @@
 
 * Allow actors and time gates to deal with decimal percentages (https://github.com/jnunemaker/flipper/pull/492)
 * Change Flipper::Cloud::Middleware to receive webhooks at / in addition to /webhooks.
+* Add `write_through` option to ActiveSupportCacheStore adapter to support write-through caching (https://github.com/jnunemaker/flipper/pull/512)
 
 ## 0.20.3
 

data/Gemfile

@@ -19,6 +19,7 @@ gem 'minitest-documentation'
 gem 'webmock', '~> 3.0'
 gem 'climate_control'
 gem 'redis-namespace'
+gem 'webrick'
 
 group(:guard) do
   gem 'guard', '~> 2.15'

data/README.md

@@ -21,7 +21,7 @@ Add this line to your application's Gemfile:
 
 You'll also want to pick a storage [adapter](#adapters), for example:
 
-    gem 'flipper-active_record'`
+    gem 'flipper-active_record'
 
 And then execute:
 
@@ -157,6 +157,7 @@ A few miscellaneous docs with more info for the hungry.
 | pic | @mention | area |
 |---|---|---|
 | ![@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 |
 | ![@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/Adapters.md

@@ -4,18 +4,17 @@ I plan on supporting the adapters in the flipper repo. Other adapters are welcom
 
 ## Officially Supported
 
-* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 3, 4, 5, and 6.
-* [ActiveSupportCacheStore adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_support_cache_store) - ActiveSupport::Cache::Store
-* [Cassanity adapter](https://github.com/jnunemaker/flipper-cassanity)
-* [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http)
-* [memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests
-* [Moneta adapter](https://github.com/jnunemaker/flipper/blob/master/docs/moneta)
+* [ActiveRecord adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_record) - Rails 5 and 6.
+* [Sequel adapter](https://github.com/jnunemaker/flipper/blob/master/docs/sequel)
+* [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
 * [Mongo adapter](https://github.com/jnunemaker/flipper/blob/master/docs/mongo)
 * [PStore adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/pstore.rb) – great for when a local file is enough
-* [read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only)
-* [Redis adapter](https://github.com/jnunemaker/flipper/blob/master/docs/redis)
-* [Rollout adapter](rollout/README.md)
-* [Sequel adapter](https://github.com/jnunemaker/flipper/blob/master/docs/sequel)
+* [Http adapter](https://github.com/jnunemaker/flipper/blob/master/docs/http) - great for using with `Flipper::Api`
+* [Moneta adapter](https://github.com/jnunemaker/flipper/blob/master/docs/moneta) - great for a variety of data stores
+* [ActiveSupportCacheStore adapter](https://github.com/jnunemaker/flipper/blob/master/docs/active_support_cache_store) - great for Rails caching
+* [Memory adapter](https://github.com/jnunemaker/flipper/blob/master/lib/flipper/adapters/memory.rb) – great for tests
+* [Read-only adapter](https://github.com/jnunemaker/flipper/blob/master/docs/read-only) - great for preventing writes from production console
+* [Rollout adapter](rollout/README.md) - great for switching from rollout to flipper
 
 ## Community Supported
 

data/docs/Caveats.md

@@ -1,4 +1,4 @@
 # Caveats
 
-1. The [individual actor gate](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md#2-individual-actor) is typically not designed for hundreds or thousands of actors to be enabled. This is an explicit choice to make it easier to batch load data from the adapters instead of performing individual checks for actors over and over. If you need to enable something for more than 20 individual people, I would recommend using a [group](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md#5-group).
-2. The disable method exists only to clear something that is enabled. If the thing you are disabling is not enabled, the disable is pointless. This means that if you enable one group an actor is in and disable another group, the feature will be enabled for the actor. ([related issue](https://github.com/jnunemaker/flipper/issues/71))
+1. The [individual actor gate](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md#2-individual-actor) is typically not designed for hundreds or thousands of actors to be enabled. This is an explicit choice to make it easier to batch load data from the adapters instead of performing individual checks for actors over and over. If you need to enable something for more than 100 individual actors, I would recommend using a [group](https://github.com/jnunemaker/flipper/blob/master/docs/Gates.md#5-group).
+2. The `disable` method exists only to clear something that is enabled. If the thing you are disabling is not enabled, the disable is pointless. This means that if you enable one group an actor is in and disable another group, the feature will be enabled for the actor. ([related issue](https://github.com/jnunemaker/flipper/issues/71))

data/docs/Optimization.md

@@ -1,52 +1,63 @@
 # Optimization
 
-## Memoizing Middleware
+## Memoization
 
-One optimization that flipper provides is a memoizing middleware. The memoizing middleware ensures that you only make one adapter call per feature per request. This means if you check the same feature over and over, it will only make one Mongo, Redis, or whatever call per feature for the length of the request.
+By default, Flipper will preload and memoize all features to ensure one adapter call per request. This means no matter how many times you check features, Flipper will only make one network request to Postgres, MySQL, Redis, Mongo or whatever adapter you are using for the length of the request.
 
-You can use the middleware like so for Rails:
+### Preloading
+
+Flipper will preload all features before each request by default, which is recommended if you have a limited number of features (< 100?) and they are used on most requests. If you have a lot of features, but only a few are used on most requests, you may want to customize preloading:
 
 ```ruby
-# setup default instance (perhaps in config/initializers/flipper.rb)
-Flipper.configure do |config|
-  config.default do
-    Flipper.new(...)
-  end
+# config/initializers/flipper.rb
+Rails.application.configure do
+  # Load specific features that are used on most requests
+  config.flipper.preload = [:stats, :search, :some_feature]
+
+  # Or completely disable preloading
+  config.flipper.preload = false
 end
+```
+
+Features that are not preloaded are still memoized, ensuring one adapter call per feature during a request.
+
+### Skip memoization
+
+Prevent preloading and memoization on specific requests by setting `memoize` to a proc that evaluates to false.
 
-# This assumes you setup a default flipper instance using configure.
-Rails.configuration.middleware.use Flipper::Middleware::Memoizer
+```ruby
+# config/initializers/flipper.rb
+Rails.application.configure do
+  config.flipper.memoize = ->(request) { !request.path.start_with?("/assets") }
+end
 ```
 
-**Note**: Be sure that the middleware is high enough up in your stack that all feature checks are wrapped.
+### Disable memoization
 
-**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`:
+To disable memoization entirely:
 
 ```ruby
-Rails.configuration.middleware.use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
-Rails.configuration.middleware.use Flipper::Middleware::Memoizer
+Rails.application.configure do
+  config.flipper.memoize = false
+end
 ```
 
-### Options
-
-The Memoizer middleware also supports a few options. Use either `preload` or `preload_all`, not both.
-
-* **`: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
-    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
-    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
-    Rails.configuration.middleware.use Flipper::Middleware::Memoizer,
-      unless: ->(request) { request.path.start_with?("/assets") }
-    ```
+### Advanced
+
+Memoization is implemented as a Rack middleware, which can be used manually in any Ruby app:
+
+```ruby
+use Flipper::Middleware::Memoizer,
+  preload: true,
+  unless: ->(request) { request.path.start_with?("/assets") }
+```
+
+**Also Note**: If you need to customize the instance of Flipper used by the memoizer, you can pass the instance to `SetupEnv`:
+
+```ruby
+use Flipper::Middleware::SetupEnv, -> { Flipper.new(...) }
+use Flipper::Middleware::Memoizer
+```
 
 ## Cache Adapters
 
@@ -61,11 +72,15 @@ https://github.com/petergoldstein/dalli
 Example using the Dalli cache adapter with the Memory adapter and a TTL of 600 seconds:
 
 ```ruby
-dalli_client = Dalli::Client.new('localhost:11211')
-memory_adapter = Flipper::Adapters::Memory.new
-adapter = Flipper::Adapters::Dalli.new(memory_adapter, dalli_client, 600)
-flipper = Flipper.new(adapter)
+Flipper.configure do |config|
+  config.adapter do
+    dalli = Dalli::Client.new('localhost:11211')
+    adapter = Flipper::Adapters::Memory.new
+    Flipper::Adapters::Dalli.new(adapter, dalli, 600)
+  end
+end
 ```
+
 ### RedisCache
 
 Applications using [Redis](https://redis.io/) via the [redis-rb](https://github.com/redis/redis-rb) client can take advantage of the RedisCache adapter.
@@ -75,12 +90,15 @@ Initialize `RedisCache`  with a flipper [adapter](https://github.com/jnunemaker/
 Example using the RedisCache adapter with the Memory adapter and a TTL of 4800 seconds:
 
 ```ruby
-  require 'flipper/adapters/redis_cache'
+require 'flipper/adapters/redis_cache'
 
-  redis = Redis.new(url: ENV['REDIS_URL'])
-  memory_adapter = Flipper::Adapters::Memory.new
-  adapter = Flipper::Adapters::RedisCache.new(memory_adapter, redis, 4800)
-  flipper = Flipper.new(adapter)
+Flipper.configure do |config|
+  config.adapter do
+    redis = Redis.new(url: ENV['REDIS_URL'])
+    memory_adapter = Flipper::Adapters::Memory.new
+    Flipper::Adapters::RedisCache.new(memory_adapter, redis, 4800)
+  end
+end
 ```
 
 ### ActiveSupportCacheStore
@@ -105,10 +123,15 @@ Example using the ActiveSupportCacheStore adapter with ActiveSupport's [MemorySt
 require 'active_support/cache'
 require 'flipper/adapters/active_support_cache_store'
 
-memory_adapter = Flipper::Adapters::Memory.new
-cache = ActiveSupport::Cache::MemoryStore.new
-adapter = Flipper::Adapters::ActiveSupportCacheStore.new(memory_adapter, cache, expires_in: 5.minutes)
-flipper = Flipper.new(adapter)
+Flipper.configure do |config|
+  config.adapter do
+    Flipper::Adapters::ActiveSupportCacheStore.new(
+      Flipper::Adapters::Memory.new,
+      ActiveSupport::Cache::MemoryStore.new # Or Rails.cache,
+      expires_in: 5.minutes
+    )
+  end
+end
 ```
 
 Setting `expires_in` is optional and will set an expiration time on Flipper cache keys.  If specified, all flipper keys will use this `expires_in` over the `expires_in` passed to your ActiveSupport cache constructor.