online_migrations 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f3b31c9fe8edb868fade7dbdaed0ebf78d53da7a1ff52786a748663bc93bf5
-  data.tar.gz: 94c2fed042d39993d85f6641db3b4a86c3a360b3c858f48aeb2da052bb2c52cc
+  metadata.gz: 0ac8a2eb2657fcc3536a9b56d16298f90f8e1a5e626ba52a6e9703b5bcaa7df0
+  data.tar.gz: c5357f94854fb43d1b8404ed9dcfafc2178430aeb9c6d69555f50629a94da3bd
 SHA512:
-  metadata.gz: f844aa5e502a91739923039a8fb84d10ae9682404bd14bd4b92352400c6dae82963b21166178c72c47ea4ecbd0792b6f46da151d92ce205e217a5788c9a8b27a
-  data.tar.gz: 2db40b6b3cf81f923251f16a023aedbb18f8f24d28abb9e6b638090030c013c24dd6a41942df3e4f4cd1264c84c997eaaeb6adcb1c2d8d8844bc4934406f9ebc
+  metadata.gz: 4ccbc274c76ab01f8ece559b3fee27c1c5c0c495225b393c3a4afb7941f0b61d3aab9ef2885195be78ed00f29bd5e6b18e3fe0cb044b745cd791aacf34283492
+  data.tar.gz: 04fb250e30e7620ac1bd06fddf24a5fdfe616f285422e47e19423e23be0c8117e57d45e45029a2e1212cc5e6ad9baf3605fac8b038152fdc73b2d9a818ba211c

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 ## master (unreleased)
 
