flipper 1.2.1 → 1.3.0.pre

data/lib/flipper/cloud/telemetry.rb

@@ -160,8 +160,16 @@ module Flipper
         # thus may have a telemetry-interval header for us to respect.
         response ||= error.response if error && error.respond_to?(:response)
 
-        if response && interval = response["telemetry-interval"]
-          self.interval = interval.to_f
+        if response
+          if Flipper::Typecast.to_boolean(response["telemetry-shutdown"])
+            debug "action=telemetry_shutdown message=The server has requested that telemetry be shut down."
+            stop
+            return
+          end
+
+          if interval = response["telemetry-interval"]
+            self.interval = interval.to_f
+          end
         end
       rescue => error
         error "action=post_to_cloud error=#{error.inspect}"

data/lib/flipper/poller.rb

@@ -20,6 +20,8 @@ module Flipper
       instances.each {|_, instance| instance.stop }.clear
     end
 
+    MINIMUM_POLL_INTERVAL = 10
+
     def initialize(options = {})
       @thread = nil
       @pid = Process.pid
@@ -30,9 +32,9 @@ module Flipper
       @last_synced_at = Concurrent::AtomicFixnum.new(0)
       @adapter = Adapters::Memory.new(nil, threadsafe: true)
 
-      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
+      if @interval < MINIMUM_POLL_INTERVAL
+        warn "Flipper::Cloud poll interval must be greater than or equal to #{MINIMUM_POLL_INTERVAL} but was #{@interval}. Setting @interval to #{MINIMUM_POLL_INTERVAL}."
+        @interval = MINIMUM_POLL_INTERVAL
       end
 
       @start_automatically = options.fetch(:start_automatically, true)
@@ -64,8 +66,7 @@ module Flipper
           # you can instrument these using poller.flipper
         end
 
-        sleep_interval = interval - (Concurrent.monotonic_time - start)
-        sleep sleep_interval if sleep_interval.positive?
+        sleep interval
       end
     end
 

data/lib/flipper/serializers/gzip.rb

@@ -3,10 +3,8 @@ require "stringio"
 
 module Flipper
   module Serializers
-    module Gzip
-      module_function
-
-      def serialize(source)
+    class Gzip
+      def self.serialize(source)
         return if source.nil?
         output = StringIO.new
         gz = Zlib::GzipWriter.new(output)
@@ -15,7 +13,7 @@ module Flipper
         output.string
       end
 
-      def deserialize(source)
+      def self.deserialize(source)
         return if source.nil?
         Zlib::GzipReader.wrap(StringIO.new(source), &:read)
       end

data/lib/flipper/serializers/json.rb

@@ -2,15 +2,13 @@ require "json"
 
 module Flipper
   module Serializers
-    module Json
-      module_function
-
-      def serialize(source)
+    class Json
+      def self.serialize(source)
         return if source.nil?
         JSON.generate(source)
       end
 
-      def deserialize(source)
+      def self.deserialize(source)
         return if source.nil?
         JSON.parse(source)
       end

data/lib/flipper/spec/shared_adapter_specs.rb

@@ -108,19 +108,19 @@ RSpec.shared_examples_for 'a flipper adapter' do
     actor22 = Flipper::Actor.new('22')
     actor_asdf = Flipper::Actor.new('asdf')
 
-    expect(subject.enable(feature, actor_gate, Flipper::Types::Actor.new(actor22))).to eq(true)
-    expect(subject.enable(feature, actor_gate, Flipper::Types::Actor.new(actor_asdf))).to eq(true)
+    expect(feature.enable(actor22)).to be(true)
+    expect(feature.enable(actor_asdf)).to be(true)
 
-    result = subject.get(feature)
-    expect(result[:actors]).to eq(Set['22', 'asdf'])
+    expect(feature).to be_enabled(actor22)
+    expect(feature).to be_enabled(actor_asdf)
 
