diff options
Diffstat (limited to 'rubocop/cop/scalability')
-rw-r--r-- | rubocop/cop/scalability/bulk_perform_with_context.rb | 46 | ||||
-rw-r--r-- | rubocop/cop/scalability/cron_worker_context.rb | 39 |
2 files changed, 85 insertions, 0 deletions
diff --git a/rubocop/cop/scalability/bulk_perform_with_context.rb b/rubocop/cop/scalability/bulk_perform_with_context.rb new file mode 100644 index 00000000000..3c5d7f39680 --- /dev/null +++ b/rubocop/cop/scalability/bulk_perform_with_context.rb @@ -0,0 +1,46 @@ +# frozen_string_literal: true + +require_relative '../../migration_helpers' +require_relative '../../code_reuse_helpers' + +module RuboCop + module Cop + module Scalability + class BulkPerformWithContext < RuboCop::Cop::Cop + include RuboCop::MigrationHelpers + include RuboCop::CodeReuseHelpers + + MSG = <<~MSG + Prefer using `Worker.bulk_perform_async_with_contexts` and + `Worker.bulk_perform_in_with_context` over the methods without a context + if your worker deals with specific projects or namespaces + The context is required to add metadata to our logs. + + If there is already a parent context that will apply to the jobs + being scheduled, please disable this cop with a comment explaing which + context will be applied. + + Read more about it https://docs.gitlab.com/ee/development/sidekiq_style_guide.html#worker-context + MSG + + def_node_matcher :schedules_in_batch_without_context?, <<~PATTERN + (send (...) {:bulk_perform_async :bulk_perform_in} _*) + PATTERN + + def on_send(node) + return if in_migration?(node) || in_spec?(node) + return unless schedules_in_batch_without_context?(node) + return if name_of_receiver(node) == "BackgroundMigrationWorker" + + add_offense(node, location: :expression) + end + + private + + def in_spec?(node) + file_path_for_node(node).end_with?("_spec.rb") + end + end + end + end +end diff --git a/rubocop/cop/scalability/cron_worker_context.rb b/rubocop/cop/scalability/cron_worker_context.rb new file mode 100644 index 00000000000..d8eba0f098e --- /dev/null +++ b/rubocop/cop/scalability/cron_worker_context.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +module RuboCop + module Cop + module Scalability + class CronWorkerContext < RuboCop::Cop::Cop + MSG = <<~MSG + Manually define an ApplicationContext for cronjob-workers. The context + is required to add metadata to our logs. + + If there is no relevant metadata, please disable the cop with a comment + explaining this. + + Read more about it https://docs.gitlab.com/ee/development/sidekiq_style_guide.html#worker-context + MSG + + def_node_matcher :includes_cronjob_queue?, <<~PATTERN + (send nil? :include (const nil? :CronjobQueue)) + PATTERN + + def_node_search :defines_contexts?, <<~PATTERN + (send nil? :with_context _) + PATTERN + + def_node_search :schedules_with_batch_context?, <<~PATTERN + (send (...) {:bulk_perform_async_with_contexts :bulk_perform_in_with_contexts} (...)) + PATTERN + + def on_send(node) + return unless includes_cronjob_queue?(node) + return if defines_contexts?(node.parent) + return if schedules_with_batch_context?(node.parent) + + add_offense(node.arguments.first, location: :expression) + end + end + end + end +end |