flipper 1.3.2 → 1.4.1

data/lib/flipper/adapter.rb

@@ -31,7 +31,7 @@ module Flipper
     # Public: Get all features and gate values in one call. Defaults to one call
     # to features and another to get_multi. Feel free to override per adapter to
     # make this more efficient.
-    def get_all
+    def get_all(**kwargs)
       instances = features.map { |key| Flipper::Feature.new(key, self) }
       get_multi(instances)
     end
@@ -73,6 +73,22 @@ module Flipper
     def name
       @name ||= self.class.name.split('::').last.split(/(?=[A-Z])/).join('_').downcase.to_sym
     end
+
+    # Public: Returns a string representation of the adapter stack for debugging.
+    # Shows the full chain of wrapped adapters.
+    #
+    # Examples:
+    #   "memoizable -> active_support_cache_store -> active_record"
+    #   "memoizable -> failover(primary: redis, secondary: memory)"
+    #
+    # Returns a String.
+    def adapter_stack
+      if respond_to?(:adapter) && adapter
+        "#{name} -> #{adapter.adapter_stack}"
+      else
+        name.to_s
+      end
+    end
   end
 end
 

data/lib/flipper/adapters/actor_limit.rb

@@ -1,3 +1,5 @@
+require "flipper/adapters/wrapper"
+
 module Flipper
   module Adapters
     class ActorLimit < Wrapper
@@ -5,13 +7,37 @@ module Flipper
 
       attr_reader :limit
 
+      class << self
+        # Returns whether sync mode is enabled for the current thread.
+        # When sync mode is enabled, actor limits are not enforced,
+        # allowing sync operations to bring local state in line with
+        # remote state regardless of limits.
+        def sync_mode
+          Thread.current[:flipper_actor_limit_sync_mode]
+        end
+
+        def sync_mode=(value)
+          Thread.current[:flipper_actor_limit_sync_mode] = value
+        end
+
+        # Executes a block with sync mode enabled. Actor limits will
+        # not be enforced within the block.
+        def with_sync_mode
+          old_value = sync_mode
+          self.sync_mode = true
+          yield
+        ensure
+          self.sync_mode = old_value
+        end
+      end
+
       def initialize(adapter, limit = 100)
         super(adapter)
         @limit = limit
       end
 
       def enable(feature, gate, resource)
-        if gate.is_a?(Flipper::Gates::Actor) && over_limit?(feature)
+        if gate.is_a?(Flipper::Gates::Actor) && !self.class.sync_mode && over_limit?(feature)
           raise LimitExceeded, "Actor limit of #{@limit} exceeded for feature #{feature.key}. See https://www.flippercloud.io/docs/features/actors#limitations"
         else
           super

data/lib/flipper/adapters/cache_base.rb

@@ -17,6 +17,9 @@ module Flipper
       # Public: The cache key where the set of known features is cached.
       attr_reader :features_cache_key
 
+      # Public: The cache key where the set of all features with gates is cached.
+      attr_reader :get_all_cache_key
+
       # Public: Alias expires_in to ttl for compatibility.
       alias_method :expires_in, :ttl
 
@@ -29,16 +32,24 @@ module Flipper
         @namespace = "flipper/#{@cache_version}"
         @namespace = @namespace.prepend(prefix) if prefix
         @features_cache_key = "#{@namespace}/features"
+        @get_all_cache_key = "#{@namespace}/get_all"
+      end
+
+      # Public: Expire the cache for the set of all features with gates.
+      def expire_get_all_cache
+        cache_delete @get_all_cache_key
       end
 
       # Public: Expire the cache for the set of known feature names.
       def expire_features_cache
         cache_delete @features_cache_key
+        expire_get_all_cache
       end
 
       # Public: Expire the cache for a given feature.
       def expire_feature_cache(key)
         cache_delete feature_cache_key(key)
+        expire_get_all_cache
       end
 
       # Public
@@ -79,9 +90,12 @@ module Flipper
       end
 
       # Public
-      def get_all
-        features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
-        read_many_features(features)
+      def get_all(**kwargs)
+        cache_fetch(@get_all_cache_key) {
+          result = read_all_features(**kwargs)
+          cache_write @features_cache_key, result.keys.to_set
+          result
+        }
       end
 
       # Public
