online_migrations 0.10.0 → 0.11.0

data/lib/online_migrations/utils.rb

@@ -27,51 +27,15 @@ module OnlineMigrations
         Kernel.warn("[online_migrations] #{message}")
       end
 
-      def supports_multiple_dbs?
-        # Technically, Active Record 6.0+ supports multiple databases,
-        # but we can not get the database spec name for this version.
-        ar_version >= 6.1
-      end
-
-      def migration_parent
-        if ar_version <= 4.2
-          ActiveRecord::Migration
-        else
-          ActiveRecord::Migration[ar_version]
-        end
-      end
-
-      def migration_parent_string
-        if ar_version <= 4.2
-          "ActiveRecord::Migration"
-        else
-          "ActiveRecord::Migration[#{ar_version}]"
-        end
-      end
-
-      def model_parent_string
-        if ar_version >= 5.0
-          "ApplicationRecord"
-        else
-          "ActiveRecord::Base"
-        end
-      end
-
-      def define_model(table_name, connection = ActiveRecord::Base.connection)
+      def define_model(table_name)
         Class.new(ActiveRecord::Base) do
           self.table_name = table_name
           self.inheritance_column = :_type_disabled
-
-          @online_migrations_connection = connection
-
-          def self.connection
-            @online_migrations_connection
-          end
         end
       end
 
       def to_bool(value)
-        !value.to_s.match(/^(true|t|yes|y|1|on)$/i).nil?
+        value.to_s.match?(/^true|t|yes|y|1|on$/i)
       end
 
       def foreign_table_name(ref_name, options)
@@ -81,7 +45,7 @@ module OnlineMigrations
       end
 
       # Implementation is from ActiveRecord.
-      # This is not needed for ActiveRecord < 7.1 (https://github.com/rails/rails/pull/47753).
+      # This is not needed for ActiveRecord >= 7.1 (https://github.com/rails/rails/pull/47753).
       def index_name(table_name, column_name)
         max_index_name_size = 62
         name = "index_#{table_name}_on_#{Array(column_name) * '_and_'}"
@@ -122,7 +86,7 @@ module OnlineMigrations
       def estimated_count(connection, table_name)
         quoted_table = connection.quote(table_name)
 
