flipper 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 843f963e51439159d1fd4c6d27abefcbc091dd38
-  data.tar.gz: 96b4532f699e3d1dc61a399be98d2494b47b3f36
+  metadata.gz: e763a777dcfe1cdd82ce50066de8634e364050ca
+  data.tar.gz: 6ca538b415aba3638eb2ec2ffa713d964c2b8011
 SHA512:
-  metadata.gz: 23146daa1a8eff45c01d065f00d0b101b7929ebda1635bfd2e902427ca8c13f98cd97920176d1855d3d9798e3db508c401bde42e40dd18c2960d0eb5034c9aee
-  data.tar.gz: c5943fff3072a0d9ddab4cb823270cc0c76b3f912a95f27d18053b03a73353a0bd0855437e3ab5a9f073df5d32b34d46531d65eec23619b2565ea02f9b75c6b5
+  metadata.gz: af7780249550d2d8a332de8b78715b1db2f0652699a010231292ffc2b8efed5b2059329fe3f8f191bc5cfbfffd145bb2f62697bf0e842a909c950f0f82c14022
+  data.tar.gz: 7fd80434279dd6e51f9084855ea9c892db1dac7cb839731b1775a42bc03c0b69b649adca3a88db3fc74f37a53127a7d759d67a9f7acdf50e9a02eb1cc1ae6f4e

data/Changelog.md

