flipper 1.3.0.pre → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71c902902ad6e2d1b19483496c257b82a67b0bdf37784c986ac24b41068000e
-  data.tar.gz: df8f571c809de456976c5b8f2adae3e1c2dc443589211a4c83a89130620d8219
+  metadata.gz: 29d129fae3234365cc1a38cbe05d41ee04ce2d7bd350ae05f2a3b1546ec757b2
+  data.tar.gz: 184b524b7d42865e223d6018a4ff366553e54f1395723ded4ff1804d6e27f325
 SHA512:
-  metadata.gz: d38bf2b382419e985d9a8bd4f6f650b27d880952f1cecfe2943e3cc2ce72e09843a8bf45b4cd833af40865b5438a3486d7dba72d6c02d197c7a98423d33dd12e
-  data.tar.gz: c67f1b896463545dd60582652d6eaffb7cf4b7e544a7d231bb83a2cc91e2c674c9de13f8a8a4a2e7966fa889792b6a34338782718c49c84a38ace66d7bde9deb
+  metadata.gz: a5776ffb099fb4908635146bccd533bdae4cafe708946d1d8f9f3e0876f9bbc94d29971fd938fd471fc463dab41c2deb11c1b2f56e873fdbe0151b235974e42e
+  data.tar.gz: 649abbcce3d804cdc141fbd74d6279ddb0a54d4ed506b6c594182adcf44ce459b4e9c3aa74005dc772da54bfcb9bcf8f324a3565c06493d090885c1f53339ed6

data/.github/workflows/ci.yml

@@ -70,7 +70,7 @@ jobs:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@v1.10.0
+        uses: supercharge/mongodb-github-action@1.11.0
         with:
           mongodb-version: 4.0
       - name: Check out repository code

data/.github/workflows/examples.yml

@@ -52,7 +52,7 @@ jobs:
       - name: Setup memcached
         uses: KeisukeYamashita/memcached-actions@v1
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@v1.10.0
+        uses: supercharge/mongodb-github-action@1.11.0
         with:
           mongodb-version: 4.0
       - name: Check out repository code

data/README.md

