Resque and Resque Scheduler Demo with Rails on macOS

This README outlines how to set up a basic Rails application with Resque for background jobs and Resque Scheduler for scheduling those jobs.

Prerequisites

Ruby 3.2.2
Rails 7.x
PostgreSQL (if running locally you will need to modify config/database.yml to use your local database)
Redis (if running locally you will need to modify config/initializers/resque.rb to use your local Redis server or you can modify the etc/hosts file to point redis to localhost)

Setup Steps

1. Create New Rails Application

rails new ResqueDemo --database=postgresql --css=tailwind

2. Add Gems

Add the following gems to your Gemfile:

gem 'resque'
gem 'resque-scheduler'

Then run:

bundle install

3. Set up Redis

Install Redis if you haven't:

brew install redis

Start Redis:

redis-server

4. Configure Resque and Resque Scheduler

Create an initializer at config/initializers/resque.rb:

require 'resque'
require 'resque-scheduler'
require 'resque/scheduler/server'

5. Update Routes

In config/routes.rb, add:

require 'resque/server'
Rails.application.routes.draw do
  mount Resque::Server, at: "/resque"
end

6. Create Example Job

Create a file app/jobs/example_job.rb:

class ExampleJob
  @queue = :example

  def self.perform(name)
    puts "Hello, #{name}"
  end
end

7. Create Rake Task

Create a new file lib/tasks/resque.rake:

namespace :resque do
  task enqueue: :environment do
    Resque.enqueue(ExampleJob, "Immediate")
  end

  task enqueue_in: :environment do
    Resque.enqueue_in(5.seconds, ExampleJob, "In 5 seconds")
  end

  task enqueue_at: :environment do
    time = Time.now + 1.minute
    Resque.enqueue_at(time, ExampleJob, "At #{time}")
  end
end

8. Create Resque Schedule Configuration

Create a config/resque_schedule.yml:

ExampleJob:
  cron: "* * * * *"
  class: "ExampleJob"
  args: "Loftwah"
  description: "I'm an example job!"

9. Run Servers and Worker

NOTE: run bin/setup to set up the database and run migrations.

In separate terminals:

Run Rails server: rails server
Run Resque worker: QUEUE=* rake resque:work
Run Resque scheduler: rake resque:scheduler

Run bin/setup and bin/dev to run all three in one terminal.

10. Test Jobs

Run the custom rake tasks to enqueue jobs:

rake resque:enqueue
rake resque:enqueue_in
rake resque:enqueue_at

11. Docker

Docker has been set up to run the application and Redis. To run the application in Docker, run:

docker compose build
docker compose up

In another terminal run the following.

docker compose exec web rails db:setup
docker compose exec web rails db:migrate

11. Test Jobs in Docker