2021-02-11 16:09:00 -05:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-02-09 10:52:43 -05:00
|
|
|
require_relative '../../migration_helpers'
|
|
|
|
|
|
|
|
module RuboCop
|
|
|
|
module Cop
|
|
|
|
module Migration
|
|
|
|
# Cop that checks if `add_concurrent_foreign_key` is used instead of
|
|
|
|
# `add_foreign_key`.
|
|
|
|
class AddConcurrentForeignKey < RuboCop::Cop::Cop
|
|
|
|
include MigrationHelpers
|
|
|
|
|
2021-03-23 11:09:28 -04:00
|
|
|
MSG = '`add_foreign_key` requires downtime, use `add_concurrent_foreign_key` instead'
|
2017-02-09 10:52:43 -05:00
|
|
|
|
2020-04-28 14:09:35 -04:00
|
|
|
def_node_matcher :false_node?, <<~PATTERN
|
2020-10-06 08:08:38 -04:00
|
|
|
(false)
|
|
|
|
PATTERN
|
|
|
|
|
|
|
|
def_node_matcher :with_lock_retries?, <<~PATTERN
|
|
|
|
(:send nil? :with_lock_retries)
|
2020-04-28 14:09:35 -04:00
|
|
|
PATTERN
|
|
|
|
|
2017-02-09 10:52:43 -05:00
|
|
|
def on_send(node)
|
|
|
|
return unless in_migration?(node)
|
|
|
|
|
|
|
|
name = node.children[1]
|
|
|
|
|
2020-10-06 08:08:38 -04:00
|
|
|
return unless name == :add_foreign_key
|
|
|
|
return if in_with_lock_retries?(node)
|
|
|
|
return if not_valid_fk?(node)
|
|
|
|
|
|
|
|
add_offense(node, location: :selector)
|
2017-02-09 10:52:43 -05:00
|
|
|
end
|
|
|
|
|
|
|
|
def method_name(node)
|
|
|
|
node.children.first
|
|
|
|
end
|
2020-04-28 14:09:35 -04:00
|
|
|
|
|
|
|
def not_valid_fk?(node)
|
|
|
|
node.each_node(:pair).any? do |pair|
|
|
|
|
pair.children[0].children[0] == :validate && false_node?(pair.children[1])
|
|
|
|
end
|
|
|
|
end
|
2020-10-06 08:08:38 -04:00
|
|
|
|
|
|
|
def in_with_lock_retries?(node)
|
|
|
|
node.each_ancestor(:block).any? do |parent|
|
|
|
|
with_lock_retries?(parent.to_a.first)
|
|
|
|
end
|
|
|
|
end
|
2017-02-09 10:52:43 -05:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|