flipper-active_record 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd8f5a24abcc3c82a2335e17b796fa84721522eb92bf138ebab4146b58da7fdc
-  data.tar.gz: c39a1899083f55078e7ca28e23d8b1363609ca1322be6d4f32cfcd23922440e2
+  metadata.gz: 6db1458b33ebce656ac2fd6a0aadeb5e2547b5cd346644ec64cf54034f93a461
+  data.tar.gz: ab9c8dee420bef036736f998a99411a89c70cdc794cdb96ec0af355a5a682902
 SHA512:
-  metadata.gz: 16b65bea23bf718930e3509b47ba4719ba4baf93dd86bccf69b292130a7732eff1ab7ea9843c9d4a7342e8180cafd08513bcdd14997be5189e6923afe575e499
-  data.tar.gz: '01816a252d70e1a9c0bd7215893c54f6ac5dd9444cf9c86b571455edb9b45b0b6bae6072a1e678d283eb70c067a738071a7b7625ace489464dda551574a36121'
+  metadata.gz: 4f8a73e94ebfdb0b1547ec276880c3c57e1b79320036af3f75c34bf6e8a1743b3a245351f5eaed5f4f4ed643a9bec6c8cec8954d1e2ac91ae71660b00c5a079d
+  data.tar.gz: a39fbf5b9517806fbaf22e303663ddd33e0a974d7e9913f5793c4ac3ef74cf9aa23782d4dacdad256b672c3a4dcc65b12aabb8520c30490147bf10449039631b

data/examples/active_record/ar_setup.rb

@@ -28,3 +28,18 @@ SQL
 ActiveRecord::Base.connection.execute <<-SQL
   CREATE UNIQUE INDEX index_gates_on_keys_and_value on flipper_gates (feature_key, key, value)
 SQL
+
+ActiveRecord::Base.connection.execute <<-SQL
+  CREATE TABLE users (
+    id integer PRIMARY KEY,
+    name string NOT NULL,
+    influencer boolean,
+    created_at datetime NOT NULL,
+    updated_at datetime NOT NULL
+  )
+SQL
+
+require 'flipper/model/active_record'
+class User < ActiveRecord::Base
+  include Flipper::Model::ActiveRecord
+end

data/examples/active_record/group_migration.rb

@@ -0,0 +1,68 @@
+# This is an example script that shows how to migrate from a bunch of individual
+# actors to a group. Should be useful for those who have ended up with large
+# actor sets and want to slim them down for performance reasons.
+
+require_relative "./ar_setup"
+require 'flipper/adapters/active_record'
+require 'active_support/all'
+
+# 1. enable feature for 100 actors, make 80 influencers
+users = 100.times.map do |n|
+  influencer = n < 80 ? true : false
+  user = User.create(name: n, influencer: influencer)
+  Flipper.enable :stats, user
+  user
+end
+
+# check enabled, should all be because individual actors are enabled
+print 'Should be [[true, 100]]: '
+print users.group_by { |user| Flipper.enabled?(:stats, user) }.map { |result, users| [result, users.size]}
+puts
+
+# 2. register a group so flipper knows what to do with it
+Flipper.register(:influencers) do |actor, context|
+  actor.respond_to?(:influencer) && actor.influencer
+end
+
+# 3. enable group for feature, THIS IS IMPORTANT
+Flipper.enable :stats, :influencers
+
+# check enabled again, should all still be true because individual actors are
+# enabled, but also the group gate would return true for 80 influencers. At this
+# point, it's kind of double true but flipper just cares if any gate returns true.
+print 'Should be [[true, 100]]: '
+print users.group_by { |user| Flipper.enabled?(:stats, user) }.map { |result, users| [result, users.size]}
+puts
+
+# 4. now we want to clean up the actors that are covered by the group to slim down
+# the actor set size. So we loop through actors and remove them if group returns
+# true for the provided actor and context.
+Flipper[:stats].actors_value.each do |flipper_id|
+  # Hydrate the flipper_id into an active record object. Modify this based on
+  # your flipper_id's if you use anything other than active record models and
+  # the default flipper_id provided by flipper.
+  class_name, id = flipper_id.split(';')
+  klass = class_name.constantize
+  user = klass.find(id)
+
+  # if user is in group then disable for actor because they'll still get the feature
+  context = Flipper::FeatureCheckContext.new(
+    feature_name: :stats,
+    values: Flipper[:stats].gate_values,
+    actors: [Flipper::Types::Actor.wrap(user)]
+  )
+
+  if Flipper::Gates::Group.new.open?(context)
+    Flipper.disable(:stats, user)
+  end
+end
+
+# check enabled again, should be the same result as previous checks
+print 'Should be [[true, 100]]: '
+print users.group_by { |user| Flipper.enabled?(:stats, user) }.map { |result, users| [result, users.size]}
+puts
+
+puts "Actors enabled: #{Flipper[:stats].actors_value.size}"
+puts "Groups enabled: #{Flipper[:stats].groups_value.size}"
+
+puts "All actors that could be migrated to groups were migrated. Yay!"

