flipper-active_record 1.3.4 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae15abe1a25ef415ec5f7783b24192ae52cbf86b6d8e8026a7b23d3182db2ea3
-  data.tar.gz: 92c793efbd0539545f73d363f61df2f3a43d949aafb0bb303ecb5d8a747e660a
+  metadata.gz: f251eeb1ae6e73d21f21c239cd933d954ef39072cdb5014af3ae7e61e821cfbd
+  data.tar.gz: 46c6c7b74fee1d6d6b5ee6f9b859161949a79dbe808145a1126cfea2177fc287
 SHA512:
-  metadata.gz: a01ae2b84eea1af1a46ed86a0727a38418ec88682fddf0e8829e340f39e368adf7e3451e07b05efc423d874cc6bf70910bfc7afe61267db84c6e8ef90d6f1764
-  data.tar.gz: 280adedbab88143432826be99f65e17673f9bc0012ddb4c89392b32c6dd2c6ec9ce71a68bf1f79dce2347a631afc5d0f3804092ddbd2d6ef6906fb2af6142534
+  metadata.gz: 712df678bfdad895ebe0130a008968a8f0cbc951acc847f0cb82870137fecb08ad3f836d29c53fcc008dafa2ca30539f8fdaf22fb363e2980e40286ab1e1ba75
+  data.tar.gz: 6d4b9665760bec901ab35e61c8eb284b8d79368adc3152f8792e3290ca7c81b5a94515d633e17eaceae5499b1fd3c73192fd34d31a2a3d4e29c3b32a62b56b14

data/lib/flipper/adapters/active_record/feature.rb

@@ -0,0 +1,20 @@
+require 'flipper/adapters/active_record/model'
+
+module Flipper
+  module Adapters
+    class ActiveRecord
+      # Private: Do not use outside of this adapter.
+      class Feature < Model
+        self.table_name = [
+          Model.table_name_prefix,
+          "flipper_features",
+          Model.table_name_suffix,
+        ].join
+
+        has_many :gates, foreign_key: "feature_key", primary_key: "key"
+
+        validates :key, presence: true
+      end
+    end
+  end
+end

data/lib/flipper/adapters/active_record/gate.rb

@@ -0,0 +1,19 @@
+require 'flipper/adapters/active_record/model'
+
+module Flipper
+  module Adapters
+    class ActiveRecord
+      # Private: Do not use outside of this adapter.
+      class Gate < Model
+        self.table_name = [
+          Model.table_name_prefix,
+          "flipper_gates",
+          Model.table_name_suffix,
+        ].join
+
+        validates :feature_key, presence: true
+        validates :key, presence: true
+      end
+    end
+  end
+end

data/lib/flipper/adapters/active_record/model.rb

@@ -0,0 +1,9 @@
+module Flipper
+  module Adapters
+    class ActiveRecord
+      class Model < ::ActiveRecord::Base
+        self.abstract_class = true
+      end
+    end
+  end
+end

data/lib/flipper/adapters/active_record.rb

@@ -2,46 +2,17 @@ require 'set'
 require 'securerandom'
 require 'flipper'
 require 'active_record'
+require_relative 'active_record/model'
+require_relative 'active_record/feature'
+require_relative 'active_record/gate'
 
 module Flipper
   module Adapters
     class ActiveRecord
       include ::Flipper::Adapter
 
-      ActiveSupport.on_load(:active_record) do
-        # Abstract base class for internal models
-        class Model < ::ActiveRecord::Base
-          self.abstract_class = true
-        end
-
-        # Private: Do not use outside of this adapter.
-        class Feature < Model
-          self.table_name = [
-            Model.table_name_prefix,
-            "flipper_features",
-            Model.table_name_suffix,
-          ].join
-
-          has_many :gates, foreign_key: "feature_key", primary_key: "key"
-
-          validates :key, presence: true
-        end
-
-        # Private: Do not use outside of this adapter.
-        class Gate < Model
-          self.table_name = [
-            Model.table_name_prefix,
-            "flipper_gates",
-            Model.table_name_suffix,
-          ].join
-
-          validates :feature_key, presence: true
-          validates :key, presence: true
-        end
-      end
-
       VALUE_TO_TEXT_WARNING = <<-EOS
-        Your database needs migrated to use the latest Flipper features.
+        Your database needs to be migrated to use the latest Flipper features.
         Run `rails generate flipper:update` and `rails db:migrate`.
       EOS
 
@@ -59,10 +30,8 @@ module Flipper
       # can roll your own tables and what not, if you so desire.
       def initialize(options = {})
         @name = options.fetch(:name, :active_record)
