47 lines
1.5 KiB
Ruby
47 lines
1.5 KiB
Ruby
|
# 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
|