flipper 0.25.4 → 0.26.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a857af3f65cd468bfeeadab8c94c8ca5bf4c27cad345d93f05e5993a8f53a57d
-  data.tar.gz: dcbe82968b60be3a46b66e0f19ddf3416c8830bd63c3926fd6ca77b45e404e02
+  metadata.gz: 5b6c4a5c4ef29f126e9a08cc7fc7c70be9831b179dfc55486b88b8c5da5fdf44
+  data.tar.gz: aab15578901fcab2b3717813aa37d3cc057554eea3d442f264f85707d94310f9
 SHA512:
-  metadata.gz: '09914ec0d548868bf62ba0c3fe07cdaf4f773897d1416ec499c0a2f2355e6d38db96689c24d80a26b32ad2ecfbd6f380dd5da3e7cd44248c461826287252a487'
-  data.tar.gz: 4518fa261e1f265bdf1718e52606bf0b25b1e84fa0431bbe64359797f073dc3cbb1d075b9961bfc054bab19e32e1edbcd2bdce37eb2d988853684bbbcf43c621
+  metadata.gz: 79989c8d6149b13b6c960878d4ac701f98f5e3da9b44a567092a4ace82350ec8ccffcd7e9c9ea2619a2a2508b6a392e99c05b14ab14b59b5a0b3a58b4f211150
+  data.tar.gz: 5192a0b9e1bebc39a28503861ba4eb35a05010a1841595e1282437c7d0694e3eccd02f215fbc6928b228948c6a02c8e9d26f85a5e23ae271fd0b32bc84bf6b53

data/Changelog.md

