rigor-sidekiq

Validates Sidekiq enqueue calls — Worker.perform_async(...), .perform_inline(...), .perform_in(t, ...), .perform_at(t, ...) — against the arity of the worker’s discovered #perform. It discovers workers by walking the configured search paths and matching classes that include Sidekiq::Job (or the legacy Sidekiq::Worker); it reads source only, with no sidekiq runtime dependency.

It ships bundled in rigortype. Activate it under plugins::

plugins:
  - rigor-sidekiq

What it checks

app/workers/welcome_email_worker.rb

class WelcomeEmailWorker
  include Sidekiq::Job
  def perform(user_id, locale = "en")   # arity 1..2
  end
end

WelcomeEmailWorker.perform_async(123)          # info:  matches #perform (arity 1..2)
WelcomeEmailWorker.perform_in(60, 123, "ja")   # info:  schedule carved out, 123/"ja" forwarded
WelcomeEmailWorker.perform_async              # error: expects 1..2 argument(s), got 0
WelcomeEmailWorker.perform_in                 # error: requires a schedule as its first argument

perform_in / perform_at consume their first argument as the schedule (interval / Time); the remaining arguments are validated against #perform. perform_async / perform_inline forward all arguments.

Rule	Severity	Fires when
plugin.sidekiq.worker-call	info	a Worker.perform_* call matched a discovered worker’s #perform arity
plugin.sidekiq.wrong-arity	error	the forwarded argument count falls outside #perform’s arity envelope (message names the schedule carve-out for perform_in / perform_at)
plugin.sidekiq.missing-schedule	error	perform_in() / perform_at() called with zero arguments (the schedule is required even when #perform takes none)
plugin.sidekiq.load-error	warning	worker discovery failed (parse/read error) — once per file

Configuration

plugins:
  - gem: rigor-sidekiq
    config:
      worker_search_paths: ["app/workers", "app/sidekiq"]          # default
      worker_marker_modules: ["Sidekiq::Job", "Sidekiq::Worker"]   # default

The default worker_marker_modules covers both modern Sidekiq (Sidekiq::Job, since 6.3) and the legacy Sidekiq::Worker.

Limitations

• Direct include only. A worker that mixes in a custom concern which re-includes Sidekiq::Job is not discovered — add the intermediate module to worker_marker_modules.
• Syntactic arity only. #perform arity is read from the parameter list; methods built with define_method are out of scope.
• No keyword-argument validation. Sidekiq serialises arguments to JSON, so positional args are the standard shape.
• Schedule type is not validated. The first slot of perform_in / perform_at is consumed as the schedule regardless of its type.
• Chained set(...) (Worker.set(queue: "low").perform_async(...)) is validated as a normal call; set’s own options are not checked.

Plugin internals

The worker discoverer / index and the contract surfaces this plugin exercises are in the plugin’s README. To write a plugin, see examples/ and the rigor-plugin-author skill.