flipper 0.22.0 → 0.28.0

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.
@@ -24,7 +24,6 @@ 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)
@@ -146,6 +145,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,7 +5,7 @@ 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
@@ -27,7 +27,6 @@ module Flipper
 
       # Public
       def initialize(adapter, cache = nil)
-        super(adapter)
         @adapter = adapter
         @name = :memoizable
         @cache = cache || {}
@@ -45,24 +44,20 @@ module Flipper
 
       # Public
       def add(feature)
-        result = @adapter.add(feature)
-        expire_features_set
-        result
+        @adapter.add(feature).tap { expire_features_set }
       end
 
       # Public
       def remove(feature)
-        result = @adapter.remove(feature)
-        expire_features_set
-        expire_feature(feature)
-        result
+        @adapter.remove(feature).tap do
+          expire_features_set
+          expire_feature(feature)
+        end
       end
 
       # Public
       def clear(feature)
-        result = @adapter.clear(feature)
-        expire_feature(feature)
-        result
+        @adapter.clear(feature).tap { expire_feature(feature) }
       end
 
       # Public
@@ -124,16 +119,20 @@ module Flipper
 
       # Public
       def enable(feature, gate, thing)
-        result = @adapter.enable(feature, gate, thing)
-        expire_feature(feature)
-        result
+        @adapter.enable(feature, gate, thing).tap { expire_feature(feature) }
       end
 
       # Public
       def disable(feature, gate, thing)
-        result = @adapter.disable(feature, gate, thing)
-        expire_feature(feature)
-        result
+        @adapter.disable(feature, gate, thing).tap { expire_feature(feature) }
+      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.
@@ -149,6 +148,16 @@ 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)

data/lib/flipper/adapters/memory.rb

@@ -1,4 +1,6 @@
-require 'set'
+require "flipper/adapter"
+require "flipper/typecast"
+require 'concurrent/atomic/read_write_lock'
 
 module Flipper
   module Adapters
@@ -14,86 +16,93 @@ module Flipper
 
       # Public
       def initialize(source = nil)
