Class: RuboCop::Cop::Sidekiq::ConstantJobClassName

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/sidekiq/constant_job_class_name.rb

Overview

Checks that job class names are constants.

Using dynamic class names for jobs can lead to:

  • Security vulnerabilities (arbitrary code execution)
  • Difficult to trace job execution
  • Harder static analysis

Examples:

# bad
job_class.perform_async(args)
"#{prefix}Job".constantize.perform_async(args)

# good
MyJob.perform_async(args)
MyModule::MyJob.perform_async(args)

Constant Summary collapse

MSG = 
'Use a constant class name for Sidekiq jobs. ' \
'Dynamic job class names are harder to trace and may be insecure.'
RESTRICT_ON_SEND = 
PerformMethods.all

Instance Method Summary collapse

Methods included from Sidekiq::Language

#active_job_class?, #perform_call?, #sidekiq_include?, #sidekiq_options_call?

Instance Method Details

#on_send(node) ⇒ Object Also known as: on_csend 



28
29
30
31
32
33
 
# File 'lib/rubocop/cop/sidekiq/constant_job_class_name.rb', line 28

def on_send(node)
  return unless RESTRICT_ON_SEND.include?(node.method_name)
  return if constant_receiver?(node)

  add_offense(node.receiver)
end