flipper-active_record 0.26.0 → 0.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96994023a61be27a5bb30418c7bc367c82689ee4f964bb838996b84ff93e4725
-  data.tar.gz: 3fbd092338493aaa9da024517e35a2daef1c176526858b94bb93ccafa3c876a9
+  metadata.gz: f2bf01c33aad4266b0237775c779d6b3b19d01d43adff566c82c1ddb26fb76f5
+  data.tar.gz: 34ba1e6bded36a3352031c82b9f32d34abbb5f8781eb28b15f7aa450cbd02cbd
 SHA512:
-  metadata.gz: 2d1d74510fbba3f6b933c277c7747d2e0057e26aefb472889ef7dc463f80316cd7e8d0a9dd2f4d7916888b2bf40266ecb68dd84889f38efab59b058885d54c2c
-  data.tar.gz: f885cc037bfd91646b895056b54802ec512d56c1a670c98fa93d67d7c8de3b39bd1e5512ce630fc95e71c1db604ca69430a5aca1cf962d6de322d100c00a4ceb
+  metadata.gz: 303520e21a9e3f71284d72bb817032df8849b5bee213e4a42924ab5e90af1f38e82734830fba40d11c0b6e91962b134838e80d181f4c7482f306f64651222bf6
+  data.tar.gz: f9b371acc123a5a7cc8e901d40db474a83f706d886496512b9f24c298d0a8e621c2e394b3b38f8bddc5b92966d7ab594f38c1b83912026eac967133dccd1eb2d

data/benchmark/active_record_adapter_ips.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require_relative './active_record_setup'
+require 'flipper'
+require 'flipper/adapters/active_record'
+require 'benchmark/ips'
+
+flipper = Flipper.new(Flipper::Adapters::ActiveRecord.new)
+
+2000.times do |i|
+  flipper.enable_actor :foo, Flipper::Actor.new("User;#{i}")
+end
+
+Benchmark.ips do |x|
+  x.report("get_all") { flipper.preload_all }
+end

data/benchmark/active_record_ips.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require_relative './active_record_setup'
+require 'flipper'
+require 'flipper/adapters/active_record'
+require 'benchmark/ips'
+
+flipper = Flipper.new(Flipper::Adapters::ActiveRecord.new)
+
+2000.times do |i|
+  flipper.enable_actor :foo, Flipper::Actor.new("User;#{i}")
+end
+
+Benchmark.ips do |x|
+  x.report("all") { Flipper::Adapters::ActiveRecord::Gate.where(feature_key: "foo".freeze).load }
+  x.report("pluck") { Flipper::Adapters::ActiveRecord::Gate.where(feature_key: "foo".freeze).pluck(:key, :value) }
+  x.compare!
+end

data/benchmark/active_record_setup.rb

@@ -0,0 +1,31 @@
+require 'bundler/setup'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+  adapter: 'sqlite3',
+  database: ':memory:',
+})
+
+ActiveRecord::Base.connection.execute <<-SQL
+  CREATE TABLE flipper_features (
+    id integer PRIMARY KEY,
+    key text NOT NULL UNIQUE,
+    created_at datetime NOT NULL,
+    updated_at datetime NOT NULL
+  )
+SQL
+
+ActiveRecord::Base.connection.execute <<-SQL
+  CREATE TABLE flipper_gates (
+    id integer PRIMARY KEY,
+    feature_key text NOT NULL,
+    key text NOT NULL,
+    value text DEFAULT NULL,
+    created_at datetime NOT NULL,
+    updated_at datetime NOT NULL
+  )
+SQL
+
+ActiveRecord::Base.connection.execute <<-SQL
+  CREATE UNIQUE INDEX index_gates_on_keys_and_value on flipper_gates (feature_key, key, value)
+SQL

data/lib/flipper/adapters/active_record.rb

@@ -53,18 +53,20 @@ module Flipper
 
       # Public: The set of known features.
       def features
-        @feature_class.all.map(&:key).to_set
+        with_connection(@feature_class) { @feature_class.all.map(&:key).to_set }
       end
 
       # Public: Adds a feature to the set of known features.
       def add(feature)
-        # race condition, but add is only used by enable/disable which happen
-        # super rarely, so it shouldn't matter in practice
-        @feature_class.transaction do
-          unless @feature_class.where(key: feature.key).first
-            begin
-              @feature_class.create! { |f| f.key = feature.key }
-            rescue ::ActiveRecord::RecordNotUnique
+        with_connection(@feature_class) do
+          # race condition, but add is only used by enable/disable which happen
+          # super rarely, so it shouldn't matter in practice
+          @feature_class.transaction do
+            unless @feature_class.where(key: feature.key).first
+              begin
+                @feature_class.create! { |f| f.key = feature.key }
+              rescue ::ActiveRecord::RecordNotUnique
+              end
             end
           end
         end
