nandi 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea1c9b758014a99ea83562525b13d80c54ed0dd310ffd64eaebae6009235cebf
-  data.tar.gz: 77d9ae338cd152b213acaa18c2e6ba6ecbe56f7f1fe955264694d98d8b526030
+  metadata.gz: ab45002075955602da710e92a39cc3b9fe8bdc9371a33e97319e9e24d68a3385
+  data.tar.gz: 25f3e29b999a37eeb5d46ea272b12e313ae11de5c272dd81120dde4d2dd6ecfe
 SHA512:
-  metadata.gz: c3b1935d279ba467262f79d7153ad5cfe1741da7d6c42ba618dd038f7216cc32435403343ad3adfde4e800953658cf5c8db75ab5b2fc434faef54d6871b4081b
-  data.tar.gz: 0c71da4c6691fe6e3b75acaa32c23af55b32c4b94ce3a7e7afc2021e98f2c64ba1aeb19e7da9a182ba0584c716fec3a725d1dff7ce7c789c49bb18f2a8cf170b
+  metadata.gz: a916d9acc8c50060a472e2c6630529ac6b6832380d2198f1d8e19785ce7da5ff211e24e44b33ce51d6f305fab24e98ba7297cba55904f89d394cc939cb202883
+  data.tar.gz: 6b1674699aa6e907474c00d31c6a337ae4af7d9e29d1528811e8dcc19e2235a3340fd59ae1f4f1b4176f21c882508e6d20ec992a77b292d7c31a78c05f671315

data/README.md

@@ -315,6 +315,10 @@ Drops an existing NOT NULL constraint. Please not that this migration is not saf
 
 Changes the default value for this column when new rows are inserted into the table.
 
+### `#extend_varchar_column_limit(table, column, from:, to:)`
+
+Widens (or removes, with `to: nil`) the character limit on an existing varchar column. Since Postgres 9.2 this is metadata-only; _narrowing_ a limit requires a full-table scan and isn't supported. The generated migration re-checks the column's actual type and limit in the database against `from:` before changing it, so this is safe to recompile even after it has already run. Not safely reversible: `down` should be `irreversible_migration`.
+
 ### `#remove_index(table, target)`
 
 Drop an index from the database.
@@ -566,6 +570,9 @@ These options can be set individually for each database. **All are optional** -
 - `access_exclusive_statement_timeout_limit`: Maximum allowed statement timeout (default: 1,500ms)
 - `concurrent_lock_timeout_limit`: Minimum timeout for concurrent operations (default: 3,600,000ms / 1 hour)
 - `concurrent_statement_timeout_limit`: Minimum statement timeout for concurrent operations (default: 3,600,000ms / 1 hour)
+- `concurrent_lock_timeout`: Lock timeout for concurrent operations (`add_index`/`remove_index`). When set, concurrent migrations use `set_lock_timeout` instead of `disable_lock_timeout!`. Default: `nil` (timeout disabled)
+- `concurrent_statement_timeout`: Statement timeout for concurrent operations. When set, concurrent migrations use `set_statement_timeout` instead of `disable_statement_timeout!`. Default: `nil` (timeout disabled)
+- `table_overrides`: Per-table overrides of `concurrent_lock_timeout`/`concurrent_statement_timeout`, keyed by table name. Falls back to the database-level value for any table (or key) not listed
 
 **Global options** (set via config accessors):
 
@@ -621,6 +628,20 @@ Nandi.configure do |config|
     migration
   end
 end
