nandi 0.9.0

data/lib/nandi/timeout_policies/concurrent.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "nandi"
+require "nandi/validation"
+require "nandi/validation/failure_helpers"
+
+module Nandi
+  module TimeoutPolicies
+    class Concurrent
+      include Nandi::Validation::FailureHelpers
+
+      def self.validate(migration)
+        new(migration).validate
+      end
+
+      def initialize(migration)
+        @migration = migration
+      end
+
+      def validate
+        collect_errors(
+          validate_statement_timeout,
+          validate_lock_timeout,
+        )
+      end
+
+      private
+
+      attr_accessor :migration
+
+      def validate_statement_timeout
+        assert(
+          migration.disable_statement_timeout? || statement_timeout_high_enough,
+          "statement timeout for concurrent operations "\
+          "must be at least #{minimum_statement_timeout}",
+        )
+      end
+
+      def validate_lock_timeout
+        assert(
+          migration.disable_lock_timeout? || lock_timeout_high_enough,
+          "lock timeout for concurrent operations "\
+          "must be at least #{minimum_lock_timeout}",
+        )
+      end
+
+      def statement_timeout_high_enough
+        migration.statement_timeout >= minimum_statement_timeout
+      end
+
+      def lock_timeout_high_enough
+        migration.lock_timeout >= minimum_lock_timeout
+      end
+
+      def minimum_lock_timeout
+        Nandi.config.concurrent_lock_timeout_limit
+      end
+
+      def minimum_statement_timeout
+        Nandi.config.concurrent_statement_timeout_limit
+      end
+    end
+  end
+end

data/lib/nandi/validation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "nandi/validation/add_column_validator"
+require "nandi/validation/remove_index_validator"
+require "nandi/validation/each_validator"
+require "nandi/validation/result"
+require "nandi/validation/failure_helpers"
+require "nandi/validation/timeout_validator"
+
+module Validation; end

data/lib/nandi/validation/add_column_validator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "nandi/validation/failure_helpers"
+
+module Nandi
+  module Validation
+    class AddColumnValidator
+      include Nandi::Validation::FailureHelpers
+
+      def self.call(instruction)
+        new(instruction).call
+      end
+
+      def initialize(instruction)
+        @instruction = instruction
+      end
+
+      def call
+        collect_errors(
+          assert(nullable? || default_value?,
+                 "add_column: non-null column lacks default"),
+          assert(!unique?, "add_column: column is unique"),
+        )
+      end
+
+      attr_reader :instruction
+
+      private
+
+      def default_value?
+        !instruction.extra_args[:default].nil?
+      end
+
+      def nullable?
+        instruction.extra_args.fetch(:null, true)
+      end
+
+      def unique?
+        instruction.extra_args.fetch(:unique, false)
+      end
+    end
+  end
+end

data/lib/nandi/validation/each_validator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "nandi/validation/failure_helpers"
+
+module Nandi
+  module Validation
+    class EachValidator
+      include Nandi::Validation::FailureHelpers
+
+      def self.call(instruction)
+        new(instruction).call
+      end
+
+      def initialize(instruction)
+        @instruction = instruction
+      end
+
+      def call
+        case instruction.procedure
+        when :remove_index
+          RemoveIndexValidator.call(instruction)
+        when :add_column
+          AddColumnValidator.call(instruction)
+        else
+          success
+        end
+      end
+
+      attr_reader :instruction
+    end
+  end
+end

data/lib/nandi/validation/failure_helpers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "dry/monads/result"
+
+module Nandi
+  module Validation
+    module FailureHelpers
+      def collect_errors(new, old)
+        return success if new.success? && old.success?
+
+        if old.failure?
+          failure(Array(old.failure) + Array(new.failure))
+        else
+          failure(Array(new.failure))
+        end
+      end
+
+      def success
+        Dry::Monads::Result::Success.new(nil)
+      end
+
+      def failure(value)
+        Dry::Monads::Result::Failure.new(value)
+      end
+
+      def assert(condition, message)
+        if condition
+          success
+        else
+          failure(message)
+        end
+      end
+    end
+  end
+end

data/lib/nandi/validation/remove_index_validator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "nandi/validation/failure_helpers"
+
+module Nandi
+  module Validation
+    class RemoveIndexValidator
+      include Nandi::Validation::FailureHelpers
+
+      def self.call(instruction)
+        new(instruction).call
+      end
+
+      def initialize(instruction)
+        @instruction = instruction
+      end
+
+      def call
+        opts = instruction.extra_args
+
+        assert(
+          opts.key?(:name) || opts.key?(:column),
+          "remove_index: requires a `name` or `column` argument",
+        )
+      end
+
+      attr_reader :instruction
+    end
+  end
+end

data/lib/nandi/validation/result.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "nandi/validation/failure_helpers"
+module Nandi
+  module Validation
+    class Result
+      include Nandi::Validation::FailureHelpers
+
+      attr_reader :errors
+
+      def initialize(instruction = nil)
+        @instruction = instruction
+        @errors = success
+      end
+
+      def valid?
+        @errors.success?
+      end
+
+      def <<(error)
+        @errors = collect_errors(error, @errors)
+        self
+      end
+
+      def error_list
+        @errors.failure.join("\n")
+      end
+    end
+  end
+end