@@ -1,3 +1,11 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## 0.26.0.rc1
+
+* Cloud Background Polling (https://github.com/jnunemaker/flipper/pull/682)
+
 ## 0.25.4
 
 * Added read_only UI config option (https://github.com/jnunemaker/flipper/pull/679)

data/flipper.gemspec

@@ -35,4 +35,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Flipper::VERSION
   gem.metadata      = Flipper::METADATA
+
+  gem.add_dependency 'concurrent-ruby', '< 2'
 end

data/lib/flipper/adapters/dual_write.rb

@@ -4,7 +4,7 @@ module Flipper
       include ::Flipper::Adapter
 
       # Public: The name of the adapter.
-      attr_reader :name
+      attr_reader :name, :local, :remote
 
       # Public: Build a new sync instance.
       #

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

@@ -14,6 +14,10 @@ module Flipper
 
         HTTPS_SCHEME = "https".freeze
 
+        attr_reader :uri, :headers
+        attr_reader :basic_auth_username, :basic_auth_password
+        attr_reader :read_timeout, :open_timeout, :write_timeout, :max_retries, :debug_output
+
         def initialize(options = {})
           @uri = URI(options.fetch(:url))
           @headers = DEFAULT_HEADERS.merge(options[:headers] || {})
@@ -22,6 +26,7 @@ module Flipper
           @read_timeout = options[:read_timeout]
           @open_timeout = options[:open_timeout]
           @write_timeout = options[:write_timeout]
+          @max_retries = options.key?(:max_retries) ? options[:max_retries] : 0
           @debug_output = options[:debug_output]
         end
 
@@ -58,7 +63,8 @@ module Flipper
           http = Net::HTTP.new(uri.host, uri.port)
           http.read_timeout = @read_timeout if @read_timeout
           http.open_timeout = @open_timeout if @open_timeout
-          apply_write_timeout(http)
+          http.max_retries = @max_retries if @max_retries
+          http.write_timeout = @write_timeout if @write_timeout
           http.set_debug_output(@debug_output) if @debug_output
 
           if uri.scheme == HTTPS_SCHEME
@@ -91,16 +97,6 @@ module Flipper
 
           request
         end
-
-        def apply_write_timeout(http)
-          if @write_timeout
-            if RUBY_VERSION >= '2.6.0'
-              http.write_timeout = @write_timeout
-            else
-              Kernel.warn("Warning: option :write_timeout requires Ruby version 2.6.0 or later")
-            end
-          end
-        end
       end
     end
   end

data/lib/flipper/adapters/http.rb

@@ -10,7 +10,7 @@ module Flipper
     class Http
       include Flipper::Adapter
 
-      attr_reader :name
+      attr_reader :name, :client
 
       def initialize(options = {})
         @client = Client.new(url: options.fetch(:url),
@@ -19,6 +19,8 @@ module Flipper
                              basic_auth_password: options[:basic_auth_password],
                              read_timeout: options[:read_timeout],
                              open_timeout: options[:open_timeout],
+                             write_timeout: options[:write_timeout],
+                             max_retries: options[:max_retries],
                              debug_output: options[:debug_output])
         @name = :http
       end

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

@@ -0,0 +1,123 @@
+require 'logger'
+require 'concurrent/atomic/read_write_lock'
+require 'concurrent/utility/monotonic_time'
+require 'concurrent/map'
+
+module Flipper
+  module Adapters
+    class Poll
+      class Poller
+        PREFIX = "[flipper http async poll adapter]".freeze
+
+        attr_reader :thread, :pid, :mutex, :logger, :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.clear
+        end
+
+        def initialize(options = {})
+          @thread = nil
+          @pid = Process.pid
+          @mutex = Mutex.new
+          @adapter = Memory.new
+          @remote_adapter = options.fetch(:remote_adapter)
+          @logger = options.fetch(:logger) { Logger.new(STDOUT) }
+          @interval = options.fetch(:interval, 10).to_f
+          @lock = Concurrent::ReadWriteLock.new
+          @last_synced_at = Concurrent::AtomicFixnum.new(0)
+
+          if @interval < 1
+            warn "#{PREFIX} 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
+          logger.debug { "#{PREFIX} Stopping worker" }
+          @thread&.kill
+        end
+
+        def run
+          loop do
+            sleep jitter
+            start = Concurrent.monotonic_time
+            begin
+              logger.debug { "#{PREFIX} Making a checkity checkity" }
+
+              adapter = Memory.new
+              adapter.import(@remote_adapter)
+
+              @lock.with_write_lock { @adapter.import(adapter) }
+              @last_synced_at.update { |time| Concurrent.monotonic_time }
+            rescue => exception
+              logger.debug { "#{PREFIX} Exception: #{exception.inspect}" }
+            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 }
+            logger.debug { "#{PREFIX} Worker thread [#{@thread.object_id}] started" }
+          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

data/lib/flipper/adapters/poll.rb

@@ -0,0 +1,35 @@
+require 'flipper/adapters/sync/synchronizer'
+
+module Flipper
+  module Adapters
+    class Poll
+      extend Forwardable
+      include ::Flipper::Adapter
+
+      # Public: The name of the adapter.
+      attr_reader :name, :adapter, :poller
+
+      def_delegators :synced_adapter, :features, :get, :get_multi, :get_all, :add, :remove, :clear, :enable, :disable
+
+      def initialize(poller, adapter)
+        @name = :poll
+        @adapter = adapter
+        @poller = poller
+        @last_synced_at = 0
+        @poller.start
+      end
+
+      private
+
+      def synced_adapter
+        @poller.start
+        poller_last_synced_at = @poller.last_synced_at.value
+        if poller_last_synced_at > @last_synced_at
+          Flipper::Adapters::Sync::Synchronizer.new(@adapter, @poller.adapter).call
+          @last_synced_at = poller_last_synced_at
+        end
+        @adapter
+      end
+    end
+  end
+end

data/lib/flipper/version.rb

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

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::Cloud::Registry.default.clear if defined?(Flipper::Cloud)
+    Flipper::Adapters::Poll::Poller.reset if defined?(Flipper::Adapters::Poll::Poller)
     Flipper.unregister_groups
     Flipper.configuration = nil
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.25.4
+  version: 0.26.0.rc1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
-dependencies: []
+date: 2022-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 description:
 email:
 - nunemaker@gmail.com
@@ -68,6 +82,8 @@ files:
 - lib/flipper/adapters/memoizable.rb
 - lib/flipper/adapters/memory.rb
 - lib/flipper/adapters/operation_logger.rb
+- lib/flipper/adapters/poll.rb
+- lib/flipper/adapters/poll/poller.rb
 - lib/flipper/adapters/pstore.rb
 - lib/flipper/adapters/read_only.rb
 - lib/flipper/adapters/sync.rb
@@ -179,9 +195,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.7
 signing_key: