flipper 0.21.0 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25b07936734df32fbd0331822a97059e76ee9919db287e1073c15b338afc5924
-  data.tar.gz: 221fbb5002318b366d022365b7597f23094d2b50215e9545d3e1c2435faa03ec
+  metadata.gz: 11758f40e5798d6592a7f810a32a501593f7a2a59322f8261b8d366c1686fc25
+  data.tar.gz: b0f7713f289ef976328f12c31d3e9249251cb2bb196c7b324dcd952eafe00c88
 SHA512:
-  metadata.gz: 4529f945a2c71a3c776940cc091e48280e5088e080c203d478aca91e94e52855d4b5c912bae8aad2b7ca95248f42cabf62599a67f307fc98c34faf46c6361bf1
-  data.tar.gz: 3fed3febaf673456551dea59b13b01777f9f59f9ee267424547b495b4d7f06a7cc5c50521431ef29260585c01f93e05f2c1c30c4e55d5833cfb1cb40fccfb7c3
+  metadata.gz: 35d55048b48cb80c10f8242cef4494224858d9bcbd7e8fb934fb12c6348ebb5538d239dad5eddfbf13fcc6cefe1e4e9eddaffecd053628d1390081b4bdf79857
+  data.tar.gz: bf145e26dbf12f788d708a4a1b50b3684ce8d53b32a148ee8fde1b697e008ddd0a903a81f20a83b2b78bc270faa9470255e4700e1e8d08b01c905ae4906a8040

data/.codeclimate.yml

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

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,31 @@
+## 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
+
+* 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

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

@@ -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/api/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 ```ruby
 # config/routes.rb
 YourRailsApp::Application.routes.draw do
-  mount Flipper::Api.app(flipper) => '/flipper/api'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
 end
 ```
 
@@ -34,8 +34,8 @@ There can be more than one router in your application. Make sure if you choose a
 *bad:*
 ```ruby
 YourRailsApp::Application.routes.draw do
-  mount Flipper::UI.app(flipper) => '/flipper'
-  mount Flipper::Api.app(flipper) => '/flipper/api'
+  mount Flipper::UI.app(Flipper) => '/flipper'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
 end
 ```
 