-    expect(subject.disable(feature, actor_gate, Flipper::Types::Actor.new(actor22))).to eq(true)
-    result = subject.get(feature)
-    expect(result[:actors]).to eq(Set['asdf'])
+    expect(feature.disable(actor22)).to be(true)
+    expect(feature).not_to be_enabled(actor22)
+    expect(feature).to be_enabled(actor_asdf)
 
-    expect(subject.disable(feature, actor_gate, Flipper::Types::Actor.new(actor_asdf))).to eq(true)
-    result = subject.get(feature)
-    expect(result[:actors]).to eq(Set.new)
+    expect(feature.disable(actor_asdf)).to eq(true)
+    expect(feature).not_to be_enabled(actor22)
+    expect(feature).not_to be_enabled(actor_asdf)
   end
 
   it 'can enable, disable and get value for percentage of actors gate' do
@@ -182,9 +182,10 @@ RSpec.shared_examples_for 'a flipper adapter' do
   end
 
   it 'converts the actor value to a string' do
-    expect(subject.enable(feature, actor_gate, Flipper::Types::Actor.new(Flipper::Actor.new(22)))).to eq(true)
-    result = subject.get(feature)
-    expect(result[:actors]).to eq(Set['22'])
+    actor = Flipper::Actor.new(22)
+    expect(feature).not_to be_enabled(actor)
+    feature.enable_actor actor
+    expect(feature).to be_enabled(actor)
   end
 
   it 'converts group value to a string' do
@@ -295,9 +296,9 @@ RSpec.shared_examples_for 'a flipper adapter' do
 
   it 'can double enable an actor without error' do
     actor = Flipper::Actor.new('Flipper::Actor;22')
-    expect(subject.enable(feature, actor_gate, Flipper::Types::Actor.new(actor))).to eq(true)
-    expect(subject.enable(feature, actor_gate, Flipper::Types::Actor.new(actor))).to eq(true)
-    expect(subject.get(feature).fetch(:actors)).to eq(Set['Flipper::Actor;22'])
+    expect(feature.enable(actor)).to be(true)
+    expect(feature.enable(actor)).to be(true)
+    expect(feature).to be_enabled(actor)
   end
 
   it 'can double enable a group without error' do

data/lib/flipper/test/shared_adapter_test.rb

@@ -104,19 +104,19 @@ module Flipper
         actor22 = Flipper::Actor.new('22')
         actor_asdf = Flipper::Actor.new('asdf')
 
-        assert_equal true, @adapter.enable(@feature, @actor_gate, Flipper::Types::Actor.new(actor22))
-        assert_equal true, @adapter.enable(@feature, @actor_gate, Flipper::Types::Actor.new(actor_asdf))
+        assert_equal true, @feature.enable(actor22)
+        assert_equal true, @feature.enable(actor_asdf)
 
-        result = @adapter.get(@feature)
-        assert_equal Set['22', 'asdf'], result[:actors]
+        assert @feature.enabled?(actor22)
+        assert @feature.enabled?(actor_asdf)
 
-        assert true, @adapter.disable(@feature, @actor_gate, Flipper::Types::Actor.new(actor22))
-        result = @adapter.get(@feature)
-        assert_equal Set['asdf'], result[:actors]
+        assert_equal true, @feature.disable(actor22)
+        refute @feature.enabled?(actor22)
+        assert @feature.enabled?(actor_asdf)
 
-        assert_equal true, @adapter.disable(@feature, @actor_gate, Flipper::Types::Actor.new(actor_asdf))
-        result = @adapter.get(@feature)
-        assert_equal Set.new, result[:actors]
+        assert_equal true, @feature.disable(actor_asdf)
+        refute @feature.enabled?(actor22)
+        refute @feature.enabled?(actor_asdf)
       end
 
       def test_can_enable_disable_get_value_for_percentage_of_actors_gate
@@ -178,10 +178,10 @@ module Flipper
       end
 
       def test_converts_the_actor_value_to_a_string
-        assert_equal true,
-                     @adapter.enable(@feature, @actor_gate, Flipper::Types::Actor.new(Flipper::Actor.new(22)))
-        result = @adapter.get(@feature)
-        assert_equal Set['22'], result[:actors]
+        actor = Flipper::Actor.new(22)
+        refute @feature.enabled?(actor)
+        @feature.enable_actor actor
+        assert @feature.enabled?(actor)
       end
 
       def test_converts_group_value_to_a_string
