flipper 0.26.0 → 0.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5edb0409042f8d4d5905b8d526fd1d240a75dbee2d947b8ae4adae0c534af5f
-  data.tar.gz: 6bc01d5f7c0ee5f3d64d30faaa599b155d6220e249006d2ead7168bc47938202
+  metadata.gz: 670e45600b4c72208ed69da2792d2d4e1ac11d7a54f19c45c4b448ba6dacc404
+  data.tar.gz: 56a6ef12c569a7392212953604ed103a1fb187b57d5f827ea141a0d5eafc5ee1
 SHA512:
-  metadata.gz: 60fee2e4a0d97a26b7403736b4422c0e69a0e9e452469e3f29e7af684001c38f2c957acdfa3f8f0554315d021a7e7091bb40898247e45d4658b14b31bc1de22f
-  data.tar.gz: bf45e695be511513be967bffd75c4e48d3af0f05b05264ee3b13a9df8bba8af929ccbf6b7a1f05c6c3a7d5476ceb757e3dda852f8e42b745bf7171f42538fb14
+  metadata.gz: a09649689708c91afbdc3e9f4eded2ec29ae1b3ac06a98f28197dcc4d3dd65983f73e0e9e44994d78b0672afbea1350ff7256dc12b7e5bb426961bfce858b4f6
+  data.tar.gz: '08eb67c5e5df45e734e8b6e50c6fd20cfbdf28dbdb8ba1a3e2d2af084250b9cd404fa21cc778989527d245154e05f5abc49aaa12a95b2ef7b12daf4bbea41830'

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
           --health-retries 5
     strategy:
       matrix:
-        ruby: ['2.6', '2.7', '3.0', '3.1']
+        ruby: ['2.6', '2.7', '3.0', '3.1', '3.2']
         rails: ['5.2', '6.0.0', '6.1.0', '7.0.0']
         exclude:
           - ruby: "2.6"
@@ -26,15 +26,22 @@ jobs:
             rails: "5.2"
           - ruby: "3.1"
             rails: "6.0.0"
+          - ruby: "3.2"
+            rails: "5.2"
+          - ruby: "3.2"
+            rails: "6.0.0"
+          - ruby: "3.2"
+            rails: "6.1.0"
     env:
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
       CI: true
+      RAILS_VERSION: ${{ matrix.rails }}
     steps:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.8.0
+        uses: supercharge/mongodb-github-action@1.9.0
         with:
           mongodb-version: 4.0
       - name: Check out repository code
@@ -46,17 +53,12 @@ jobs:
           key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
             ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Install libpq-dev
+        run: sudo apt-get -yqq install libpq-dev
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/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
+          bundler-cache: true # 'bundle install' and cache gems
       - name: Run Rake with Rails ${{ matrix.rails }}
-        env:
-          RAILS_VERSION: ${{ matrix.rails }}
-        run: |
-          bundle install --jobs 4 --retry 3
-          bundle exec rake
+        run: bundle exec rake

data/.github/workflows/examples.yml

@@ -32,11 +32,12 @@ jobs:
       SQLITE3_VERSION: 1.4.1
       REDIS_URL: redis://localhost:6379/0
       CI: true
+      RAILS_VERSION: ${{ matrix.rails }}
     steps:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.8.0
+        uses: supercharge/mongodb-github-action@1.9.0
         with:
           mongodb-version: 4.0
       - name: Check out repository code
@@ -48,20 +49,14 @@ jobs:
           key: ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: |
             ${{ runner.os }}-gems-${{ matrix.ruby }}-${{ matrix.rails }}-
+      - name: Install libpq-dev
+        run: sudo apt-get -yqq install libpq-dev
       - name: Set up Ruby ${{ matrix.ruby }}
         uses: ruby/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