@@ -107,6 +121,10 @@ module Flipper
 
       private
 
+      def read_all_features(**kwargs)
+        @adapter.get_all(**kwargs)
+      end
+
       # Private: Returns the Set of known feature keys.
       def read_feature_keys
         cache_fetch(@features_cache_key) { @adapter.features }

data/lib/flipper/adapters/dual_write.rb

@@ -15,6 +15,10 @@ module Flipper
         @remote = remote
       end
 
+      def adapter_stack
+        "#{name}(local: #{@local.adapter_stack}, remote: #{@remote.adapter_stack})"
+      end
+
       def features
         @local.features
       end
@@ -27,8 +31,8 @@ module Flipper
         @local.get_multi(features)
       end
 
-      def get_all
-        @local.get_all
+      def get_all(**kwargs)
+        @local.get_all(**kwargs)
       end
 
       def add(feature)

data/lib/flipper/adapters/failover.rb

@@ -13,6 +13,8 @@ module Flipper
       #                           primary is updated
       #             :errors - Array of exception types for which to failover
 
+      attr_reader :primary, :secondary
+
       def initialize(primary, secondary, options = {})
         @primary = primary
         @secondary = secondary
@@ -21,6 +23,10 @@ module Flipper
         @errors = options.fetch(:errors, [ StandardError ])
       end
 
+      def adapter_stack
+        "#{name}(primary: #{@primary.adapter_stack}, secondary: #{@secondary.adapter_stack})"
+      end
+
       def features
         @primary.features
       rescue *@errors
@@ -39,10 +45,10 @@ module Flipper
         @secondary.get_multi(features)
       end
 
-      def get_all
-        @primary.get_all
+      def get_all(**kwargs)
+        @primary.get_all(**kwargs)
       rescue *@errors
-        @secondary.get_all
+        @secondary.get_all(**kwargs)
       end
 
       def add(feature)

data/lib/flipper/adapters/failsafe.rb

@@ -50,8 +50,8 @@ module Flipper
         {}
       end
 
-      def get_all
-        @adapter.get_all
+      def get_all(**kwargs)
+        @adapter.get_all(**kwargs)
       rescue *@errors
         {}
       end

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

@@ -45,12 +45,19 @@ module Flipper
         end
 
         def add_header(key, value)
-          key = key.to_s.downcase.gsub('_'.freeze, '-'.freeze).freeze
-          @headers[key] = value
+          @headers[normalize_header_key(key)] = value
         end
 
-        def get(path)
-          perform Net::HTTP::Get, path, @headers
+        def get(path, options = {})
+          headers = @headers.dup
+
+          if options[:headers]
+            options[:headers].each do |key, value|
+              headers[normalize_header_key(key)] = value
+            end
+          end
+
+          perform Net::HTTP::Get, path, headers
         end
 
         def post(path, body = nil)
@@ -125,6 +132,10 @@ module Flipper
         def client_frameworks
           CLIENT_FRAMEWORKS.transform_values { |detect| detect.call rescue nil }.compact
         end
+
+        def normalize_header_key(key)
+          key.to_s.downcase.gsub('_'.freeze, '-'.freeze)
+        end
       end
     end
   end

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

@@ -20,7 +20,7 @@ module Flipper
             if more_info = data["more_info"]
               message << "\n#{data["more_info"]}"
             end
-          rescue => exception
+          rescue
             # welp we tried
           end
 

data/lib/flipper/adapters/http.rb

@@ -22,6 +22,10 @@ module Flipper
                              write_timeout: options[:write_timeout],
                              max_retries: options[:max_retries],
                              debug_output: options[:debug_output])
+        @last_get_all_etag = nil
+        @last_get_all_result = nil
+        @last_get_all_response = nil
+        @get_all_mutex = Mutex.new
       end
 
       def get(feature)
@@ -55,12 +59,33 @@ module Flipper
         result
       end
 