@@ -74,16 +76,18 @@ module Flipper
 
       # Public: Removes a feature from the set of known features.
       def remove(feature)
-        @feature_class.transaction do
-          @feature_class.where(key: feature.key).destroy_all
-          clear(feature)
+        with_connection(@feature_class) do
+          @feature_class.transaction do
+            @feature_class.where(key: feature.key).destroy_all
+            clear(feature)
+          end
         end
         true
       end
 
       # Public: Clears the gate values for a feature.
       def clear(feature)
-        @gate_class.where(feature_key: feature.key).destroy_all
+        with_connection(@gate_class) { @gate_class.where(feature_key: feature.key).destroy_all }
         true
       end
 
@@ -91,35 +95,52 @@ module Flipper
       #
       # Returns a Hash of Flipper::Gate#key => value.
       def get(feature)
-        db_gates = @gate_class.where(feature_key: feature.key)
-        result_for_feature(feature, db_gates)
+        gates = with_connection(@gate_class) { @gate_class.where(feature_key: feature.key).pluck(:key, :value) }
+        result_for_gates(feature, gates)
       end
 
       def get_multi(features)
-        db_gates = @gate_class.where(feature_key: features.map(&:key))
-        grouped_db_gates = db_gates.group_by(&:feature_key)
-        result = {}
-        features.each do |feature|
-          result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key])
+        with_connection(@gate_class) do
+          gates = @gate_class.where(feature_key: features.map(&:key)).pluck(:feature_key, :key, :value)
+          grouped_gates = gates.inject({}) do |hash, (feature_key, key, value)|
+            hash[feature_key] ||= []
+            hash[feature_key] << [key, value]
+            hash
+          end
+
+          result = {}
+          features.each do |feature|
+            result[feature.key] = result_for_gates(feature, grouped_gates[feature.key])
+          end
+          result
         end
-        result
       end
 
       def get_all
-        features = ::Arel::Table.new(@feature_class.table_name.to_sym)
-        gates = ::Arel::Table.new(@gate_class.table_name.to_sym)
-        rows_query = features.join(gates, Arel::Nodes::OuterJoin)
-          .on(features[:key].eq(gates[:feature_key]))
-          .project(features[:key].as('feature_key'), gates[:key], gates[:value])
-        rows = @feature_class.connection.select_all rows_query
-        db_gates = rows.map { |row| @gate_class.new(row) }
-        grouped_db_gates = db_gates.group_by(&:feature_key)
-        result = Hash.new { |hash, key| hash[key] = default_config }
-        features = grouped_db_gates.keys.map { |key| Flipper::Feature.new(key, self) }
-        features.each do |feature|
-          result[feature.key] = result_for_feature(feature, grouped_db_gates[feature.key])
+        with_connection(@feature_class) do
+          # query the gates from the db in a single query
+          features = ::Arel::Table.new(@feature_class.table_name.to_sym)
+          gates = ::Arel::Table.new(@gate_class.table_name.to_sym)
+          rows_query = features.join(gates, ::Arel::Nodes::OuterJoin)
+            .on(features[:key].eq(gates[:feature_key]))
+            .project(features[:key].as('feature_key'), gates[:key], gates[:value])
+          gates = @feature_class.connection.select_rows(rows_query)
+
+          # group the gates by feature key
+          grouped_gates = gates.inject({}) do |hash, (feature_key, key, value)|
+            hash[feature_key] ||= []
+            hash[feature_key] << [key, value]
+            hash
+          end
+
+          # build up the result hash
+          result = Hash.new { |hash, key| hash[key] = default_config }
+          features = grouped_gates.keys.map { |key| Flipper::Feature.new(key, self) }
+          features.each do |feature|
+            result[feature.key] = result_for_gates(feature, grouped_gates[feature.key])
+          end
+          result
         end
-        result
       end
 
       # Public: Enables a gate for a given thing.
@@ -158,7 +179,9 @@ module Flipper
         when :integer
           set(feature, gate, thing)
         when :set
-          @gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).destroy_all
+          with_connection(@gate_class) do
+            @gate_class.where(feature_key: feature.key, key: gate.key, value: thing.value).destroy_all
+          end
         else
           unsupported_data_type gate.data_type
         end
@@ -175,18 +198,20 @@ module Flipper
 
       def set(feature, gate, thing, options = {})
         clear_feature = options.fetch(:clear, false)
