nandi 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 986532981584b1518a8422a2cc212ed963782fb31554012a0e2b4da50bf8a3db
-  data.tar.gz: 282b4f7c95256f6a8af1090b82a2324d0cc12e4570bf22608c219d8486cb5334
+  metadata.gz: '068eff75d4f385070e3da2d3738019cf4e6be7554a16e235f3701e3c0db79419'
+  data.tar.gz: cfe9e766d00073ab040888cad17bedb8c4b2b294d7e353d5298a9ccce9a130f2
 SHA512:
-  metadata.gz: 7788cca1a5ca77b8e8e04decc6819b41078936452f3ab2cae00a3b35ca6c338f4fb4870e2d8eb11f4f3109029c41a2ccd327fb980417e1b95c1bf48644bca23e
-  data.tar.gz: 2331b4022d381b2863ecbf2429365aa2870fb39386fde1cb0aa27ea8800fc3c7777490896a2d55af95696d8b0457c2f485890f5dcd8878019f1a50b2ea28af09
+  metadata.gz: 86c97f9217b2fc3819d8204f80e0f29d7d00e63b3929b40cd684d66b6e701d97b69bb1094714ef8e33bf3c451d67fb31803a18c6625ac2f2a06e4c159ff2dd98
+  data.tar.gz: 83b8831e08ddcfedf0e558acf5b4813866605757f17d3ca74ec21f9815f774f8207d0b2e7dd1d50aa87674c39e06420fac106454996b2a8f37eb4a660a6e1b95

data/README.md

@@ -566,6 +566,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 +624,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/compiled_migration.rb

@@ -50,7 +50,7 @@ module Nandi
     end
 
     def migration
-      @migration ||= class_name.camelize.constantize.new(Nandi.validator)
+      @migration ||= class_name.camelize.constantize.new(Nandi.validator, database_name: db_name)
     end
 
     def compiled_digest

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/migration.rb

@@ -69,12 +69,18 @@ module Nandi
     end
 
     # @param validator [Nandi::Validator]
-    def initialize(validator)
+    # @param database_name [Symbol, nil] The database this migration is being compiled
+    #   for. Used to resolve per-database config. Defaults to the default database.
+    def initialize(validator, database_name: nil)
       @validator = validator
+      @database_name = database_name
       @instructions = Hash.new { |h, k| h[k] = InstructionSet.new([]) }
       validate
     end
 
+    # @api private
+    attr_reader :database_name
+
     # @api private
     def up_instructions
       compile_instructions(:up)
@@ -331,7 +337,7 @@ module Nandi
 
     def disable_lock_timeout?
       if self.class.lock_timeout.nil?
-        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_lock_timeout.nil?
+        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_lock_timeout(database_name, table).nil?
       else
         false
       end
@@ -339,7 +345,7 @@ module Nandi
 
     def disable_statement_timeout?
       if self.class.statement_timeout.nil?
-        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_statement_timeout.nil?
+        strictest_lock == LockWeights::SHARE && Nandi.config.concurrent_statement_timeout(database_name, table).nil?
       else
         false
       end
@@ -354,7 +360,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
@@ -377,20 +383,33 @@ module Nandi
 
     def default_statement_timeout
       if strictest_lock == LockWeights::SHARE
-        Nandi.config.concurrent_statement_timeout || Nandi.config.access_exclusive_statement_timeout
+        Nandi.config.concurrent_statement_timeout(database_name, table) ||
+          Nandi.config.access_exclusive_statement_timeout(database_name)
       else
-        Nandi.config.access_exclusive_statement_timeout
+        Nandi.config.access_exclusive_statement_timeout(database_name)
       end
     end
 
     def default_lock_timeout
       if strictest_lock == LockWeights::SHARE
-        Nandi.config.concurrent_lock_timeout || Nandi.config.access_exclusive_lock_timeout
+        Nandi.config.concurrent_lock_timeout(database_name, table) ||
+          Nandi.config.access_exclusive_lock_timeout(database_name)
       else
-        Nandi.config.access_exclusive_lock_timeout
+        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/timeout_policies/access_exclusive.rb

@@ -43,11 +43,11 @@ module Nandi
       end
 
       def statement_timeout_maximum
-        Nandi.config.access_exclusive_statement_timeout_max
+        Nandi.config.access_exclusive_statement_timeout_max(migration.database_name)
       end
 
       def lock_timeout_maximum
-        Nandi.config.access_exclusive_lock_timeout_max
+        Nandi.config.access_exclusive_lock_timeout_max(migration.database_name)
       end
     end
   end

data/lib/nandi/timeout_policies/concurrent.rb

@@ -53,11 +53,11 @@ module Nandi
       end
 
       def minimum_lock_timeout
-        Nandi.config.concurrent_lock_timeout_min
+        Nandi.config.concurrent_lock_timeout_min(migration.database_name)
       end
 
       def minimum_statement_timeout
-        Nandi.config.concurrent_statement_timeout_min
+        Nandi.config.concurrent_statement_timeout_min(migration.database_name)
       end
     end
   end

data/lib/nandi/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - GoCardless Engineering
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Fear-free migrations for PostgreSQL
 test_files: []