@@ -292,9 +292,9 @@ module Flipper
 
       def test_can_double_enable_an_actor_without_error
         actor = Flipper::Actor.new('Flipper::Actor;22')
-        assert_equal true, @adapter.enable(@feature, @actor_gate, Flipper::Types::Actor.new(actor))
-        assert_equal true, @adapter.enable(@feature, @actor_gate, Flipper::Types::Actor.new(actor))
-        assert_equal Set['Flipper::Actor;22'], @adapter.get(@feature).fetch(:actors)
+        assert_equal true, @feature.enable(actor)
+        assert_equal true, @feature.enable(actor)
+        assert @feature.enabled?(actor)
       end
 
       def test_can_double_enable_a_group_without_error

data/lib/flipper/test_help.rb

@@ -1,17 +1,24 @@
 module Flipper
   module TestHelp
+    extend self
+
     def flipper_configure
-      # Create a single shared memory adapter instance for each test
-      @flipper_adapter = Flipper::Adapters::Memory.new
+      # Use a shared Memory adapter for all tests. This is instantiated outside of the
+      # `configure` block so the same instance is returned in new threads.
+      adapter = Flipper::Adapters::Memory.new
 
       Flipper.configure do |config|
-        config.adapter { @flipper_adapter }
+        config.adapter { adapter }
         config.default { Flipper.new(config.adapter) }
       end
     end
 
     def flipper_reset
-      Flipper.instance = nil # Reset previous flipper instance
+      # Remove all features
+      Flipper.features.each(&:remove) rescue nil
+
+      # Reset previous DSL instance
+      Flipper.instance = nil
     end
   end
 end
@@ -19,19 +26,17 @@ end
 if defined?(RSpec) && RSpec.respond_to?(:configure)
   RSpec.configure do |config|
     config.include Flipper::TestHelp
-    config.before(:each) do
-      flipper_reset
-      flipper_configure
-    end
+    config.before(:suite) { Flipper::TestHelp.flipper_configure }
+    config.before(:each) { flipper_reset }
   end
 end
-
 if defined?(ActiveSupport)
   ActiveSupport.on_load(:active_support_test_case) do
+    Flipper::TestHelp.flipper_configure
+
     ActiveSupport::TestCase.class_eval do
       include Flipper::TestHelp
 
-      setup :flipper_configure
       setup :flipper_reset
     end
   end

data/lib/flipper/typecast.rb

@@ -3,8 +3,8 @@ require "flipper/serializers/json"
 require "flipper/serializers/gzip"
 
 module Flipper
-  module Typecast
-    TruthMap = {
+  class Typecast
+    TRUTH_MAP = {
       true    => true,
       1       => true,
       'true'  => true,
@@ -15,7 +15,7 @@ module Flipper
     #
     # Returns true or false.
     def self.to_boolean(value)
-      !!TruthMap[value]
+      !!TRUTH_MAP[value]
     end
 
     # Internal: Convert value to an integer.

data/lib/flipper/version.rb

@@ -1,5 +1,5 @@
 module Flipper
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.0.pre'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

data/lib/flipper.rb

@@ -174,6 +174,7 @@ end
 
 require 'flipper/actor'
 require 'flipper/adapter'
+require 'flipper/adapters/wrapper'
 require 'flipper/adapters/memoizable'
 require 'flipper/adapters/memory'
 require 'flipper/adapters/strict'

data/package-lock.json

@@ -0,0 +1,41 @@
+{
+  "name": "flipper",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "hasInstallScript": true,
+      "dependencies": {
+        "@popperjs/core": "^2.11.8",
+        "bootstrap": "^5.3.3"
+      }
+    },
+    "node_modules/@popperjs/core": {
+      "version": "2.11.8",
+      "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.11.8.tgz",
+      "integrity": "sha512-P1st0aksCrn9sGZhp8GMYwBnQsbvAWsZAX44oXNNvLHGqAOcoVxmjZiohstwQ7SqKnbR47akdNi+uleWD8+g6A==",
+      "funding": {
+        "type": "opencollective",
+        "url": "https://opencollective.com/popperjs"
+      }
+    },
+    "node_modules/bootstrap": {
+      "version": "5.3.3",
+      "resolved": "https://registry.npmjs.org/bootstrap/-/bootstrap-5.3.3.tgz",
+      "integrity": "sha512-8HLCdWgyoMguSO9o+aH+iuZ+aht+mzW0u3HIMzVu7Srrpv7EBBxTnrFlSCskwdY1+EOFQSm7uMJhNQHkdPcmjg==",
+      "funding": [
+        {
+          "type": "github",
+          "url": "https://github.com/sponsors/twbs"
+        },
+        {
+          "type": "opencollective",
+          "url": "https://opencollective.com/bootstrap"
+        }
+      ],
+      "peerDependencies": {
+        "@popperjs/core": "^2.11.8"
+      }
+    }
+  }
+}

