diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-04 18:08:40 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-04 18:08:40 +0300 |
commit | 6b833f1e0340e00fdee074da9c42c0d4e07a46d2 (patch) | |
tree | 6fc3a7a2f8a02fec8d1e7561b453d33eb4048dad /rubocop/cop/scalability/bulk_perform_with_context.rb | |
parent | 88a0824944720b6edaaef56376713541b9a02118 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'rubocop/cop/scalability/bulk_perform_with_context.rb')
-rw-r--r-- | rubocop/cop/scalability/bulk_perform_with_context.rb | 46 |
1 files changed, 46 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 |