+          bundler-cache: true # 'bundle install' and cache gems
       - 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

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.26.2
+
+* Improve Active Record Adapter get/get_multi/get_all performance by 5-10x when dealing with thousands of gate values (https://github.com/jnunemaker/flipper/pull/707).
+
+## 0.26.1
+
+* Improve `Flipper#enabled?` performance by ~37%-55% (https://github.com/jnunemaker/flipper/pull/706)
+* Make Memory adapter threadsafe (https://github.com/jnunemaker/flipper/pull/702 and https://github.com/jnunemaker/flipper/pull/703)
+* ActiveRecord adapter: wrap all reads/writes in `with_connection` (https://github.com/jnunemaker/flipper/pull/705)
+* Improve performance of background polling (https://github.com/jnunemaker/flipper/pull/699)
+* Remove executables directive from gem (https://github.com/jnunemaker/flipper/pull/693)
+
 ## 0.26.0
 
 * Cloud Background Polling (https://github.com/jnunemaker/flipper/pull/682)

data/Gemfile

@@ -20,6 +20,10 @@ gem 'webmock', '~> 3.0'
 gem 'ice_age'
 gem 'redis-namespace'
 gem 'webrick'
+gem 'stackprof'
+gem 'benchmark-ips'
+gem 'stackprof-webnav'
+gem 'flamegraph'
 
 group(:guard) do
   gem 'guard', '~> 2.15'

data/benchmark/enabled_ips.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+require 'flipper'
+require 'benchmark/ips'
+
+actor = Flipper::Actor.new("User;1")
+
+Benchmark.ips do |x|
+  x.report("with actor") { Flipper.enabled?(:foo, actor) }
+  x.report("without actor") { Flipper.enabled?(:foo) }
+end

data/benchmark/enabled_profile.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'flipper'
+require 'stackprof'
+require 'benchmark/ips'
+
+flipper = Flipper.new(Flipper::Adapters::Memory.new)
+feature = flipper.feature(:foo)
+actor = Flipper::Actor.new("User;1")
+
+profile = StackProf.run(mode: :wall, interval: 1_000) do
+  2_000_000.times do
+    feature.enabled?(actor)
+  end
+end
+
+result = StackProf::Report.new(profile)
+puts
+result.print_text
+puts "\n\n\n"
+result.print_method(/Flipper::Feature#enabled?/)

data/benchmark/instrumentation_ips.rb

@@ -0,0 +1,21 @@
+require 'bundler/setup'
+require 'flipper'
+require 'active_support/notifications'
+require 'active_support/isolated_execution_state'
+require 'benchmark/ips'
+
+class FlipperSubscriber
+  def call(name, start, finish, id, payload)
+  end
+
+  ActiveSupport::Notifications.subscribe(/flipper/, new)
+end
+
+actor = Flipper::Actor.new("User;1")
+bare = Flipper.new(Flipper::Adapters::Memory.new)
+instrumented = Flipper.new(Flipper::Adapters::Memory.new, instrumenter: ActiveSupport::Notifications)
+
+Benchmark.ips do |x|
+  x.report("with instrumentation") { instrumented.enabled?(:foo, actor) }
+  x.report("without instrumentation") { bare.enabled?(:foo, actor) }
+end

data/benchmark/typecast_ips.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'flipper'
+require 'benchmark/ips'
+
+Benchmark.ips do |x|
+  x.report("Typecast.to_boolean true") { Flipper::Typecast.to_boolean(true) }
+  x.report("Typecast.to_boolean 1") { Flipper::Typecast.to_boolean(1) }
+  x.report("Typecast.to_boolean 'true'") { Flipper::Typecast.to_boolean('true'.freeze) }
+  x.report("Typecast.to_boolean '1'") { Flipper::Typecast.to_boolean('1'.freeze) }
+  x.report("Typecast.to_boolean false") { Flipper::Typecast.to_boolean(false) }
+
+  x.report("Typecast.to_integer 1") { Flipper::Typecast.to_integer(1) }
+  x.report("Typecast.to_integer '1'") { Flipper::Typecast.to_integer('1') }
+
+  x.report("Typecast.to_float 1") { Flipper::Typecast.to_float(1) }
+  x.report("Typecast.to_float '1'") { Flipper::Typecast.to_float('1'.freeze) }
+  x.report("Typecast.to_float 1.01") { Flipper::Typecast.to_float(1) }
+  x.report("Typecast.to_float '1.01'") { Flipper::Typecast.to_float('1'.freeze) }
+end

data/flipper.gemspec

@@ -13,7 +13,6 @@ end
 
 ignored_files = plugin_files
 ignored_files << Dir['script/*']
-ignored_files << '.travis.yml'
 ignored_files << '.gitignore'
 ignored_files << 'Guardfile'
 ignored_files.flatten!.uniq!
@@ -28,7 +27,6 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/jnunemaker/flipper'
   gem.license       = 'MIT'
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n") - ignored_files + ['lib/flipper/version.rb']
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n") - ignored_test_files
   gem.name          = 'flipper'

data/lib/flipper/adapters/memory.rb

@@ -1,4 +1,4 @@
-require 'set'
+require 'concurrent/atomic/read_write_lock'
 
 module Flipper
   module Adapters
@@ -14,86 +14,93 @@ module Flipper
 
       # Public
       def initialize(source = nil)
-        @source = source || {}
+        @source = Hash.new.update(source || {})
         @name = :memory
+        @lock = Concurrent::ReadWriteLock.new
       end
 
       # Public: The set of known features.
       def features
-        @source.keys.to_set
+        @lock.with_read_lock { @source.keys }.to_set
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        @source[feature.key] ||= default_config
+        @lock.with_write_lock { @source[feature.key] ||= default_config }
         true
       end
 
       # Public: Removes a feature from the set of known features and clears
       # all the values for the feature.
       def remove(feature)
-        @source.delete(feature.key)
+        @lock.with_write_lock { @source.delete(feature.key) }
         true
       end
 
       # Public: Clears all the gate values for a feature.
       def clear(feature)
-        @source[feature.key] = default_config
+        @lock.with_write_lock { @source[feature.key] = default_config }
         true
       end
 
       # Public
       def get(feature)
-        @source[feature.key] || default_config
+        @lock.with_read_lock { @source[feature.key] } || default_config
       end
 
       def get_multi(features)
-        result = {}
-        features.each do |feature|
-          result[feature.key] = @source[feature.key] || default_config
+        @lock.with_read_lock do
+          result = {}
+          features.each do |feature|
+            result[feature.key] = @source[feature.key] || default_config
+          end
+          result
         end
-        result
       end
 
       def get_all
-        @source
+        @lock.with_read_lock { @source.to_h }
       end
 
       # Public
       def enable(feature, gate, thing)
-        @source[feature.key] ||= default_config
-
-        case gate.data_type
-        when :boolean
-          clear(feature)
-          @source[feature.key][gate.key] = thing.value.to_s
-        when :integer
-          @source[feature.key][gate.key] = thing.value.to_s
-        when :set
-          @source[feature.key][gate.key] << thing.value.to_s
-        else
-          raise "#{gate} is not supported by this adapter yet"
+        @lock.with_write_lock do
+          @source[feature.key] ||= default_config
+
+          case gate.data_type
+          when :boolean
+            @source[feature.key] = default_config
+            @source[feature.key][gate.key] = thing.value.to_s
+          when :integer
+            @source[feature.key][gate.key] = thing.value.to_s
+          when :set
+            @source[feature.key][gate.key] << thing.value.to_s
+          else
+            raise "#{gate} is not supported by this adapter yet"
+          end
+
+          true
         end
-
-        true
       end
 
       # Public
       def disable(feature, gate, thing)
-        @source[feature.key] ||= default_config
-
-        case gate.data_type
-        when :boolean
-          clear(feature)
-        when :integer
-          @source[feature.key][gate.key] = thing.value.to_s
-        when :set
-          @source[feature.key][gate.key].delete thing.value.to_s
-        else
-          raise "#{gate} is not supported by this adapter yet"
+        @lock.with_write_lock do
+          @source[feature.key] ||= default_config
+
+          case gate.data_type
+          when :boolean
+            @source[feature.key] = default_config
+          when :integer
+            @source[feature.key][gate.key] = thing.value.to_s
+          when :set
+            @source[feature.key][gate.key].delete thing.value.to_s
+          else
+            raise "#{gate} is not supported by this adapter yet"
+          end
+
+          true
         end
-
-        true
       end
 
       # Public
@@ -104,6 +111,12 @@ module Flipper
         ]
         "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
       end
+
+      # Public: a more efficient implementation of import for this adapter
+      def import(source_adapter)
+        get_all = source_adapter.get_all
+        @lock.with_write_lock { @source.replace(get_all) }
+      end
     end
   end
 end

data/lib/flipper/adapters/poll/poller.rb

@@ -1,125 +1,2 @@
-require 'logger'
-require 'concurrent/atomic/read_write_lock'
-require 'concurrent/utility/monotonic_time'
-require 'concurrent/map'
-
-module Flipper
-  module Adapters
-    class Poll
-      class Poller
-        attr_reader :thread, :pid, :mutex, :interval, :last_synced_at
-
-        def self.instances
-          @instances ||= Concurrent::Map.new
-        end
-        private_class_method :instances
-
-        def self.get(key, options = {})
-          instances.compute_if_absent(key) { new(options) }
-        end
-
-        def self.reset
-          instances.each {|_,poller| poller.stop }.clear
-        end
-
-        def initialize(options = {})
-          @thread = nil
-          @pid = Process.pid
-          @mutex = Mutex.new
-          @adapter = Memory.new
-          @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
-          @remote_adapter = options.fetch(:remote_adapter)
-          @interval = options.fetch(:interval, 10).to_f
-          @lock = Concurrent::ReadWriteLock.new
-          @last_synced_at = Concurrent::AtomicFixnum.new(0)
-
-          if @interval < 1
-            warn "Flipper::Cloud poll interval must be greater than or equal to 1 but was #{@interval}. Setting @interval to 1."
-            @interval = 1
-          end
-
-          @start_automatically = options.fetch(:start_automatically, true)
-
-          if options.fetch(:shutdown_automatically, true)
-            at_exit { stop }
-          end
-        end
-
-        def adapter
-          @lock.with_read_lock { Memory.new(@adapter.get_all.dup) }
-        end
-
-        def start
-          reset if forked?
-          ensure_worker_running
-        end
-
-        def stop
-          @instrumenter.instrument("poller.#{InstrumentationNamespace}", {
-            operation: :stop,
-          })
-          @thread&.kill
-        end
-
-        def run
-          loop do
-            sleep jitter
-            start = Concurrent.monotonic_time
-            begin
-              @instrumenter.instrument("poller.#{InstrumentationNamespace}", operation: :poll) do
-                adapter = Memory.new
-                adapter.import(@remote_adapter)
-
-                @lock.with_write_lock { @adapter.import(adapter) }
-                @last_synced_at.update { |time| Concurrent.monotonic_time }
-              end
-            rescue => exception
-              # you can instrument these using poller.flipper
-            end
-
-            sleep_interval = interval - (Concurrent.monotonic_time - start)
-            sleep sleep_interval if sleep_interval.positive?
-          end
-        end
-
-        private
-
-        def jitter
-          rand
-        end
-
-        def forked?
-          pid != Process.pid
-        end
-
-        def ensure_worker_running
-          # Return early if thread is alive and avoid the mutex lock and unlock.
-          return if thread_alive?
-
-          # If another thread is starting worker thread, then return early so this
-          # thread can enqueue and move on with life.
-          return unless mutex.try_lock
-
-          begin
-            return if thread_alive?
-            @thread = Thread.new { run }
-            @instrumenter.instrument("poller.#{InstrumentationNamespace}", {
-              operation: :thread_start,
-            })
-          ensure
-            mutex.unlock
-          end
-        end
-
-        def thread_alive?
-          @thread && @thread.alive?
-        end
-
-        def reset
-          @pid = Process.pid
-          mutex.unlock if mutex.locked?
-        end
-      end
-    end
-  end
-end
+warn "DEPRECATION WARNING: Flipper::Adapters::Poll::Poller is deprecated. Use Flipper::Poller instead."
+require 'flipper/adapters/poll'

data/lib/flipper/adapters/poll.rb

@@ -1,4 +1,5 @@
 require 'flipper/adapters/sync/synchronizer'
+require 'flipper/poller'
 
 module Flipper
   module Adapters
@@ -6,6 +7,9 @@ module Flipper
       extend Forwardable
       include ::Flipper::Adapter
 
+      # Deprecated
+      Poller = ::Flipper::Poller
+
       # Public: The name of the adapter.
       attr_reader :name, :adapter, :poller
 

data/lib/flipper/feature.rb

@@ -100,13 +100,12 @@ module Flipper
     #
     # Returns true if enabled, false if not.
     def enabled?(thing = nil)
-      instrument(:enabled?) do |payload|
-        values = gate_values
-        thing = gate(:actor).wrap(thing) unless thing.nil?
-        payload[:thing] = thing
+      thing = Types::Actor.wrap(thing) unless thing.nil?
+
+      instrument(:enabled?, thing: thing) do |payload|
         context = FeatureCheckContext.new(
           feature_name: @name,
-          values: values,
+          values: gate_values,
           thing: thing
         )
 
@@ -207,7 +206,7 @@ module Flipper
 
       if values.boolean || values.percentage_of_time == 100
         :on
-      elsif non_boolean_gates.detect { |gate| gate.enabled?(values[gate.key]) }
+      elsif non_boolean_gates.detect { |gate| gate.enabled?(values.send(gate.key)) }
         :conditional
       else
         :off
@@ -232,7 +231,8 @@ module Flipper
 
     # Public: Returns the raw gate values stored by the adapter.
     def gate_values
-      GateValues.new(adapter.get(self))
+      adapter_values = adapter.get(self)
+      GateValues.new(adapter_values)
     end
 
     # Public: Get groups enabled for this feature.
@@ -290,7 +290,7 @@ module Flipper
     # Returns an Array of Flipper::Gate instances.
     def enabled_gates
       values = gate_values
-      gates.select { |gate| gate.enabled?(values[gate.key]) }
+      gates.select { |gate| gate.enabled?(values.send(gate.key)) }
     end
 
     # Public: Get the names of the enabled gates.
@@ -339,20 +339,24 @@ module Flipper
     #
     # Returns an array of gates
     def gates
-      @gates ||= [
-        Gates::Boolean.new,
-        Gates::Actor.new,
-        Gates::PercentageOfActors.new,
-        Gates::PercentageOfTime.new,
-        Gates::Group.new,
-      ]
+      @gates ||= gates_hash.values.freeze
+    end
+
+    def gates_hash
+      @gates_hash ||= {
+        boolean: Gates::Boolean.new,
+        actor: Gates::Actor.new,
+        percentage_of_actors: Gates::PercentageOfActors.new,
+        percentage_of_time: Gates::PercentageOfTime.new,
+        group: Gates::Group.new,
+      }.freeze
     end
 
     # Public: Find a gate by name.
     #
     # Returns a Flipper::Gate if found, nil if not.
     def gate(name)
-      gates.detect { |gate| gate.name == name.to_sym }
+      gates_hash[name.to_sym]
     end
 
     # Public: Find the gate that protects a thing.
@@ -368,8 +372,8 @@ module Flipper
     private
 
     # Private: Instrument a feature operation.
-    def instrument(operation)
-      @instrumenter.instrument(InstrumentationName) do |payload|
+    def instrument(operation, initial_payload = {})
+      @instrumenter.instrument(InstrumentationName, initial_payload) do |payload|
         payload[:feature_name] = name
         payload[:operation] = operation
         payload[:result] = yield(payload) if block_given?

data/lib/flipper/feature_check_context.rb

@@ -10,10 +10,10 @@ module Flipper
     # Public: The thing we want to know if a feature is enabled for.
     attr_reader :thing
 
-    def initialize(options = {})
-      @feature_name = options.fetch(:feature_name)
-      @values = options.fetch(:values)
-      @thing = options.fetch(:thing)
+    def initialize(feature_name:, values:, thing:)
+      @feature_name = feature_name
+      @values = values
+      @thing = thing
     end
 
     # Public: Convenience method for groups value like Feature has.

data/lib/flipper/gate_values.rb

@@ -3,16 +3,6 @@ require 'flipper/typecast'
 
 module Flipper
   class GateValues
-    # Private: Array of instance variables that are readable through the []
-    # instance method.
-    LegitIvars = {
-      'boolean' => '@boolean',
-      'actors' => '@actors',
-      'groups' => '@groups',
-      'percentage_of_time' => '@percentage_of_time',
-      'percentage_of_actors' => '@percentage_of_actors',
-    }.freeze
-
     attr_reader :boolean
     attr_reader :actors
     attr_reader :groups
@@ -27,12 +17,6 @@ module Flipper
       @percentage_of_time = Typecast.to_percentage(adapter_values[:percentage_of_time])
     end
 
-    def [](key)
-      if ivar = LegitIvars[key.to_s]
-        instance_variable_get(ivar)
-      end
-    end
-
     def eql?(other)
       self.class.eql?(other.class) &&
         boolean == other.boolean &&

data/lib/flipper/gates/actor.rb

@@ -23,18 +23,8 @@ module Flipper
       #
       # Returns true if gate open for thing, false if not.
       def open?(context)
-        value = context.values[key]
-        if context.thing.nil?
-          false
-        else
-          if protects?(context.thing)
-            actor = wrap(context.thing)
-            enabled_actor_ids = value
-            enabled_actor_ids.include?(actor.value)
-          else
-            false
-          end
-        end
+        return false if context.thing.nil?
+        context.values.actors.include?(context.thing.value)
       end
 
       def wrap(thing)

data/lib/flipper/gates/boolean.rb

@@ -24,7 +24,7 @@ module Flipper
       # Returns true if explicitly set to true, false if explicitly set to false
       # or nil if not explicitly set.
       def open?(context)
-        context.values[key]
+        context.values.boolean
       end
 
       def wrap(thing)

data/lib/flipper/gates/group.rb

@@ -23,14 +23,10 @@ module Flipper
       #
       # Returns true if gate open for thing, false if not.
       def open?(context)
-        value = context.values[key]
-        if context.thing.nil?
-          false
-        else
-          value.any? do |name|
-            group = Flipper.group(name)
-            group.match?(context.thing, context)
-          end
+        return false if context.thing.nil?
+
+        context.values.groups.any? do |name|
+          Flipper.group(name).match?(context.thing, context)
         end
       end
 

data/lib/flipper/gates/percentage_of_actors.rb

@@ -21,21 +21,19 @@ module Flipper
         value > 0
       end
 
+      # Private: this constant is used to support up to 3 decimal places
+      # in percentages.
+      SCALING_FACTOR = 1_000
+      private_constant :SCALING_FACTOR
+
       # Internal: Checks if the gate is open for a thing.
       #
       # Returns true if gate open for thing, false if not.
       def open?(context)
-        percentage = context.values[key]
-
-        if Types::Actor.wrappable?(context.thing)
-          actor = Types::Actor.wrap(context.thing)
-          id = "#{context.feature_name}#{actor.value}"
-          # this is to support up to 3 decimal places in percentages
-          scaling_factor = 1_000
-          Zlib.crc32(id) % (100 * scaling_factor) < percentage * scaling_factor
-        else
-          false
-        end
+        return false if context.thing.nil?
+
+        id = "#{context.feature_name}#{context.thing.value}"
+        Zlib.crc32(id) % (100 * SCALING_FACTOR) < context.values.percentage_of_actors * SCALING_FACTOR
       end
 
       def protects?(thing)

data/lib/flipper/gates/percentage_of_time.rb

@@ -23,8 +23,7 @@ module Flipper
       #
       # Returns true if gate open for thing, false if not.
       def open?(context)
-        value = context.values[key]
-        rand < (value / 100.0)
+        rand < (context.values.percentage_of_time / 100.0)
       end
 
       def protects?(thing)

data/lib/flipper/poller.rb

@@ -0,0 +1,117 @@
+require 'logger'
+require 'concurrent/utility/monotonic_time'
+require 'concurrent/map'
+require 'concurrent/atomic/atomic_fixnum'
+
+module Flipper
+  class Poller
+    attr_reader :adapter, :thread, :pid, :mutex, :interval, :last_synced_at
+
+    def self.instances
+      @instances ||= Concurrent::Map.new
+    end
+    private_class_method :instances
+
+    def self.get(key, options = {})
+      instances.compute_if_absent(key) { new(options) }
+    end
+
+    def self.reset
+      instances.each {|_,poller| poller.stop }.clear
+    end
+
+    def initialize(options = {})
+      @thread = nil
+      @pid = Process.pid
+      @mutex = Mutex.new
+      @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+      @remote_adapter = options.fetch(:remote_adapter)
+      @interval = options.fetch(:interval, 10).to_f
+      @last_synced_at = Concurrent::AtomicFixnum.new(0)
+      @adapter = Adapters::Memory.new
+
+      if @interval < 1
+        warn "Flipper::Cloud poll interval must be greater than or equal to 1 but was #{@interval}. Setting @interval to 1."
+        @interval = 1
+      end
+
+      @start_automatically = options.fetch(:start_automatically, true)
+
+      if options.fetch(:shutdown_automatically, true)
+        at_exit { stop }
+      end
+    end
+
+    def start
+      reset if forked?
+      ensure_worker_running
+    end
+
+    def stop
+      @instrumenter.instrument("poller.#{InstrumentationNamespace}", {
+        operation: :stop,
+      })
+      @thread&.kill
+    end
+
+    def run
+      loop do
+        sleep jitter
+        start = Concurrent.monotonic_time
+        begin
+          sync
+        rescue => exception
+          # you can instrument these using poller.flipper
+        end
+
+        sleep_interval = interval - (Concurrent.monotonic_time - start)
+        sleep sleep_interval if sleep_interval.positive?
+      end
+    end
+
+    def sync
+      @instrumenter.instrument("poller.#{InstrumentationNamespace}", operation: :poll) do
+        @adapter.import @remote_adapter
+        @last_synced_at.update { |time| Concurrent.monotonic_time }
+      end
+    end
+
+    private
+
+    def jitter
+      rand
+    end
+
+    def forked?
+      pid != Process.pid
+    end
+
+    def ensure_worker_running
+      # Return early if thread is alive and avoid the mutex lock and unlock.
+      return if thread_alive?
+
+      # If another thread is starting worker thread, then return early so this
+      # thread can enqueue and move on with life.
+      return unless mutex.try_lock
+
+      begin
+        return if thread_alive?
+        @thread = Thread.new { run }
+        @instrumenter.instrument("poller.#{InstrumentationNamespace}", {
+          operation: :thread_start,
+        })
+      ensure
+        mutex.unlock
+      end
+    end
+
+    def thread_alive?
+      @thread && @thread.alive?
+    end
+
+    def reset
+      @pid = Process.pid
+      mutex.unlock if mutex.locked?
+    end
+  end
+end

data/lib/flipper/typecast.rb

@@ -21,11 +21,9 @@ module Flipper
     # Returns an Integer representation of the value.
     # Raises ArgumentError if conversion is not possible.
     def self.to_integer(value)
-      if value.respond_to?(:to_i)
-        value.to_i
-      else
-        raise ArgumentError, "#{value.inspect} cannot be converted to an integer"
-      end
+      value.to_i
+    rescue NoMethodError
+      raise ArgumentError, "#{value.inspect} cannot be converted to an integer"
     end
 
     # Internal: Convert value to a float.
@@ -33,11 +31,9 @@ module Flipper
     # Returns a Float representation of the value.
     # Raises ArgumentError if conversion is not possible.
     def self.to_float(value)
-      if value.respond_to?(:to_f)
-        value.to_f
-      else
-        raise ArgumentError, "#{value.inspect} cannot be converted to a float"
-      end
+      value.to_f
+    rescue NoMethodError
+      raise ArgumentError, "#{value.inspect} cannot be converted to a float"
     end
 
     # Internal: Convert value to a percentage.
@@ -45,11 +41,11 @@ module Flipper
     # Returns a Integer or Float representation of the value.
     # Raises ArgumentError if conversion is not possible.
     def self.to_percentage(value)
-      if value.to_s.include?('.'.freeze)
-        to_float(value)
-      else
-        to_integer(value)
-      end
+      result_to_f = value.to_f
+      result_to_i = result_to_f.to_i
+      result_to_f == result_to_i ? result_to_i : result_to_f
+    rescue NoMethodError
+      raise ArgumentError, "#{value.inspect} cannot be converted to a percentage"
     end
 
     # Internal: Convert value to a set.

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.26.0'.freeze
+  VERSION = '0.26.2'.freeze
 end

data/lib/flipper.rb

@@ -155,6 +155,7 @@ require 'flipper/instrumenters/noop'
 require 'flipper/identifier'
 require 'flipper/middleware/memoizer'
 require 'flipper/middleware/setup_env'
+require 'flipper/poller'
 require 'flipper/registry'
 require 'flipper/type'
 require 'flipper/types/actor'

data/spec/flipper/adapters/memory_spec.rb

@@ -14,7 +14,9 @@ RSpec.describe Flipper::Adapters::Memory do
     flipper.enable_actor :following, Flipper::Actor.new('3')
     flipper.enable_group :following, Flipper::Types::Group.new(:staff)
 
-    expect(source).to eq({
+    dup = described_class.new(subject.get_all)
+
+    expect(dup.get_all).to eq({
       "subscriptions" => subject.default_config.merge(boolean: "true"),
       "search" => subject.default_config,
       "logging" => subject.default_config.merge(:percentage_of_time => "30"),

data/spec/flipper/feature_check_context_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Flipper::FeatureCheckContext do
   end
 
   it 'initializes just fine' do
-    instance = described_class.new(options)
+    instance = described_class.new(**options)
     expect(instance.feature_name).to eq(feature_name)
     expect(instance.values).to eq(values)
     expect(instance.thing).to eq(thing)
@@ -20,46 +20,46 @@ RSpec.describe Flipper::FeatureCheckContext do
   it 'requires feature_name' do
     options.delete(:feature_name)
     expect do
-      described_class.new(options)
-    end.to raise_error(KeyError)
+      described_class.new(**options)
+    end.to raise_error(ArgumentError)
   end
 
   it 'requires values' do
     options.delete(:values)
     expect do
-      described_class.new(options)
-    end.to raise_error(KeyError)
+      described_class.new(**options)
+    end.to raise_error(ArgumentError)
   end
 
   it 'requires thing' do
     options.delete(:thing)
     expect do
-      described_class.new(options)
-    end.to raise_error(KeyError)
+      described_class.new(**options)
+    end.to raise_error(ArgumentError)
   end
 
   it 'knows actors_value' do
     args = options.merge(values: Flipper::GateValues.new(actors: Set['User;1']))
-    expect(described_class.new(args).actors_value).to eq(Set['User;1'])
+    expect(described_class.new(**args).actors_value).to eq(Set['User;1'])
   end
 
   it 'knows groups_value' do
     args = options.merge(values: Flipper::GateValues.new(groups: Set['admins']))
-    expect(described_class.new(args).groups_value).to eq(Set['admins'])
+    expect(described_class.new(**args).groups_value).to eq(Set['admins'])
   end
 
   it 'knows boolean_value' do
-    instance = described_class.new(options.merge(values: Flipper::GateValues.new(boolean: true)))
+    instance = described_class.new(**options.merge(values: Flipper::GateValues.new(boolean: true)))
     expect(instance.boolean_value).to eq(true)
   end
 
   it 'knows percentage_of_actors_value' do
     args = options.merge(values: Flipper::GateValues.new(percentage_of_actors: 14))
-    expect(described_class.new(args).percentage_of_actors_value).to eq(14)
+    expect(described_class.new(**args).percentage_of_actors_value).to eq(14)
   end
 
   it 'knows percentage_of_time_value' do
     args = options.merge(values: Flipper::GateValues.new(percentage_of_time: 41))
-    expect(described_class.new(args).percentage_of_time_value).to eq(41)
+    expect(described_class.new(**args).percentage_of_time_value).to eq(41)
   end
 end

data/spec/flipper/gate_values_spec.rb

@@ -80,13 +80,13 @@ RSpec.describe Flipper::GateValues do
   it 'raises argument error for percentage of time value that cannot be converted to an integer' do
     expect do
       described_class.new(percentage_of_time: ['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for percentage of actors value that cannot be converted to an int' do
     expect do
       described_class.new(percentage_of_actors: ['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for actors value that cannot be converted to a set' do
@@ -100,35 +100,4 @@ RSpec.describe Flipper::GateValues do
       described_class.new(groups: 'asdf')
     end.to raise_error(ArgumentError, %("asdf" cannot be converted to a set))
   end
-
-  describe '#[]' do
-    it 'can read the boolean value' do
-      expect(described_class.new(boolean: true)[:boolean]).to be(true)
-      expect(described_class.new(boolean: true)['boolean']).to be(true)
-    end
-
-    it 'can read the actors value' do
-      expect(described_class.new(actors: Set[1, 2])[:actors]).to eq(Set[1, 2])
-      expect(described_class.new(actors: Set[1, 2])['actors']).to eq(Set[1, 2])
-    end
-
-    it 'can read the groups value' do
-      expect(described_class.new(groups: Set[:admins])[:groups]).to eq(Set[:admins])
-      expect(described_class.new(groups: Set[:admins])['groups']).to eq(Set[:admins])
-    end
-
-    it 'can read the percentage of time value' do
-      expect(described_class.new(percentage_of_time: 15)[:percentage_of_time]).to eq(15)
-      expect(described_class.new(percentage_of_time: 15)['percentage_of_time']).to eq(15)
-    end
-
-    it 'can read the percentage of actors value' do
-      expect(described_class.new(percentage_of_actors: 15)[:percentage_of_actors]).to eq(15)
-      expect(described_class.new(percentage_of_actors: 15)['percentage_of_actors']).to eq(15)
-    end
-
-    it 'returns nil for value that is not present' do
-      expect(described_class.new({})['not legit']).to be(nil)
-    end
-  end
 end

data/spec/flipper/gates/percentage_of_actors_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Flipper::Gates::PercentageOfActors do
     Flipper::FeatureCheckContext.new(
       feature_name: feature,
       values: Flipper::GateValues.new(percentage_of_actors: percentage_of_actors_value),
-      thing: thing || Flipper::Types::Actor.new(Flipper::Actor.new(1))
+      thing: Flipper::Types::Actor.new(thing || Flipper::Actor.new(1))
     )
   end
 

data/spec/flipper/poller_spec.rb

@@ -0,0 +1,47 @@
+require "flipper/poller"
+
+RSpec.describe Flipper::Poller do
+  let(:remote_adapter) { Flipper::Adapters::Memory.new }
+  let(:remote) { Flipper.new(remote_adapter) }
+  let(:local) { Flipper.new(subject.adapter) }
+
+  subject do
+    described_class.new(
+      remote_adapter: remote_adapter,
+      start_automatically: false,
+      interval: Float::INFINITY
+    )
+  end
+
+  before do
+    allow(subject).to receive(:loop).and_yield # Make loop just call once
+    allow(subject).to receive(:sleep)          # Disable sleep
+    allow(Thread).to receive(:new).and_yield   # Disable separate thread
+  end
+
+  describe "#adapter" do
+    it "always returns same memory adapter instance" do
+      expect(subject.adapter).to be_a(Flipper::Adapters::Memory)
+      expect(subject.adapter.object_id).to eq(subject.adapter.object_id)
+    end
+  end
+
+  describe "#sync" do
+    it "syncs remote adapter to local adapter" do
+      remote.enable :polling
+
+      expect(local.enabled?(:polling)).to be(false)
+      subject.sync
+      expect(local.enabled?(:polling)).to be(true)
+    end
+  end
+
+  describe "#start" do
+    it "starts the poller thread" do
+      expect(Thread).to receive(:new).and_yield
+      expect(subject).to receive(:loop).and_yield
+      expect(subject).to receive(:sync)
+      subject.start
+    end
+  end
+end

data/spec/flipper/typecast_spec.rb

@@ -56,7 +56,7 @@ RSpec.describe Flipper::Typecast do
     nil => 0,
     '' => 0,
     0 => 0,
-    0.0 => 0.0,
+    0.0 => 0,
     1 => 1,
     1.1 => 1.1,
     '0.01' => 0.01,
@@ -100,13 +100,13 @@ RSpec.describe Flipper::Typecast do
   it 'raises argument error for bad integer percentage' do
     expect do
       described_class.to_percentage(['asdf'])
-    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to an integer))
+    end.to raise_error(ArgumentError, %(["asdf"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for bad float percentage' do
     expect do
       described_class.to_percentage(['asdf.0'])
-    end.to raise_error(ArgumentError, %(["asdf.0"] cannot be converted to a float))
+    end.to raise_error(ArgumentError, %(["asdf.0"] cannot be converted to a percentage))
   end
 
   it 'raises argument error for set value that cannot be converted to a set' do

data/spec/spec_helper.rb

@@ -22,7 +22,7 @@ Dir[FlipperRoot.join('spec/support/**/*.rb')].sort.each { |f| require f }
 
 RSpec.configure do |config|
   config.before(:example) do
-    Flipper::Adapters::Poll::Poller.reset if defined?(Flipper::Adapters::Poll::Poller)
+    Flipper::Poller.reset if defined?(Flipper::Poller)
     Flipper.unregister_groups
     Flipper.configuration = nil
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.26.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -35,7 +35,6 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/examples.yml"
-- ".github/workflows/release.yml"
 - ".rspec"
 - ".tool-versions"
 - CODE_OF_CONDUCT.md
@@ -45,6 +44,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- benchmark/enabled_ips.rb
+- benchmark/enabled_profile.rb
+- benchmark/instrumentation_ips.rb
+- benchmark/typecast_ips.rb
 - docker-compose.yml
 - docs/DockerCompose.md
 - docs/README.md
@@ -112,6 +115,7 @@ files:
 - lib/flipper/metadata.rb
 - lib/flipper/middleware/memoizer.rb
 - lib/flipper/middleware/setup_env.rb
+- lib/flipper/poller.rb
 - lib/flipper/railtie.rb
 - lib/flipper/registry.rb
 - lib/flipper/spec/shared_adapter_specs.rb
@@ -160,6 +164,7 @@ files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/poller_spec.rb
 - spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb
@@ -239,6 +244,7 @@ test_files:
 - spec/flipper/instrumenters/noop_spec.rb
 - spec/flipper/middleware/memoizer_spec.rb
 - spec/flipper/middleware/setup_env_spec.rb
+- spec/flipper/poller_spec.rb
 - spec/flipper/railtie_spec.rb
 - spec/flipper/registry_spec.rb
 - spec/flipper/typecast_spec.rb

data/.github/workflows/release.yml

@@ -1,44 +0,0 @@
-# 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@v3
-        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 }}