Rename CsvExportWorker -> CsvExportJob

Sidekiq::Worker has been deprecated in Sidekiq 7. This replaces all instances of Sidekiq::Worker with Sidekiq::Job and renames/moves workers to app/sidekiq/MyJob.rb.
alphagov · Oct 18, 2024 · a690c1a · a690c1a
1 parent a841df8
commit a690c1a
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/app/controllers/content_controller.rb b/app/controllers/content_controller.rb
@@ -21,7 +21,7 @@ def export_csv
     @recipient = current_user.email
 
     start_time_string = Time.zone.now.to_s
-    CsvExportWorker.perform_async(search_params.stringify_keys, @recipient, start_time_string)
+    CsvExportJob.perform_async(search_params.stringify_keys, @recipient, start_time_string)
   end
 
 private

diff --git a/app/workers/csv_export_worker.rb → app/sidekiq/csv_export_job.rb b/app/workers/csv_export_worker.rb → app/sidekiq/csv_export_job.rb
@@ -1,9 +1,9 @@
 require "prometheus/client"
 require "prometheus/client/push"
 
-class CsvExportWorker
+class CsvExportJob
   include FileStorage
-  include Sidekiq::Worker
+  include Sidekiq::Job
 
   sidekiq_options retry: 0
   sidekiq_options queue: "export_csv"
@@ -61,3 +61,5 @@ def push_metrics_to_pushgateway(elapsed_time_seconds)
     ).add(prometheus_registry)
   end
 end
+
+CsvExportWorker = CsvExportJob ## TODO: Remove once queued jobs at the time of the upgrade are complete
diff --git a/spec/workers/concerns/file_storage_spec.rb → spec/sidekiq/concerns/file_storage_spec.rb b/spec/workers/concerns/file_storage_spec.rb → spec/sidekiq/concerns/file_storage_spec.rb
diff --git a/spec/workers/csv_export_worker_spec.rb → spec/sidekiq/csv_export_job_spec.rb b/spec/workers/csv_export_worker_spec.rb → spec/sidekiq/csv_export_job_spec.rb
@@ -1,6 +1,6 @@
 require "govuk_sidekiq/testing"
 
-RSpec.describe CsvExportWorker do
+RSpec.describe CsvExportJob do
   let(:search_params) do
     {
       date_range: "past-30-days",
@@ -68,7 +68,7 @@
   let(:csv_export_histogram) { instance_spy(Prometheus::Client::Histogram) }
 
   before do
-    Sidekiq::Worker.clear_all
+    Sidekiq::Job.clear_all
 
     ENV["AWS_CSV_EXPORT_BUCKET_NAME"] = "test-bucket"
     ENV["PROMETHEUS_PUSHGATEWAY_URL"] = "http://prometheus-pushgateway.local"