-        @feature_class = options.fetch(:feature_class) { Feature }
-        @gate_class = options.fetch(:gate_class) { Gate }
-
-        warn VALUE_TO_TEXT_WARNING if value_not_text?
+        @feature_class = options.fetch(:feature_class) { Flipper::Adapters::ActiveRecord::Feature }
+        @gate_class = options.fetch(:gate_class) { Flipper::Adapters::ActiveRecord::Gate }
       end
 
       # Public: The set of known features.
@@ -72,7 +41,7 @@ module Flipper
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        with_connection(@feature_class) do
+        with_write_connection(@feature_class) do
           @feature_class.transaction(requires_new: true) do
             begin
               # race condition, but add is only used by enable/disable which happen
@@ -91,7 +60,7 @@ module Flipper
 
       # Public: Removes a feature from the set of known features.
       def remove(feature)
-        with_connection(@feature_class) do
+        with_write_connection(@feature_class) do
           @feature_class.transaction do
             @feature_class.where(key: feature.key).destroy_all
             clear(feature)
@@ -102,7 +71,7 @@ module Flipper
 
       # Public: Clears the gate values for a feature.
       def clear(feature)
-        with_connection(@gate_class) { @gate_class.where(feature_key: feature.key).destroy_all }
+        with_write_connection(@gate_class) { @gate_class.where(feature_key: feature.key).destroy_all }
         true
       end
 
@@ -131,7 +100,7 @@ module Flipper
         end
       end
 
-      def get_all
+      def get_all(**kwargs)
         with_connection(@feature_class) do |connection|
           # query the gates from the db in a single query
           features = ::Arel::Table.new(@feature_class.table_name.to_sym)
@@ -154,6 +123,7 @@ module Flipper
           features.each do |feature|
             result[feature.key] = result_for_gates(feature, grouped_gates[feature.key])
           end
+          result.default_proc = nil
           result
         end
       end
@@ -196,9 +166,11 @@ module Flipper
         when :integer
           set(feature, gate, thing)
         when :json
-          delete(feature, gate)
+          with_write_connection(@gate_class) do
+            delete(feature, gate)
+          end
         when :set
-          with_connection(@gate_class) do
+          with_write_connection(@gate_class) do
             @gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).destroy_all
           end
         else
@@ -221,7 +193,7 @@ module Flipper
 
         raise VALUE_TO_TEXT_WARNING if json_feature && value_not_text?
 
-        with_connection(@gate_class) do
+        with_write_connection(@gate_class) do
           @gate_class.transaction(requires_new: true) do
             clear(feature) if clear_feature
             delete(feature, gate)
@@ -246,7 +218,7 @@ module Flipper
       end
 
       def enable_multi(feature, gate, thing)
-        with_connection(@gate_class) do |connection|
+        with_write_connection(@gate_class) do |connection|
           begin
             connection.transaction(requires_new: true) do
               @gate_class.create! do |g|
@@ -289,15 +261,43 @@ module Flipper
       # Check if value column is text instead of string
       # See https://github.com/flippercloud/flipper/pull/692
       def value_not_text?
-        @gate_class.column_for_attribute(:value).type != :text
+        with_connection(@gate_class) do |connection|
+          @gate_class.column_for_attribute(:value).type != :text
+        end
       rescue ::ActiveRecord::ActiveRecordError => error
         # If the table doesn't exist, the column doesn't exist either
         warn "#{error.message}. You likely need to run `rails g flipper:active_record` and/or `rails db:migrate`."
       end
 
       def with_connection(model = @feature_class, &block)
+        warn VALUE_TO_TEXT_WARNING if !warned_about_value_not_text? && value_not_text?
         model.connection_pool.with_connection(&block)
       end
+
+      def with_write_connection(model = @feature_class, &block)
+        # Use Rails' built-in method to find the class that controls the connection
+        # This walks up the inheritance chain to find which class called connects_to
+        if model.respond_to?(:connection_class_for_self)
+          connection_class = model.connection_class_for_self
+
+          # Only use connected_to if this class actually has connects_to configured
+          # connection_class? returns true when connects_to was called on the class
+          if connection_class.respond_to?(:connection_class?) && connection_class.connection_class?
+            connection_class.connected_to(role: :writing) do
+              with_connection(model, &block)
+            end
+          else
+            with_connection(model, &block)
+          end
+        else
+          with_connection(model, &block)
+        end
+      end
+
+      def warned_about_value_not_text?
+        return @warned_about_value_not_text if defined?(@warned_about_value_not_text)
+        @warned_about_value_not_text = true
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,5 +1,5 @@
 module Flipper
-  VERSION = '1.3.4'.freeze
+  VERSION = '1.4.2'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

data/spec/flipper/adapters/active_record_spec.rb

@@ -94,36 +94,36 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
 
         context "ActiveRecord connection_pool" do
           before do