data/flipper-active_record.gemspec

@@ -32,5 +32,5 @@ Gem::Specification.new do |gem|
   gem.metadata      = Flipper::METADATA
 
   gem.add_dependency 'flipper', "~> #{Flipper::VERSION}"
-  gem.add_dependency 'activerecord', '>= 4.2', '< 8'
+  gem.add_dependency 'activerecord', '>= 4.2', '< 9'
 end

data/lib/flipper/adapters/active_record.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'securerandom'
 require 'flipper'
 require 'active_record'
 
@@ -7,7 +8,6 @@ module Flipper
     class ActiveRecord
       include ::Flipper::Adapter
 
-      # Abstract base class for internal models
       class Model < ::ActiveRecord::Base
         self.abstract_class = true
       end
@@ -38,7 +38,7 @@ module Flipper
       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
 
@@ -56,10 +56,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.
@@ -70,14 +68,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 +127,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 +217,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 +241,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)
@@ -282,15 +284,23 @@ 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 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.0'.freeze
+  VERSION = '1.3.5'.freeze
 
   REQUIRED_RUBY_VERSION = '2.6'.freeze
   NEXT_REQUIRED_RUBY_VERSION = '3.0'.freeze

data/spec/flipper/adapters/active_record_spec.rb

@@ -9,9 +9,10 @@ RSpec.describe Flipper::Adapters::ActiveRecord do
 
   before(:all) do
     # Eval migration template so we can run migration against each database
-    migration = ERB.new(File.read(File.join(File.dirname(__FILE__), '../../../lib/generators/flipper/templates/migration.erb')))
+    template_path = File.join(File.dirname(__FILE__), '../../../lib/generators/flipper/templates/migration.erb')
+    migration = ERB.new(File.read(template_path))
     migration_version = "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-    eval migration.result(binding) # defines CreateFlipperTables
+    eval migration.result_with_hash(migration_version: migration_version) # defines CreateFlipperTables
   end
 
   [
@@ -23,6 +24,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,24 +44,21 @@ 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)
+          silence do
+            ActiveRecord::Tasks::DatabaseTasks.purge(config)
             CreateFlipperTables.migrate(:up)
           end
         end
 
-        after(:each) do
-          ActiveRecord::Tasks::DatabaseTasks.purge(config)
-          ActiveRecord::Base.connection.close
-        end
-
         after(:all) do
           silence { ActiveRecord::Tasks::DatabaseTasks.drop(config) } unless $skip
         end
@@ -79,6 +78,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 +228,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
-        Flipper.instance = nil
+          Flipper.configuration = nil
+        end
+
+        before(:each) do
+          ActiveRecord::Base.establish_connection(config)
+        end
 
-        Flipper::Adapters.send(:remove_const, :ActiveRecord) if Flipper::Adapters.const_defined?(:ActiveRecord)
+        after(:each) do
+          ActiveRecord::Base.connection.close
+        end
 
-        silence do
-          expect {
-            load 'flipper/adapters/active_record.rb'
-            Flipper::Adapters::ActiveRecord.new
-          }.not_to raise_error
+        after(:all) do
+          silence { ActiveRecord::Tasks::DatabaseTasks.drop(config) } unless $skip
+        end
+
+        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
+          end
         end
       end
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flipper-active_record
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - John Nunemaker
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flipper
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -33,7 +32,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,8 +42,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
-description:
+        version: '9'
 email: support@flippercloud.io
 executables: []
 extensions: []
@@ -56,6 +54,7 @@ files:
 - examples/active_record/ar_setup.rb
 - examples/active_record/basic.rb
 - examples/active_record/cached.rb
+- examples/active_record/group_migration.rb
 - examples/active_record/internals.rb
 - flipper-active_record.gemspec
 - lib/flipper-active_record.rb
@@ -74,8 +73,8 @@ 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
-post_install_message:
+  changelog_uri: https://github.com/flippercloud/flipper/releases/tag/v1.3.5
+  funding_uri: https://github.com/sponsors/flippercloud
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: ActiveRecord feature flag adapter for Flipper
 test_files: