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/cron_worker_context.rb | |
parent | 88a0824944720b6edaaef56376713541b9a02118 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'rubocop/cop/scalability/cron_worker_context.rb')
-rw-r--r-- | rubocop/cop/scalability/cron_worker_context.rb | 39 |
1 files changed, 39 insertions, 0 deletions
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 |