-      def get_all
-        response = @client.get("/features?exclude_gate_names=true")
+      def get_all(cache_bust: false)
+        options = {}
+        path = "/features?exclude_gate_names=true"
+        path += "&_cb=#{Time.now.to_i}" if cache_bust
+        etag = @get_all_mutex.synchronize { @last_get_all_etag }
+
+        if etag && !cache_bust
+          options[:headers] = { if_none_match: etag }
+        end
+
+        response = @client.get(path, options)
+        @get_all_mutex.synchronize { @last_get_all_response = response }
+
+        if response.is_a?(Net::HTTPNotModified)
+          cached_result = @get_all_mutex.synchronize { @last_get_all_result }
+
+          if cached_result
+            return cached_result
+          else
+            raise Error, response
+          end
+        end
+
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
-        parsed_response = Typecast.from_json(response.body)
-        parsed_features = parsed_response.fetch('features')
+        parsed_response = response.body.empty? ? {} : Typecast.from_json(response.body)
+        parsed_features = parsed_response['features'] || []
         gates_by_key = parsed_features.each_with_object({}) do |parsed_feature, hash|
           hash[parsed_feature['key']] = parsed_feature['gates']
           hash
@@ -71,9 +96,19 @@ module Flipper
           feature = Feature.new(key, self)
           result[feature.key] = result_for_feature(feature, gates_by_key[feature.key])
         end
+
+        @get_all_mutex.synchronize do
+          @last_get_all_etag = response['etag'] if response['etag']
+          @last_get_all_result = result
+        end
+
         result
       end
 
+      def last_get_all_response
+        @get_all_mutex.synchronize { @last_get_all_response }
+      end
+
       def features
         response = @client.get('/features?exclude_gate_names=true')
         raise Error, response unless response.is_a?(Net::HTTPOK)

data/lib/flipper/adapters/instrumented.rb

@@ -101,14 +101,14 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         default_payload = {
           operation: :get_all,
           adapter_name: @adapter.name,
         }
 
         @instrumenter.instrument(InstrumentationName, default_payload) do |payload|
-          payload[:result] = @adapter.get_all
+          payload[:result] = @adapter.get_all(**kwargs)
         end
       end
 

data/lib/flipper/adapters/memoizable.rb

@@ -81,7 +81,7 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         if memoizing?
           response = nil
           if cache[@get_all_key]
@@ -90,7 +90,7 @@ module Flipper
               response[key] = cache[key_for(key)]
             end
           else
-            response = @adapter.get_all
+            response = @adapter.get_all(**kwargs)
             response.each do |key, value|
               cache[key_for(key)] = value
             end
@@ -103,7 +103,7 @@ module Flipper
           response.default_proc = ->(memo, key) { memo[key] = default_config }
           response
         else
-          @adapter.get_all
+          @adapter.get_all(**kwargs)
         end
       end
 

data/lib/flipper/adapters/memory.rb

@@ -54,7 +54,7 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         synchronize { Typecast.features_hash(@source) }
       end
 

data/lib/flipper/adapters/poll.rb

@@ -18,6 +18,21 @@ module Flipper
         @adapter = adapter
         @poller = poller
         @last_synced_at = 0
+
+        # If the adapter is empty, we need to sync before starting the poller.
+        # Yes, this will block the main thread, but that's better than thinking
+        # nothing is enabled.
+        if adapter.features.empty?
+          begin
+            @poller.sync
+          rescue
+            # TODO: Warn here that it's possible that no data has been synced
+            # and flags are being evaluated without flag data being present
+            # until a sync completes. We rescue to avoid flipper being down
+            # causing your processes to crash.
+          end
+        end
+
         @poller.start
       end
 

data/lib/flipper/adapters/pstore.rb

@@ -66,7 +66,7 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         @store.transaction do
           features = read_feature_keys.map { |key| Flipper::Feature.new(key, self) }
           read_many_features(features)

data/lib/flipper/adapters/strict.rb

@@ -10,11 +10,40 @@ module Flipper
         end
       end
 