-            ActiveRecord::Base.connection_handler.clear_active_connections!
+            clear_active_connections!
           end
 
           context "#features" do
             it "does not hold onto connections" do
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.features
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
             end
 
             it "does not release previously held connection" do
               ActiveRecord::Base.connection # establish a new connection
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.features
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
             end
           end
 
           context "#get_all" do
             it "does not hold onto connections" do
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.get_all
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
             end
 
             it "does not release previously held connection" do
               ActiveRecord::Base.connection # establish a new connection
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.get_all
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
             end
           end
 
@@ -131,24 +131,24 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
             let(:feature) { Flipper::Feature.new(:search, subject) }
 
             it "does not hold onto connections" do
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.add(feature)
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.remove(feature)
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.clear(feature)
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
             end
 
             it "does not release previously held connection" do
               ActiveRecord::Base.connection # establish a new connection
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.add(feature)
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.remove(feature)
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.clear(feature)
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
             end
           end
 
@@ -156,16 +156,16 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
             let(:feature) { Flipper::Feature.new(:search, subject) }
 
             it "does not hold onto connections" do
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.get_multi([feature])
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
             end
 
             it "does not release previously held connection" do
               ActiveRecord::Base.connection # establish a new connection
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.get_multi([feature])
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
             end
           end
 
@@ -174,20 +174,20 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
             let(:gate) { feature.gate(:boolean)}
 
             it "does not hold onto connections" do
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.enable(feature, gate, gate.wrap(true))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.disable(feature, gate, gate.wrap(false))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
             end
 
             it "does not release previously held connection" do
               ActiveRecord::Base.connection # establish a new connection
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.enable(feature, gate, gate.wrap(true))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.disable(feature, gate, gate.wrap(false))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
             end
           end
 
@@ -196,20 +196,118 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
             let(:gate) { feature.gate(:group) }
 
             it "does not hold onto connections" do
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.enable(feature, gate, gate.wrap(:admin))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
               subject.disable(feature, gate, gate.wrap(:admin))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+              expect(active_connections?).to be(false)
             end
 
             it "does not release previously held connection" do
               ActiveRecord::Base.connection # establish a new connection
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.enable(feature, gate, gate.wrap(:admin))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
               subject.disable(feature, gate, gate.wrap(:admin))
-              expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+              expect(active_connections?).to be(true)
+            end
+          end
+        end
+
+        if ActiveRecord.version >= Gem::Version.new('7.1')
+          context 'with read/write roles' do
+            before do
+              skip "connected_to with roles is not supported on #{config['adapter']}" if config["adapter"] == "sqlite3"
+            end
+
+            let(:abstract_class) do
+              # Create a named abstract class (Rails requires names for connects_to)
+              klass = Class.new(ActiveRecord::Base) do
+                self.abstract_class = true
+              end
+              stub_const('TestApplicationRecord', klass)
+
+              # Now configure connects_to with the same database for both roles
+              # In production, these would be different (primary/replica)
+              klass.connects_to database: {
+                writing: config,
+                reading: config
+              }
+
+              klass
+            end
+
+            after do
+              # Disconnect role-based connections to avoid interfering with database cleanup
+              clear_all_connections!
+            end
+
+            let(:feature_class) do
+              klass = Class.new(abstract_class) do
+                self.table_name = 'flipper_features'
+                validates :key, presence: true
+              end
+              stub_const('TestFeature', klass)
+              klass
+            end
+
+            let(:gate_class) do
+              klass = Class.new(abstract_class) do
+                self.table_name = 'flipper_gates'
+              end
+              stub_const('TestGate', klass)
+              klass
+            end
+
+            let(:adapter_with_roles) do
+              described_class.new(
+                feature_class: feature_class,
+                gate_class: gate_class
+              )
+            end
+
+            it 'can perform write operations when forced to reading role' do
+              abstract_class.connected_to(role: :reading) do
+                flipper = Flipper.new(adapter_with_roles)
+
+                feature = flipper[:test_feature]
+                expect { feature.enable }.not_to raise_error
+                expect(feature.enabled?).to be(true)
+                expect { feature.disable }.not_to raise_error
+                expect(feature.enabled?).to be(false)
+
+                feature = flipper[:actor_test]
+                actor = Struct.new(:flipper_id).new(123)
+                expect { feature.enable_actor(actor) }.not_to raise_error
+                expect(feature.enabled?(actor)).to be(true)
+                expect { feature.disable_actor(actor) }.not_to raise_error
+                expect(feature.enabled?(actor)).to be(false)
+
+                feature = flipper[:gate_test]
+                expect { feature.enable_percentage_of_time(50) }.not_to raise_error
+                expect { feature.disable_percentage_of_time }.not_to raise_error
+                feature.enable
+                expect { feature.remove }.not_to raise_error
+
+                feature = flipper[:expression_test]
+                expression = Flipper.property(:plan).eq("premium")
+                expect { feature.enable_expression(expression) }.not_to raise_error
+                expect(feature.expression).to eq(expression)
+                expect { feature.disable_expression }.not_to raise_error
+                expect(feature.expression).to be_nil
+              end
+            end
+
+            it 'does not hold onto connections during write operations' do
+              clear_active_connections!
+
+              abstract_class.connected_to(role: :reading) do
+                flipper = Flipper.new(adapter_with_roles)
+                feature = flipper[:connection_test]
+
+                feature.enable
+                expect(active_connections?).to be(false)
+              end
             end
           end
         end
