Support serializing ActiveRecord job arguments in global id form (#1688)

st0012 · web-flow · commit 4217838a403e · 2022-02-01T18:05:59.000+08:00
* Support serializing ActiveRecord job arguments in global id form

* Update changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## Unreleased
+
+### Features
+
+- Support serializing ActiveRecord job arguments in global id form [#1688](https://github.com/getsentry/sentry-ruby/pull/1688)
+
 ## 5.0.2
 
 - Respect port info provided in user's DSN [#1702](https://github.com/getsentry/sentry-ruby/pull/1702)
diff --git a/sentry-rails/lib/sentry/rails/active_job.rb b/sentry-rails/lib/sentry/rails/active_job.rb
@@ -37,7 +37,7 @@ def capture_and_reraise_with_sentry(scope, &block)
           extra: sentry_context,
           tags: {
             job_id: job_id,
-            provider_job_id:provider_job_id
+            provider_job_id: provider_job_id
           }
         )
         raise e
@@ -57,13 +57,26 @@ def already_supported_by_sentry_integration?
       def sentry_context
         {
           active_job: self.class.name,
-          arguments: arguments,
+          arguments: sentry_serialize_arguments(arguments),
           scheduled_at: scheduled_at,
           job_id: job_id,
           provider_job_id: provider_job_id,
           locale: locale
         }
       end
+
+      def sentry_serialize_arguments(argument)
+        case argument
+        when Hash
+          argument.transform_values { |v| sentry_serialize_arguments(v) }
+        when Array, Enumerable
+          argument.map { |v| sentry_serialize_arguments(v) }
+        when ->(v) { v.respond_to?(:to_global_id) }
+          argument.to_global_id.to_s rescue argument
+        else
+          argument
+        end
+      end
     end
   end
 end
diff --git a/sentry-rails/spec/sentry/rails/activejob_spec.rb b/sentry-rails/spec/sentry/rails/activejob_spec.rb
@@ -27,6 +27,12 @@ def perform
   end
 end
 
+class JobWithArgument < ActiveJob::Base
+  def perform(*args, integer:, post:, **options)
+    raise "foo"
+  end
+end
+
 class QueryPostJob < ActiveJob::Base
   self.logger = nil
 
@@ -76,6 +82,52 @@ def rescue_callback(error)
     expect(NormalJob.perform_now).to eq("foo")
   end
 
+  describe "ActiveJob arguments serialization" do
+    it "serializes ActiveRecord arguments in globalid form" do
+      post = Post.create!
+      post2 = Post.create!
+
+      expect do
+        JobWithArgument.perform_now("foo", { bar: Sentry }, integer: 1, post: post, nested: { another_level: { post: post2 } })
+      end.to raise_error(RuntimeError)
+
+      event = transport.events.last.to_json_compatible
+      expect(event.dig("extra", "arguments")).to eq(
+        [
+          "foo",
+          { "bar" => "Sentry" },
+          {
+            "integer" => 1,
+            "post" => "gid://rails-test-app/Post/#{post.id}",
+            "nested" => { "another_level" => { "post" => "gid://rails-test-app/Post/#{post2.id}" } }
+          }
+        ]
+      )
+    end
+
+    it "handles problematic globalid conversion gracefully" do
+      post = Post.create!
+
+      def post.to_global_id
+        raise
+      end
+
+      expect do
+        JobWithArgument.perform_now(integer: 1, post: post)
+      end.to raise_error(RuntimeError)
+
+      event = transport.events.last.to_json_compatible
+      expect(event.dig("extra", "arguments")).to eq(
+        [
+          {
+            "integer" => 1,
+            "post" => post.to_s,
+          }
+        ]
+      )
+    end
+  end
+
   it "adds useful context to extra" do
     expect { FailedJob.perform_now }.to raise_error(FailedJob::TestError)
 
