flipper 0.26.2 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 670e45600b4c72208ed69da2792d2d4e1ac11d7a54f19c45c4b448ba6dacc404
-  data.tar.gz: 56a6ef12c569a7392212953604ed103a1fb187b57d5f827ea141a0d5eafc5ee1
+  metadata.gz: 202d50faf999fd9ed12d91ef7f160f786892b9476ad86b815fd4be5390cf8992
+  data.tar.gz: 1f59767d2f210820f488e97a0388f84aa2d474ac7b573e1650a69104d15f384a
 SHA512:
-  metadata.gz: a09649689708c91afbdc3e9f4eded2ec29ae1b3ac06a98f28197dcc4d3dd65983f73e0e9e44994d78b0672afbea1350ff7256dc12b7e5bb426961bfce858b4f6
-  data.tar.gz: '08eb67c5e5df45e734e8b6e50c6fd20cfbdf28dbdb8ba1a3e2d2af084250b9cd404fa21cc778989527d245154e05f5abc49aaa12a95b2ef7b12daf4bbea41830'
+  metadata.gz: f4b8079927fe805c7c6200694c6b9d9b020539cf1835d62a713724adc1483c48399a3f0073c969d4f9619b0362d615c21813ed79470172ea7037e62cfbb791db
+  data.tar.gz: 8a389963c5386d4d9ef13be89e06f6f38e959dcb0c427b7950ffee628828d627ff567581da375d3e9eb8b3501ba7e24d0f4b82acdf6a04599fb0cf7a2385f250

