flipper 1.2.2 → 1.3.0

data/lib/flipper/cloud/telemetry/instrumenter.rb

@@ -3,9 +3,11 @@ require "delegate"
 module Flipper
   module Cloud
     class Telemetry
-      class Instrumenter < SimpleDelegator
+      class Instrumenter
+        attr_reader :instrumenter
+
         def initialize(cloud_configuration, instrumenter)
-          super instrumenter
+          @instrumenter = instrumenter
           @cloud_configuration = cloud_configuration
         end
 
@@ -14,12 +16,6 @@ module Flipper
           @cloud_configuration.telemetry.record(name, payload)
           return_value
         end
-
-        private
-
-        def instrumenter
-          __getobj__
-        end
       end
     end
   end

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

@@ -25,6 +25,7 @@ module Flipper
         log: ENV.fetch('FLIPPER_LOG', 'true').casecmp('true').zero?,
         cloud_path: "_flipper",
         strict: default_strict_value,
+        actor_limit: ENV["FLIPPER_ACTOR_LIMIT"]&.to_i || 100,
         test_help: Flipper::Typecast.to_boolean(ENV["FLIPPER_TEST_HELP"] || Rails.env.test?),
       )
     end
@@ -65,13 +66,12 @@ module Flipper
       end
     end
 
-    initializer "flipper.strict", after: :load_config_initializers do |app|
+    initializer "flipper.adapters", after: :load_config_initializers do |app|
       flipper = app.config.flipper
 
-      if flipper.strict
-        Flipper.configure do |config|
-          config.use Flipper::Adapters::Strict, flipper.strict
-        end
+      Flipper.configure do |config|
+        config.use Flipper::Adapters::Strict, flipper.strict if flipper.strict
+        config.use Flipper::Adapters::ActorLimit, flipper.actor_limit if flipper.actor_limit
       end
     end
 

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/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.2'.freeze
+  VERSION = '1.3.0'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

data/lib/flipper.rb

@@ -174,10 +174,12 @@ end
 
 require 'flipper/actor'
 require 'flipper/adapter'
+require 'flipper/adapters/wrapper'
+require 'flipper/adapters/actor_limit'
+require 'flipper/adapters/instrumented'
 require 'flipper/adapters/memoizable'
 require 'flipper/adapters/memory'
 require 'flipper/adapters/strict'
-require 'flipper/adapters/instrumented'
 require 'flipper/adapter_builder'
 require 'flipper/configuration'
 require 'flipper/dsl'

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

@@ -0,0 +1,20 @@
+require "flipper/adapters/actor_limit"
+
+RSpec.describe Flipper::Adapters::ActorLimit do
+  it_should_behave_like 'a flipper adapter' do
+    let(:limit) { 5 }
+    let(:adapter) { Flipper::Adapters::ActorLimit.new(Flipper::Adapters::Memory.new, limit) }
+
+    subject { adapter }
+
+    describe '#enable' do
+      it "fails when limit exceeded" do
+        5.times { |i| feature.enable Flipper::Actor.new("User;#{i}") }
+
+        expect {
+          feature.enable Flipper::Actor.new("User;6")
+        }.to raise_error(Flipper::Adapters::ActorLimit::LimitExceeded)
+      end
+    end
+  end
+end

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"
@@ -141,49 +161,4 @@ RSpec.describe Flipper::CLI do
       it { should have_attributes(status: 0, stdout: /enabled.*admins/m) }
     end
   end
-
-  context "bundler is not installed" do
-    let(:argv) { "list" }
-
-    around do |example|
-      original_bundler = Bundler
-      begin
-        Object.send(:remove_const, :Bundler)
-        example.run
-      ensure
-        Object.const_set(:Bundler, original_bundler)
-      end
-    end
-
-    it "should not raise an error" do
-      Flipper.enable(:enabled_feature)
-      Flipper.enable_group(:enabled_groups, :admins)
-      Flipper.add(:disabled_feature)
-
-      expect(subject).to have_attributes(status: 0, stdout: /enabled_feature.*enabled_groups.*disabled_feature/m)
-    end
-  end
-
-  def run(argv)
-    original_stdout = $stdout
-    original_stderr = $stderr
-
-    $stdout = StringIO.new
-    $stderr = StringIO.new
-    status = 0
-
-    # Prentend this a TTY so we can test colorization
-    allow($stdout).to receive(:tty?).and_return(true)
-
-    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

