serializes request_id when queued

Author: jason-raitz

app/jobs/application_job.rb

@@ -1,27 +1,33 @@
 class ApplicationJob < ActiveJob::Base
-  # This is a little unorthodox, but we want the request_id to be available as an instance variable on the job,
-  # so we add it to the arguments before the job is enqueued and then pull it out in a before_perform callback.
-  # Admittedly, the request_id method mutates the arguments as a side effect of pulling the request_id out.
+  attr_accessor :request_id
 
-  before_enqueue do
-    arguments << { request_id: Current.request_id } if Current.request_id
+  before_enqueue do |job|
+    job.request_id = Current.request_id
   end
 
-  before_perform :log_job_metadata
+  before_perform :restore_request_id, :log_job_metadata
 
-  def request_id
-    r_id_hash, rest = arguments.partition { |arg| arg.is_a?(Hash) && arg.key?(:request_id) } unless defined? @request_id
-    self.arguments = rest if rest.any?
-    @request_id = r_id_hash.first[:request_id] if r_id_hash.any?
-    @request_id
+  def serialize
+    super.merge('request_id' => request_id)
+  end
+
+  def deserialize(job_data)
+    super
+    self.request_id = job_data['request_id']
   end
 
   def today
     @today ||= Time.zone.now.strftime('%Y%m%d')
   end
 
+  private
+
+  def restore_request_id
+    self.request_id ||= Current.request_id
+  end
+
   def log_job_metadata
-    logger.with_fields = { activejob_id: job_id, request_id: }
+    logger.with_fields = { activejob_id: job_id, request_id: request_id }
   end
 
   # Log an exception

spec/jobs/application_job_spec.rb

@@ -22,19 +22,15 @@ def perform(*args); end
       it 'enqueues the job with the request_id' do
         expect do
           TestJob.perform_later('some_arg')
-        end.to have_enqueued_job(TestJob).with('some_arg', { request_id: request_id })
-      end
-
-      it 'sets @request_id and removes it from the arguments' do
-        job = TestJob.new('some_arg', { request_id: request_id })
-        perform_enqueued_jobs { job.perform_now }
+        end.to have_enqueued_job(TestJob)
 
-        expect(job.instance_variable_get(:@request_id)).to eq(request_id)
-        expect(job.arguments).to eq(['some_arg'])
+        enqueued_job = ActiveJob::Base.queue_adapter.enqueued_jobs.last
+        expect(enqueued_job[:args]).to eq(['some_arg'])
+        expect(enqueued_job['request_id']).to eq(request_id)
       end
 
       it 'logs the activejob_id and request_id' do
-        job = TestJob.new('some_arg', { request_id: request_id })
+        job = TestJob.new('some_arg')
         allow(job.logger).to receive(:with_fields=)
 
         perform_enqueued_jobs { job.perform_now }
@@ -50,14 +46,17 @@ def perform(*args); end
         expect do
           TestJob.perform_later('some_arg')
         end.to have_enqueued_job(TestJob).with('some_arg')
+
+        enqueued_job = ActiveJob::Base.queue_adapter.enqueued_jobs.last
+        expect(enqueued_job['request_id']).to be_nil
       end
 
-      it 'does not set @request_id if not provided' do
+      it 'does not set request_id if not provided' do
         job = TestJob.new('some_arg')
         perform_enqueued_jobs { job.perform_now }
 
-        expect(job.instance_variable_get(:@request_id)).to be_nil
         expect(job.arguments).to eq(['some_arg'])
+        expect(job.request_id).to be_nil
       end
 
       it 'logs the activejob_id without a request_id' do