diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-20 09:40:42 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-20 09:40:42 +0000 |
commit | ee664acb356f8123f4f6b00b73c1e1cf0866c7fb (patch) | |
tree | f8479f94a28f66654c6a4f6fb99bad6b4e86a40e /rubocop/cop/redis_queue_usage.rb | |
parent | 62f7d5c5b69180e82ae8196b7b429eeffc8e7b4f (diff) | |
download | gitlab-ce-ee664acb356f8123f4f6b00b73c1e1cf0866c7fb.tar.gz |
Add latest changes from gitlab-org/gitlab@15-5-stable-eev15.5.0-rc42
Diffstat (limited to 'rubocop/cop/redis_queue_usage.rb')
-rw-r--r-- | rubocop/cop/redis_queue_usage.rb | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/rubocop/cop/redis_queue_usage.rb b/rubocop/cop/redis_queue_usage.rb new file mode 100644 index 00000000000..d993abc6327 --- /dev/null +++ b/rubocop/cop/redis_queue_usage.rb @@ -0,0 +1,38 @@ +# frozen_string_literal: true + +module RuboCop + module Cop + # This class complements Rubocop::Cop::SidekiqRedisCall by disallowing the use of + # Gitlab::Redis::Queues with the exception of initialising Sidekiq and monitoring. + class RedisQueueUsage < RuboCop::Cop::Base + MSG = 'Gitlab::Redis::Queues should only be used by Sidekiq initializers. '\ + 'Assignments or using its params to initialise another connection is not allowed.' + + def_node_matcher :calling_redis_queue_module_methods?, <<~PATTERN + (send (const (const (const nil? :Gitlab) :Redis) :Queues) ...) + PATTERN + + def_node_matcher :using_redis_queue_module_as_parameter?, <<~PATTERN + (send ... (const (const (const nil? :Gitlab) :Redis) :Queues)) + PATTERN + + def_node_matcher :redis_queue_assignment?, <<~PATTERN + ({lvasgn | ivasgn | cvasgn | gvasgn | casgn | masgn | op_asgn | or_asgn | and_asgn } ... + `(const (const (const nil? :Gitlab) :Redis) :Queues)) + PATTERN + + def on_send(node) + return unless using_redis_queue_module_as_parameter?(node) || calling_redis_queue_module_methods?(node) + + add_offense(node, message: MSG) + end + + # offenses caught in assignment may overlap with on_send + %i[on_lvasgn on_ivasgn on_cvasgn on_gvasgn on_casgn on_masgn on_op_asgn on_or_asgn on_and_asgn].each do |name| + define_method(name) do |node| + add_offense(node, message: MSG) if redis_queue_assignment?(node) + end + end + end + end +end |