fix(sidekiq): avoid encoding unused producer body size

Author: solnic

sentry-sidekiq/lib/sentry/sidekiq/job_extension.rb

@@ -35,11 +35,14 @@ def messaging_data(job)
           system: name,
           message_id: job["jid"],
           destination: job["queue"],
-          receive_latency: receive_latency(job),
-          body_size: body_size(job)
+          receive_latency: receive_latency(job)
         }.compact
       end
 
+      def consumer_messaging_data(job)
+        messaging_data(job).merge(body_size: body_size(job)).compact
+      end
+
       def retry_info(job)
         { count: @retry_policy.retry_count(job) || 0, will_retry: @retry_policy.will_retry?(job) }
       end

sentry-sidekiq/lib/sentry/sidekiq/sentry_context_middleware.rb

@@ -24,7 +24,7 @@ def call(worker, job, queue)
           scope, sidekiq_job,
           payload: sidekiq_job,
           trace_headers: job_extension.extract_trace_headers(sidekiq_job),
-          messaging_data: -> { job_extension.messaging_data(sidekiq_job) },
+          messaging_data: -> { job_extension.consumer_messaging_data(sidekiq_job) },
           default_retry_count: job_extension.retry_info(sidekiq_job)[:count],
           always_continue_trace: true
         )

sentry-sidekiq/spec/sentry/sidekiq/sentry_context_middleware_spec.rb

@@ -328,6 +328,24 @@ def ensure_queue_empty(queue, timeout: 0.1)
       expect(span[:data]['messaging.destination.name']).to eq('default')
     end
 
+    it "serializes a sampled enqueue only when writing the job to Redis" do
+      serializations = 0
+      serializer = TracePoint.new(:call) do |call|
+        serializations += 1 if call.self.equal?(Sidekiq) && call.method_id == :dump_json
+      end
+
+      jid = serializer.enable do
+        client.push('queue' => 'default', 'class' => HappyWorker, 'args' => ["hello"])
+      end
+      transaction.finish
+
+      expect(queue.first.jid).to eq(jid)
+      expect(queue.first.args).to eq(["hello"])
+      expect(serializations).to eq(1)
+      span = transport.events.last.spans.find { |entry| entry[:op] == "queue.publish" }
+      expect(span[:data]['messaging.message.id']).to eq(jid)
+    end
+
     it "only reports a producer body size that matches the finalized queued message" do
       client.push('queue' => 'default', 'class' => HappyWorker, 'args' => ["héllo"])