Getting Started

Installation

Add the gem to your Rails project:

$ bundle add async-job-adapter-active_job

Core Concepts

The async-job-adapter-active_job gem provides an Active Job adapter for the async-job gem. This allows you to use the async-job gem with Rails' built-in Active Job framework.

• The Async::Job::ActiveJob::Dispatcher class manages zero or more queues.
• The Async::Job::ActiveJob::Railtie class provides a convenient interface for configuring the integration.

In general, Async::Job has a concept of queues, where jobs enter into a queue, may get serialized to a queue, then deserialized and processed. This ActiveJob adapter provides Async::Job::ActiveJob::Interface which goes at the head of the queue, and matches the interface that ActiveJob expects for enqueueing jobs. At the tail of the queue, the Async::Job::ActiveJob::Executor class is responsible for processing jobs by dispatching back into ActiveJob.

Usage

In order to use Async::Job, you need to define your queues and configure the Active Job adapter. Here is an example configuration:

ActiveJob Queue Adapter Configuration

You can configure the ActiveJob queue adapter globally (in config/application.rb) or per-environment (in config/environments/*.rb).

# In config/application.rb or config/environments/*.rb

config.active_job.queue_adapter = :async_job

Async::Job Queue Configuration

You can define your queues in an initializer file (e.g., config/initializers/async_job.rb). Here is an example configuration that sets up two queues: a default queue using Redis and a local queue that processes jobs inline. NOTE that inline jobs will run sequentially (that is, not concurrently) outside of an Async event loop (that is to say, your jobs will block unless you're running your server using falcon).

# config/initializers/async_job.rb

require "async/job/processor/redis"
require "async/job/processor/inline"

Rails.application.configure do
	# Create a queue for the "default" backend:
	config.async_job.define_queue "default" do
		dequeue Async::Job::Processor::Redis
	end
	
	# Create a queue named "local" which uses the Inline backend:
	config.async_job.define_queue "local" do
		dequeue Async::Job::Processor::Inline
	end
end

Job Specific Configuration

Rather than using Async::Job for all jobs, you could opt in using a specific queue adapter for a specific job. Here is an example:

class MyJob < ApplicationJob
	self.queue_adapter = :async_job
	queue_as :local
	
	# ...
end

Running A Server

If you are using a queue that requires a server (e.g. Redis), you will need to run a server. A simple server is provided async-job-adapter-active_job-server, which by default will run all define queues.

$ bundle exec async-job-adapter-active_job-server

You can specify different queues using the ASYNC_JOB_ADAPTER_ACTIVE_JOB_QUEUE_NAMES environment variable.

Alternatively, you may prefer to run your own service. See the code in bin/async-job-adapter-active_job-server for an example of how to run a server using a service definition.

Enqueuing Jobs

To enqueue a job, you can use the perform_later method in your Active Job class. Here is an example:

class MyJob < ApplicationJob
	queue_as :default
	
	def perform(message)
		puts message
	end
end

MyJob.perform_later("Hello, world!")