-        count = connection.select_value(<<-SQL.strip_heredoc)
+        count = connection.select_value(<<~SQL)
           SELECT
             (reltuples / COALESCE(NULLIF(relpages, 0), 1)) *
             (pg_relation_size(#{quoted_table}) / (current_setting('block_size')::integer))
@@ -135,25 +99,11 @@ module OnlineMigrations
           count = count.to_i
           # If the table has never yet been vacuumed or analyzed, reltuples contains -1
           # indicating that the row count is unknown.
-          count = 0 if count == -1
+          count = 0 if count < 0
           count
         end
       end
 
-      def ar_where_not_multiple_conditions(relation, conditions)
-        if Utils.ar_version >= 6.1
-          relation.where.not(conditions)
-        else
-          # In Active Record < 6.1, NOT with multiple conditions behaves as NOR,
-          # which should really behave as NAND.
-          # https://www.bigbinary.com/blog/rails-6-deprecates-where-not-working-as-nor-and-will-change-to-nand-in-rails-6-1
-          arel_table = relation.arel_table
-          conditions = conditions.map { |column, value| arel_table[column].not_eq(value) }
-          conditions = conditions.inject(:or)
-          relation.where(conditions)
-        end
-      end
-
       FUNCTION_CALL_RE = /(\w+)\s*\(/
       private_constant :FUNCTION_CALL_RE
 
@@ -167,7 +117,7 @@ module OnlineMigrations
       end
 
       def volatile_function?(connection, function_name)
-        query = <<-SQL.strip_heredoc
+        query = <<~SQL
           SELECT provolatile
           FROM pg_catalog.pg_proc
           WHERE proname = #{connection.quote(function_name)}
@@ -175,6 +125,18 @@ module OnlineMigrations
 
         connection.select_value(query) == "v"
       end
+
+      def shard_names(model)
+        model.ancestors.each do |ancestor|
+          # There is no official method to get shard names from the model.
+          # This is the way that currently is used in ActiveRecord tests themselves.
+          pool_manager = ActiveRecord::Base.connection_handler.send(:get_pool_manager, ancestor.name)
+
+          # .uniq call is not needed for Active Record 7.1+
+          # See https://github.com/rails/rails/pull/49284.
+          return pool_manager.shard_names.uniq if pool_manager
+        end
+      end
     end
   end
 end

data/lib/online_migrations/verbose_sql_logs.rb

@@ -7,6 +7,7 @@ module OnlineMigrations
       def enable
         @activerecord_logger_was = ActiveRecord::Base.logger
         @verbose_query_logs_was = verbose_query_logs
+        return if @activerecord_logger_was.nil?
 
         stdout_logger = ActiveSupport::Logger.new($stdout)
         stdout_logger.formatter = @activerecord_logger_was.formatter
@@ -34,7 +35,7 @@ module OnlineMigrations
         def verbose_query_logs
           if Utils.ar_version >= 7.0
             ActiveRecord.verbose_query_logs
-          elsif Utils.ar_version >= 5.2
+          else
             ActiveRecord::Base.verbose_query_logs
           end
         end
@@ -42,7 +43,7 @@ module OnlineMigrations
         def set_verbose_query_logs(value) # rubocop:disable Naming/AccessorMethodName
           if Utils.ar_version >= 7.0
             ActiveRecord.verbose_query_logs = value
-          elsif Utils.ar_version >= 5.2
+          else
             ActiveRecord::Base.verbose_query_logs = value
           end
         end

data/lib/online_migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OnlineMigrations
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/online_migrations.rb

@@ -18,7 +18,6 @@ module OnlineMigrations
   autoload :Migrator
   autoload :SchemaDumper
   autoload :DatabaseTasks
-  autoload :ForeignKeyDefinition
   autoload :ForeignKeysCollector
   autoload :IndexDefinition
   autoload :IndexesCollector
@@ -55,12 +54,12 @@ module OnlineMigrations
     autoload :DeleteOrphanedRecords
     autoload :PerformActionOnRelation
     autoload :ResetCounters
+    autoload :ApplicationRecord
     autoload :MigrationJob
     autoload :Migration
     autoload :MigrationJobRunner
     autoload :MigrationRunner
     autoload :MigrationHelpers
-    autoload :AdvisoryLock
     autoload :Scheduler
   end
 
@@ -76,6 +75,12 @@ module OnlineMigrations
       @config ||= Config.new
     end
 
+    # Run background migrations
+    def run_background_migrations
+      BackgroundMigrations::Scheduler.run
+    end
+
+    # @private
     def load
       require "active_record/connection_adapters/postgresql_adapter"
       ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(OnlineMigrations::SchemaStatements)
@@ -92,10 +97,6 @@ module OnlineMigrations
       else
         ActiveRecord::ConnectionAdapters::SchemaCache.prepend(OnlineMigrations::SchemaCache)
       end
-
-      if OnlineMigrations::Utils.ar_version <= 5.1
-        ActiveRecord::ConnectionAdapters::ForeignKeyDefinition.prepend(OnlineMigrations::ForeignKeyDefinition)
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 description:
 email:
 - fatkodima123@gmail.com
@@ -38,12 +38,14 @@ files:
 - docs/configuring.md
 - lib/generators/online_migrations/background_migration_generator.rb
 - lib/generators/online_migrations/install_generator.rb
+- lib/generators/online_migrations/templates/add_sharding_to_online_migrations.rb.tt
 - lib/generators/online_migrations/templates/background_migration.rb.tt
 - lib/generators/online_migrations/templates/initializer.rb.tt
 - lib/generators/online_migrations/templates/migration.rb.tt
+- lib/generators/online_migrations/upgrade_generator.rb
 - lib/online_migrations.rb
 - lib/online_migrations/background_migration.rb
-- lib/online_migrations/background_migrations/advisory_lock.rb
+- lib/online_migrations/background_migrations/application_record.rb
 - lib/online_migrations/background_migrations/backfill_column.rb
 - lib/online_migrations/background_migrations/background_migration_class_validator.rb
 - lib/online_migrations/background_migrations/config.rb
@@ -68,7 +70,6 @@ files:
 - lib/online_migrations/copy_trigger.rb
 - lib/online_migrations/database_tasks.rb
 - lib/online_migrations/error_messages.rb
-- lib/online_migrations/foreign_key_definition.rb
 - lib/online_migrations/foreign_keys_collector.rb
 - lib/online_migrations/index_definition.rb
 - lib/online_migrations/indexes_collector.rb
@@ -96,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/online_migrations/background_migrations/advisory_lock.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "zlib"
-
-module OnlineMigrations
-  module BackgroundMigrations
-    # @private
-    class AdvisoryLock
-      attr_reader :name, :connection
-
-      def initialize(name:, connection: ActiveRecord::Base.connection)
-        @name = name
-        @connection = connection
-      end
-
-      def try_lock
-        locked = connection.select_value("SELECT pg_try_advisory_lock(#{lock_key})")
-        Utils.to_bool(locked)
-      end
-
-      def unlock
-        connection.select_value("SELECT pg_advisory_unlock(#{lock_key})")
-      end
-
-      # Runs the given block if an advisory lock is able to be acquired.
-      def with_lock
-        if try_lock
-          begin
-            yield
-          ensure
-            unlock
-          end
-        end
-      end
-
-      def active?
-        objid = lock_key & 0xffffffff
-        classid = (lock_key & (0xffffffff << 32)) >> 32
-
-        active = connection.select_value(<<-SQL.strip_heredoc)
-          SELECT granted
-          FROM pg_locks
-          WHERE locktype = 'advisory'
-            AND pid = pg_backend_pid()
-            AND mode = 'ExclusiveLock'
-            AND classid = #{classid}
-            AND objid = #{objid}
-        SQL
-
-        Utils.to_bool(active)
-      end
-
-      private
-        SALT = 936723412
-
-        def lock_key
-          name_hash = Zlib.crc32(name)
-          SALT * name_hash
-        end
-    end
-  end
-end

data/lib/online_migrations/foreign_key_definition.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module OnlineMigrations
-  # @private
-  module ForeignKeyDefinition
-    if Utils.ar_version <= 4.2
-      def defined_for?(to_table: nil, **options)
-        (to_table.nil? || to_table.to_s == self.to_table) &&
-          options.all? { |k, v| self.options[k].to_s == v.to_s }
-      end
-    elsif Utils.ar_version <= 5.1
-      def defined_for?(*args, **options)
-        super(*args, **options.except(:validate))
-      end
-    end
-  end
-end