-        @source = source || {}
+        @source = Typecast.features_hash(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 { 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"
+        @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 +113,14 @@ 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)
+        @lock.with_write_lock { @source.replace(get_all) }
+        true
+      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,
@@ -37,7 +39,6 @@ module Flipper
 
       # Public
       def initialize(adapter, operations = nil)
-        super(adapter)
         @adapter = adapter
         @name = :operation_logger
         @operations = operations || []
@@ -98,6 +99,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

@@ -0,0 +1,2 @@
+warn "DEPRECATION WARNING: Flipper::Adapters::Poll::Poller is deprecated. Use Flipper::Poller instead."
+require 'flipper/adapters/poll'

data/lib/flipper/adapters/poll.rb

@@ -0,0 +1,39 @@
+require 'flipper/adapters/sync/synchronizer'
+require 'flipper/poller'
+
+module Flipper
+  module Adapters
+    class Poll
+      extend Forwardable
+      include ::Flipper::Adapter
+
+      # Deprecated
+      Poller = ::Flipper::Poller
+
+      # 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/adapters/pstore.rb

@@ -17,14 +17,11 @@ module Flipper
       # Public: The path to where the file is stored.
       attr_reader :path
 
-      # Public: PStore's thread_safe option.
-      attr_reader :thread_safe
-
       # Public
-      def initialize(path = 'flipper.pstore', thread_safe = false)
+      def initialize(path = 'flipper.pstore', thread_safe = true)
+        @name = :pstore
         @path = path
         @store = ::PStore.new(path, thread_safe)
-        @name = :pstore
       end
 
       # Public: The set of known features.

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

@@ -7,11 +7,6 @@ module Flipper
         # Private: Number of seconds between syncs (default: 10).
         DEFAULT_INTERVAL = 10
 
-        # Private
-        def self.now
-          Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
-        end
-
         # Public: The Float or Integer number of seconds between invocations of
         # the wrapped synchronizer.
         attr_reader :interval
@@ -46,7 +41,7 @@ module Flipper
         end
 
         def now
-          self.class.now
+          Process.clock_gettime(Process::CLOCK_MONOTONIC, :second)
         end
       end
     end

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

@@ -37,7 +37,8 @@ module Flipper
           # Sync all the gate values.
           remote_get_all.each do |feature_key, remote_gates_hash|
             feature = Feature.new(feature_key, @local)
-            local_gates_hash = local_get_all[feature_key] || @local.default_config
+            # 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)
             remote_gate_values = GateValues.new(remote_gates_hash)
             FeatureSynchronizer.new(feature, local_gate_values, remote_gate_values).call

data/lib/flipper/adapters/sync.rb

@@ -58,33 +58,27 @@ module Flipper
       end
 
       def add(feature)
-        result = @remote.add(feature)
-        @local.add(feature)
-        result
+        @remote.add(feature).tap { @local.add(feature) }
       end
 
       def remove(feature)
-        result = @remote.remove(feature)
-        @local.remove(feature)
-        result
+        @remote.remove(feature).tap { @local.remove(feature) }
       end
 
       def clear(feature)
-        result = @remote.clear(feature)
-        @local.clear(feature)
-        result
+        @remote.clear(feature).tap { @local.clear(feature) }
       end
 
       def enable(feature, gate, thing)
-        result = @remote.enable(feature, gate, thing)
-        @local.enable(feature, gate, thing)
-        result
+        @remote.enable(feature, gate, thing).tap do
+          @local.enable(feature, gate, thing)
+        end
       end
 
       def disable(feature, gate, thing)
-        result = @remote.disable(feature, gate, thing)
-        @local.disable(feature, gate, thing)
-        result
+        @remote.disable(feature, gate, thing).tap do
+          @local.disable(feature, gate, thing)
+        end
       end
 
       private

data/lib/flipper/dsl.rb

@@ -10,17 +10,19 @@ module Flipper
     # Private: What is being used to instrument all the things.
     attr_reader :instrumenter
 
-    def_delegators :@adapter, :memoize=, :memoizing?
+    def_delegators :@adapter, :memoize=, :memoizing?, :import, :export
 
     # Public: Returns a new instance of the DSL.
     #
     # adapter - The adapter that this DSL instance should use.
     # options - The Hash of options.
     #           :instrumenter - What should be used to instrument all the things.
+    #           :memoize - Should adapter be wrapped by memoize adapter or not.
     def initialize(adapter, options = {})
       @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
-      memoized = Adapters::Memoizable.new(adapter)
-      @adapter = memoized
+      memoize = options.fetch(:memoize, true)
+      adapter = Adapters::Memoizable.new(adapter) if memoize
+      @adapter = adapter
       @memoized_features = {}
     end
 
@@ -235,12 +237,12 @@ module Flipper
 
     # Public: Wraps an object as a flipper actor.
     #
-    # thing - The object that you would like to wrap.
+    # actor - The object that you would like to wrap.
     #
     # Returns an instance of Flipper::Types::Actor.
-    # Raises ArgumentError if thing does not respond to `flipper_id`.
-    def actor(thing)
-      Types::Actor.new(thing)
+    # Raises ArgumentError if actor does not respond to `flipper_id`.
+    def actor(actor)
+      Types::Actor.new(actor)
     end
 
     # Public: Shortcut for getting a percentage of time instance.
@@ -270,10 +272,6 @@ module Flipper
       adapter.features.map { |name| feature(name) }.to_set
     end
 
-    def import(flipper)
-      adapter.import(flipper.adapter)
-    end
-
     # Cloud DSL method that does nothing for open source version.
     def sync
     end

data/lib/flipper/errors.rb

@@ -2,25 +2,16 @@ module Flipper
   # Top level error that all other errors inherit from.
   class Error < StandardError; end
 
-  # Raised when gate can not be found for a thing.
+  # Raised when gate can not be found for an actor.
   class GateNotFound < Error
-    def initialize(thing)
-      super "Could not find gate for #{thing.inspect}"
+    def initialize(actor)
+      super "Could not find gate for #{actor.inspect}"
     end
   end
 
   # Raised when attempting to declare a group name that has already been used.
   class DuplicateGroup < Error; end
 
-  # Raised when default instance not configured but there is an attempt to
-  # use it.
-  class DefaultNotSet < Flipper::Error
-    def initialize(message = nil)
-      warn "Flipper::DefaultNotSet is deprecated and will be removed in 1.0"
-      super
-    end
-  end
-
   # Raised when an invalid value is set to a configuration property
   class InvalidConfigurationValue < Flipper::Error
     def initialize(message = nil)
@@ -28,12 +19,4 @@ module Flipper
       super(message || default)
     end
   end
-
-  # Raised when accessing a configuration property that has been deprecated
-  class ConfigurationDeprecated < Flipper::Error
-    def initialize(message = nil)
-      default = "The configuration property has been deprecated"
-      super(message || default)
-    end
-  end
 end

data/lib/flipper/export.rb

@@ -0,0 +1,26 @@
+require "flipper/adapters/memory"
+
+module Flipper
+  class Export
+    attr_reader :contents, :format, :version
+
+    def initialize(contents:, format: :json, version: 1)
+      @contents = contents
+      @format = format
+      @version = version
+    end
+
+    def features
+      raise NotImplementedError
+    end
+
+    def adapter
+      @adapter ||= Flipper::Adapters::Memory.new(features)
+    end
+
+    def eql?(other)
+      self.class.eql?(other.class) && @contents == other.contents && @format == other.format && @version == other.version
+    end
+    alias_method :==, :eql?
+  end
+end

data/lib/flipper/exporter.rb

@@ -0,0 +1,17 @@
+require "flipper/exporters/json/v1"
+
+module Flipper
+  module Exporter
+    extend self
+
+    FORMATTERS = {
+      json: {
+        1 => Flipper::Exporters::Json::V1,
+      }
+    }.freeze
+
+    def build(format: :json, version: 1)
+      FORMATTERS.fetch(format).fetch(version).new
+    end
+  end
+end

data/lib/flipper/exporters/json/export.rb

@@ -0,0 +1,32 @@
+require "flipper/export"
+require "flipper/typecast"
+
+module Flipper
+  module Exporters
+    module Json
+      # Raised when the contents of the export are not valid.
+      class InvalidError < StandardError; end
+      class JsonError < InvalidError; end
+
+      # Internal: JSON export class that knows how to build features hash
+      # from data.
+      class Export < ::Flipper::Export
+        def initialize(contents:, version: 1)
+          super contents: contents, version: version, format: :json
+        end
+
+        # Public: The features hash identical to calling get_all on adapter.
+        def features
+          @features ||= begin
+            features = JSON.parse(contents).fetch("features")
+            Typecast.features_hash(features)
+          rescue JSON::ParserError
+            raise JsonError
+          rescue
+            raise InvalidError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flipper/exporters/json/v1.rb

@@ -0,0 +1,33 @@
+require "json"
+require "flipper/exporters/json/export"
+
+module Flipper
+  module Exporters
+    module Json
+      class V1
+        VERSION = 1
+
+        def call(adapter)
+          features = adapter.get_all
+
+          # Convert sets to arrays for json
+          features.each do |feature_key, gates|
+            gates.each do |key, value|
+              case value
+              when Set
+                features[feature_key][key] = value.to_a
+              end
+            end
+          end
+
+          json = JSON.dump({
+            version: VERSION,
+            features: features,
+          })
+
+          Json::Export.new(contents: json, version: VERSION)
+        end
+      end
+    end
+  end
+end