Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'rubocop/cop/scalability/cron_worker_context.rb')
-rw-r--r--rubocop/cop/scalability/cron_worker_context.rb39
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