flipper 0.28.3 → 1.4.2

data/lib/flipper/adapters/failover.rb

@@ -3,9 +3,6 @@ module Flipper
     class Failover
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: Build a new failover instance.
       #
       # primary   - The primary flipper adapter.
@@ -16,8 +13,9 @@ module Flipper
       #                           primary is updated
       #             :errors - Array of exception types for which to failover
 
+      attr_reader :primary, :secondary
+
       def initialize(primary, secondary, options = {})
-        @name = :failover
         @primary = primary
         @secondary = secondary
 
@@ -25,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
@@ -43,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

@@ -3,9 +3,6 @@ module Flipper
     class Failsafe
       include ::Flipper::Adapter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public: Build a new Failsafe instance.
       #
       # adapter   - Flipper adapter to guard.
@@ -15,7 +12,6 @@ module Flipper
       def initialize(adapter, options = {})
         @adapter = adapter
         @errors = options.fetch(:errors, [StandardError])
-        @name = :failsafe
       end
 
       def features
@@ -54,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

@@ -7,20 +7,28 @@ module Flipper
     class Http
       class Client
         DEFAULT_HEADERS = {
-          'Content-Type' => 'application/json',
-          'Accept' => 'application/json',
-          'User-Agent' => "Flipper HTTP Adapter v#{VERSION}",
+          'content-type' => 'application/json',
+          'accept' => 'application/json',
+          'user-agent' => "Flipper HTTP Adapter v#{VERSION}",
         }.freeze
 
         HTTPS_SCHEME = "https".freeze
 
+        CLIENT_FRAMEWORKS = {
+          rails:    -> { Rails.version if defined?(Rails) },
+          sinatra:  -> { Sinatra::VERSION if defined?(Sinatra) },
+          hanami:   -> { Hanami::VERSION if defined?(Hanami) },
+          sidekiq:  -> { Sidekiq::VERSION if defined?(Sidekiq) },
+          good_job: -> { GoodJob::VERSION if defined?(GoodJob) },
+        }
+
         attr_reader :uri, :headers
         attr_reader :basic_auth_username, :basic_auth_password
-        attr_reader :read_timeout, :open_timeout, :write_timeout, :max_retries, :debug_output
+        attr_reader :read_timeout, :open_timeout, :write_timeout
+        attr_reader :max_retries, :debug_output
 
         def initialize(options = {})
           @uri = URI(options.fetch(:url))
-          @headers = DEFAULT_HEADERS.merge(options[:headers] || {})
           @basic_auth_username = options[:basic_auth_username]
           @basic_auth_password = options[:basic_auth_password]
           @read_timeout = options[:read_timeout]
@@ -28,10 +36,28 @@ module Flipper
           @write_timeout = options[:write_timeout]
           @max_retries = options.key?(:max_retries) ? options[:max_retries] : 0
           @debug_output = options[:debug_output]
+
+          @headers = {}
+          DEFAULT_HEADERS.each { |key, value| add_header key, value }
+          if options[:headers]
+            options[:headers].each { |key, value| add_header key, value }
+          end
+        end
+
+        def add_header(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)
@@ -77,18 +103,23 @@ module Flipper
 
         def build_request(http_method, uri, headers, options)
           request_headers = {
-            "Client-Language" => "ruby",
-            "Client-Language-Version" => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
-            "Client-Platform" => RUBY_PLATFORM,
-            "Client-Engine" => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
-            "Client-Pid" => Process.pid.to_s,
-            "Client-Thread" => Thread.current.object_id.to_s,
-            "Client-Hostname" => Socket.gethostname,
+            'client-language' => "ruby",
+            'client-language-version' => "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})",
+            'client-platform' => RUBY_PLATFORM,
+            'client-engine' => defined?(RUBY_ENGINE) ? RUBY_ENGINE : "",
+            'client-pid' => Process.pid.to_s,
+            'client-thread' => Thread.current.object_id.to_s,
+            'client-hostname' => Socket.gethostname,
           }.merge(headers)
 
           body = options[:body]
           request = http_method.new(uri.request_uri)
           request.initialize_http_header(request_headers)
