Improve default slug generation for sidekiq-scheduler (#2184)

`sidekiq-scheduler` allows to use a class name as a schedule name directly as follows.

```
Namspeced::CancelAbandonedOrders:
  cron: '0 */5 * * * *'
```

In this case, a slug is shown as `namspecedcancelabandonedorders` on Sentry.
I think this isn't good for readability.
This PR converts `::` to `-` as well as the cron default behavior of Crons mixin.

Related with: #2138.

Author: y-yagi

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ### Features
 
+- Improve default slug generation for `sidekiq-scheduler` [#2184](https://github.com/getsentry/sentry-ruby/pull/2184)
+
 ### Bug Fixes
 
 - Network errors raised in `Sentry::HTTPTransport` will no longer be reported to Sentry [#2178](https://github.com/getsentry/sentry-ruby/pull/2178)

sentry-ruby/lib/sentry/cron/monitor_check_ins.rb

@@ -44,7 +44,7 @@ def sentry_monitor_check_ins(slug: nil, monitor_config: nil)
           prepend Patch
         end
 
-        def sentry_monitor_slug
+        def sentry_monitor_slug(name: self.name)
           @sentry_monitor_slug ||= begin
             slug = name.gsub('::', '-').downcase
             slug[-MAX_SLUG_LENGTH..-1] || slug

sentry-sidekiq/lib/sentry/sidekiq-scheduler/scheduler.rb

@@ -50,8 +50,9 @@ def new_job(name, interval_type, config, schedule, options)
         # only patch if not explicitly included in job by user
         unless klass_const.send(:ancestors).include?(Sentry::Cron::MonitorCheckIns)
           klass_const.send(:include, Sentry::Cron::MonitorCheckIns)
+          slug = klass_const.send(:sentry_monitor_slug, name: name)
           klass_const.send(:sentry_monitor_check_ins,
-                           slug: name,
+                           slug: slug,
                            monitor_config: monitor_config)
 
           ::Sidekiq.logger.info "Injected Sentry Crons monitor checkins into #{klass}"

sentry-sidekiq/spec/fixtures/sidekiq-scheduler-schedule.yml

@@ -11,4 +11,6 @@
   reports:
     in: "2 hours"
     class: "ReportingWorker"
+  VeryLongOuterModule::VeryVeryVeryVeryLongInnerModule::Job:
+    cron: "* * * * *"
 

sentry-sidekiq/spec/sentry/sidekiq-scheduler/scheduler_spec.rb

@@ -49,8 +49,12 @@
     expect(EveryHappyWorker.sentry_monitor_config.schedule.to_hash).to eq({value: 10, type: :interval, unit: :minute})
   end
 
-  it "does not add monitors for a one-off job" do
-    expect(ReportingWorker.ancestors).not_to include(Sentry::Cron::MonitorCheckIns)
-  end
+ it 'truncates from the beginning and parameterizes slug' do
+    expect(VeryLongOuterModule::VeryVeryVeryVeryLongInnerModule::Job.ancestors).to include(Sentry::Cron::MonitorCheckIns)
+    expect(VeryLongOuterModule::VeryVeryVeryVeryLongInnerModule::Job.sentry_monitor_slug).to eq('ongoutermodule-veryveryveryverylonginnermodule-job')
+    expect(VeryLongOuterModule::VeryVeryVeryVeryLongInnerModule::Job.sentry_monitor_config).to be_a(Sentry::Cron::MonitorConfig)
+    expect(VeryLongOuterModule::VeryVeryVeryVeryLongInnerModule::Job.sentry_monitor_config.schedule).to be_a(Sentry::Cron::MonitorSchedule::Crontab)
+    expect(VeryLongOuterModule::VeryVeryVeryVeryLongInnerModule::Job.sentry_monitor_config.schedule.value).to eq('* * * * *')
+ end
 end
 

sentry-sidekiq/spec/spec_helper.rb

@@ -208,6 +208,13 @@ def [](key)
   end
 end
 
+module VeryLongOuterModule
+  module VeryVeryVeryVeryLongInnerModule
+    class Job
+    end
+  end
+end
+
 # Sidekiq 7 has a Config class, but for Sidekiq 6, we'll mock it.
 def sidekiq_config(opts)
   WITH_SIDEKIQ_7 ? ::Sidekiq::Config.new(opts) : SidekiqConfigMock.new(opts)