如何调试Sidekiq中Rollbar::Delay::Sidekiq的JSON序列化不安全警告？

错误日志 #

- NoMethodError (undefined method `encode` for nil:NilClass
-       redirect_to "/post_message#token=#{@secret.encode(token)}"
-                                                 ^^^^^^^):
- app/controllers/canvas_test_controller.rb:126:in `redirect_token`
- I, [2023-08-22T10:21:40.643432 #25]  INFO -- : [3cc2fde2-4da9-451b-973e-15c8fe93d91d] [Rollbar] Scheduling item
- pid=25 tid=3a1x WARN: Job arguments to Rollbar::Delay::Sidekiq do not serialize to JSON safely. This will raise an error in
- Sidekiq 7.0. See https://github.com/mperham/sidekiq/wiki/Best-Practices or raise an error today
- by calling `Sidekiq.strict_args!` during Sidekiq initialization.

问题描述 #

我故意触发该错误以测试Rollbar，但收到Sidekiq警告：Job arguments to Rollbar::Delay::Sidekiq do not serialize to JSON safely.。我已在代码中遵循Sidekiq的最佳实践，但该警告似乎来自Rollbar::Delay::Sidekiq。

使用的Gem版本 #

rollbar (3.4.0)
sidekiq (6.5.6)

我尝试将sidekiq和rollbar都更新到最新版本，但警告仍然存在。请问该如何调试此问题？

调试与解决步骤 #

• 问题根源：Rollbar异步上报错误时，传递给Sidekiq Job的参数包含无法JSON序列化的对象（比如异常实例的复杂属性、未序列化的ActiveRecord对象等）。以下是具体调试和修复方法：
  1. 开启Sidekiq严格参数模式：在Sidekiq初始化代码中添加Sidekiq.strict_args!，触发错误时会直接抛出异常而非仅警告，能精准定位无法序列化的参数。
  2. 打印Rollbar payload内容：在Rollbar配置中添加钩子，输出即将传递给Sidekiq的参数，便于排查：

     Rollbar.configure do |config|
       # 保留原有配置
       config.before_process << proc do |payload|
         Rails.logger.debug "Rollbar待序列化payload: #{payload.inspect}"
       end
     end
     

• 针对性修复参数序列化问题：
  1. 过滤不可序列化属性：在Rollbar配置中，用config.scrub_fields或自定义处理器，移除或转换payload中无法JSON序列化的内容，比如异常中的特定实例变量、关联对象等。
  2. 临时同步上报验证：设置config.use_async = false，如果警告消失，确认问题出在异步Job的参数上，再聚焦处理异步逻辑。
  3. 自定义异步处理器：替换默认的Rollbar::Delay::Sidekiq，手动处理参数的JSON序列化与解析：

     class CustomRollbarSidekiqDelay
       def self.call(payload)
         RollbarProcessingJob.perform_async(payload.to_json)
       end
     end
     
     class RollbarProcessingJob
       include Sidekiq::Job
       def perform(payload_json)
         payload = JSON.parse(payload_json)
         Rollbar.process_from_async_handler(payload)
       end
     end
     
     # 在Rollbar配置中启用自定义处理器
     Rollbar.configure do |config|
       config.delay_handler = CustomRollbarSidekiqDelay
     end
     

• 检查Gem适配细节：查看Rollbar的版本更新说明，确认是否有针对Sidekiq序列化问题的修复，或是否需要特定配置项兼容当前Sidekiq版本。

内容的提问来源于stack exchange，提问作者adhu