+
+          client_frameworks.each do |framework, version|
+            request.add_field("client-framework", [framework, version].join("="))
+          end
+
           request.body = body if body
 
           if @basic_auth_username && @basic_auth_password
@@ -97,6 +128,14 @@ module Flipper
 
           request
         end
+
+        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

@@ -11,7 +11,7 @@ module Flipper
           message = "Failed with status: #{response.code}"
 
           begin
-            data = JSON.parse(response.body)
+            data = Typecast.from_json(response.body)
 
             if error_message = data["message"]
               message << "\n\n#{data["message"]}"
@@ -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

@@ -10,7 +10,7 @@ module Flipper
     class Http
       include Flipper::Adapter
 
-      attr_reader :name, :client
+      attr_reader :client
 
       def initialize(options = {})
         @client = Client.new(url: options.fetch(:url),
@@ -22,13 +22,16 @@ module Flipper
                              write_timeout: options[:write_timeout],
                              max_retries: options[:max_retries],
                              debug_output: options[:debug_output])
-        @name = :http
+        @last_get_all_etag = nil
+        @last_get_all_result = nil
+        @last_get_all_response = nil
+        @get_all_mutex = Mutex.new
       end
 
       def get(feature)
         response = @client.get("/features/#{feature.key}")
         if response.is_a?(Net::HTTPOK)
-          parsed_response = JSON.parse(response.body)
+          parsed_response = Typecast.from_json(response.body)
           result_for_feature(feature, parsed_response.fetch('gates'))
         elsif response.is_a?(Net::HTTPNotFound)
           default_config
@@ -42,7 +45,7 @@ module Flipper
         response = @client.get("/features?keys=#{csv_keys}&exclude_gate_names=true")
         raise Error, response unless response.is_a?(Net::HTTPOK)
 
-        parsed_response = JSON.parse(response.body)
+        parsed_response = Typecast.from_json(response.body)
         parsed_features = parsed_response.fetch('features')
         gates_by_key = parsed_features.each_with_object({}) do |parsed_feature, hash|
           hash[parsed_feature['key']] = parsed_feature['gates']
@@ -56,30 +59,61 @@ 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 = JSON.parse(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
         end
 
         result = {}
-        gates_by_key.keys.each do |key|
+        gates_by_key.each_key do |key|
           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)
 
-        parsed_response = JSON.parse(response.body)
+        parsed_response = Typecast.from_json(response.body)
         parsed_response['features'].map { |feature| feature['key'] }.to_set
       end
 
@@ -97,7 +131,7 @@ module Flipper
       end
 
       def enable(feature, gate, thing)
-        body = request_body_for_gate(gate, thing.value.to_s)
+        body = request_body_for_gate(gate, thing.value)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = @client.post("/features/#{feature.key}/#{gate.key}#{query_string}", body)
         raise Error, response unless response.is_a?(Net::HTTPOK)
@@ -105,7 +139,7 @@ module Flipper
       end
 
       def disable(feature, gate, thing)
-        body = request_body_for_gate(gate, thing.value.to_s)
+        body = request_body_for_gate(gate, thing.value)
         query_string = gate.key == :groups ? "?allow_unregistered_groups=true" : ""
         response = case gate.key
         when :percentage_of_actors, :percentage_of_time
@@ -138,11 +172,13 @@ module Flipper
         when :boolean
           {}
         when :groups
-          { name: value }
+          { name: value.to_s }
         when :actors
-          { flipper_id: value }
+          { flipper_id: value.to_s }
         when :percentage_of_actors, :percentage_of_time
-          { percentage: value }
+          { percentage: value.to_s }
+        when :expression
+          value
         else
           raise "#{gate.key} is not a valid flipper gate key"
         end