+
+# Give a specific, huge table a longer concurrent statement/lock timeout than
+# the database-wide default, without loosening it for every other table.
+Nandi.configure do |config|
+  config.register_database(:primary,
+    concurrent_lock_timeout: 120_000,        # 2 minutes, database-wide default
+    concurrent_statement_timeout: 600_000,   # 10 minutes, database-wide default
+    table_overrides: {
+      payments: {
+        concurrent_lock_timeout: 300_000,      # 5 minutes
+        concurrent_statement_timeout: 1_800_000, # 30 minutes
+      },
+    })
+end
 ```
 
 ### Directory Structure

data/lib/nandi/config.rb

@@ -84,8 +84,8 @@ module Nandi
     def access_exclusive_statement_timeout_max(database_name = nil) = config(database_name).access_exclusive_statement_timeout_max
     def concurrent_lock_timeout_min(database_name = nil) = config(database_name).concurrent_lock_timeout_min
     def concurrent_statement_timeout_min(database_name = nil) = config(database_name).concurrent_statement_timeout_min
-    def concurrent_lock_timeout(database_name = nil) = config(database_name).concurrent_lock_timeout
-    def concurrent_statement_timeout(database_name = nil) = config(database_name).concurrent_statement_timeout
+    def concurrent_lock_timeout(database_name = nil, table_name = nil) = config(database_name).concurrent_lock_timeout(table_name)
+    def concurrent_statement_timeout(database_name = nil, table_name = nil) = config(database_name).concurrent_statement_timeout(table_name)
     # rubocop:enable Layout/LineLength
 
     # Delegate setter methods to the default database for backwards compatibility

data/lib/nandi/instructions/extend_varchar_column_limit.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class ExtendVarcharColumnLimit
+      attr_reader :table, :column, :from, :to
+
+      def initialize(table:, column:, from:, to:)
+        unless from.is_a?(Integer)
+          raise ArgumentError, "extend_varchar_column_limit requires an integer `from:` limit"
+        end
+
+        unless to.nil? || (to.is_a?(Integer) && to > from)
+          raise ArgumentError,
+                "extend_varchar_column_limit only supports widening a character limit, or " \
+                "removing it entirely (to: nil), but #{table}.#{column} would go from #{from} " \
+                "to #{to.inspect}. Narrowing a limit requires a full-table scan under an " \
+                "ACCESS EXCLUSIVE lock and isn't supported here."
+        end
+
+        @table = table
+        @column = column
+        @from = from
+        @to = to
+      end
+
+      def procedure
+        :extend_varchar_column_limit
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions.rb

@@ -12,6 +12,7 @@ require "nandi/instructions/add_foreign_key"
 require "nandi/instructions/drop_constraint"
 require "nandi/instructions/remove_not_null_constraint"
 require "nandi/instructions/change_column_default"
+require "nandi/instructions/extend_varchar_column_limit"
 require "nandi/instructions/validate_constraint"
 require "nandi/instructions/add_check_constraint"
 require "nandi/instructions/irreversible_migration"

data/lib/nandi/migration.rb

@@ -311,6 +311,19 @@ module Nandi
       )
     end
 
+    # Widens (or removes) the character limit on an existing varchar column.
+    # Since Postgres 9.2 this is metadata-only (a brief ACCESS EXCLUSIVE lock).
+    # Narrowing remains a different, unsafe operation and is not supported.
+    #
+    # Not safely reversible: `down` should be `irreversible_migration`.
+    # @param table [Symbol, String] The name of the table with the column
+    # @param column [Symbol, String] The name of the column to change
+    # @param from [Integer] The column's current character limit
+    # @param to [Integer, nil] The new character limit, or nil to remove it entirely
+    def extend_varchar_column_limit(table, column, from:, to:)
+      current_instructions << Instructions::ExtendVarcharColumnLimit.new(table:, column:, from:, to:)
+    end
+
     # Raises an `ActiveRecord::IrreversibleMigration` error for use in
     # irreversible migrations
     def irreversible_migration
@@ -337,7 +350,7 @@ module Nandi
 
     def disable_lock_timeout?
       if self.class.lock_timeout.nil?
-        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_lock_timeout(database_name).nil?
+        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_lock_timeout(database_name, table).nil?
       else
         false
       end
@@ -345,7 +358,7 @@ module Nandi
 
     def disable_statement_timeout?
       if self.class.statement_timeout.nil?
-        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_statement_timeout(database_name).nil?
+        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_statement_timeout(database_name, table).nil?
       else
         false
       end
@@ -360,7 +373,7 @@ module Nandi
     end
 
     def mixins
-      (up_instructions + down_instructions).inject([]) do |mixins, i|
+      all_instructions.inject([]) do |mixins, i|
         i.respond_to?(:mixins) ? [*mixins, *i.mixins] : mixins
       end.uniq
     end
@@ -383,7 +396,7 @@ module Nandi
 
     def default_statement_timeout
       if strictest_lock == LockWeights::SHARE
-        Nandi.config.concurrent_statement_timeout(database_name) ||
+        Nandi.config.concurrent_statement_timeout(database_name, table) ||
           Nandi.config.access_exclusive_statement_timeout(database_name)
       else
         Nandi.config.access_exclusive_statement_timeout(database_name)
@@ -392,12 +405,24 @@ module Nandi
 
     def default_lock_timeout
       if strictest_lock == LockWeights::SHARE
-        Nandi.config.concurrent_lock_timeout(database_name) || Nandi.config.access_exclusive_lock_timeout(database_name)
+        Nandi.config.concurrent_lock_timeout(database_name, table) ||
+          Nandi.config.access_exclusive_lock_timeout(database_name)
       else
         Nandi.config.access_exclusive_lock_timeout(database_name)
       end
     end
 
+    # The table this migration modifies, if any. Validator guarantees a migration
+    # modifies at most one table, so this is unambiguous.
+    def table
+      instruction_with_table = all_instructions.find { |i| i.respond_to?(:table) }
+      instruction_with_table&.table&.to_sym
+    end
+
+    def all_instructions
+      up_instructions + down_instructions
+    end
+
     def invoke_custom_method(name, ...)
       klass = Nandi.config.custom_methods[name]
       current_instructions << klass.new(...)

data/lib/nandi/multi_database.rb

@@ -54,14 +54,24 @@ module Nandi
       # The default lock timeout for migrations that take place concurrently
       # (eg. add_index, remove_index). When set, concurrent migrations will use
       # set_lock_timeout instead of disable_lock_timeout!. Default: nil (disabled).
+      # Can be overridden for a specific table via `table_overrides`.
+      # @param table_name [Symbol, String, nil]
       # @return [Integer, nil]
-      attr_accessor :concurrent_lock_timeout
+      def concurrent_lock_timeout(table_name = nil)
+        table_override(table_name, :concurrent_lock_timeout) || @concurrent_lock_timeout
+      end
+      attr_writer :concurrent_lock_timeout
 
       # The default statement timeout for migrations that take place concurrently
       # (eg. add_index, remove_index). When set, concurrent migrations will use
       # set_statement_timeout instead of disable_statement_timeout!. Default: nil (disabled).
+      # Can be overridden for a specific table via `table_overrides`.
+      # @param table_name [Symbol, String, nil]
       # @return [Integer, nil]
-      attr_accessor :concurrent_statement_timeout
+      def concurrent_statement_timeout(table_name = nil)
+        table_override(table_name, :concurrent_statement_timeout) || @concurrent_statement_timeout
+      end
+      attr_writer :concurrent_statement_timeout
 
       # The directory for output files. Default: `db/migrate`
       # @return [String]
@@ -121,6 +131,17 @@ module Nandi
           config[:concurrent_statement_timeout_min] || DEFAULT_CONCURRENT_STATEMENT_TIMEOUT_MIN
         @concurrent_lock_timeout = config[:concurrent_lock_timeout]
         @concurrent_statement_timeout = config[:concurrent_statement_timeout]
+        @table_overrides = normalize_table_overrides(config[:table_overrides])
+      end
+
+      def normalize_table_overrides(table_overrides)
+        (table_overrides || {}).transform_keys(&:to_sym)
+      end
+
+      def table_override(table_name, key)
+        return nil if table_name.nil?
+
+        @table_overrides.dig(table_name.to_sym, key)
       end
 
       def path_prefix(name, default)

data/lib/nandi/renderers/active_record/instructions.rb

@@ -105,6 +105,16 @@ module Nandi
           formatted_property :value
         end
 
+        class ExtendVarcharColumnLimitCell < Base
+          property :table
+          property :column
+          property :from
+
+          def to_type_sql
+            model.to.nil? ? "character varying" : "character varying(#{model.to})"
+          end
+        end
+
         class RemoveNotNullConstraintCell < Base
           formatted_property :table
           formatted_property :column

data/lib/nandi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nandi
-  VERSION = "3.1.0"
+  VERSION = "3.3.0"
 end

data/lib/templates/nandi/renderers/active_record/instructions/extend_varchar_column_limit/show.rb.erb

@@ -0,0 +1,16 @@
+execute <<-SQL
+  DO $$
+  DECLARE
+    actual_type text;
+  BEGIN
+    SELECT format_type(atttypid, atttypmod) INTO actual_type
+    FROM pg_attribute
+    WHERE attrelid = '<%= table %>'::regclass AND attname = '<%= column %>' AND NOT attisdropped;
+
+    IF actual_type IS DISTINCT FROM 'character varying(<%= from %>)' THEN
+      RAISE EXCEPTION 'expected <%= table %>.<%= column %> to be character varying(<%= from %>), found %', actual_type;
+    END IF;
+  END $$;
+
+  ALTER TABLE <%= table %> ALTER COLUMN "<%= column %>" TYPE <%= to_type_sql %>;
+SQL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.0
 platform: ruby
 authors:
 - GoCardless Engineering
@@ -112,6 +112,7 @@ files:
 - lib/nandi/instructions/create_table.rb
 - lib/nandi/instructions/drop_constraint.rb
 - lib/nandi/instructions/drop_table.rb
+- lib/nandi/instructions/extend_varchar_column_limit.rb
 - lib/nandi/instructions/irreversible_migration.rb
 - lib/nandi/instructions/remove_column.rb
 - lib/nandi/instructions/remove_index.rb
@@ -155,6 +156,7 @@ files:
 - lib/templates/nandi/renderers/active_record/instructions/create_table/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/drop_constraint/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/drop_table/show.rb.erb
+- lib/templates/nandi/renderers/active_record/instructions/extend_varchar_column_limit/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/irreversible_migration/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/remove_column/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/remove_index/show.rb.erb
@@ -180,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Fear-free migrations for PostgreSQL
 test_files: []