+      class << self
+        # Returns whether sync mode is enabled for the current thread.
+        # When sync mode is enabled, strict checks are not enforced,
+        # allowing sync operations to add features and bring local state
+        # in line with remote state.
+        def sync_mode
+          Thread.current[:flipper_strict_sync_mode]
+        end
+
+        def sync_mode=(value)
+          Thread.current[:flipper_strict_sync_mode] = value
+        end
+
+        # Executes a block with sync mode enabled. Strict checks will
+        # not be enforced within the block.
+        def with_sync_mode
+          old_value = sync_mode
+          self.sync_mode = true
+          yield
+        ensure
+          self.sync_mode = old_value
+        end
+      end
+
       def initialize(adapter, handler = nil, &block)
         super(adapter)
         @handler = block || handler
       end
 
+      def add(feature)
+        assert_feature_exists(feature) unless self.class.sync_mode
+        super
+      end
+
       def get(feature)
         assert_feature_exists(feature)
         super
@@ -28,6 +57,7 @@ module Flipper
       private
 
       def assert_feature_exists(feature)
+        return if self.class.sync_mode
         return if @adapter.features.include?(feature.key)
 
         case handler

data/lib/flipper/adapters/sync/feature_synchronizer.rb

@@ -55,7 +55,11 @@ module Flipper
         def sync_expression
           return if local_expression == remote_expression
 
-          @feature.enable_expression remote_expression
+          if remote_expression.nil?
+            @feature.disable_expression
+          else
+            @feature.enable_expression remote_expression
+          end
         end
 
         def sync_actors

data/lib/flipper/adapters/sync/synchronizer.rb

@@ -1,5 +1,7 @@
 require "flipper/feature"
 require "flipper/gate_values"
+require "flipper/adapters/actor_limit"
+require "flipper/adapters/strict"
 require "flipper/adapters/sync/feature_synchronizer"
 
 module Flipper
@@ -16,27 +18,33 @@ module Flipper
         # options - The Hash of options.
         #           :instrumenter - The instrumenter used to instrument.
         #           :raise - Should errors be raised (default: true).
+        #           :cache_bust - Should cache busting be used for remote get_all (default: false).
         def initialize(local, remote, options = {})
           @local = local
           @remote = remote
           @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
           @raise = options.fetch(:raise, true)
+          @cache_bust = options.fetch(:cache_bust, false)
         end
 
         # Public: Forces a sync.
         def call
-          @instrumenter.instrument("synchronizer_call.flipper") { sync }
+          @instrumenter.instrument("synchronizer_call.flipper") do
+            Flipper::Adapters::Strict.with_sync_mode do
+              Flipper::Adapters::ActorLimit.with_sync_mode { sync }
+            end
+          end
         end
 
         private
 
         def sync
           local_get_all = @local.get_all
-          remote_get_all = @remote.get_all
+          remote_get_all = @remote.get_all(cache_bust: @cache_bust)
 
           # Sync all the gate values.
           remote_get_all.each do |feature_key, remote_gates_hash|
-            feature = Feature.new(feature_key, @local)
+            feature = Feature.new(feature_key, @local, instrumenter: @instrumenter)
             # 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)
@@ -46,11 +54,11 @@ module Flipper
 
           # Add features that are missing in local and present in remote.
           features_to_add = remote_get_all.keys - local_get_all.keys
-          features_to_add.each { |key| Feature.new(key, @local).add }
+          features_to_add.each { |key| Feature.new(key, @local, instrumenter: @instrumenter).add }
 
           # Remove features that are present in local and missing in remote.
           features_to_remove = local_get_all.keys - remote_get_all.keys
-          features_to_remove.each { |key| Feature.new(key, @local).remove }
+          features_to_remove.each { |key| Feature.new(key, @local, instrumenter: @instrumenter).remove }
 
           nil
         rescue => exception

data/lib/flipper/adapters/sync.rb

@@ -9,7 +9,7 @@ module Flipper
       include ::Flipper::Adapter
 
       # Public: The synchronizer that will keep the local and remote in sync.
-      attr_reader :synchronizer
+      attr_reader :synchronizer, :local, :remote
 
       # Public: Build a new sync instance.
       #
@@ -33,6 +33,10 @@ module Flipper
         synchronize
       end
 
+      def adapter_stack
+        "#{name}(local: #{@local.adapter_stack}, remote: #{@remote.adapter_stack})"
+      end
+
       def features
         synchronize
         @local.features
@@ -48,9 +52,9 @@ module Flipper
         @local.get_multi(features)
       end
 
