Refactor ApplicationJob

thomasleese · thomasleese · commit b11669b944cb · 2026-04-30T09:12:34.000+01:00
This refactors the `ApplicationJob` in to two variants,
`ApplicationJobActiveJob and `ApplicationJobSidekiq`, according to how
the job is defined.

We're making this change to support migrating away from using Active Job
and instead using the Sidekiq API directly, which gives us a number of
benefits.

We can't just switch over in one go, as any Active Job jobs left in the
queue will fail to run once the job class has been converted. So
instead, we need two versions of each job, and then only once we no
longer have any Active Job jobs in the queue, we can remove the
Active Job variations.

Jira-Issue: MAV-7288
diff --git a/app/jobs/application_job.rb b/app/jobs/application_job.rb
diff --git a/app/jobs/application_job_active_job.rb b/app/jobs/application_job_active_job.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# rubocop:disable Rails/ApplicationJob
+class ApplicationJobActiveJob < ActiveJob::Base
+  discard_on ActiveJob::DeserializationError
+end
+# rubocop:enable Rails/ApplicationJob
diff --git a/app/jobs/application_job_sidekiq.rb b/app/jobs/application_job_sidekiq.rb
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ApplicationJobSidekiq
+  include Sidekiq::Job
+end
diff --git a/app/jobs/bulk_remove_parent_relationships_job.rb b/app/jobs/bulk_remove_parent_relationships_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class BulkRemoveParentRelationshipsJob < ApplicationJob
+class BulkRemoveParentRelationshipsJob < ApplicationJobActiveJob
   queue_as :imports
 
   def perform(
diff --git a/app/jobs/commit_patient_changesets_job.rb b/app/jobs/commit_patient_changesets_job.rb
@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-class CommitPatientChangesetsJob
-  include Sidekiq::Job
-  include Sidekiq::Throttled::Job
+class CommitPatientChangesetsJob < ApplicationJobSidekiq
   include PatientImportConcern
 
-  queue_as :imports
+  sidekiq_options queue: :imports
 
   def perform(patient_changeset_ids)
     changesets =
diff --git a/app/jobs/enqueue_automated_careplus_reports_job.rb b/app/jobs/enqueue_automated_careplus_reports_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueAutomatedCareplusReportsJob < ApplicationJob
+class EnqueueAutomatedCareplusReportsJob < ApplicationJobActiveJob
   queue_as :careplus
 
   def perform
diff --git a/app/jobs/enqueue_location_position_updater_job.rb b/app/jobs/enqueue_location_position_updater_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueLocationPositionUpdaterJob < ApplicationJob
+class EnqueueLocationPositionUpdaterJob < ApplicationJobActiveJob
   queue_as :third_party_data_imports
 
   def perform
diff --git a/app/jobs/enqueue_patients_aged_out_of_schools_job.rb b/app/jobs/enqueue_patients_aged_out_of_schools_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueuePatientsAgedOutOfSchoolsJob < ApplicationJob
+class EnqueuePatientsAgedOutOfSchoolsJob < ApplicationJobActiveJob
   queue_as :patients
 
   def perform
diff --git a/app/jobs/enqueue_process_unmatched_consent_forms_job.rb b/app/jobs/enqueue_process_unmatched_consent_forms_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueProcessUnmatchedConsentFormsJob < ApplicationJob
+class EnqueueProcessUnmatchedConsentFormsJob < ApplicationJobActiveJob
   include SingleConcurrencyConcern
 
   queue_as :consents
diff --git a/app/jobs/enqueue_school_consent_reminders_job.rb b/app/jobs/enqueue_school_consent_reminders_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueSchoolConsentRemindersJob < ApplicationJob
+class EnqueueSchoolConsentRemindersJob < ApplicationJobActiveJob
   queue_as :notifications
 
   def perform
diff --git a/app/jobs/enqueue_school_consent_requests_job.rb b/app/jobs/enqueue_school_consent_requests_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueSchoolConsentRequestsJob < ApplicationJob
+class EnqueueSchoolConsentRequestsJob < ApplicationJobActiveJob
   queue_as :notifications
 
   def perform
diff --git a/app/jobs/enqueue_school_session_reminders_job.rb b/app/jobs/enqueue_school_session_reminders_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueSchoolSessionRemindersJob < ApplicationJob
+class EnqueueSchoolSessionRemindersJob < ApplicationJobActiveJob
   queue_as :notifications
 
   def perform
diff --git a/app/jobs/enqueue_update_patients_from_pds_job.rb b/app/jobs/enqueue_update_patients_from_pds_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class EnqueueUpdatePatientsFromPDSJob < ApplicationJob
+class EnqueueUpdatePatientsFromPDSJob < ApplicationJobActiveJob
   include SingleConcurrencyConcern
 
   queue_as :pds
diff --git a/app/jobs/enqueue_vaccinations_search_in_nhs_job.rb b/app/jobs/enqueue_vaccinations_search_in_nhs_job.rb
@@ -7,7 +7,7 @@
 # sessions, starting from 2 days before invitations or consent requests are sent
 # out and ending once the last date of the sessions has passed. For all other
 # patients we want to ensure a search is performed every 28 days at most.
-class EnqueueVaccinationsSearchInNHSJob < ApplicationJob
+class EnqueueVaccinationsSearchInNHSJob < ApplicationJobActiveJob
   queue_as :immunisations_api_search
 
   def perform(programme_types: nil)
diff --git a/app/jobs/gias_import_job.rb b/app/jobs/gias_import_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class GIASImportJob < ApplicationJob
+class GIASImportJob < ApplicationJobActiveJob
   include SingleConcurrencyConcern
 
   queue_as :third_party_data_imports
diff --git a/app/jobs/important_notice_generator_job.rb b/app/jobs/important_notice_generator_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ImportantNoticeGeneratorJob < ApplicationJob
+class ImportantNoticeGeneratorJob < ApplicationJobActiveJob
   queue_as :cache
 
   BATCH_SIZE = 1000
diff --git a/app/jobs/invalidate_self_consents_job.rb b/app/jobs/invalidate_self_consents_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class InvalidateSelfConsentsJob < ApplicationJob
+class InvalidateSelfConsentsJob < ApplicationJobActiveJob
   queue_as :consents
 
   def perform
diff --git a/app/jobs/location_position_updater_job.rb b/app/jobs/location_position_updater_job.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-class LocationPositionUpdaterJob
-  include Sidekiq::Job
-
+class LocationPositionUpdaterJob < ApplicationJobSidekiq
   sidekiq_options queue: :third_party_data_imports, lock: :until_executing
 
   def perform(location_id)
diff --git a/app/jobs/metrics/base_job.rb b/app/jobs/metrics/base_job.rb
@@ -5,9 +5,7 @@
 #
 # It configures the job to run on the `metrics` queue and does not retry if it
 # fails, allowing it to be scheduled regularly.
-class Metrics::BaseJob
-  include Sidekiq::Job
-
+class Metrics::BaseJob < ApplicationJobSidekiq
   # We don't retry jobs that export metrics if they fail as they are often
   #  scheduled to run regularly.
   sidekiq_options queue: :metrics, retry: false
diff --git a/app/jobs/notify_delivery_job.rb b/app/jobs/notify_delivery_job.rb
@@ -2,7 +2,7 @@
 
 require "notifications/client"
 
-class NotifyDeliveryJob < ApplicationJob
+class NotifyDeliveryJob < ApplicationJobActiveJob
   TEAM_ONLY_API_KEY_MESSAGE =
     "Can’t send to this recipient using a team-only API key"
 
diff --git a/app/jobs/patient_nhs_number_lookup_job.rb b/app/jobs/patient_nhs_number_lookup_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PatientNHSNumberLookupJob < ApplicationJob
+class PatientNHSNumberLookupJob < ApplicationJobActiveJob
   include PDSThrottlingConcern
 
   queue_as :pds
diff --git a/app/jobs/patient_status_updater_job.rb b/app/jobs/patient_status_updater_job.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-class PatientStatusUpdaterJob
-  include Sidekiq::Job
-
+class PatientStatusUpdaterJob < ApplicationJobSidekiq
   sidekiq_options queue: :cache, lock: :until_executed
 
   def perform(patient_id = nil)
diff --git a/app/jobs/patient_team_updater_job.rb b/app/jobs/patient_team_updater_job.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-class PatientTeamUpdaterJob
-  include Sidekiq::Job
-
+class PatientTeamUpdaterJob < ApplicationJobSidekiq
   sidekiq_options queue: :cache, lock: :until_executed
 
   def perform(patient_id = nil, team_id = nil)
diff --git a/app/jobs/patient_update_from_pds_job.rb b/app/jobs/patient_update_from_pds_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PatientUpdateFromPDSJob < ApplicationJob
+class PatientUpdateFromPDSJob < ApplicationJobActiveJob
   include PDSThrottlingConcern
 
   queue_as :pds
diff --git a/app/jobs/patients_aged_out_of_school_job.rb b/app/jobs/patients_aged_out_of_school_job.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-class PatientsAgedOutOfSchoolJob
-  include Sidekiq::Job
-
+class PatientsAgedOutOfSchoolJob < ApplicationJobSidekiq
   sidekiq_options queue: :patients
 
   def perform(school_id)
diff --git a/app/jobs/patients_clear_registration_job.rb b/app/jobs/patients_clear_registration_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PatientsClearRegistrationJob < ApplicationJob
+class PatientsClearRegistrationJob < ApplicationJobActiveJob
   queue_as :patients
 
   def perform
diff --git a/app/jobs/patients_refused_consent_already_vaccinated_job.rb b/app/jobs/patients_refused_consent_already_vaccinated_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PatientsRefusedConsentAlreadyVaccinatedJob < ApplicationJob
+class PatientsRefusedConsentAlreadyVaccinatedJob < ApplicationJobActiveJob
   queue_as :patients
 
   def perform
diff --git a/app/jobs/pds_cascading_search_job.rb b/app/jobs/pds_cascading_search_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PDSCascadingSearchJob < ApplicationJob
+class PDSCascadingSearchJob < ApplicationJobActiveJob
   include PDSThrottlingConcern
 
   queue_as :pds
diff --git a/app/jobs/process_consent_form_job.rb b/app/jobs/process_consent_form_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ProcessConsentFormJob < ApplicationJob
+class ProcessConsentFormJob < ApplicationJobActiveJob
   include PDSThrottlingConcern
 
   queue_as :consents
diff --git a/app/jobs/process_import_job.rb b/app/jobs/process_import_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ProcessImportJob < ApplicationJob
+class ProcessImportJob < ApplicationJobActiveJob
   include SingleConcurrencyConcern
 
   queue_as :imports
diff --git a/app/jobs/process_patient_changeset_job.rb b/app/jobs/process_patient_changeset_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ProcessPatientChangesetJob < ApplicationJob
+class ProcessPatientChangesetJob < ApplicationJobActiveJob
   queue_as :imports
 
   def perform(patient_changeset_id)
diff --git a/app/jobs/remove_import_csv_job.rb b/app/jobs/remove_import_csv_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class RemoveImportCSVJob < ApplicationJob
+class RemoveImportCSVJob < ApplicationJobActiveJob
   queue_as :imports
 
   def perform
diff --git a/app/jobs/reporting_api/refresh_job.rb b/app/jobs/reporting_api/refresh_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ReportingAPI::RefreshJob < ApplicationJob
+class ReportingAPI::RefreshJob < ApplicationJobActiveJob
   def perform
     ReportingAPI::Total.refresh!
   end
diff --git a/app/jobs/review_class_import_school_move_job.rb b/app/jobs/review_class_import_school_move_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ReviewClassImportSchoolMoveJob < ApplicationJob
+class ReviewClassImportSchoolMoveJob < ApplicationJobActiveJob
   queue_as :imports
 
   def perform(import_id)
diff --git a/app/jobs/review_patient_changeset_job.rb b/app/jobs/review_patient_changeset_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class ReviewPatientChangesetJob < ApplicationJob
+class ReviewPatientChangesetJob < ApplicationJobActiveJob
   queue_as :imports
 
   def perform(patient_changeset_id)
diff --git a/app/jobs/search_vaccination_records_in_nhs_job.rb b/app/jobs/search_vaccination_records_in_nhs_job.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-class SearchVaccinationRecordsInNHSJob
-  include Sidekiq::Job
+class SearchVaccinationRecordsInNHSJob < ApplicationJobSidekiq
   include ImmunisationsAPIThrottlingConcern
 
   sidekiq_options queue: :immunisations_api_search
diff --git a/app/jobs/send_automated_careplus_reports_job.rb b/app/jobs/send_automated_careplus_reports_job.rb
@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-class SendAutomatedCareplusReportsJob
-  include Sidekiq::Job
-
+class SendAutomatedCareplusReportsJob < ApplicationJobSidekiq
   sidekiq_options queue: :careplus, lock: :until_executed
 
   def perform(team_id)
diff --git a/app/jobs/send_automatic_school_consent_reminders_job.rb b/app/jobs/send_automatic_school_consent_reminders_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class SendAutomaticSchoolConsentRemindersJob < ApplicationJob
+class SendAutomaticSchoolConsentRemindersJob < ApplicationJobActiveJob
   include SendSchoolConsentNotificationConcern
 
   queue_as :notifications
diff --git a/app/jobs/send_manual_school_consent_reminders_job.rb b/app/jobs/send_manual_school_consent_reminders_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class SendManualSchoolConsentRemindersJob < ApplicationJob
+class SendManualSchoolConsentRemindersJob < ApplicationJobActiveJob
   include SendSchoolConsentNotificationConcern
 
   queue_as :notifications
diff --git a/app/jobs/send_school_consent_requests_job.rb b/app/jobs/send_school_consent_requests_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class SendSchoolConsentRequestsJob < ApplicationJob
+class SendSchoolConsentRequestsJob < ApplicationJobActiveJob
   include SendSchoolConsentNotificationConcern
 
   queue_as :notifications
diff --git a/app/jobs/send_school_session_reminders_job.rb b/app/jobs/send_school_session_reminders_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class SendSchoolSessionRemindersJob < ApplicationJob
+class SendSchoolSessionRemindersJob < ApplicationJobActiveJob
   queue_as :notifications
 
   def perform(session)
diff --git a/app/jobs/send_vaccination_confirmations_job.rb b/app/jobs/send_vaccination_confirmations_job.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class SendVaccinationConfirmationsJob < ApplicationJob
+class SendVaccinationConfirmationsJob < ApplicationJobActiveJob
   queue_as :notifications
 
   def perform
diff --git a/app/jobs/sync_vaccination_record_to_nhs_job.rb b/app/jobs/sync_vaccination_record_to_nhs_job.rb
@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-class SyncVaccinationRecordToNHSJob
-  include Sidekiq::Job
+class SyncVaccinationRecordToNHSJob < ApplicationJobSidekiq
   include ImmunisationsAPIThrottlingConcern
 
   sidekiq_options queue: :immunisations_api_sync,
diff --git a/app/jobs/trim_active_record_sessions_job.rb b/app/jobs/trim_active_record_sessions_job.rb
@@ -2,7 +2,7 @@
 
 # Based off https://github.com/rails/activerecord-session_store/blob/9198a952916df925f36ac2beab247296ee5c0341/lib/tasks/database.rake#L14-L20
 
-class TrimActiveRecordSessionsJob < ApplicationJob
+class TrimActiveRecordSessionsJob < ApplicationJobActiveJob
   def perform
     ActiveRecord::SessionStore::Session.where(
       "updated_at < ?",