+## 0.5.3 (2022-11-10)
+
+- Fix removing index by name
+- Fix multiple databases support for `start_after` and `target_version` configs
+- Fix error when `Rails` defined without `Rails.env`
+- Improve error message for adding column with a NULL default for PostgreSQL < 11
+
+## 0.5.2 (2022-10-04)
+
+- Fix sequence resetting in tests that use fixtures
+
+- Fix `update_column_in_batches` for SQL subquery values
+
+    It generated inefficient queries before, e.g.:
+
+    ```ruby
+    update_column_in_batches(:users, :comments_count, Arel.sql(<<~SQL))
+      (select count(*) from comments where comments.user_id = users.id)
+    SQL
+    ```
+
+    Generated SQL queries before:
+    ```sql
+    update users
+    set comments_count = (..count subquery..)
+    where comments_count is null or comments_count != (..count subquery..)
+    ```
+
+    Generated SQL queries now:
+    ```sql
+    update users set comments_count = (..count subquery..)
+    ```
+
+- Fix check for `add_column` with `default: nil` for PostgreSQL < 11
+- Replacing a unique index when other unique index with the prefix of columns exists is safe
+
 ## 0.5.1 (2022-07-19)
 
 - Raise for possible index corruption in all environments (previously, the check was made only

data/lib/generators/online_migrations/install_generator.rb

@@ -10,21 +10,21 @@ module OnlineMigrations
 
     source_root File.expand_path("templates", __dir__)
 
-    def create_migration_file
-      migration_template("migration.rb", File.join(migrations_dir, "install_online_migrations.rb"))
-    end
-
     def copy_initializer_file
       template("initializer.rb", "config/initializers/online_migrations.rb")
     end
 
+    def create_migration_file
+      migration_template("migration.rb", File.join(migrations_dir, "install_online_migrations.rb"))
+    end
+
     private
       def migration_parent
         Utils.migration_parent_string
       end
 
       def start_after
-        self.class.next_migration_number(migrations_dir)
+        self.class.current_migration_number(migrations_dir)
       end
 
       def migrations_dir

data/lib/generators/online_migrations/templates/initializer.rb.tt

@@ -59,11 +59,11 @@ OnlineMigrations.configure do |config|
 
   # Add custom checks. Use the `stop!` method to stop migrations.
   #
-  #   config.add_check do |method, args|
-  #     if method == :add_column && args[0].to_s == "users"
-  #       stop!("No more columns on the users table")
-  #     end
+  # config.add_check do |method, args|
+  #   if method == :add_column && args[0].to_s == "users"
+  #     stop!("No more columns on the users table")
   #   end
+  # end
 
   # ==> Background migrations configuration
   # The number of rows to process in a single background migration run.

data/lib/online_migrations/command_checker.rb

@@ -174,13 +174,18 @@ module OnlineMigrations
       def add_column(table_name, column_name, type, **options)
         default = options[:default]
         volatile_default = false
-        if !new_or_small_table?(table_name) && !default.nil? &&
-           (postgresql_version < Gem::Version.new("11") || (volatile_default = Utils.volatile_default?(connection, type, default)))
+        if !new_or_small_table?(table_name) && options.key?(:default) &&
+           (postgresql_version < Gem::Version.new("11") || (!default.nil? && (volatile_default = Utils.volatile_default?(connection, type, default))))
 
-          raise_error :add_column_with_default,
-            code: command_str(:add_column_with_default, table_name, column_name, type, options),
-            not_null: options[:null] == false,
-            volatile_default: volatile_default
+          if default.nil?
+            raise_error :add_column_with_default_null,
+              code: command_str(:add_column, table_name, column_name, type, options.except(:default))
+          else
+            raise_error :add_column_with_default,
+              code: command_str(:add_column_with_default, table_name, column_name, type, options),
+              not_null: options[:null] == false,
+              volatile_default: volatile_default
+          end
         end
 
         if type == :json
@@ -478,9 +483,17 @@ module OnlineMigrations
             command: command_str(:remove_index, table_name, **options.merge(algorithm: :concurrently))
         end
 
-        if options[:column] || options[:name]
-          options[:column] ||= connection.indexes(table_name).find { |index| index.name == options[:name].to_s }
-          @removed_indexes << IndexDefinition.new(table: table_name, columns: options.delete(:column), **options)
+        index_def = connection.indexes(table_name).find do |index|
+          index.name == options[:name].to_s ||
+            Array(index.columns).map(&:to_s) == Array(options[:column]).map(&:to_s)
+        end
+
+        if index_def
+          existing_options = [:name, :columns, :unique, :where, :type, :using, :opclasses].map do |option|
+            [option, index_def.public_send(option)] if index_def.respond_to?(option)
+          end.compact.to_h
+
+          @removed_indexes << IndexDefinition.new(table: table_name, **existing_options)
         end
       end
 

data/lib/online_migrations/config.rb

@@ -185,7 +185,7 @@ module OnlineMigrations
       @small_tables = []
       @check_down = false
       @enabled_checks = @error_messages.keys.map { |k| [k, {}] }.to_h
-      @verbose_sql_logs = defined?(Rails) && Rails.env.production?
+      @verbose_sql_logs = defined?(Rails.env) && Rails.env.production?
     end
 
     def lock_retrier=(value)
@@ -262,17 +262,13 @@ module OnlineMigrations
     private
       def ensure_supports_multiple_dbs
         unless Utils.supports_multiple_dbs?
-          raise "Multiple databases are not supported by this ActiveRecord version"
+          raise "OnlineMigrations does not support multiple databases for Active Record < 6.1"
         end
       end
 
       def db_config_name
         connection = OnlineMigrations.current_migration.connection
-        if Utils.ar_version < 6.1
-          connection.pool.spec.name
-        else
-          connection.pool.db_config.name
-        end
+        connection.pool.db_config.name
       end
   end
 end

data/lib/online_migrations/error_messages.rb

@@ -74,6 +74,16 @@ class <%= migration_name %> < <%= migration_parent %>
 end
 <% end %>",
 
+      add_column_with_default_null:
+"Adding a column with a null default blocks reads and writes while the entire table is rewritten.
+Instead, add the column without a default value.
+
+class <%= migration_name %> < <%= migration_parent %>
+  def change
+    <%= code %>
+  end
+end",
+
       add_column_json:
 "There's no equality operator for the json column type, which can cause errors for
 existing SELECT DISTINCT queries in your application. Use jsonb instead.

data/lib/online_migrations/index_definition.rb

@@ -30,10 +30,7 @@ module OnlineMigrations
       return false if where != other.where
       return false if other.respond_to?(:opclasses) && opclasses != other.opclasses
 
-      case [unique, other.unique]
-      when [true, true]
-        columns == other.columns
-      when [true, false]
+      if unique && !other.unique
         false
       else
         prefix?(self, other)

data/lib/online_migrations/schema_cache.rb

@@ -69,8 +69,9 @@ module OnlineMigrations
       def renamed_tables
         @renamed_tables ||= begin
           table_renames = OnlineMigrations.config.table_renames
+          views = connection.views
           table_renames.select do |old_name, _|
-            connection.views.include?(old_name)
+            views.include?(old_name)
           end
         end
       end
@@ -78,8 +79,9 @@ module OnlineMigrations
       def renamed_columns
         @renamed_columns ||= begin
           column_renames = OnlineMigrations.config.column_renames
+          views = connection.views
           column_renames.select do |table_name, _|
-            connection.views.include?(table_name)
+            views.include?(table_name)
           end
         end
       end

data/lib/online_migrations/schema_statements.rb

@@ -85,9 +85,13 @@ module OnlineMigrations
 
       conditions = columns_and_values.map do |(column_name, value)|
         value = Arel.sql(value.call.to_s) if value.is_a?(Proc)
-        arel_column = model.arel_table[column_name]
-        arel_column.not_eq(value).or(arel_column.eq(nil))
-      end
+
+        # Ignore subqueries in conditions
+        unless value.is_a?(Arel::Nodes::SqlLiteral) && value.to_s =~ /select\s+/i
+          arel_column = model.arel_table[column_name]
+          arel_column.not_eq(value).or(arel_column.eq(nil))
+        end
+      end.compact
 
       batch_relation = model.where(conditions.inject(:and))
       batch_relation = yield batch_relation if block_given?
@@ -685,7 +689,18 @@ module OnlineMigrations
       index_name = options[:name]
       index_name ||= index_name(table_name, column_names)
 
-      if index_exists?(table_name, column_names, **options)
+      index_exists =
+        if Utils.ar_version <= 5.0
+          # Older Active Record is unable to handle blank columns correctly in `index_exists?`,
+          # so we need to use `index_name_exists?`.
+          index_name_exists?(table_name, index_name, nil)
+        elsif Utils.ar_version <= 6.0
+          index_name_exists?(table_name, index_name)
+        else
+          index_exists?(table_name, column_names, **options)
+        end
+
+      if index_exists
         disable_statement_timeout do
           # "DROP INDEX CONCURRENTLY" requires a "SHARE UPDATE EXCLUSIVE" lock.
           # It only conflicts with constraint validations, other creating/removing indexes,
@@ -820,6 +835,29 @@ module OnlineMigrations
       end
     end
 
+    # @private
+    def pk_and_sequence_for(table)
+      views = self.views
+
+      table_renames = OnlineMigrations.config.table_renames
+      renamed_tables = table_renames.select do |old_name, _|
+        views.include?(old_name)
+      end
+
+      column_renames = OnlineMigrations.config.column_renames
+      renamed_columns = column_renames.select do |table_name, _|
+        views.include?(table_name)
+      end
+
+      if renamed_tables.key?(table)
+        super(renamed_tables[table])
+      elsif renamed_columns.key?(table)
+        super("#{table}_column_rename")
+      else
+        super
+      end
+    end
+
     # Disables statement timeout while executing &block
     #
     # Long-running migrations may take more than the timeout allowed by the database.
@@ -905,7 +943,7 @@ module OnlineMigrations
       def __index_column_names(column_names)
         if column_names.is_a?(String) && /\W/.match(column_names)
           column_names
-        else
+        elsif column_names.present?
           Array(column_names)
         end
       end

data/lib/online_migrations/utils.rb

@@ -9,7 +9,7 @@ module OnlineMigrations
       end
 
       def developer_env?
-        defined?(Rails) && (Rails.env.development? || Rails.env.test?)
+        defined?(Rails.env) && (Rails.env.development? || Rails.env.test?)
       end
 
       def say(message)
@@ -26,7 +26,9 @@ module OnlineMigrations
       end
 
       def supports_multiple_dbs?
-        ar_version >= 6.0
+        # 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

data/lib/online_migrations/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: online_migrations
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - fatkodima
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Catch unsafe PostgreSQL migrations in development and run them easier in