flipper-active_record 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8f5a24abcc3c82a2335e17b796fa84721522eb92bf138ebab4146b58da7fdc
-  data.tar.gz: c39a1899083f55078e7ca28e23d8b1363609ca1322be6d4f32cfcd23922440e2
+  metadata.gz: e82da07ef8d67f32fbd0bd95cd69cf7fb2c2ab8788ed626b1cd79e6cd6e42329
+  data.tar.gz: 59465c6d945b524f1986a0062f80f0c3eaefdf54974a0800f03b59853edfb1f8
 SHA512:
-  metadata.gz: 16b65bea23bf718930e3509b47ba4719ba4baf93dd86bccf69b292130a7732eff1ab7ea9843c9d4a7342e8180cafd08513bcdd14997be5189e6923afe575e499
-  data.tar.gz: '01816a252d70e1a9c0bd7215893c54f6ac5dd9444cf9c86b571455edb9b45b0b6bae6072a1e678d283eb70c067a738071a7b7625ace489464dda551574a36121'
+  metadata.gz: 6e344370f349b7845b02e62a648bdbbd88bf3c335bd1e1c51d8ff0d4d41ed0cd71ee612fa3a0024ef1fc42ac9804b94608f8d3daf11f7ebce33e129d93797ddc
+  data.tar.gz: 86a3dee958e280c3fe2ee35f1fe0f4d29c5a0bcce6f830398bbc851e5d235ed318d10a3031972015834ce0d8c358321ac97d7dcb446e3ee24a3217081390d9d1

data/lib/flipper/adapters/active_record.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'securerandom'
 require 'flipper'
 require 'active_record'
 
@@ -7,34 +8,36 @@ module Flipper
     class ActiveRecord
       include ::Flipper::Adapter
 
-      # Abstract base class for internal models
-      class Model < ::ActiveRecord::Base
-        self.abstract_class = true
-      end
+      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
+        # 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"
+          has_many :gates, foreign_key: "feature_key", primary_key: "key"
 
-        validates :key, presence: true
-      end
+          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
+        # 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
+          validates :feature_key, presence: true
+          validates :key, presence: true
+        end
       end
 
       VALUE_TO_TEXT_WARNING = <<-EOS
@@ -70,14 +73,15 @@ module Flipper
       # Public: Adds a feature to the set of known features.
       def add(feature)
         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).exists?
-              begin
+          @feature_class.transaction(requires_new: true) do
+            begin
+              # race condition, but add is only used by enable/disable which happen
+              # super rarely, so it shouldn't matter in practice
+              unless @feature_class.where(key: feature.key).exists?
                 @feature_class.create!(key: feature.key)
-              rescue ::ActiveRecord::RecordNotUnique
               end
+            rescue ::ActiveRecord::RecordNotUnique
+              # already added
             end
           end
         end
@@ -128,14 +132,14 @@ module Flipper
       end
 
       def get_all
-        with_connection(@feature_class) do
+        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)
           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)
+          gates = connection.select_rows(rows_query)
 
           # group the gates by feature key
           grouped_gates = gates.inject({}) do |hash, (feature_key, key, value)|
@@ -218,10 +222,9 @@ module Flipper
         raise VALUE_TO_TEXT_WARNING if json_feature && value_not_text?
 
         with_connection(@gate_class) do
-          @gate_class.transaction do
+          @gate_class.transaction(requires_new: true) do
             clear(feature) if clear_feature
             delete(feature, gate)
-            @gate_class.where(feature_key: feature.key, key: gate.key).destroy_all
             begin
               @gate_class.create! do |g|
                 g.feature_key = feature.key
@@ -243,17 +246,21 @@ module Flipper
       end
 
       def enable_multi(feature, gate, thing)
-        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
+        with_connection(@gate_class) do |connection|
+          begin
+            connection.transaction(requires_new: true) do
+              @gate_class.create! do |g|
+                g.feature_key = feature.key
+                g.key = gate.key
+                g.value = thing.value.to_s
+              end
+            end
+          rescue ::ActiveRecord::RecordNotUnique
+            # already added so move on with life
           end
         end
 
         nil