data/package.json

@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "dependencies": {
+    "@popperjs/core": "^2.11.8",
+    "bootstrap": "^5.3.3"
+  },
+  "scripts": {
+    "postinstall": "script/vendor-assets"
+  }
+}

data/spec/flipper/adapters/http_spec.rb

@@ -1,6 +1,15 @@
 require 'flipper/adapters/http'
 require 'flipper/adapters/pstore'
-require 'rack/handler/webrick'
+
+rack_handler = begin
+  # Rack 3+
+  require 'rackup/handler/webrick'
+  Rackup::Handler::WEBrick
+rescue LoadError
+  require 'rack/handler/webrick'
+  Rack::Handler::WEBrick
+end
+
 
 FLIPPER_SPEC_API_PORT = ENV.fetch('FLIPPER_SPEC_API_PORT', 9001).to_i
 
@@ -36,7 +45,7 @@ RSpec.describe Flipper::Adapters::Http do
           ],
         }
         @server = WEBrick::HTTPServer.new(server_options)
-        @server.mount '/', Rack::Handler::WEBrick, app
+        @server.mount '/', rack_handler, app
 
         Thread.new { @server.start }
         Timeout.timeout(1) { :wait until @started }

data/spec/flipper/cli_spec.rb

@@ -1,13 +1,33 @@
 require "flipper/cli"
 
 RSpec.describe Flipper::CLI do
+  let(:stdout) { StringIO.new }
+  let(:stderr) { StringIO.new }
+  let(:cli) { Flipper::CLI.new(stdout: stdout, stderr: stderr) }
+
+  before do
+    # Prentend stdout/stderr a TTY to test colorization
+    allow(stdout).to receive(:tty?).and_return(true)
+    allow(stderr).to receive(:tty?).and_return(true)
+  end
+
   # Infer the command from the description
   subject(:argv) do
     descriptions = self.class.parent_groups.map {|g| g.metadata[:description_args] }.reverse.flatten.drop(1)
     descriptions.map { |arg| Shellwords.split(arg) }.flatten
   end
 
-  subject { run argv }
+  subject do
+    status = 0
+
+    begin
+      cli.run(argv)
+    rescue SystemExit => e
+      status = e.status
+    end
+
+    OpenStruct.new(status: status, stdout: stdout.string, stderr: stderr.string)
+  end
 
   before do
     ENV["FLIPPER_REQUIRE"] = "./spec/fixtures/environment"
@@ -16,14 +36,14 @@ RSpec.describe Flipper::CLI do
   describe "enable" do
     describe "feature" do
       it do
