flipper 1.3.0.pre → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b71c902902ad6e2d1b19483496c257b82a67b0bdf37784c986ac24b41068000e
-  data.tar.gz: df8f571c809de456976c5b8f2adae3e1c2dc443589211a4c83a89130620d8219
+  metadata.gz: 934e0e50f2aea9b4294ed435a780f5eb55ad8b547df9c80f609022b880a4dd9c
+  data.tar.gz: 8799605783af26860795d336a66d511f35b0f644424aca80cd3f81baaadc6475
 SHA512:
-  metadata.gz: d38bf2b382419e985d9a8bd4f6f650b27d880952f1cecfe2943e3cc2ce72e09843a8bf45b4cd833af40865b5438a3486d7dba72d6c02d197c7a98423d33dd12e
-  data.tar.gz: c67f1b896463545dd60582652d6eaffb7cf4b7e544a7d231bb83a2cc91e2c674c9de13f8a8a4a2e7966fa889792b6a34338782718c49c84a38ace66d7bde9deb
+  metadata.gz: d0e041360e5d15966dd4f4a39be10616aff35dd56a7491297adce42b8d13d3ba7126feaf2d3798194c72fac73afad7e2355379ff51e40481f4a0ee25c49e6c8a
+  data.tar.gz: c16307b9a21775b1db67e9fd99c72c5206e7b0d6e0324e7625f349228757aea1243be676ba838ac0b853a7a48469fe8536da41085982556c0492ad985daf51ca

data/README.md

@@ -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/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.0'.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/engine_spec.rb

@@ -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
 
@@ -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
+      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/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.0
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-04-17 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.0
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -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