@@ -265,4 +363,19 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
       end
     end
   end
+
+  def active_connections?
+    method = ActiveRecord::Base.connection_handler.method(:active_connections?)
+    method.arity == 0 ? method.call : method.call(:all)
+  end
+
+  def clear_active_connections!
+    method = ActiveRecord::Base.connection_handler.method(:clear_active_connections!)
+    method.arity == 0 ? method.call : method.call(:all)
+  end
+
+  def clear_all_connections!
+    method = ActiveRecord::Base.connection_handler.method(:clear_all_connections!)
+    method.arity == 0 ? method.call : method.call(:all)
+  end
 end

data/test/adapters/active_record_test.rb

@@ -47,8 +47,16 @@ class ActiveRecordTest < MiniTest::Test
     ActiveRecord::Base.table_name_prefix = :foo_
     ActiveRecord::Base.table_name_suffix = :_bar
 
+    # Remove constants so they get redefined with new prefix/suffix
+    Flipper::Adapters::ActiveRecord.send(:remove_const, :Model) if Flipper::Adapters::ActiveRecord.const_defined?(:Model)
+    Flipper::Adapters::ActiveRecord.send(:remove_const, :Feature) if Flipper::Adapters::ActiveRecord.const_defined?(:Feature)
+    Flipper::Adapters::ActiveRecord.send(:remove_const, :Gate) if Flipper::Adapters::ActiveRecord.const_defined?(:Gate)
     Flipper::Adapters.send(:remove_const, :ActiveRecord)
+
     load("flipper/adapters/active_record.rb")
+    load("flipper/adapters/active_record/model.rb")
+    load("flipper/adapters/active_record/feature.rb")
+    load("flipper/adapters/active_record/gate.rb")
 
     assert_equal "foo_flipper_features_bar", Flipper::Adapters::ActiveRecord::Feature.table_name
     assert_equal "foo_flipper_gates_bar", Flipper::Adapters::ActiveRecord::Gate.table_name
@@ -57,7 +65,15 @@ class ActiveRecordTest < MiniTest::Test
     ActiveRecord::Base.table_name_prefix = ""
     ActiveRecord::Base.table_name_suffix = ""
 
+    # Remove constants so they get redefined with reset prefix/suffix
+    Flipper::Adapters::ActiveRecord.send(:remove_const, :Model) if Flipper::Adapters::ActiveRecord.const_defined?(:Model)
+    Flipper::Adapters::ActiveRecord.send(:remove_const, :Feature) if Flipper::Adapters::ActiveRecord.const_defined?(:Feature)
+    Flipper::Adapters::ActiveRecord.send(:remove_const, :Gate) if Flipper::Adapters::ActiveRecord.const_defined?(:Gate)
     Flipper::Adapters.send(:remove_const, :ActiveRecord)
+
     load("flipper/adapters/active_record.rb")
+    load("flipper/adapters/active_record/model.rb")
+    load("flipper/adapters/active_record/feature.rb")
+    load("flipper/adapters/active_record/gate.rb")
   end
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.4.2
 platform: ruby
 authors:
 - John Nunemaker
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2026-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -15,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 1.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -43,6 +44,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
+description:
 email: support@flippercloud.io
 executables: []
 extensions: []
@@ -59,6 +61,9 @@ files:
 - flipper-active_record.gemspec
 - lib/flipper-active_record.rb
 - lib/flipper/adapters/active_record.rb
+- lib/flipper/adapters/active_record/feature.rb
+- lib/flipper/adapters/active_record/gate.rb
+- lib/flipper/adapters/active_record/model.rb
 - lib/flipper/version.rb
 - lib/generators/flipper/active_record_generator.rb
 - lib/generators/flipper/templates/migration.erb
@@ -73,8 +78,9 @@ 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.4
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.4.2
   funding_uri: https://github.com/sponsors/flippercloud
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -89,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: ActiveRecord feature flag adapter for Flipper
-test_files:
-- spec/flipper/adapters/active_record_spec.rb
-- test/adapters/active_record_test.rb
+test_files: []