Class: RuboCop::Cop::Sidekiq::MissingLogging

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

Overview

Checks for missing logging in Sidekiq job perform methods.

Examples:

# bad
def perform(user_id)
  do_work(user_id)
end

# good
def perform(user_id)
  logger.info "Starting job for #{user_id}"
  do_work(user_id)
end

Constant Summary collapse

MSG = 
'Add logging to Sidekiq job perform methods.'

Instance Method Summary collapse

Methods included from Sidekiq::Language

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

Instance Method Details

#on_def(node) ⇒ Object 



23
24
25
26
27
28
29
 
# File 'lib/rubocop/cop/sidekiq/missing_logging.rb', line 23

def on_def(node)
  return unless node.method?(:perform)
  return unless in_sidekiq_job?(node)
  return if logger_call?(node)

  add_offense(node.loc.keyword)
end