-        expect(subject).to have_attributes(status: 0, stdout: /feature.*enabled/)
+        expect(subject).to have_attributes(status: 0, stdout: /feature.*\e\[32m.*enabled/)
         expect(Flipper).to be_enabled(:feature)
       end
     end
 
     describe "-a User;1 feature" do
       it do
-        expect(subject).to have_attributes(status: 0, stdout: /feature.*enabled.*User;1/m)
+        expect(subject).to have_attributes(status: 0, stdout: /feature.*\e\[33m.*enabled.*User;1/m)
         expect(Flipper).to be_enabled(:feature, Flipper::Actor.new("User;1"))
       end
     end
@@ -141,24 +161,4 @@ RSpec.describe Flipper::CLI do
       it { should have_attributes(status: 0, stdout: /enabled.*admins/m) }
     end
   end
-
-  def run(argv)
-    original_stdout = $stdout
-    original_stderr = $stderr
-
-    $stdout = StringIO.new
-    $stderr = StringIO.new
-    status = 0
-
-    begin
-      Flipper::CLI.run(argv)
-    rescue SystemExit => e
-      status = e.status
-    end
-
-    OpenStruct.new(status: status, stdout: $stdout.string, stderr: $stderr.string)
-  ensure
-    $stdout = original_stdout
-    $stderr = original_stderr
-  end
 end

data/spec/flipper/cloud/configuration_spec.rb

@@ -12,16 +12,16 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can set token from ENV var" do
-    with_env "FLIPPER_CLOUD_TOKEN" => "from_env" do
-      instance = described_class.new(required_options.reject { |k, v| k == :token })
-      expect(instance.token).to eq("from_env")
-    end
+    ENV["FLIPPER_CLOUD_TOKEN"] = "from_env"
+    instance = described_class.new(required_options.reject { |k, v| k == :token })
+    expect(instance.token).to eq("from_env")
   end
 
   it "can set instrumenter" do
     instrumenter = Object.new
     instance = described_class.new(required_options.merge(instrumenter: instrumenter))
-    expect(instance.instrumenter).to be(instrumenter)
+    expect(instance.instrumenter).to be_a(Flipper::Cloud::Telemetry::Instrumenter)
+    expect(instance.instrumenter.instrumenter).to be(instrumenter)
   end
 
   it "can set read_timeout" do
@@ -30,10 +30,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can set read_timeout from ENV var" do
-    with_env "FLIPPER_CLOUD_READ_TIMEOUT" => "9" do
-      instance = described_class.new(required_options.reject { |k, v| k == :read_timeout })
-      expect(instance.read_timeout).to eq(9)
-    end
+    ENV["FLIPPER_CLOUD_READ_TIMEOUT"] = "9"
+    instance = described_class.new(required_options.reject { |k, v| k == :read_timeout })
+    expect(instance.read_timeout).to eq(9)
   end
 
   it "can set open_timeout" do
@@ -42,10 +41,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can set open_timeout from ENV var" do
-    with_env "FLIPPER_CLOUD_OPEN_TIMEOUT" => "9" do
-      instance = described_class.new(required_options.reject { |k, v| k == :open_timeout })
-      expect(instance.open_timeout).to eq(9)
-    end
+    ENV["FLIPPER_CLOUD_OPEN_TIMEOUT"] = "9"
+    instance = described_class.new(required_options.reject { |k, v| k == :open_timeout })
+    expect(instance.open_timeout).to eq(9)
   end
 
   it "can set write_timeout" do
@@ -54,10 +52,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can set write_timeout from ENV var" do
-    with_env "FLIPPER_CLOUD_WRITE_TIMEOUT" => "9" do
-      instance = described_class.new(required_options.reject { |k, v| k == :write_timeout })
-      expect(instance.write_timeout).to eq(9)
-    end
+    ENV["FLIPPER_CLOUD_WRITE_TIMEOUT"] = "9"
+    instance = described_class.new(required_options.reject { |k, v| k == :write_timeout })
+    expect(instance.write_timeout).to eq(9)
   end
 
   it "can set sync_interval" do
@@ -66,10 +63,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can set sync_interval from ENV var" do
-    with_env "FLIPPER_CLOUD_SYNC_INTERVAL" => "15" do
-      instance = described_class.new(required_options.reject { |k, v| k == :sync_interval })
-      expect(instance.sync_interval).to eq(15)
-    end
+    ENV["FLIPPER_CLOUD_SYNC_INTERVAL"] = "15"
+    instance = described_class.new(required_options.reject { |k, v| k == :sync_interval })
+    expect(instance.sync_interval).to eq(15)
   end
 
   it "passes sync_interval into sync adapter" do
@@ -87,10 +83,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "defaults debug_output to STDOUT if FLIPPER_CLOUD_DEBUG_OUTPUT_STDOUT set to true" do
-    with_env "FLIPPER_CLOUD_DEBUG_OUTPUT_STDOUT" => "true" do
-      instance = described_class.new(required_options)
+    ENV["FLIPPER_CLOUD_DEBUG_OUTPUT_STDOUT"] = "true"
+    instance = described_class.new(required_options)
     expect(instance.debug_output).to eq(STDOUT)
-    end
   end
 
   it "defaults adapter block" do
@@ -128,10 +123,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can override URL using ENV var" do
-    with_env "FLIPPER_CLOUD_URL" => "https://example.com" do
-      instance = described_class.new(required_options.reject { |k, v| k == :url })
-      expect(instance.url).to eq("https://example.com")
-    end
+    ENV["FLIPPER_CLOUD_URL"] = "https://example.com"
+    instance = described_class.new(required_options.reject { |k, v| k == :url })
+    expect(instance.url).to eq("https://example.com")
   end
 
   it "defaults sync_method to :poll" do
@@ -150,12 +144,11 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "sets sync_method to :webhook if FLIPPER_CLOUD_SYNC_SECRET set" do
-    with_env "FLIPPER_CLOUD_SYNC_SECRET" => "abc" do
-      instance = described_class.new(required_options)
+    ENV["FLIPPER_CLOUD_SYNC_SECRET"] = "abc"
+    instance = described_class.new(required_options)
 
-      expect(instance.sync_method).to eq(:webhook)
-      expect(instance.adapter).to be_instance_of(Flipper::Adapters::DualWrite)
-    end
+    expect(instance.sync_method).to eq(:webhook)
+    expect(instance.adapter).to be_instance_of(Flipper::Adapters::DualWrite)
   end
 
   it "can set sync_secret" do
@@ -164,10 +157,9 @@ RSpec.describe Flipper::Cloud::Configuration do
   end
 
   it "can override sync_secret using ENV var" do
-    with_env "FLIPPER_CLOUD_SYNC_SECRET" => "from_env" do
-      instance = described_class.new(required_options.reject { |k, v| k == :sync_secret })
-      expect(instance.sync_secret).to eq("from_env")
-    end
+    ENV["FLIPPER_CLOUD_SYNC_SECRET"] = "from_env"
+    instance = described_class.new(required_options.reject { |k, v| k == :sync_secret })
+    expect(instance.sync_secret).to eq("from_env")
   end
 
   it "can sync with cloud" do

data/spec/flipper/cloud/telemetry/backoff_policy_spec.rb

@@ -49,19 +49,18 @@ RSpec.describe Flipper::Cloud::Telemetry::BackoffPolicy do
     end
 
     it "from env" do
-      env = {
+      ENV.update(
         "FLIPPER_BACKOFF_MIN_TIMEOUT_MS" => "1000",
         "FLIPPER_BACKOFF_MAX_TIMEOUT_MS" => "2000",
         "FLIPPER_BACKOFF_MULTIPLIER" => "1.9",
         "FLIPPER_BACKOFF_RANDOMIZATION_FACTOR" => "0.1",
-      }
-      with_env env do
-        policy = described_class.new
-        expect(policy.min_timeout_ms).to eq(1000)
-        expect(policy.max_timeout_ms).to eq(2000)
-        expect(policy.multiplier).to eq(1.9)
-        expect(policy.randomization_factor).to eq(0.1)
-      end
+      )
+
+      policy = described_class.new
+      expect(policy.min_timeout_ms).to eq(1000)
+      expect(policy.max_timeout_ms).to eq(2000)
+      expect(policy.multiplier).to eq(1.9)
+      expect(policy.randomization_factor).to eq(0.1)
     end
   end