@@ -166,13 +202,17 @@ module Flipper
         case gate.data_type
         when :boolean, :integer
           value ? value.to_s : value
+        when :json
+          value
         when :set
           value ? value.to_set : Set.new
         else
-          unsupported_data_type(gate.data_type)
+          unsupported_data_type gate.data_type
         end
       end
 
+      private
+
       def unsupported_data_type(data_type)
         raise "#{data_type} is not supported by this adapter"
       end

data/lib/flipper/adapters/instrumented.rb

@@ -13,9 +13,6 @@ module Flipper
       # Private: What is used to instrument all the things.
       attr_reader :instrumenter
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Internal: Initializes a new adapter instance.
       #
       # adapter - Vanilla adapter instance to wrap.
@@ -25,7 +22,6 @@ module Flipper
       #
       def initialize(adapter, options = {})
         @adapter = adapter
-        @name = :instrumented
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
       end
 
@@ -105,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

@@ -8,35 +8,25 @@ module Flipper
     class Memoizable
       include ::Flipper::Adapter
 
-      FeaturesKey = :flipper_features
-      GetAllKey = :all_memoized
-
       # Internal
       attr_reader :cache
 
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Internal: The adapter this adapter is wrapping.
       attr_reader :adapter
 
-      # Private
-      def self.key_for(key)
-        "feature/#{key}"
-      end
-
       # Public
       def initialize(adapter, cache = nil)
         @adapter = adapter
-        @name = :memoizable
         @cache = cache || {}
         @memoize = false
+        @features_key = :flipper_features
+        @get_all_key = :all_memoized
       end
 
       # Public
       def features
         if memoizing?
-          cache.fetch(FeaturesKey) { cache[FeaturesKey] = @adapter.features }
+          cache.fetch(@features_key) { cache[@features_key] = @adapter.features }
         else
           @adapter.features
         end
@@ -91,21 +81,21 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         if memoizing?
           response = nil
-          if cache[GetAllKey]
+          if cache[@get_all_key]
             response = {}
-            cache[FeaturesKey].each do |key|
+            cache[@features_key].each do |key|
               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
-            cache[FeaturesKey] = response.keys.to_set
-            cache[GetAllKey] = true
+            cache[@features_key] = response.keys.to_set
+            cache[@get_all_key] = true
           end
 
           # Ensures that looking up other features that do not exist doesn't
@@ -113,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
 
@@ -127,6 +117,11 @@ module Flipper
         @adapter.disable(feature, gate, thing).tap { expire_feature(feature) }
       end
 
+      # Public
+      def read_only?
+        @adapter.read_only?
+      end
+
       def import(source)
         @adapter.import(source).tap { cache.clear if memoizing? }
       end
@@ -161,7 +156,7 @@ module Flipper
       private
 
       def key_for(key)
-        self.class.key_for(key)
+        "feature/#{key}"
       end
 
       def expire_feature(feature)
@@ -169,7 +164,7 @@ module Flipper
       end
 
       def expire_features_set
-        cache.delete(FeaturesKey) if memoizing?
+        cache.delete(@features_key) if memoizing?
       end
     end
   end

data/lib/flipper/adapters/memory.rb

@@ -8,15 +8,9 @@ module Flipper
     class Memory
       include ::Flipper::Adapter
 
-      FeaturesKey = :features
-
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public
       def initialize(source = nil, threadsafe: true)
         @source = Typecast.features_hash(source)
-        @name = :memory
         @lock = Mutex.new if threadsafe
         reset
       end
@@ -60,7 +54,7 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         synchronize { Typecast.features_hash(@source) }
       end
 
@@ -77,6 +71,8 @@ module Flipper
             @source[feature.key][gate.key] = thing.value.to_s
           when :set
             @source[feature.key][gate.key] << thing.value.to_s
+          when :json
+            @source[feature.key][gate.key] = thing.value
           else
             raise "#{gate} is not supported by this adapter yet"
           end
