Fix a crash when ActiveJob context include a range with TimeWithZone (#2548)

* Add spec:versioned rake task

* Add a spec checking range serialization in ActiveJob

* Fix argument serialization for ranges

If a range consists for ActiveSupport::TimeWithZone,
it will be serialized as a string.

Previously it would raise an error

```
TypeError: can't iterate from ActiveSupport::TimeWithZone
```

Closes #2545

* Ensure begin-less and end-less ranges work too

* Update CHANGELOG

* [rubocop] ignore versioned specs

Our target ruby version is 2.6 so...

Author: solnic

.rubocop.yml

@@ -18,3 +18,4 @@ AllCops:
     - "sentry-raven/**/*"
     - "sentry-*/tmp/**/*"
     - "sentry-*/examples/**/*"
+    - "sentry-*/spec/versioned/2.7/**/*"

CHANGELOG.md

@@ -4,6 +4,10 @@
 
 - Add correct breadcrumb levels for 4xx/5xx response codes ([#2549](https://github.com/getsentry/sentry-ruby/pull/2549))
 
+### Bug Fixes
+
+- Fix argument serialization for ranges that consist of ActiveSupport::TimeWithZone ([#2548](https://github.com/getsentry/sentry-ruby/pull/2548))
+
 ### Miscellaneous
 
 - Deprecate `enable_tracing` in favor of `traces_sample_rate = 1.0` [#2535](https://github.com/getsentry/sentry-ruby/pull/2535)

sentry-rails/Rakefile

@@ -5,6 +5,24 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec).tap do |task|
   task.rspec_opts = "--order rand"
+  task.pattern = "spec/sentry/**/*_spec.rb"
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:versioned).tap do |task|
+    ruby_ver_dir = RUBY_VERSION.split(".")[0..1].join(".")
+    matching_dir = Dir["spec/versioned/*"].detect { |dir| File.basename(dir) <= ruby_ver_dir }
+
+    unless matching_dir
+      puts "No versioned specs found for ruby #{RUBY_VERSION}"
+      exit 0
+    end
+
+    puts "Running versioned specs from #{matching_dir} for ruby #{RUBY_VERSION}"
+
+    task.rspec_opts = "--order rand"
+    task.pattern = "#{matching_dir}/**/*_spec.rb"
+  end
 end
 
 task :isolated_specs do
@@ -13,4 +31,4 @@ task :isolated_specs do
   end
 end
 
-task default: [:spec, :isolated_specs]
+task default: [:spec, :"spec:versioned", :isolated_specs]

sentry-rails/lib/sentry/rails/active_job.rb

@@ -79,6 +79,12 @@ def sentry_context(job)
 
           def sentry_serialize_arguments(argument)
             case argument
+            when Range
+              if (argument.begin || argument.end).is_a?(ActiveSupport::TimeWithZone)
+                argument.to_s
+              else
+                argument.map { |v| sentry_serialize_arguments(v) }
+              end
             when Hash
               argument.transform_values { |v| sentry_serialize_arguments(v) }
             when Array, Enumerable

sentry-rails/spec/sentry/rails/activejob_spec.rb

@@ -139,6 +139,49 @@ def post.to_global_id
         ]
       )
     end
+
+    it "serializes range arguments gracefully when Range#map is implemented" do
+      post = Post.create!
+
+      expect do
+        JobWithArgument.perform_now("foo", { bar: Sentry }, integer: 1, post: post, range: 1..3)
+      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}",
+            "range" => [1, 2, 3]
+          }
+        ]
+      )
+    end
+
+    it "serializes range arguments gracefully when Range consists of ActiveSupport::TimeWithZone" do
+      post = Post.create!
+      range = 5.days.ago...1.day.ago
+
+      expect do
+        JobWithArgument.perform_now("foo", { bar: Sentry }, integer: 1, post: post, range: range)
+      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}",
+            "range" => "#{range.first}...#{range.last}"
+          }
+        ]
+      )
+    end
   end
 
   it "adds useful context to extra" do

sentry-rails/spec/spec_helper.rb

@@ -30,6 +30,8 @@
 
 DUMMY_DSN = 'http://12345:[email protected]/sentry/42'
 
+Dir["#{__dir__}/support/**/*.rb"].each { |file| require file }
+
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
   config.example_status_persistence_file_path = ".rspec_status"

sentry-rails/spec/support/test_jobs.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "active_job/railtie"
+
+class NormalJob < ActiveJob::Base
+  def perform
+    "foo"
+  end
+end
+
+class FailedJob < ActiveJob::Base
+  self.logger = nil
+
+  class TestError < RuntimeError
+  end
+
+  def perform
+    a = 1
+    b = 0
+    raise TestError, "Boom!"
+  end
+end
+
+class FailedWithExtraJob < FailedJob
+  def perform
+    Sentry.get_current_scope.set_extras(foo: :bar)
+    super
+  end
+end
+
+class JobWithArgument < ActiveJob::Base
+  def perform(*args, integer:, post:, **options)
+    raise "foo"
+  end
+end
+
+class QueryPostJob < ActiveJob::Base
+  self.logger = nil
+
+  def perform
+    Post.all.to_a
+  end
+end
+
+class RescuedActiveJob < FailedWithExtraJob
+  rescue_from TestError, with: :rescue_callback
+
+  def rescue_callback(error); end
+end
+
+class ProblematicRescuedActiveJob < FailedWithExtraJob
+  rescue_from TestError, with: :rescue_callback
+
+  def rescue_callback(error)
+    raise "foo"
+  end
+end
+
+class NormalJobWithCron < NormalJob
+  include Sentry::Cron::MonitorCheckIns
+  sentry_monitor_check_ins
+end
+
+class FailedJobWithCron < FailedJob
+  include Sentry::Cron::MonitorCheckIns
+  sentry_monitor_check_ins slug: "failed_job", monitor_config: Sentry::Cron::MonitorConfig.from_crontab("5 * * * *")
+end

sentry-rails/spec/versioned/2.7/activejob_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe "ActiveJob integration", type: :job do
+  before do
+    make_basic_app
+  end
+
+  let(:event) do
+    transport.events.last.to_json_compatible
+  end
+
+  let(:transport) do
+    Sentry.get_current_client.transport
+  end
+
+  it "returns #perform method's return value" do
+    expect(NormalJob.perform_now).to eq("foo")
+  end
+
+  describe "ActiveJob arguments serialization" do
+    it "serializes range begin-less and end-less arguments gracefully when Range consists of ActiveSupport::TimeWithZone" do
+      post = Post.create!
+
+      range_no_beginning = (..1.day.ago)
+      range_no_end = (5.days.ago..)
+
+      expect do
+        JobWithArgument.perform_now("foo", { bar: Sentry },
+          integer: 1, post: post, range_no_beginning: range_no_beginning, range_no_end: range_no_end)
+      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}",
+            "range_no_beginning" => "..#{range_no_beginning.last}",
+            "range_no_end" => "#{range_no_end.first}.."
+          }
+        ]
+      )
+    end
+  end
+end