safe-pg-migrations 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ca207baa7afe377dff14c412d91032adf75dc6f37adea0b9e05c205f7857277
-  data.tar.gz: c7cfe9a20a090734c26b874b7b50588455a752b9e1dfb53c050de4749f5834d0
+  metadata.gz: 2a0df9e7452f957e5b9d5bde43186d621c8b8b4dab8f0131e100c295f03876bf
+  data.tar.gz: 461407396bd567c37f8f361dcc45386691aa502828913b0954cc8e3cbe305fff
 SHA512:
-  metadata.gz: 2acdce15510505d5c13278774472acb012f0154b9214a41c78b068fd5812dddb5f9bddb1c2ad24e4feb23d06c19f3f5bfe5ecddc8d38ed6c9745d21257a365fa
-  data.tar.gz: 492776e5ab2b70fa14b71bec6b9171a481f57b310d6b6ca79ad8a572e4d4ef12c41a9b9dd4e50e2755fee9b686f6ee161b4e2f7581905539528ab06aed4bdabf
+  metadata.gz: 28e27ecdfd15480ae55a49357200f9b5e0ed4af1ac943973925ca5ac091c7b61ce50dca8047b6a24fe42a736a1214bfb56a08a7f791e59dfbce14587c10e7585
+  data.tar.gz: f70e209ad111bf97d7a0fa8aea884a3191bc5ee028b67d5e445a553549c00e86f01cd948368e7b3f93ee1713724877d9e67272f6e5729cc71b69cddbac62316d

data/README.md