@@ -1,6 +1,6 @@
 [![Flipper Mark](docs/images/banner.jpg)](https://www.flippercloud.io)
 
-[Website](https://flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=website_link) | [Documentation](https://flippercloud.io/docs?utm_source=oss&utm_medium=readme&utm_campaign=docs_link) | [Examples](examples) | [Twitter](https://twitter.com/flipper_cloud) | [Ruby.social](https://ruby.social/@flipper)
+[Website](https://flippercloud.io?utm_source=oss&utm_medium=readme&utm_campaign=website_link) | [Documentation](https://flippercloud.io/docs?utm_source=oss&utm_medium=readme&utm_campaign=docs_link) | [Examples](examples) | [Chat](https://chat.flippercloud.io/join/xjHq-aJsA-BeZH) | [Twitter](https://twitter.com/flipper_cloud) | [Ruby.social](https://ruby.social/@flipper)
 
 # Flipper
 
@@ -112,3 +112,4 @@ We also have a [free plan](https://www.flippercloud.io?utm_source=oss&utm_medium
 | ![@thetimbanks](https://avatars1.githubusercontent.com/u/471801?s=64)  | [@thetimbanks](https://github.com/thetimbanks) | ui          |
 | ![@lazebny](https://avatars1.githubusercontent.com/u/6276766?s=64)     | [@lazebny](https://github.com/lazebny)         | docker      |
 | ![@pagertree](https://avatars.githubusercontent.com/u/24941240?s=64)   | [@pagertree](https://github.com/pagertree)   | sponsor     |
+| ![@kdaigle](https://avatars.githubusercontent.com/u/2501?s=64)   | [@kdaigle](https://github.com/kdaigle)   | sponsor     |

data/Rakefile

@@ -17,7 +17,7 @@ end
 
 desc 'Tags version, pushes to remote, and pushes gem'
 task release: :build do
-  sh 'git', 'tag', "v#{Flipper::VERSION}"
+  # sh 'git', 'tag', "v#{Flipper::VERSION}"
   sh 'git push origin main'
   sh "git push origin v#{Flipper::VERSION}"
   puts "\nWhat OTP code should be used?"

data/lib/flipper/adapter_builder.rb

@@ -3,7 +3,7 @@ module Flipper
   #
   #   adapter = Flipper::AdapterBuilder.new do
   #     use Flipper::Adapters::Strict
-  #     use Flipper::Adapters::Memoizer
+  #     use Flipper::Adapters::Memoizable
   #     store Flipper::Adapters::Memory
   #   end.to_adapter
   #

data/lib/flipper/adapters/actor_limit.rb

@@ -0,0 +1,28 @@
+module Flipper
+  module Adapters
+    class ActorLimit < Wrapper
+      LimitExceeded = Class.new(Flipper::Error)
+
+      attr_reader :limit
+
+      def initialize(adapter, limit = 100)
+        super(adapter)
+        @limit = limit
+      end
+
+      def enable(feature, gate, resource)
+        if gate.is_a?(Flipper::Gates::Actor) && over_limit?(feature)
+          raise LimitExceeded, "Actor limit of #{@limit} exceeded for feature #{feature.key}. See https://www.flippercloud.io/docs/features/actors#limitations"
+        else
+          super
+        end
+      end
+
+      private
+
+      def over_limit?(feature)
+        feature.actors_value.size >= @limit
+      end
+    end
+  end
+end

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

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

data/lib/flipper.rb

@@ -175,10 +175,11 @@ 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/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/strict_spec.rb

@@ -29,13 +29,13 @@ RSpec.describe Flipper::Adapters::Strict do
 
     context "#get" do
       it "raises an error for unknown feature" do
-        expect(silence { subject.get(feature) }).to match(/Could not find feature "unknown"/)
+        expect(capture_output { subject.get(feature) }).to match(/Could not find feature "unknown"/)
       end
     end
 
     context "#get_multi" do
       it "raises an error for unknown feature" do
-        expect(silence { subject.get_multi([feature]) }).to match(/Could not find feature "unknown"/)
+        expect(capture_output { subject.get_multi([feature]) }).to match(/Could not find feature "unknown"/)
       end
     end
   end

data/spec/flipper/engine_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Flipper::Engine do
 
   let(:config) { application.config.flipper }
 
-  subject { application.initialize! }
+  subject { SpecHelpers.silence { application.initialize! } }
 
   shared_examples 'config.strict' do
     let(:adapter) { Flipper.adapter.adapter }
@@ -53,7 +53,7 @@ RSpec.describe Flipper::Engine do
       ENV['FLIPPER_STRICT'] = 'false'
       subject
       expect(config.strict).to eq(false)
-      expect(adapter).to be_instance_of(Flipper::Adapters::Memory)
+      expect(adapter).not_to be_instance_of(Flipper::Adapters::Strict)
     end
 
     [true, :raise, :warn].each do |value|
@@ -69,7 +69,7 @@ RSpec.describe Flipper::Engine do
       initializer { config.strict = false }
       subject
       expect(config.strict).to eq(false)
-      expect(adapter).to be_instance_of(Flipper::Adapters::Memory)
+      expect(adapter).not_to be_instance_of(Flipper::Adapters::Strict)
     end
 
     it "defaults to strict=:warn in RAILS_ENV=development" do
@@ -85,7 +85,7 @@ RSpec.describe Flipper::Engine do
         expect(Rails.env).to eq(env)
         subject
         expect(config.strict).to eq(false)
-        expect(adapter).to be_instance_of(Flipper::Adapters::Memory)
+        expect(adapter).not_to be_instance_of(Flipper::Adapters::Strict)
       end
     end
 
@@ -233,7 +233,7 @@ RSpec.describe Flipper::Engine do
     it "initializes cloud configuration" do
       stub_request(:get, /flippercloud\.io/).to_return(status: 200, body: "{}")
 
-      application.initialize!
+      silence { application.initialize! }
 
       expect(Flipper.instance).to be_a(Flipper::Cloud::DSL)
       expect(Flipper.instance.instrumenter).to be_a(Flipper::Cloud::Telemetry::Instrumenter)
@@ -263,7 +263,7 @@ RSpec.describe Flipper::Engine do
       }
 
       it "configures webhook app" do
-        application.initialize!
+        silence { application.initialize! }
 
         stub = stub_request(:get, "https://www.flippercloud.io/adapter/features?exclude_gate_names=true").with({
           headers: { "flipper-cloud-token" => ENV["FLIPPER_CLOUD_TOKEN"] },
@@ -278,7 +278,7 @@ RSpec.describe Flipper::Engine do
 
     context "without CLOUD_SYNC_SECRET" do
       it "does not configure webhook app" do
-        application.initialize!
+        silence { application.initialize! }
 
         post "/_flipper"
         expect(last_response.status).to eq(404)
@@ -288,7 +288,7 @@ RSpec.describe Flipper::Engine do
     context "without FLIPPER_CLOUD_TOKEN" do
       it "gracefully skips configuring webhook app" do
         ENV["FLIPPER_CLOUD_TOKEN"] = nil
-        application.initialize!
+        silence { application.initialize! }
         expect(Flipper.instance).to be_a(Flipper::DSL)
 
         post "/_flipper"
@@ -324,7 +324,7 @@ RSpec.describe Flipper::Engine do
     end
 
     it "enables cloud" do
-      application.initialize!
+      silence { application.initialize! }
       expect(ENV["FLIPPER_CLOUD_TOKEN"]).to eq("credentials-token")
       expect(ENV["FLIPPER_CLOUD_SYNC_SECRET"]).to eq("credentials-secret")
       expect(Flipper.instance).to be_a(Flipper::Cloud::DSL)
@@ -337,6 +337,33 @@ RSpec.describe Flipper::Engine do
     expect(ActiveRecord::Base.ancestors).to include(Flipper::Model::ActiveRecord)
   end
 
+  describe "config.actor_limit" do
+    let(:adapter) do
+      silence { application.initialize! }
+      Flipper.adapter.adapter.adapter
+    end
+
+    it "defaults to 100" do
+      expect(adapter).to be_instance_of(Flipper::Adapters::ActorLimit)
+      expect(adapter.limit).to eq(100)
+    end
+
+    it "can be set from FLIPPER_ACTOR_LIMIT env" do
+      ENV["FLIPPER_ACTOR_LIMIT"] = "500"
+      expect(adapter.limit).to eq(500)
+    end
+
+    it "can be set from an initializer" do
+      initializer { config.actor_limit = 99 }
+      expect(adapter.limit).to eq(99)
+    end
+
+    it "can be disabled from an initializer" do
+      initializer { config.actor_limit = false }
+      expect(adapter).not_to be_instance_of(Flipper::Adapters::ActorLimit)
+    end
+  end
+
   # Add app initializer in the same order as config/initializers/*
   def initializer(&block)
     application.initializer 'spec', before: :load_config_initializers do

data/spec/flipper/middleware/memoizer_spec.rb

@@ -285,7 +285,7 @@ RSpec.describe Flipper::Middleware::Memoizer do
     end
 
     def get(uri, params = {}, env = {}, &block)
-      silence { super(uri, params, env, &block) }
+      capture_output { super(uri, params, env, &block) }
     end
 
     include_examples 'flipper middleware'

data/spec/spec_helper.rb

@@ -27,6 +27,9 @@ ENV["FLIPPER_CLOUD_LOGGING_ENABLED"] = "false"
 
 RSpec.configure do |config|
   config.before(:example) do
+    # default stub for telemetry
+    stub_request(:post, "https://www.flippercloud.io/adapter/telemetry").
+      to_return(status: 200, body: "", headers: {})
     Flipper::Cloud::Telemetry.reset if defined?(Flipper::Cloud::Telemetry) && Flipper::Cloud::Telemetry.respond_to?(:reset)
     Flipper::Poller.reset if defined?(Flipper::Poller)
     Flipper.unregister_groups

data/spec/support/fail_on_output.rb

@@ -1,7 +1,7 @@
 if ENV["CI"] || ENV["FAIL_ON_OUTPUT"]
   RSpec.configure do |config|
     config.around do |example|
-      output = silence { example.run }
+      output = capture_output { example.run }
       fail "Use `silence { }` to avoid printing to STDOUT/STDERR\n#{output}" unless output.empty?
     end
   end

data/spec/support/spec_helpers.rb

@@ -79,11 +79,22 @@ module SpecHelpers
     original_stdout = $stdout
 
     # Redirect stderr and stdout
-    output = $stderr = $stdout = StringIO.new
+    $stderr = $stdout = StringIO.new
+
+    yield
+  ensure
+    $stderr = original_stderr
+    $stdout = original_stdout
+  end
+
+  def capture_output
+    original_stderr = $stderr
+    original_stdout = $stdout
+
+    output = $stdout = $stderr = StringIO.new
 
     yield
 
-    # Return output
     output.string
   ensure
     $stderr = original_stderr

data/test/adapters/actor_limit_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+require "flipper/test/shared_adapter_test"
+require "flipper/adapters/actor_limit"
+
+class Flipper::Adapters::ActorLimitTest < MiniTest::Test
+  prepend Flipper::Test::SharedAdapterTests
+
+  def setup
+    @memory = Flipper::Adapters::Memory.new
+    @adapter = Flipper::Adapters::ActorLimit.new(@memory, 5)
+  end
+
+  def test_enable_fails_when_limit_exceeded
+    5.times { |i| @feature.enable Flipper::Actor.new("User;#{i}") }
+
+    assert_raises Flipper::Adapters::ActorLimit::LimitExceeded do
+      @feature.enable Flipper::Actor.new("User;6")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper
 version: !ruby/object:Gem::Version
-  version: 1.3.0.pre
+  version: 1.3.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -90,6 +90,7 @@ files:
 - lib/flipper/actor.rb
 - lib/flipper/adapter.rb
 - lib/flipper/adapter_builder.rb
+- lib/flipper/adapters/actor_limit.rb
 - lib/flipper/adapters/cache_base.rb
 - lib/flipper/adapters/dual_write.rb
 - lib/flipper/adapters/failover.rb
@@ -203,6 +204,7 @@ files:
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_builder_spec.rb
 - spec/flipper/adapter_spec.rb
+- spec/flipper/adapters/actor_limit_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/failover_spec.rb
 - spec/flipper/adapters/failsafe_spec.rb
@@ -296,6 +298,7 @@ files:
 - spec/support/fake_udp_socket.rb
 - spec/support/skippable.rb
 - spec/support/spec_helpers.rb
+- test/adapters/actor_limit_test.rb
 - test/adapters/memory_test.rb
 - test/adapters/pstore_test.rb
 - test/test_helper.rb
@@ -311,7 +314,7 @@ metadata:
   homepage_uri: https://www.flippercloud.io
   source_code_uri: https://github.com/flippercloud/flipper
   bug_tracker_uri: https://github.com/flippercloud/flipper/issues
-  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.0.pre
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -327,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Beautiful, performant feature flags for Ruby and Rails.
@@ -338,6 +341,7 @@ test_files:
 - spec/flipper/actor_spec.rb
 - spec/flipper/adapter_builder_spec.rb
 - spec/flipper/adapter_spec.rb
+- spec/flipper/adapters/actor_limit_spec.rb
 - spec/flipper/adapters/dual_write_spec.rb
 - spec/flipper/adapters/failover_spec.rb
 - spec/flipper/adapters/failsafe_spec.rb
@@ -431,6 +435,7 @@ test_files:
 - spec/support/fake_udp_socket.rb
 - spec/support/skippable.rb
 - spec/support/spec_helpers.rb
+- test/adapters/actor_limit_test.rb
 - test/adapters/memory_test.rb
 - test/adapters/pstore_test.rb
 - test/test_helper.rb