-      def get_all
+      def get_all(**kwargs)
         synchronize
-        @local.get_all
+        @local.get_all(**kwargs)
       end
 
       def add(feature)

data/lib/flipper/cli.rb

@@ -84,6 +84,57 @@ module Flipper
         end
       end
 
+      command 'export' do |c|
+        c.description = "Export features as JSON"
+        c.action do
+          export = Flipper.export(format: :json, version: 1)
+          ui.info export.contents
+        end
+      end
+
+      command 'cloud' do |c|
+        c.description = "Flipper Cloud commands"
+        c.action do |subcommand = nil, *args|
+          require 'flipper/cloud/migrate'
+
+          case subcommand
+          when 'migrate'
+            result = Flipper::Cloud.migrate(Flipper)
+            if result.url
+              ui.info "Migrating to Flipper Cloud..."
+              ui.info result.url
+              system("open", result.url)
+            else
+              message = "Migration failed (HTTP #{result.code})"
+              message << ": #{result.message}" if result.message
+              ui.error message
+              exit 1
+            end
+          when 'push'
+            token = args.first
+            unless token
+              ui.error "Usage: flipper cloud push <token>"
+              exit 1
+            end
+            result = Flipper::Cloud.push(token, Flipper)
+            if result.code == 204
+              ui.info "Successfully pushed features to Flipper Cloud"
+            else
+              message = "Push failed (HTTP #{result.code})"
+              message << ": #{result.message}" if result.message
+              ui.error message
+              exit 1
+            end
+          else
+            ui.info "Usage: flipper cloud <command>"
+            ui.info ""
+            ui.info "Commands:"
+            ui.info "  migrate  Migrate features to a new Flipper Cloud account"
+            ui.info "  push     Push features to an existing Flipper Cloud project"
+          end
+        end
+      end
+
       command 'help' do |c|
         c.load_environment = false
         c.action do |command = nil|

data/lib/flipper/cloud/configuration.rb

@@ -3,7 +3,6 @@ require "socket"
 require "flipper/adapters/http"
 require "flipper/adapters/poll"
 require "flipper/poller"
-require "flipper/adapters/memory"
 require "flipper/adapters/dual_write"
 require "flipper/adapters/sync/synchronizer"
 require "flipper/cloud/telemetry"
@@ -111,9 +110,10 @@ module Flipper
       end
 
       # Public: Force a sync.
-      def sync
+      def sync(cache_bust: false)
         Flipper::Adapters::Sync::Synchronizer.new(local_adapter, http_adapter, {
           instrumenter: instrumenter,
+          cache_bust: cache_bust,
         }).call
       end
 
@@ -135,11 +135,14 @@ module Flipper
         logger.send(level, "name=flipper_cloud #{message}")
       end
 
+      def instrument(name, payload = {}, &block)
+        instrumenter.instrument(name, payload, &block)
+      end
+
       private
 
       def app_adapter
-        read_adapter = sync_method == :webhook ? local_adapter : poll_adapter
-        Flipper::Adapters::DualWrite.new(read_adapter, http_adapter)
+        Flipper::Adapters::DualWrite.new(poll_adapter, http_adapter)
       end
 
       def poller
@@ -198,8 +201,13 @@ module Flipper
       end
 
       def setup_sync(options)
-        set_option :sync_interval, options, default: 10, typecast: :float, minimum: 10
         set_option :sync_secret, options
+
+        # 1 hour for webhook, 10 seconds for poll. If using webhooks we don't
+        # need to sync as often but we should still sync occasionally to avoid
+        # any chance of stale data.
+        default_interval = sync_method == :webhook ? 3600 : 10
+        set_option :sync_interval, options, default: default_interval, typecast: :float, minimum: 10
       end
 
       def setup_adapter(options)
@@ -242,7 +250,7 @@ module Flipper
         if required
           option_value = send(name)
           if option_value.nil? || option_value.empty?
-            message = "Flipper::Cloud #{name} is missing. Please "
+            message = String.new("Flipper::Cloud #{name} is missing. Please ")
             message << "set #{env_var} or " if from_env
             message << "provide #{name} (e.g. Flipper::Cloud.new(#{name}: value))."
             raise ArgumentError, message