-        @gate_class.transaction do
-          clear(feature) if clear_feature
-          @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
-          begin
-            @gate_class.create! do |g|
-              g.feature_key = feature.key
-              g.key = gate.key
-              g.value = thing.value.to_s
+        with_connection(@gate_class) do
+          @gate_class.transaction do
+            clear(feature) if clear_feature
+            @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
+            begin
+              @gate_class.create! do |g|
+                g.feature_key = feature.key
+                g.key = gate.key
+                g.value = thing.value.to_s
+              end
+            rescue ::ActiveRecord::RecordNotUnique
+              # assume this happened concurrently with the same thing and its fine
+              # see https://github.com/jnunemaker/flipper/issues/544
             end
-          rescue ::ActiveRecord::RecordNotUnique
-            # assume this happened concurrently with the same thing and its fine
-            # see https://github.com/jnunemaker/flipper/issues/544
           end
         end
 
@@ -194,10 +219,12 @@ module Flipper
       end
 
       def enable_multi(feature, gate, thing)
-        @gate_class.create! do |g|
-          g.feature_key = feature.key
-          g.key = gate.key
-          g.value = thing.value.to_s
+        with_connection(@gate_class) do
+          @gate_class.create! do |g|
+            g.feature_key = feature.key
+            g.key = gate.key
+            g.value = thing.value.to_s
+          end
         end
 
         nil
@@ -205,28 +232,32 @@ module Flipper
         # already added so no need move on with life
       end
 
-      def result_for_feature(feature, db_gates)
-        db_gates ||= []
+      def result_for_gates(feature, gates)
         result = {}
+        gates ||= []
         feature.gates.each do |gate|
           result[gate.key] =
             case gate.data_type
             when :boolean
-              if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
-                detected_db_gate.value
+              if row = gates.detect { |key, value| !key.nil? && key.to_sym == gate.key }
+                row.last
               end
             when :integer
-              if detected_db_gate = db_gates.detect { |db_gate| db_gate.key == gate.key.to_s }
-                detected_db_gate.value
+              if row = gates.detect { |key, value| !key.nil? && key.to_sym == gate.key }
+                row.last
               end
             when :set
-              db_gates.select { |db_gate| db_gate.key == gate.key.to_s }.map(&:value).to_set
+              gates.select { |key, value| !key.nil? && key.to_sym == gate.key }.map(&:last).to_set
             else
               unsupported_data_type gate.data_type
             end
         end
         result
       end
+
+      def with_connection(model = @feature_class, &block)
+        model.connection_pool.with_connection(&block)
+      end
     end
   end
 end

data/lib/flipper/version.rb

@@ -1,3 +1,3 @@
 module Flipper
-  VERSION = '0.26.0'.freeze
+  VERSION = '0.26.2'.freeze
 end

data/spec/flipper/adapters/active_record_spec.rb

@@ -57,4 +57,126 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
       expect(Flipper.adapter.adapter).to be_a(Flipper::Adapters::ActiveRecord)
     end
   end
+
+  context "ActiveRecord connection_pool" do
+    before do
+      ActiveRecord::Base.clear_active_connections!
+    end
+
+    context "#features" do
+      it "does not hold onto connections" do
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.features
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.features
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.get_all
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.get_all
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+      end
+    end
+
+    context "#add / #remove / #clear" 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)
+        subject.add(feature)
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.remove(feature)
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.clear(feature)
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.add(feature)
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+        subject.remove(feature)
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+        subject.clear(feature)
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+      end
+    end
+
+    context "#get_multi" 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)
+        subject.get_multi([feature])
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.get_multi([feature])
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+      end
+    end
+
+    context "#enable/#disable boolean" do
+      let(:feature) { Flipper::Feature.new(:search, subject) }
+      let(:gate) { feature.gate(:boolean)}
+
+      it "does not hold onto connections" do
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.enable(feature, gate, gate.wrap(true))
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.disable(feature, gate, gate.wrap(false))
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.enable(feature, gate, gate.wrap(true))
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+        subject.disable(feature, gate, gate.wrap(false))
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+      end
+    end
+
+    context "#enable/#disable set" do
+      let(:feature) { Flipper::Feature.new(:search, subject) }
+      let(:gate) { feature.gate(:group) }
+
+      it "does not hold onto connections" do
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.enable(feature, gate, gate.wrap(:admin))
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(false)
+        subject.disable(feature, gate, gate.wrap(:admin))
+        expect(ActiveRecord::Base.connection_handler.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)
+        subject.enable(feature, gate, gate.wrap(:admin))
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+        subject.disable(feature, gate, gate.wrap(:admin))
+        expect(ActiveRecord::Base.connection_handler.active_connections?).to be(true)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.26.2
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.26.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.0
+        version: 0.26.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- benchmark/active_record_adapter_ips.rb
+- benchmark/active_record_ips.rb
+- benchmark/active_record_setup.rb
 - examples/active_record/ar_setup.rb
 - examples/active_record/basic.rb
 - examples/active_record/internals.rb