data/Changelog.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 0.27.0
+
+* Easy Import/Export (https://github.com/jnunemaker/flipper/pull/709). This has some breaking changes but only if you are using flipper internals. If you are just using Flipper.* methods, you'll be fine.
+
 ## 0.26.2
 
 * Improve Active Record Adapter get/get_multi/get_all performance by 5-10x when dealing with thousands of gate values (https://github.com/jnunemaker/flipper/pull/707).

data/Gemfile

@@ -8,13 +8,12 @@ end
 
 gem 'debug'
 gem 'rake', '~> 12.3.3'
-gem 'shotgun', '~> 0.9'
 gem 'statsd-ruby', '~> 1.2.1'
 gem 'rspec', '~> 3.0'
-gem 'rack-test', '~> 0.6.3'
+gem 'rack-test'
 gem 'sqlite3', "~> #{ENV['SQLITE3_VERSION'] || '1.4.1'}"
 gem 'rails', "~> #{ENV['RAILS_VERSION'] || '7.0.0'}"
-gem 'minitest', '~> 5.8'
+gem 'minitest', '~> 5.18'
 gem 'minitest-documentation'
 gem 'webmock', '~> 3.0'
 gem 'ice_age'

data/examples/api/basic.ru

@@ -1,19 +1,18 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/basic.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/basic.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "flipper/api"
 require "flipper/adapters/pstore"
 
 # You can uncomment this to get some default data:
 # Flipper.enable :logging
 
+use Rack::Reloader
+
 run Flipper::Api.app

data/examples/api/custom_memoized.ru

@@ -1,15 +1,12 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/custom_memoized.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/custom_memoized.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "active_support/notifications"
 require "flipper/api"
 require "flipper/adapters/pstore"
@@ -31,6 +28,8 @@ ActiveSupport::Notifications.subscribe(/.*/, ->(*args) {
 # You can uncomment this to get some default data:
 # flipper[:logging].enable_percentage_of_time 5
 
+use Rack::Reloader
+
 run Flipper::Api.app(flipper) { |builder|
   builder.use Flipper::Middleware::SetupEnv, flipper
   builder.use Flipper::Middleware::Memoizer, preload: true

data/examples/api/memoized.ru

@@ -1,15 +1,12 @@
 #
 # Usage:
-#   # if you want it to not reload and be really fast
 #   bin/rackup examples/api/memoized.ru -p 9999
 #
-#   # if you want reloading
-#   bin/shotgun examples/api/memoized.ru -p 9999
-#
 #   http://localhost:9999/
 #
 
 require 'bundler/setup'
+require 'rack/reloader'
 require "active_support/notifications"
 require "flipper/api"
 require "flipper/adapters/pstore"
@@ -38,6 +35,8 @@ Flipper.register(:admins) { |actor|
 # You can uncomment this to get some default data:
 # Flipper.enable :logging
 
+use Rack::Reloader
+
 run Flipper::Api.app { |builder|
   builder.use Flipper::Middleware::Memoizer, preload: true
 }

data/lib/flipper/adapter.rb

@@ -1,7 +1,3 @@
-require "set"
-require "flipper/feature"
-require "flipper/adapters/sync/synchronizer"
-
 module Flipper
   # Adding a module include so we have some hooks for stuff down the road
   module Adapter
@@ -20,6 +16,11 @@ module Flipper
           percentage_of_time: nil,
         }
       end
+
+      def from(source)
+        return source if source.is_a?(Flipper::Adapter)
+        source.adapter
+      end
     end
 
     # Public: Get all features and gate values in one call. Defaults to one call
@@ -43,9 +44,19 @@ module Flipper
 
     # Public: Ensure that adapter is in sync with source adapter provided.
     #
-    # Returns result of Synchronizer#call.
-    def import(source_adapter)
-      Adapters::Sync::Synchronizer.new(self, source_adapter, raise: true).call
+    # source - The source dsl, adapter or export to import.
+    #
+    # Returns true if successful.
+    def import(source)
+      Adapters::Sync::Synchronizer.new(self, self.class.from(source), raise: true).call
+      true
+    end
+
+    # Public: Exports the adapter in a given format for a given format version.
+    #
+    # Returns a Flipper::Export instance.
+    def export(format: :json, version: 1)
+      Flipper::Exporter.build(format: format, version: version).call(self)
     end
 
     # Public: Default config for a feature's gate values.
@@ -54,3 +65,8 @@ module Flipper
     end
   end
 end
+
+require "set"
+require "flipper/exporter"
+require "flipper/feature"
+require "flipper/adapters/sync/synchronizer"

data/lib/flipper/adapters/http.rb

@@ -39,7 +39,7 @@ 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)
@@ -57,7 +57,7 @@ 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)
@@ -76,7 +76,7 @@ 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)
@@ -123,6 +123,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)

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 || {}
@@ -128,6 +127,14 @@ module Flipper
         @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.
       #
       # value - The Boolean that decides if local caching is on.
@@ -141,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,3 +1,5 @@
+require "flipper/adapter"
+require "flipper/typecast"
 require 'concurrent/atomic/read_write_lock'
 
 module Flipper
@@ -14,7 +16,7 @@ module Flipper
 
       # Public
       def initialize(source = nil)
-        @source = Hash.new.update(source || {})
+        @source = Typecast.features_hash(source)
         @name = :memory
         @lock = Concurrent::ReadWriteLock.new
       end
@@ -59,7 +61,7 @@ module Flipper
       end
 
       def get_all
-        @lock.with_read_lock { @source.to_h }
+        @lock.with_read_lock { Typecast.features_hash(@source) }
       end
 
       # Public
@@ -113,9 +115,11 @@ module Flipper
       end
 
       # Public: a more efficient implementation of import for this adapter
-      def import(source_adapter)
-        get_all = source_adapter.get_all
+      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

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/dsl.rb

@@ -10,7 +10,7 @@ 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.
     #
@@ -272,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/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

data/lib/flipper/instrumentation/subscriber.rb

@@ -72,6 +72,14 @@ module Flipper
         update_timer "flipper.adapter.#{adapter_name}.#{operation}"
       end
 
+      def update_poller_metrics
+        # noop
+      end
+
+      def update_synchronizer_call_metrics
+        # noop
+      end
+
       QUESTION_MARK = '?'.freeze
 
       # Private

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -33,7 +33,15 @@ RSpec.shared_examples_for 'a flipper adapter' do
     expect(subject.class.ancestors).to include(Flipper::Adapter)
   end
 
+  it 'knows how to get adapter from source' do
+    adapter = Flipper::Adapters::Memory.new
+    flipper = Flipper.new(adapter)
+    expect(subject.class.from(adapter).class.ancestors).to include(Flipper::Adapter)
+    expect(subject.class.from(flipper).class.ancestors).to include(Flipper::Adapter)
+  end
+
   it 'returns correct default values for the gates if none are enabled' do
+    expect(subject.get(feature)).to eq(subject.class.default_config)
     expect(subject.get(feature)).to eq(subject.default_config)
   end
 
@@ -304,4 +312,19 @@ RSpec.shared_examples_for 'a flipper adapter' do
     subject.enable(feature, boolean_gate, flipper.boolean(true))
     expect(subject.get(feature)).to eq(subject.default_config.merge(boolean: "true"))
   end
+
+  it 'can import and export' do
+    adapter = Flipper::Adapters::Memory.new
+    source_flipper = Flipper.new(adapter)
+    source_flipper.enable(:stats)
+    export = adapter.export
+
+    # some adapters cannot import so if they return false lets assert it
+    # didn't happen
+    if subject.import(export)
+      expect(flipper[:stats]).to be_enabled
+    else
+      expect(flipper[:stats]).not_to be_enabled
+    end
+  end
 end

data/lib/flipper/test/shared_adapter_test.rb

@@ -34,7 +34,16 @@ module Flipper
         assert_includes @adapter.class.ancestors, Flipper::Adapter
       end
 
+      def test_knows_how_to_get_adapter_from_source
+        adapter = Flipper::Adapters::Memory.new
+        flipper = Flipper.new(adapter)
+
+        assert_includes adapter.class.from(adapter).class.ancestors, Flipper::Adapter
+        assert_includes adapter.class.from(flipper).class.ancestors, Flipper::Adapter
+      end
+
       def test_returns_correct_default_values_for_gates_if_none_are_enabled
+        assert_equal @adapter.class.default_config, @adapter.get(@feature)
         assert_equal @adapter.default_config, @adapter.get(@feature)
       end
 
@@ -300,6 +309,21 @@ module Flipper
         assert_equal true, @adapter.enable(@feature, @boolean_gate, @flipper.boolean(true))
         assert_equal @adapter.default_config.merge(boolean: "true"), @adapter.get(@feature)
       end
+
+      def test_can_import_and_export
+        adapter = Flipper::Adapters::Memory.new
+        source_flipper = Flipper.new(adapter)
+        source_flipper.enable(:stats)
+        export = adapter.export
+
+        # some adapters cannot import so if they return false lets assert it
+        # didn't happen
+        if @adapter.import(export)
+          assert @flipper[:stats].enabled?
+        else
+          refute @flipper[:stats].enabled?
+        end
+      end
     end
   end
 end

data/lib/flipper/typecast.rb

@@ -62,5 +62,22 @@ module Flipper
         raise ArgumentError, "#{value.inspect} cannot be converted to a set"
       end
     end
+
+    def self.features_hash(source)
+      normalized_source = {}
+      (source || {}).each do |feature_key, gates|
+        normalized_source[feature_key] ||= {}
+        gates.each do |gate_key, value|
+          normalized_value = case value
+          when Array, Set
+            value.to_set
+          else
+            value ? value.to_s : value
+          end
+          normalized_source[feature_key][gate_key.to_sym] = normalized_value
+        end
+      end
+      normalized_source
+    end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.26.2'.freeze
+  VERSION = '0.27.0'.freeze
 end

data/lib/flipper.rb

@@ -64,7 +64,7 @@ module Flipper
                  :enable_percentage_of_time, :disable_percentage_of_time,
                  :time, :percentage_of_time,
                  :features, :feature, :[], :preload, :preload_all,
-                 :adapter, :add, :exist?, :remove, :import,
+                 :adapter, :add, :exist?, :remove, :import, :export,
                  :memoize=, :memoizing?,
                  :sync, :sync_secret # For Flipper::Cloud. Will error for OSS Flipper.