@@ -20,7 +20,8 @@ RSpec.describe Flipper::Cloud::Configuration do
   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

data/spec/flipper/cloud/telemetry_spec.rb

@@ -2,6 +2,12 @@ require 'flipper/cloud/telemetry'
 require 'flipper/cloud/configuration'
 
 RSpec.describe Flipper::Cloud::Telemetry do
+  before do
+    # Stub polling for features.
+    stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").
+      to_return(status: 200, body: "{}")
+  end
+
   it "phones home and does not update telemetry interval if missing" do
     stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
       to_return(status: 200, body: "{}")
@@ -42,6 +48,52 @@ RSpec.describe Flipper::Cloud::Telemetry do
     expect(stub).to have_been_requested
   end
 
+  it "phones home and requests shutdown if telemetry-shutdown header is true" do
+    stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
+      to_return(status: 404, body: "{}", headers: {"telemetry-shutdown" => "true"})
+
+    output = StringIO.new
+    cloud_configuration = Flipper::Cloud::Configuration.new(
+      token: "test",
+      logger: Logger.new(output),
+      logging_enabled: true,
+    )
+
+    # Record some telemetry and stop the threads so we submit a response.
+    telemetry = described_class.new(cloud_configuration)
+    telemetry.record(Flipper::Feature::InstrumentationName, {
+      operation: :enabled?,
+      feature_name: :foo,
+      result: true,
+    })
+    telemetry.stop
+    expect(stub).to have_been_requested
+    expect(output.string).to match(/action=telemetry_shutdown message=The server has requested that telemetry be shut down./)
+  end
+
+  it "phones home and does not shutdown if telemetry shutdown header is missing" do
+    stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
+      to_return(status: 404, body: "{}", headers: {})
+
+    output = StringIO.new
+    cloud_configuration = Flipper::Cloud::Configuration.new(
+      token: "test",
+      logger: Logger.new(output),
+      logging_enabled: true,
+    )
+
+    # Record some telemetry and stop the threads so we submit a response.
+    telemetry = described_class.new(cloud_configuration)
+    telemetry.record(Flipper::Feature::InstrumentationName, {
+      operation: :enabled?,
+      feature_name: :foo,
+      result: true,
+    })
+    telemetry.stop
+    expect(stub).to have_been_requested
+    expect(output.string).not_to match(/action=telemetry_shutdown message=The server has requested that telemetry be shut down./)
+  end
+
   it "can update telemetry interval from error" do
     stub = stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
       to_return(status: 500, body: "{}", headers: {"telemetry-interval" => "120"})

data/spec/flipper/cloud_spec.rb

@@ -36,7 +36,8 @@ RSpec.describe Flipper::Cloud do
       expect(client.uri.host).to eq('www.flippercloud.io')
       expect(client.uri.path).to eq('/adapter')
       expect(client.headers["flipper-cloud-token"]).to eq(token)
-      expect(@instance.instrumenter).to be(Flipper::Instrumenters::Noop)
+      expect(@instance.instrumenter).to be_a(Flipper::Cloud::Telemetry::Instrumenter)
+      expect(@instance.instrumenter.instrumenter).to be(Flipper::Instrumenters::Noop)
     end
   end
 
@@ -62,7 +63,8 @@ RSpec.describe Flipper::Cloud do
   it 'can set instrumenter' do
     instrumenter = Flipper::Instrumenters::Memory.new
     instance = described_class.new(token: 'asdf', 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 'allows wrapping adapter with another adapter like the instrumenter' do