flipper 0.26.0 → 1.1.0

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,12 @@ module Flipper
                              write_timeout: options[:write_timeout],
                              max_retries: options[:max_retries],
                              debug_output: options[:debug_output])
-        @name = :http
       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
@@ -39,10 +38,10 @@ module Flipper
 
       def get_multi(features)
         csv_keys = features.map(&:key).join(',')
-        response = @client.get("/features?keys=#{csv_keys}")
+        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']
@@ -57,10 +56,10 @@ module Flipper
       end
 
       def get_all
-        response = @client.get("/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_features = parsed_response.fetch('features')
         gates_by_key = parsed_features.each_with_object({}) do |parsed_feature, hash|
           hash[parsed_feature['key']] = parsed_feature['gates']
@@ -68,7 +67,7 @@ module Flipper
         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
@@ -76,10 +75,10 @@ module Flipper
       end
 
       def features
-        response = @client.get('/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 +96,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 +104,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
@@ -123,6 +122,14 @@ module Flipper
         true
       end
 
+      def import(source)
+        adapter = self.class.from(source)
+        export = adapter.export(format: :json, version: 1)
+        response = @client.post("/import", export.contents)
+        raise Error, response unless response.is_a?(Net::HTTPNoContent)
+        true
+      end
+
       private
 
       def request_body_for_gate(gate, value)
@@ -130,11 +137,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
@@ -158,13 +167,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

@@ -4,7 +4,7 @@ module Flipper
   module Adapters
     # Internal: Adapter that wraps another adapter and instruments all adapter
     # operations.
-    class Instrumented < SimpleDelegator
+    class Instrumented
       include ::Flipper::Adapter
 
       # Private: The name of instrumentation events.
@@ -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.
@@ -24,9 +21,7 @@ module Flipper
       #           :instrumenter - What to use to instrument all the things.
       #
       def initialize(adapter, options = {})
-        super(adapter)
         @adapter = adapter
-        @name = :instrumented
         @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
       end
 
@@ -146,6 +141,30 @@ module Flipper
           payload[:result] = @adapter.disable(feature, gate, thing)
         end
       end
+
+      def import(source)
+        default_payload = {
+          operation: :import,
+          adapter_name: @adapter.name,
+        }
+
+        @instrumenter.instrument(InstrumentationName, default_payload) do |payload|
+          payload[:result] = @adapter.import(source)
+        end
+      end
+
+      def export(format: :json, version: 1)
+        default_payload = {
+          operation: :export,
+          adapter_name: @adapter.name,
+          format: format,
+          version: version,
+        }
+
+        @instrumenter.instrument(InstrumentationName, default_payload) do |payload|
+          payload[:result] = @adapter.export(format: format, version: version)
+        end
+      end
     end
   end
 end

data/lib/flipper/adapters/memoizable.rb

@@ -5,39 +5,28 @@ module Flipper
     # Internal: Adapter that wraps another adapter with the ability to memoize
     # adapter calls in memory. Used by flipper dsl and the memoizer middleware
     # to make it possible to memoize adapter calls for the duration of a request.
-    class Memoizable < SimpleDelegator
+    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)
-        super(adapter)
         @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
@@ -95,9 +84,9 @@ module Flipper
       def get_all
         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
@@ -105,8 +94,8 @@ module Flipper
             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
@@ -128,6 +117,19 @@ 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
+
+      def export(format: :json, version: 1)
+        @adapter.export(format: format, version: version)
+      end
+
       # Internal: Turns local caching on/off.
       #
       # value - The Boolean that decides if local caching is on.
@@ -141,10 +143,20 @@ module Flipper
         !!@memoize
       end
 
+      if RUBY_VERSION >= '3.0'
+        def method_missing(name, *args, **kwargs, &block)
+          @adapter.send name, *args, **kwargs, &block
+        end
+      else
+        def method_missing(name, *args, &block)
+          @adapter.send name, *args, &block
+        end
+      end
+
       private
 
       def key_for(key)
-        self.class.key_for(key)
+        "feature/#{key}"
       end
 
       def expire_feature(feature)
@@ -152,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

@@ -1,4 +1,5 @@
-require 'set'
+require "flipper/adapter"
+require "flipper/typecast"
 
 module Flipper
   module Adapters
@@ -7,93 +8,99 @@ module Flipper
     class Memory
       include ::Flipper::Adapter
 
-      FeaturesKey = :features
-
-      # Public: The name of the adapter.
-      attr_reader :name
-
       # Public
-      def initialize(source = nil)
-        @source = source || {}
-        @name = :memory
+      def initialize(source = nil, threadsafe: true)
+        @source = Typecast.features_hash(source)
+        @lock = Mutex.new if threadsafe
+        reset
       end
 
       # Public: The set of known features.
       def features
-        @source.keys.to_set
+        synchronize { @source.keys }.to_set
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        @source[feature.key] ||= default_config
+        synchronize { @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)
+        synchronize { @source.delete(feature.key) }
         true
       end
 
       # Public: Clears all the gate values for a feature.
       def clear(feature)
-        @source[feature.key] = default_config
+        synchronize { @source[feature.key] = default_config }
         true
       end
 
       # Public
       def get(feature)
-        @source[feature.key] || default_config
+        synchronize { @source[feature.key] } || default_config
       end
 
       def get_multi(features)
-        result = {}
-        features.each do |feature|
-          result[feature.key] = @source[feature.key] || default_config
+        synchronize do
+          result = {}
+          features.each do |feature|
+            result[feature.key] = @source[feature.key] || default_config
+          end
+          result
         end
-        result
       end
 
       def get_all
-        @source
+        synchronize { Typecast.features_hash(@source) }
       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"
+        synchronize 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
+          when :json
+            @source[feature.key][gate.key] = thing.value
+          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"
+        synchronize 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
+          when :json
+            @source[feature.key].delete(gate.key)
+          else
+            raise "#{gate} is not supported by this adapter yet"
+          end
+
+          true
         end
-
-        true
       end
 
       # Public
@@ -104,6 +111,34 @@ module Flipper
         ]
         "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
       end
+
+      # Public: a more efficient implementation of import for this adapter
+      def import(source)
+        adapter = self.class.from(source)
+        get_all = Typecast.features_hash(adapter.get_all)
+        synchronize { @source.replace(get_all) }
+        true
+      end
+
+      private
+
+      def reset
+        @pid = Process.pid
+        @lock&.unlock if @lock&.locked?
+      end
+
+      def forked?
+        @pid != Process.pid
+      end
+
+      def synchronize(&block)
+        if @lock
+          reset if forked?
+          @lock.synchronize(&block)
+        else
+          block.call
+        end
+      end
     end
   end
 end

data/lib/flipper/adapters/operation_logger.rb

@@ -5,8 +5,8 @@ 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 < SimpleDelegator
-      include ::Flipper::Adapter
+    class OperationLogger
+      include Flipper::Adapter
 
       class Operation
         attr_reader :type, :args
@@ -18,6 +18,8 @@ module Flipper
       end
 
       OperationTypes = [
+        :import,
+        :export,
         :features,
         :add,
         :remove,
@@ -32,14 +34,9 @@ module Flipper
       # 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)
-        super(adapter)
         @adapter = adapter
-        @name = :operation_logger
         @operations = operations || []
       end
 
@@ -98,6 +95,18 @@ module Flipper
         @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

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'