Merge branch 'bvl-explain-contextless-workers' into 'master'

Explain cron-workers that don't need context

See merge request gitlab-org/gitlab!24494

app/workers/admin_email_worker.rb

@@ -2,7 +2,10 @@
 
 class AdminEmailWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category_not_owned!
 

app/workers/expire_build_artifacts_worker.rb

@@ -2,7 +2,10 @@
 
 class ExpireBuildArtifactsWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :continuous_integration
 

app/workers/gitlab_usage_ping_worker.rb

@@ -4,7 +4,10 @@ class GitlabUsagePingWorker
   LEASE_TIMEOUT = 86400
 
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category_not_owned!
 

app/workers/import_export_project_cleanup_worker.rb

@@ -2,7 +2,10 @@
 
 class ImportExportProjectCleanupWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :importers
 

app/workers/prune_old_events_worker.rb

@@ -2,7 +2,10 @@
 
 class PruneOldEventsWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category_not_owned!
 

app/workers/prune_web_hook_logs_worker.rb

@@ -4,7 +4,10 @@
 # table.
 class PruneWebHookLogsWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :integrations
 

app/workers/remove_unreferenced_lfs_objects_worker.rb

@@ -2,7 +2,10 @@
 
 class RemoveUnreferencedLfsObjectsWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :git_lfs
 

app/workers/repository_archive_cache_worker.rb

@@ -2,7 +2,10 @@
 
 class RepositoryArchiveCacheWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :source_code_management
 

app/workers/repository_check/dispatch_worker.rb

@@ -3,7 +3,10 @@
 module RepositoryCheck
   class DispatchWorker
     include ApplicationWorker
-    include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+    # rubocop:disable Scalability/CronWorkerContext
+    # This worker does not perform work scoped to a context
+    include CronjobQueue
+    # rubocop:enable Scalability/CronWorkerContext
     include ::EachShardWorker
     include ExclusiveLeaseGuard
 

app/workers/requests_profiles_worker.rb

@@ -2,7 +2,10 @@
 
 class RequestsProfilesWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :source_code_management
 

app/workers/stuck_import_jobs_worker.rb

@@ -2,7 +2,11 @@
 
 class StuckImportJobsWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker updates several import states inline and does not schedule
+  # other jobs. So no context needed
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :importers
   worker_resource_boundary :cpu

app/workers/trending_projects_worker.rb

@@ -2,6 +2,10 @@
 
 class TrendingProjectsWorker
   include ApplicationWorker
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
   include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
 
   feature_category :source_code_management

ee/app/workers/clear_shared_runners_minutes_worker.rb

@@ -4,8 +4,11 @@ class ClearSharedRunnersMinutesWorker
   LEASE_TIMEOUT = 3600
 
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
-
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  # all queries are scoped across multiple namespaces
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
   feature_category :continuous_integration
 
   def perform

ee/app/workers/geo/container_repository_sync_dispatch_worker.rb

@@ -2,7 +2,10 @@
 
 module Geo
   class ContainerRepositorySyncDispatchWorker < Geo::Scheduler::Secondary::SchedulerWorker
-    include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+    # rubocop:disable Scalability/CronWorkerContext
+    # This worker does not perform work scoped to a context
+    include CronjobQueue
+    # rubocop:enable Scalability/CronWorkerContext
 
     def perform
       unless Gitlab.config.geo.registry_replication.enabled

ee/app/workers/geo/file_download_dispatch_worker.rb

@@ -2,7 +2,10 @@
 
 module Geo
   class FileDownloadDispatchWorker < Geo::Scheduler::Secondary::SchedulerWorker
-    include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+    # rubocop:disable Scalability/CronWorkerContext
+    # This worker does not perform work scoped to a context
+    include CronjobQueue
+    # rubocop:enable Scalability/CronWorkerContext
 
     private
 

ee/app/workers/geo/metrics_update_worker.rb

@@ -4,7 +4,10 @@ module Geo
   class MetricsUpdateWorker
     include ApplicationWorker
     include ExclusiveLeaseGuard
-    include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+    # rubocop:disable Scalability/CronWorkerContext
+    # This worker does not perform work scoped to a context
+    include CronjobQueue
+    # rubocop:enable Scalability/CronWorkerContext
 
     feature_category :geo_replication
 

ee/app/workers/geo/prune_event_log_worker.rb

@@ -3,7 +3,10 @@
 module Geo
   class PruneEventLogWorker
     include ApplicationWorker