@@ -44,8 +44,8 @@ In this case any requests to /flipper\* will be routed to Flipper::UI - includin
 *good:*
 ```ruby
 YourRailsApp::Application.routes.draw do
-  mount Flipper::Api.app(flipper) => '/flipper/api'
-  mount Flipper::UI.app(flipper) => '/flipper'
+  mount Flipper::Api.app(Flipper) => '/flipper/api'
+  mount Flipper::UI.app(Flipper) => '/flipper'
 end
 ````
 For more advanced mounting techniques and for suggestions on how to mount in a non-Rails application, it is recommend that you review the [`Flipper::UI` usage documentation](https://github.com/jnunemaker/flipper/blob/master/docs/ui/README.md#usage) as the same approaches apply to `Flipper::Api`.

data/examples/api/basic.ru

@@ -0,0 +1,19 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/basic.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/basic.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+# You can uncomment this to get some default data:
+# Flipper.enable :logging
+
+run Flipper::Api.app

data/examples/api/custom_memoized.ru

@@ -0,0 +1,37 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/custom_memoized.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/custom_memoized.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "active_support/notifications"
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+adapter = Flipper::Adapters::Instrumented.new(
+  Flipper::Adapters::PStore.new,
+  instrumenter: ActiveSupport::Notifications,
+)
+flipper = Flipper.new(adapter)
+
+ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
+  name, start, finish, id, data = args
+  case name
+  when "adapter_operation.flipper"
+    p data[:adapter_name] => data[:operation]
+  end
+})
+
+# You can uncomment this to get some default data:
+# flipper[:logging].enable_percentage_of_time 5
+
+run Flipper::Api.app(flipper) { |builder|
+  builder.use Flipper::Middleware::SetupEnv, flipper
+  builder.use Flipper::Middleware::Memoizer, preload: true
+}

data/examples/api/memoized.ru

@@ -0,0 +1,43 @@
+#
+# Usage:
+#   # if you want it to not reload and be really fast
+#   bin/rackup examples/api/memoized.ru -p 9999
+#
+#   # if you want reloading
+#   bin/shotgun examples/api/memoized.ru -p 9999
+#
+#   http://localhost:9999/
+#
+
+require 'bundler/setup'
+require "active_support/notifications"
+require "flipper/api"
+require "flipper/adapters/pstore"
+
+Flipper.configure do |config|
+  config.adapter {
+    Flipper::Adapters::Instrumented.new(
+      Flipper::Adapters::PStore.new,
+      instrumenter: ActiveSupport::Notifications,
+    )
+  }
+end
+
+ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
+  name, start, finish, id, data = args
+  case name
+  when "adapter_operation.flipper"
+    p data[:adapter_name] => data[:operation]
+  end
+})
+
+Flipper.register(:admins) { |actor|
+  actor.respond_to?(:admin?) && actor.admin?
+}
+
+# You can uncomment this to get some default data:
+# Flipper.enable :logging
+
+run Flipper::Api.app { |builder|
+  builder.use Flipper::Middleware::Memoizer, preload: true
+}

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/sync/synchronizer.rb

@@ -37,7 +37,8 @@ module Flipper
           # Sync all the gate values.
           remote_get_all.each do |feature_key, remote_gates_hash|
             feature = Feature.new(feature_key, @local)
-            local_gates_hash = local_get_all[feature_key] || @local.default_config
+            # Check if feature_key is in hash before accessing to prevent unintended hash modification
+            local_gates_hash = local_get_all.key?(feature_key) ? local_get_all[feature_key] : @local.default_config
             local_gate_values = GateValues.new(local_gates_hash)
             remote_gate_values = GateValues.new(remote_gates_hash)
             FeatureSynchronizer.new(feature, local_gate_values, remote_gate_values).call

data/lib/flipper/middleware/memoizer.rb

@@ -15,7 +15,7 @@ module Flipper
       #   use Flipper::Middleware::Memoizer
       #
       #   # using with preload_all features
-      #   use Flipper::Middleware::Memoizer, preload_all: true
+      #   use Flipper::Middleware::Memoizer, preload: true
       #
       #   # using with preload specific features
       #   use Flipper::Middleware::Memoizer, preload: [:stats, :search, :some_feature]

data/lib/flipper/railtie.rb

@@ -5,7 +5,8 @@ module Flipper
         env_key: "flipper",
         memoize: true,
         preload: true,
-        instrumenter: ActiveSupport::Notifications
+        instrumenter: ActiveSupport::Notifications,
+        log: true
       )
     end
 
@@ -17,7 +18,7 @@ module Flipper
       end
     end
 
-    initializer "flipper.memoizer", after: :load_config_initializers do |app|
+    initializer "flipper.memoizer" do |app|
       config = app.config.flipper
 
       if config.memoize
@@ -29,6 +30,13 @@ module Flipper
       end
     end
 
+    initializer "flipper.log" do |app|
+      config = app.config.flipper
+      if config.log && config.instrumenter == ActiveSupport::Notifications
+        require "flipper/instrumentation/log_subscriber"
+      end
+    end
+
     initializer "flipper.identifier" do
       ActiveSupport.on_load(:active_record) do
         ActiveRecord::Base.include Flipper::Identifier

data/lib/flipper/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-09 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/examples.yml"
 - CODE_OF_CONDUCT.md
 - Changelog.md
 - Dockerfile
@@ -37,6 +38,9 @@ files:
 - docs/http/README.md
 - docs/images/banner.jpg
 - docs/read-only/README.md
+- examples/api/basic.ru
+- examples/api/custom_memoized.ru
+- examples/api/memoized.ru
 - examples/basic.rb
 - examples/configuring_default.rb
 - examples/dsl.rb
@@ -47,6 +51,7 @@ files:
 - examples/importing.rb
 - examples/individual_actor.rb
 - examples/instrumentation.rb
+- examples/instrumentation_last_accessed_at.rb
 - examples/memoizing.rb
 - examples/percentage_of_actors.rb
 - examples/percentage_of_actors_enabled_check.rb