data/lib/nandi/validation/timeout_validator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "nandi/validation/failure_helpers"
+
+module Nandi
+  module Validation
+    class TimeoutValidator
+      include Nandi::Validation::FailureHelpers
+
+      def self.call(migration)
+        new(migration).call
+      end
+
+      def initialize(migration)
+        @migration = migration
+      end
+
+      def call
+        timeout_policies.inject(success) do |result, policy|
+          collect_errors(policy.validate(migration), result)
+        end
+      end
+
+      private
+
+      def timeout_policies
+        instructions.map(&Nandi::TimeoutPolicies.method(:policy_for)).uniq
+      end
+
+      def instructions
+        [*migration.up_instructions, *migration.down_instructions]
+      end
+
+      attr_reader :migration
+    end
+  end
+end

data/lib/nandi/validator.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "nandi/validation"
+require "nandi/timeout_policies"
+
+module Nandi
+  class Validator
+    include Nandi::Validation::FailureHelpers
+
+    class InstructionValidator
+      def self.call(instruction)
+        new(instruction).call
+      end
+
+      def initialize(instruction)
+        @instruction = instruction
+      end
+
+      def call
+        raise NotImplementedError
+      end
+
+      attr_reader :instruction
+    end
+
+    def self.call(migration)
+      new(migration).call
+    end
+
+    def initialize(migration)
+      @migration = migration
+    end
+
+    def call
+      migration_invariants_respected << each_instruction_validation
+    end
+
+    private
+
+    def migration_invariants_respected
+      Validation::Result.new.tap do |result|
+        result << assert(
+          at_most_one_object_modified,
+          "modifying more than one table per migration",
+        )
+
+        result << assert(
+          new_indexes_are_separated_from_other_migrations,
+          "creating more than one index per migration",
+        )
+
+        result << validate_timeouts
+      end
+    end
+
+    def at_most_one_object_modified
+      [migration.up_instructions, migration.down_instructions].all? do |instructions|
+        affected_tables = instructions.map do |instruction|
+          instruction.respond_to?(:table) && instruction.table.to_sym
+        end
+
+        affected_tables.uniq.count <= 1
+      end
+    end
+
+    def new_indexes_are_separated_from_other_migrations
+      [migration.up_instructions, migration.down_instructions].map do |instructions|
+        instructions.none? { |i| i.procedure == :add_index } ||
+          instructions.count == 1
+      end.all?
+    end
+
+    def statement_timeout_is_within_acceptable_bounds
+      migration.strictest_lock != Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE ||
+        migration.statement_timeout <=
+          Nandi.config.access_exclusive_statement_timeout_limit
+    end
+
+    def lock_timeout_is_within_acceptable_bounds
+      migration.strictest_lock != Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE ||
+        migration.lock_timeout <=
+          Nandi.config.access_exclusive_lock_timeout_limit
+    end
+
+    def each_instruction_validation
+      instructions.inject(success) do |result, instruction|
+        collect_errors(Validation::EachValidator.call(instruction), result)
+      end
+    end
+
+    def validate_timeouts
+      Nandi::Validation::TimeoutValidator.call(migration)
+    end
+
+    def instructions
+      [*migration.up_instructions, *migration.down_instructions]
+    end
+
+    attr_reader :migration
+  end
+end

data/lib/nandi/version.rb

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

data/lib/templates/nandi/renderers/active_record/generate/show.rb.erb

@@ -0,0 +1,27 @@
+class <%= name %> < ActiveRecord::Migration[<%= activerecord_version %>]
+  <%= mixins.map { |m| "include #{m.name}"}.join("\n") %>
+  <% if disable_lock_timeout? %>
+  disable_lock_timeout!
+  <% else %>
+  set_lock_timeout(<%= lock_timeout %>)
+  <% end %>
+  <% if disable_statement_timeout? %>
+  disable_statement_timeout!
+  <% else %>
+  set_statement_timeout(<%= statement_timeout %>)
+  <% end %>
+
+  <% if should_disable_ddl_transaction? %>disable_ddl_transaction!<% end %>
+  def up
+  <% up_instructions.each do |i| %>
+    <%= render_partial(i) %>
+  <% end %>
+  end
+  <% if down_instructions&.any? %>
+  def down
+  <% down_instructions.each do |i| %>
+    <%= render_partial(i) %>
+  <% end %>
+  end
+  <% end %>
+end

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

@@ -0,0 +1,7 @@
+execute <<-SQL
+  ALTER TABLE <%= table %>
+  ADD CONSTRAINT <%= name %>
+  CHECK (<%= check %>)
+  NOT VALID
+SQL
+

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

@@ -0,0 +1,6 @@
+add_column(
+  <%= table %>,
+  <%= name %>,
+  <%= type %>,
+  <%= extra_args %>
+)