-    include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+    # rubocop:disable Scalability/CronWorkerContext
+    # This worker does not perform work scoped to a context
+    include CronjobQueue
+    # rubocop:enable Scalability/CronWorkerContext
     include ::Gitlab::Utils::StrongMemoize
     include ::Gitlab::Geo::LogHelpers
 

ee/app/workers/geo/repository_verification/secondary/shard_worker.rb

@@ -4,7 +4,10 @@ module Geo
   module RepositoryVerification
     module Secondary
       class ShardWorker < Geo::Scheduler::Secondary::SchedulerWorker
-        include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+        # rubocop:disable Scalability/CronWorkerContext
+        # This worker does not perform work scoped to a context
+        include CronjobQueue
+        # rubocop:enable Scalability/CronWorkerContext
         attr_accessor :shard_name
 
         def perform(shard_name)

ee/app/workers/geo/scheduler/per_shard_scheduler_worker.rb

@@ -4,7 +4,10 @@ module Geo
   module Scheduler
     class PerShardSchedulerWorker
       include ApplicationWorker
-      include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+      # rubocop:disable Scalability/CronWorkerContext
+      # This worker does not perform work scoped to a context
+      include CronjobQueue
+      # rubocop:enable Scalability/CronWorkerContext
       include ::Gitlab::Geo::LogHelpers
       include ::EachShardWorker
 

ee/app/workers/geo/sidekiq_cron_config_worker.rb

@@ -3,7 +3,10 @@
 module Geo
   class SidekiqCronConfigWorker
     include ApplicationWorker
-    include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+    # rubocop:disable Scalability/CronWorkerContext
+    # This worker does not perform work scoped to a context
+    include CronjobQueue
+    # rubocop:enable Scalability/CronWorkerContext
 
     feature_category :geo_replication
 

ee/app/workers/historical_data_worker.rb

@@ -2,7 +2,10 @@
 
 class HistoricalDataWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :license_compliance
 

ee/app/workers/ldap_all_groups_sync_worker.rb

@@ -2,7 +2,10 @@
 
 class LdapAllGroupsSyncWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :authentication_and_authorization
   worker_has_external_dependencies!

ee/app/workers/pseudonymizer_worker.rb

@@ -2,7 +2,10 @@
 
 class PseudonymizerWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  # rubocop:disable Scalability/CronWorkerContext
+  # This worker does not perform work scoped to a context
+  include CronjobQueue
+  # rubocop:enable Scalability/CronWorkerContext
 
   feature_category :integrations
 

ee/app/workers/update_all_mirrors_worker.rb

@@ -2,7 +2,7 @@
 
 class UpdateAllMirrorsWorker
   include ApplicationWorker
-  include CronjobQueue # rubocop:disable Scalability/CronWorkerContext
+  include CronjobQueue
 
   feature_category :source_code_management
 

rubocop/cop/scalability/cron_worker_context.rb

@@ -23,7 +23,7 @@ module RuboCop
         PATTERN
 
         def_node_search :schedules_with_batch_context?, <<~PATTERN
-          (send (...) {:bulk_perform_async_with_contexts :bulk_perform_in_with_contexts} (...))
+          (send (...) {:bulk_perform_async_with_contexts :bulk_perform_in_with_contexts} _*)
         PATTERN
 
         def on_send(node)

spec/rubocop/cop/scalability/cron_worker_context_spec.rb

@@ -58,7 +58,9 @@ describe RuboCop::Cop::Scalability::CronWorkerContext do
         include CronjobQueue
 
         def perform
-          SomeOtherWorker.bulk_perform_async_with_contexts(contexts_for_arguments)
+          SomeOtherWorker.bulk_perform_async_with_contexts(things,
+                                                           arguments_proc: -> (thing) { thing.id },
+                                                           context_proc: -> (thing) { { project: thing.project } })
         end
       end
     CODE
@@ -70,7 +72,9 @@ describe RuboCop::Cop::Scalability::CronWorkerContext do
         include CronjobQueue
 
         def perform
-          SomeOtherWorker.bulk_perform_in_with_contexts(contexts_for_arguments)
+          SomeOtherWorker.bulk_perform_in_with_contexts(10.minutes, things,
+                                                        arguments_proc: -> (thing) { thing.id },
+                                                        context_proc: -> (thing) { { project: thing.project } })
         end
       end
     CODE