SKILL.md
Implement Background Job
Use this skill when the task is to add, configure, or review background jobs in a Rails application.
HARD-GATE
EVERY job MUST have its test written and validated BEFORE implementation:
1. Write the job spec (idempotency, retry, error handling)
2. Run the spec — verify it fails
3. ONLY THEN write the job class
The authoritative perform contract — EVERY perform method does exactly three things:
1. Load the record from the passed ID
2. Guard for idempotency / permanent no-op conditions
3. Delegate the side effect or orchestration to a service object
If perform needs more than that, extract a service.
EVERY job that performs a side effect (charge, email, API call) MUST have
an idempotency check BEFORE the side effect.
Core Rules
| Aspect | Rule |
|---|---|
| Arguments | Pass IDs, not objects |
| Retries | retryon (explicit attempts:) for transient; discardon for permanent errors |
| Backend (Rails 8) | Solid Queue (database-backed, no Redis) |
| Backend (Rails 7) | Sidekiq + Redis for high throughput |
| Recurring | config/recurring.yml (Solid Queue) or cron/sidekiq-cron |
| Anti-patterns | No ActiveRecord objects as args; no :inline/:async in production; no business logic in perform |
Core Process
- Write the job spec first — idempotency, retry, and error handling — and run it to confirm it fails.
- Write the job class following the perform contract in HARD-GATE.
- Add
retryonwith explicitattempts:limit anddiscardonfor at least one permanent error. - Run the full test suite.
- Enqueue or perform the job twice — confirm the second run is a no-op.
- For recurring jobs, define them in
config/recurring.yml(Rails 8) or the chosen scheduler config.
Extended Resources
Rails 8 vs Rails 7
| Aspect | Rails 7 and earlier | Rails 8 |
|---|---|---|
| Default | No default; set queue_adapter (often Sidekiq) |
Solid Queue (database-backed) |
| Dev/test | :async or :inline |
Same |
| Recurring | External (cron, sidekiq-cron) | config/recurring.yml |
| Dashboard | Third-party (Sidekiq Web) | Mission Control Jobs |
Examples
Thin job with idempotency and retry:
class SendInvoiceReminderJob < ApplicationJob
queue_as :default
retry_on Net::OpenTimeout, wait: :polynomially_longer, attempts: 5
discard_on ActiveRecord::RecordNotFound
def perform(invoice_id)
invoice = Invoice.find(invoice_id)
return if invoice.reminder_sent_at?
InvoiceReminders::Send.call(invoice:)
end
end
Service owns the side effect and state update:
module InvoiceReminders
class Send
def self.call(invoice:)
InvoiceMailer.overdue(invoice).deliver_now
invoice.update!(reminder_sent_at: Time.current)
end
end
end
- [BACKENDS.md](./BACKENDS.md) — Solid Queue vs Sidekiq setup, configuration details, and Redis requirements.
Load these files only when their specific content is needed:
- [assets/jobpatterns.md](assets/jobpatterns.md) — Use when implementing multi-step orchestration or batch job patterns
- [assets/retryexamples.md](assets/retryexamples.md) — Use when configuring
retryon/discardonfor specific error classes beyond the basic patterns above
Output Checklist
- Backend decision stated (Rails version/scale → Solid Queue or Sidekiq)
- Job spec shown first; command run; confirms failure before implementation
-
performreceives IDs, loads record, guards idempotency, delegates to service -
retryonwithattempts:limit anddiscardonfor permanent error - Double-run verification confirms second run is a no-op
- Recurring job (if any) defined in
config/recurring.ymlor scheduler config - If ops docs requested: record backend, retry, recurring schedule, and idempotency decisions in
process_log.md
Integration
| Skill | When to chain |
|---|---|
| review-migration | Solid Queue uses DB tables; add migrations safely |
| security-check | Jobs receive serialized input; validate like any entry point |
| write-tests | TDD gate: write job spec before implementation; use performenqueuedjobs |
| create-service-object | Keep perform thin; call service objects for business logic |