@@ -346,18 +346,11 @@ SafePgMigrations.config.retry_delay = 1.minute # Delay between retries for retry
 SafePgMigrations.config.max_tries = 5 # Number of retries before abortion of the migration
 ```
 
-## Running tests
-
-```bash
-bundle
-psql -h localhost -c 'CREATE DATABASE safe_pg_migrations_test'
-rake test
-```
-
 ## Authors
 
 - [Matthieu Prat](https://github.com/matthieuprat)
 - [Romain Choquet](https://github.com/rchoquet)
+- [Thomas Hareau](https://github.com/ThHareau)
 - [Paul-Etienne Coisne](https://github.com/coisnepe)
 
 ## License

data/lib/safe-pg-migrations/base.rb

@@ -6,9 +6,11 @@ require 'safe-pg-migrations/helpers/satisfied_helper'
 require 'safe-pg-migrations/helpers/index_helper'
 require 'safe-pg-migrations/helpers/batch_over'
 require 'safe-pg-migrations/helpers/session_setting_management'
+require 'safe-pg-migrations/helpers/statements_helper'
 require 'safe-pg-migrations/plugins/verbose_sql_logger'
 require 'safe-pg-migrations/plugins/blocking_activity_logger'
 require 'safe-pg-migrations/plugins/statement_insurer/add_column'
+require 'safe-pg-migrations/plugins/statement_insurer/change_column_null'
 require 'safe-pg-migrations/plugins/statement_insurer'
 require 'safe-pg-migrations/plugins/statement_retrier'
 require 'safe-pg-migrations/plugins/idempotent_statements'

data/lib/safe-pg-migrations/helpers/statements_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SafePgMigrations
+  module Helpers
+    module StatementsHelper
+      RETRIABLE_SCHEMA_STATEMENTS = %i[
+        add_check_constraint
+        add_column
+        add_foreign_key
+        change_column_default
+        change_column_null
+        create_table
+        remove_column
+        remove_foreign_key
+        drop_table
+      ].freeze
+    end
+  end
+end

data/lib/safe-pg-migrations/plugins/blocking_activity_logger.rb

@@ -7,16 +7,9 @@ module SafePgMigrations
   module BlockingActivityLogger
     include Helpers::BlockingActivityFormatter
     include Helpers::BlockingActivitySelector
+    include Helpers::StatementsHelper
 
-    %i[
-      add_column
-      remove_column
-      add_foreign_key
-      remove_foreign_key
-      change_column_default
-      change_column_null
-      create_table
-    ].each do |method|
+    RETRIABLE_SCHEMA_STATEMENTS.each do |method|
       define_method method do |*args, &block|
         log_context = lambda do
           break unless SafePgMigrations.config.sensitive_logger

data/lib/safe-pg-migrations/plugins/statement_insurer/change_column_null.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SafePgMigrations
+  module StatementInsurer
+    module ChangeColumnNull
+      def change_column_null(table_name, column_name, null, default = nil)
+        return super unless should_create_constraint? default, null
+
+        expression = "#{column_name} IS NOT NULL"
+        # constraint will be defined if the constraint was manually created in another migration
+        constraint = check_constraint_by_expression table_name, expression
+
+        default_name = check_constraint_name(table_name, expression: expression)
+        constraint_name = constraint&.name || default_name
+
+        add_check_constraint table_name, expression, name: constraint_name
+
+        Helpers::Logger.say_method_call :change_column_null, table_name, column_name, false
+        super table_name, column_name, false
+
+        return unless should_remove_constraint? default_name, constraint_name
+
+        Helpers::Logger.say_method_call :remove_check_constraint, table_name, expression, name: constraint_name
+        remove_check_constraint table_name, expression, name: constraint_name
+      end
+
+      private
+
+      def check_constraint_by_expression(table_name, expression)
+        check_constraints(table_name).detect { |check_constraint| check_constraint.expression = expression }
+      end
+
+      def should_create_constraint?(default, null)
+        !default && !null && Helpers::SatisfiedHelper.satisfies_change_column_null_requirements?
+      end
+
+      def should_remove_constraint?(default_name, constraint_name)
+        # we don't want to remove the constraint if it was created in another migration. The best guess we have here is
+        # that manually created constraint would likely have a name that is not the default name. This is not a perfect,
+        # a manually created constraint without a name would be removed. However, it is now replaced by the NOT NULL
+        # statement on the table, so this is not a big issue.
+        default_name == constraint_name
+      end
+    end
+  end
+end

data/lib/safe-pg-migrations/plugins/statement_insurer.rb

@@ -4,6 +4,7 @@ module SafePgMigrations
   module StatementInsurer
     include Helpers::SessionSettingManagement
     include AddColumn
+    include ChangeColumnNull
 
     def validate_check_constraint(table_name, **options)
       Helpers::Logger.say_method_call :validate_check_constraint, table_name, **options
@@ -73,18 +74,6 @@ module SafePgMigrations
       without_timeout { super(table_name, **options) }
     end
 
-    def change_column_null(table_name, column_name, null, default = nil)
-      return super if default || null || !Helpers::SatisfiedHelper.satisfies_change_column_null_requirements?
-
-      add_check_constraint table_name, "#{column_name} IS NOT NULL"
-
-      Helpers::Logger.say_method_call :change_column_null, table_name, column_name, false
-      super table_name, column_name, false
-
-      Helpers::Logger.say_method_call :remove_check_constraint, table_name, "#{column_name} IS NOT NULL"
-      remove_check_constraint table_name, "#{column_name} IS NOT NULL"
-    end
-
     def remove_column(table_name, column_name, *)
       foreign_key = foreign_key_for(table_name, column: column_name)
 

data/lib/safe-pg-migrations/plugins/statement_retrier.rb

@@ -2,9 +2,7 @@
 
 module SafePgMigrations
   module StatementRetrier
-    RETRIABLE_SCHEMA_STATEMENTS = %i[
-      add_column add_foreign_key remove_foreign_key change_column_default change_column_null remove_column drop_table
-    ].freeze
+    include Helpers::StatementsHelper
 
     RETRIABLE_SCHEMA_STATEMENTS.each do |method|
       define_method method do |*args, &block|

data/lib/safe-pg-migrations/railtie.rb

@@ -10,33 +10,7 @@ module SafePgMigrations
         ActiveRecord::Migration.singleton_class.prepend(SafePgMigrations::Migration::ClassMethods)
       end
 
-      break unless Object.const_defined? :StrongMigrations
-
-      StrongMigrations.add_check do |method, args|
-        break unless method == :add_column
-
-        options = args.last.is_a?(Hash) ? args.last : {}
-
-        default_value_backfill = options.fetch(:default_value_backfill, :auto)
-
-        if default_value_backfill == :update_in_batches
-          check_message = <<~CHECK
-            default_value_backfill: :update_in_batches will take time if the table is too big.
-
-            Your configuration sets a pause of #{SafePgMigrations.config.backfill_pause} seconds between batches of
-            #{SafePgMigrations.config.backfill_batch_size} rows. Each batch execution will take time as well. Please
-            check that the estimated duration of the migration is acceptable before adding `safety_assured`.
-          CHECK
-
-          check_message += <<~CHECK if SafePgMigrations.config.default_value_backfill_threshold
-
-            Also, please note that SafePgMigrations is configured to raise if the table has more than
-            #{SafePgMigrations.config.default_value_backfill_threshold} rows.
-          CHECK
-
-          stop! check_message
-        end
-      end
+      SafePgMigrations::StrongMigrationsIntegration.initialize
     end
   end
 end

data/lib/safe-pg-migrations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafePgMigrations
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe-pg-migrations
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Matthieu Prat
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -58,10 +58,12 @@ files:
 - lib/safe-pg-migrations/helpers/logger.rb
 - lib/safe-pg-migrations/helpers/satisfied_helper.rb
 - lib/safe-pg-migrations/helpers/session_setting_management.rb
+- lib/safe-pg-migrations/helpers/statements_helper.rb
 - lib/safe-pg-migrations/plugins/blocking_activity_logger.rb
 - lib/safe-pg-migrations/plugins/idempotent_statements.rb
 - lib/safe-pg-migrations/plugins/statement_insurer.rb
 - lib/safe-pg-migrations/plugins/statement_insurer/add_column.rb
+- lib/safe-pg-migrations/plugins/statement_insurer/change_column_null.rb
 - lib/safe-pg-migrations/plugins/statement_retrier.rb
 - lib/safe-pg-migrations/plugins/strong_migrations_integration.rb
 - lib/safe-pg-migrations/plugins/useless_statements_logger.rb