@@ -97,6 +93,8 @@ module Flipper
             @source[feature.key][gate.key] = thing.value.to_s
           when :set
             @source[feature.key][gate.key].delete thing.value.to_s
+          when :json
+            @source[feature.key].delete(gate.key)
           else
             raise "#{gate} is not supported by this adapter yet"
           end

data/lib/flipper/adapters/operation_logger.rb

@@ -5,115 +5,34 @@ module Flipper
     # Public: Adapter that wraps another adapter and stores the operations.
     #
     # Useful in tests to verify calls and such. Never use outside of testing.
-    class OperationLogger
-      include Flipper::Adapter
+    class OperationLogger < Wrapper
 
       class Operation
-        attr_reader :type, :args
+        attr_reader :type, :args, :kwargs
 
-        def initialize(type, args)
+        def initialize(type, args, kwargs = {})
           @type = type
           @args = args
+          @kwargs = kwargs
         end
       end
 
-      OperationTypes = [
-        :import,
-        :export,
-        :features,
-        :add,
-        :remove,
-        :clear,
-        :get,
-        :get_multi,
-        :get_all,
-        :enable,
-        :disable,
-      ].freeze
-
       # Internal: An array of the operations that have happened.
       attr_reader :operations
 
-      # Internal: The name of the adapter.
-      attr_reader :name
-
       # Public
       def initialize(adapter, operations = nil)
-        @adapter = adapter
-        @name = :operation_logger
+        super(adapter)
         @operations = operations || []
       end
 
-      # Public: The set of known features.
-      def features
-        @operations << Operation.new(:features, [])
-        @adapter.features
-      end
-
-      # Public: Adds a feature to the set of known features.
-      def add(feature)
-        @operations << Operation.new(:add, [feature])
-        @adapter.add(feature)
-      end
-
-      # Public: Removes a feature from the set of known features and clears
-      # all the values for the feature.
-      def remove(feature)
-        @operations << Operation.new(:remove, [feature])
-        @adapter.remove(feature)
-      end
-
-      # Public: Clears all the gate values for a feature.
-      def clear(feature)
-        @operations << Operation.new(:clear, [feature])
-        @adapter.clear(feature)
-      end
-
-      # Public
-      def get(feature)
-        @operations << Operation.new(:get, [feature])
-        @adapter.get(feature)
-      end
-
-      # Public
-      def get_multi(features)
-        @operations << Operation.new(:get_multi, [features])
-        @adapter.get_multi(features)
-      end
-
-      # Public
-      def get_all
-        @operations << Operation.new(:get_all, [])
-        @adapter.get_all
-      end
-
-      # Public
-      def enable(feature, gate, thing)
-        @operations << Operation.new(:enable, [feature, gate, thing])
-        @adapter.enable(feature, gate, thing)
-      end
-
-      # Public
-      def disable(feature, gate, thing)
-        @operations << Operation.new(:disable, [feature, gate, thing])
-        @adapter.disable(feature, gate, thing)
-      end
-
-      # Public
-      def import(source)
-        @operations << Operation.new(:import, [source])
-        @adapter.import(source)
-      end
-
-      # Public
-      def export(format: :json, version: 1)
-        @operations << Operation.new(:export, [format, version])
-        @adapter.export(format: format, version: version)
-      end
-
       # Public: Count the number of times a certain operation happened.
-      def count(type)
-        type(type).size
+      def count(type = nil)
+        if type
+          type(type).size
+        else
+          @operations.size
+        end
       end
 
       # Public: Get all operations of a certain type.
@@ -135,6 +54,13 @@ module Flipper
         inspect_id = ::Kernel::format "%x", (object_id * 2)
         %(#<#{self.class}:0x#{inspect_id} @name=#{name.inspect}, @operations=#{@operations.inspect}, @adapter=#{@adapter.inspect}>)
       end
+
+      private
+
+      def wrap(method, *args, **kwargs, &block)
+        @operations << Operation.new(method, args, kwargs)
+        block.call
+      end
     end
   end
 end