-      rescue ::ActiveRecord::RecordNotUnique
-        # already added so no need move on with life
       end
 
       def result_for_gates(feature, gates)

data/lib/flipper/version.rb

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

data/spec/flipper/adapters/active_record_spec.rb

@@ -23,6 +23,7 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
     {
       "adapter" => "mysql2",
       "encoding" => "utf8mb4",
+      "host" => ENV["MYSQL_HOST"],
       "username" => ENV["MYSQL_USER"] || "root",
       "password" => ENV["MYSQL_PASSWORD"] || "",
       "database" => ENV["MYSQL_DATABASE"] || "flipper_test",
@@ -42,22 +43,17 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
       context "with tables created" do
         before(:all) do
           skip_on_error(ActiveRecord::ConnectionNotEstablished, "#{config['adapter']} not available") do
-            silence { ActiveRecord::Tasks::DatabaseTasks.create(config) }
+            silence do
+              ActiveRecord::Tasks::DatabaseTasks.create(config)
+            end
           end
 
           Flipper.configuration = nil
         end
 
         before(:each) do
-          skip_on_error(ActiveRecord::ConnectionNotEstablished, "#{config['adapter']} not available") do
-            ActiveRecord::Base.establish_connection(config)
-            CreateFlipperTables.migrate(:up)
-          end
-        end
-
-        after(:each) do
           ActiveRecord::Tasks::DatabaseTasks.purge(config)
-          ActiveRecord::Base.connection.close
+          CreateFlipperTables.migrate(:up)
         end
 
         after(:all) do
@@ -79,6 +75,20 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
           flipper.preload([:foo])
         end
 
+        it 'should not poison wrapping transactions' do
+          flipper = Flipper.new(subject)
+
+          actor = Struct.new(:flipper_id).new('flipper-id-123')
+          flipper.enable_actor(:foo, actor)
+
+          ActiveRecord::Base.transaction do
+            flipper.enable_actor(:foo, actor)
+            # any read on the next line is fine, just need to ensure that
+            # poisoned transaction isn't raised
+            expect(Flipper::Adapters::ActiveRecord::Gate.count).to eq(1)
+          end
+        end
+
         context "ActiveRecord connection_pool" do
           before do
             ActiveRecord::Base.connection_handler.clear_active_connections!
@@ -215,18 +225,39 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
         end
       end
 
-      it "works when table doesn't exist" do
+      context "without tables created" do
+        before(:all) do
+          skip_on_error(ActiveRecord::ConnectionNotEstablished, "#{config['adapter']} not available") do
+            silence do
+              ActiveRecord::Tasks::DatabaseTasks.create(config)
+            end
+          end
+
+          Flipper.configuration = nil
+        end
+
+        before(:each) do
+          ActiveRecord::Base.establish_connection(config)
+        end
+
+        after(:each) do
+          ActiveRecord::Base.connection.close
+        end
 
-        Flipper.configuration = nil
-        Flipper.instance = nil
+        after(:all) do
+          silence { ActiveRecord::Tasks::DatabaseTasks.drop(config) } unless $skip
+        end
 
-        Flipper::Adapters.send(:remove_const, :ActiveRecord) if Flipper::Adapters.const_defined?(:ActiveRecord)
+        it "does not raise an error" do
+          Flipper.configuration = nil
+          Flipper.instance = nil
 
-        silence do
-          expect {
-            load 'flipper/adapters/active_record.rb'
-            Flipper::Adapters::ActiveRecord.new
-          }.not_to raise_error
+          silence do
+            expect {
+              load 'flipper/adapters/active_record.rb'
+              Flipper::Adapters::ActiveRecord.new
+            }.not_to raise_error
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - John Nunemaker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 2024-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +74,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
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -90,7 +90,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: ActiveRecord feature flag adapter for Flipper