@@ -1,3 +1,10 @@
+## master (to be 0.15.0)
+
+* Move Flipper::UI configuration options to Flipper::UI::Configuration (https://github.com/jnunemaker/flipper/pull/345).
+* Bug fix in adapter synchronizing and switched DSL#import to use Synchronizer (https://github.com/jnunemaker/flipper/pull/347).
+* Fix AR adapter table name prefix/suffix bug (https://github.com/jnunemaker/flipper/pull/350).
+* Allow feature names to end with "features" in UI (https://github.com/jnunemaker/flipper/pull/353).
+
 ## 0.14.0
 
 * Changed sync_interval to be seconds instead of milliseconds.

data/lib/flipper/adapter.rb

@@ -1,3 +1,5 @@
+require "flipper/adapters/sync/synchronizer"
+
 module Flipper
   # Adding a module include so we have some hooks for stuff down the road
   module Adapter
@@ -37,55 +39,16 @@ module Flipper
       result
     end
 
-    # Public: Wipe features and gate values and then import features and gate
-    # values from provided adapter.
+    # Public: Ensure that adapter is in sync with source adapter provided.
     #
-    # Returns nothing.
+    # Returns result of Synchronizer#call.
     def import(source_adapter)
-      wipe
-      copy_features_and_gates(source_adapter)
-      nil
+      Adapters::Sync::Synchronizer.new(self, source_adapter, raise: true).call
     end
 
     # Public: Default config for a feature's gate values.
     def default_config
       self.class.default_config
     end
-
-    private
-
-    # Private: Copy source adapter features and gate values into self.
-    def copy_features_and_gates(source_adapter)
-      source_adapter.features.each do |key|
-        source_feature = Flipper::Feature.new(key, source_adapter)
-        destination_feature = Flipper::Feature.new(key, self)
-
-        case source_feature.state
-        when :on
-          destination_feature.enable
-        when :conditional
-          source_feature.groups_value.each do |value|
-            destination_feature.enable_group(value)
-          end
-
-          source_feature.actors_value.each do |value|
-            destination_feature.enable_actor(Flipper::Actor.new(value))
-          end
-
-          destination_feature.enable_percentage_of_actors(source_feature.percentage_of_actors_value)
-          destination_feature.enable_percentage_of_time(source_feature.percentage_of_time_value)
-        when :off
-          destination_feature.add
-        end
-      end
-    end
-
-    # Private: Completely wipe adapter features and gate values.
-    def wipe
-      features.each do |key|
-        feature = Flipper::Feature.new(key, self)
-        remove(feature)
-      end
-    end
   end
 end

data/lib/flipper/adapters/sync.rb

@@ -27,8 +27,10 @@ module Flipper
         @local = local
         @remote = remote
         @synchronizer = options.fetch(:synchronizer) do
+          sync_options = {
+            raise: false,
+          }
           instrumenter = options[:instrumenter]
-          sync_options = {}
           sync_options[:instrumenter] = instrumenter if instrumenter
           synchronizer = Synchronizer.new(@local, @remote, sync_options)
           IntervalSynchronizer.new(synchronizer, interval: options[:interval])

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

@@ -39,6 +39,7 @@ module Flipper
             return if local_boolean_enabled?
             @feature.enable
           else
+            @feature.disable if local_boolean_enabled?
             sync_actors
             sync_groups
             sync_percentage_of_actors

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

@@ -6,15 +6,24 @@ require "flipper/adapters/sync/feature_synchronizer"
 module Flipper
   module Adapters
     class Sync
-      # Internal: Given a local and remote adapter, it can update the local to
+      # Public: Given a local and remote adapter, it can update the local to
       # match the remote doing only the necessary enable/disable operations.
       class Synchronizer
+        # Public: Initializes a new synchronizer.
+        #
+        # local - The Flipper adapter to get in sync with the remote.
+        # remote - The Flipper adapter that is source of truth that the local
+        #          adapter should be brought in line with.
+        # options - The Hash of options.
+        #           :instrumenter - The instrumenter used to instrument.
         def initialize(local, remote, options = {})
           @local = local
           @remote = remote
           @instrumenter = options.fetch(:instrumenter, Instrumenters::Noop)
+          @raise = options.fetch(:raise, true)
         end
 
+        # Public: Forces a sync.
         def call
           @instrumenter.instrument("synchronizer_call.flipper") { sync }
         end
@@ -23,8 +32,6 @@ module Flipper
 
         def sync
           local_get_all = @local.get_all
-          # TODO: Move remote get all to background thread to minimize impact to
-          # whatever is happening in main thread.
           remote_get_all = @remote.get_all
 
           # Sync all the gate values.
@@ -36,11 +43,18 @@ module Flipper
             FeatureSynchronizer.new(feature, local_gate_values, remote_gate_values).call
           end
 
-          # Add features that are missing
+          # 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 }
+
+          # 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 }
+
+          nil
         rescue => exception
           @instrumenter.instrument("synchronizer_exception.flipper", exception: exception)
+          raise if @raise
         end
       end
     end

data/lib/flipper/errors.rb

@@ -29,4 +29,12 @@ 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/instrumenters/memory.rb

@@ -21,6 +21,18 @@ module Flipper
         @events << Event.new(name, payload, result)
         result
       end
+
+      def events_by_name(name)
+        @events.select { |event| event.name == name }
+      end
+
+      def event_by_name(name)
+        events_by_name(name).first
+      end
+
+      def reset
+        @events = []
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.14.0'.freeze
+  VERSION = '0.15.0'.freeze
 end

data/spec/flipper/adapters/sync/feature_synchronizer_spec.rb

@@ -56,7 +56,29 @@ RSpec.describe Flipper::Adapters::Sync::FeatureSynchronizer do
     end
   end
 
-  context "when conditionally enabled" do
+  context "when remote conditionally enabled" do
+    it "disables feature locally and syncs conditional enablements" do
+      feature.enable
+      adapter.reset
+      remote_gate_values_hash = {
+        boolean: nil,
+        actors: Set["1"],
+        groups: Set["staff"],
+        percentage_of_time: 10,
+        percentage_of_actors: 15,
+      }
+      remote = Flipper::GateValues.new(remote_gate_values_hash)
+
+      described_class.new(feature, feature.gate_values, remote).call
+
+      local_gate_values_hash = adapter.get(feature)
+      expect(local_gate_values_hash.fetch(:boolean)).to be(nil)
+      expect(local_gate_values_hash.fetch(:actors)).to eq(Set["1"])
+      expect(local_gate_values_hash.fetch(:groups)).to eq(Set["staff"])
+      expect(local_gate_values_hash.fetch(:percentage_of_time)).to eq("10")
+      expect(local_gate_values_hash.fetch(:percentage_of_actors)).to eq("15")
+    end
+
     it "adds remotely added actors" do
       remote = Flipper::GateValues.new(actors: Set["1", "2"])
       feature.enable_actor(Flipper::Actor.new("1"))

data/spec/flipper/adapters/sync/synchronizer_spec.rb

@@ -6,30 +6,84 @@ require "flipper/adapters/sync/synchronizer"
 RSpec.describe Flipper::Adapters::Sync::Synchronizer do
   let(:local) { Flipper::Adapters::Memory.new }
   let(:remote) { Flipper::Adapters::Memory.new }
+  let(:local_flipper) { Flipper.new(local) }
+  let(:remote_flipper) { Flipper.new(remote) }
   let(:instrumenter) { Flipper::Instrumenters::Memory.new }
 
   subject { described_class.new(local, remote, instrumenter: instrumenter) }
 
   it "instruments call" do
     subject.call
-    events = instrumenter.events.select do |event|
-      event.name == "synchronizer_call.flipper"
-    end
+    expect(instrumenter.events_by_name("synchronizer_exception.flipper").size).to be(0)
+
+    events = instrumenter.events_by_name("synchronizer_call.flipper")
     expect(events.size).to be(1)
   end
 
-  it "does not raise, but instruments exceptions for visibility" do
+  it "raises errors by default" do
     exception = StandardError.new
     expect(remote).to receive(:get_all).and_raise(exception)
 
-    expect { subject.call }.not_to raise_error
+    expect { subject.call }.to raise_error(exception)
+  end
 
-    events = instrumenter.events.select do |event|
-      event.name == "synchronizer_exception.flipper"
+  context "when raise disabled" do
+    subject do
+      options = {
+        instrumenter: instrumenter,
+        raise: false,
+      }
+      described_class.new(local, remote, options)
+    end
+
+    it "does not raise, but instruments exceptions for visibility" do
+      exception = StandardError.new
+      expect(remote).to receive(:get_all).and_raise(exception)
+
+      expect { subject.call }.not_to raise_error
+
+      events = instrumenter.events_by_name("synchronizer_exception.flipper")
+      expect(events.size).to be(1)
+
+      event = events[0]
+      expect(event.payload[:exception]).to eq(exception)
+    end
+  end
+
+  describe '#call' do
+    it 'returns nothing' do
+      expect(subject.call).to be(nil)
+      expect(instrumenter.events_by_name("synchronizer_exception.flipper").size).to be(0)
     end
-    expect(events.size).to be(1)
 
-    event = events[0]
-    expect(event.payload[:exception]).to eq(exception)
+    it 'syncs each remote feature to local' do
+      remote_flipper.enable(:search)
+      remote_flipper.enable_percentage_of_time(:logging, 10)
+
+      subject.call
+      expect(instrumenter.events_by_name("synchronizer_exception.flipper").size).to be(0)
+
+      expect(local_flipper[:search].boolean_value).to eq(true)
+      expect(local_flipper[:logging].percentage_of_time_value).to eq(10)
+      expect(local_flipper.features.map(&:key).sort).to eq(%w(logging search))
+    end
+
+    it 'adds features in remote that are not in local' do
+      remote_flipper.add(:search)
+
+      subject.call
+      expect(instrumenter.events_by_name("synchronizer_exception.flipper").size).to be(0)
+
+      expect(local_flipper.features.map(&:key)).to eq(["search"])
+    end
+
+    it 'removes features in local that are not in remote' do
+      local_flipper.add(:stats)
+
+      subject.call
+      expect(instrumenter.events_by_name("synchronizer_exception.flipper").size).to be(0)
+
+      expect(local_flipper.features.map(&:key)).to eq([])
+    end
   end
 end

data/spec/flipper/adapters/sync_spec.rb

@@ -194,4 +194,10 @@ RSpec.describe Flipper::Adapters::Sync do
     expect(subject).to receive(:sync)
     subject.get_all
   end
+
+  it 'does not raise sync exceptions' do
+    exception = StandardError.new
+    expect(remote_adapter).to receive(:get_all).and_raise(exception)
+    expect { subject.get_all }.not_to raise_error
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies: []
 description: Feature flipper is the act of enabling/disabling features in your application,
   ideally without re-deploying or changing anything in your code base. Flipper makes
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.4.5.4
 signing_key: 
 specification_version: 4
 summary: Feature flipper for ANYTHING