Sidekiq Bus

This gem provides an adapter for Sidekiq for use in the queue-bus system. It uses Redis and the Sidekiq that you are already using to allow simple asynchronous communication between apps.

Install

To install, include the 'sidekiq-bus' gem and add the following to your Rakefile:

require "sidekiq_bus/tasks"

Example

Application A can publish an event

# pick an adapter
require 'sidekiq-bus' # (or other adapter)

# business logic
QueueBus.publish("user_created", "id" => 42, "first_name" => "John", "last_name" => "Smith")

# or do it later
QueueBus.publish_at(1.hour.from_now, "user_created", "id" => 42, "first_name" => "John", "last_name" => "Smith")

Application B is subscribed to events

# pick an adapter
require 'sidekiq-bus' # (or other adapter)

# initializer
QueueBus.dispatch("app_b") do
  # processes event on app_b_default queue
  # subscribe is short-hand to subscribe to your 'default' queue and this block will process events with the name "user_created"
  subscribe "user_created" do |attributes|
    NameCount.find_or_create_by_name(attributes["last_name"]).increment!
  end

  # processes event on app_b_critical queue
  # critical is short-hand to subscribe to your 'critical' queue and this block will process events with the name "user_paid"
  critical "user_paid" do |attributes|
    CreditCard.charge!(attributes)
  end

  # you can pass any queue name you would like to process from as well IE: `banana "peeled" do |attributes|`

  # and regexes work as well. note that with the above configuration along with this regex,
  # the following as well as the corresponding block above would both be executed
  subscribe /^user_/ do |attributes|
    Metrics.record_user_action(attributes["bus_event_type"], attributes["id"])
  end

  # the above all filter on just the event_type, but you can filter on anything
  # this would be _any_ event that has a user_id and the page value of homepage regardless of bus_event_type
  subscribe "my_key", { "user_id" => :present, "page" => "homepage"} do
    Mixpanel.homepage_action!(attributes["action"])
  end
end

Applications can also subscribe within classes using the provided Subscriber module.

class SimpleSubscriber
  include QueueBus::Subscriber
  subscribe :my_method

  def my_method(attributes)
    # heavy lifting
  end
end

The following is equivalent to the original initializer and shows more options:

class OtherSubscriber
  include QueueBus::Subscriber
  application :app_b

  subscribe :user_created
  subscribe_queue :app_b_critical, :user_paid
  subscribe_queue :app_b_default, :user_action, :bus_event_type => /^user_/
  subscribe :homepage_method, :user_id => :present, :page => "homepage"

  def user_created(attributes)
    NameCount.find_or_create_by_name(attributes["last_name"]).increment!
  end

  def user_paid(attributes)
    CreditCard.charge!(attributes)
  end

  def user_action(attributes)
    Metrics.record_user_action(attributes["bus_event_type"], attributes["id"])
  end

  def homepage_method
    Mixpanel.homepage_action!(attributes["action"])
  end
end

Note: This subscribes when this class is loaded, so it needs to be in your load or otherwise referenced/required during app initialization to work properly.

sidekiq.rb

To make sure that your sidekiq server is consuming on the proper queues, add code like this to your config/sidekiq.rb file:

# config/sidekiq.rb

# Load the environment here
require './boot.rb'

if Sidekiq.server?
  # Load the queues into sidekiq:
  weights = {
    'app_events'    => 10,
    'app_heartbeat' => 3,
    'app_refresh'   => 1
  }
  Sidekiq.options[:queues] =
    SidekiqBus.generate_weighted_queues(overrides: weights, default: 2)
end

Commands

Each app needs to tell Redis about its subscriptions:

$ rake queuebus:subscribe

You'll then need to run Sidekiq. Make sure the bus_incoming queues and the ones you are using are included.

$ bundle exec sidekiq -q default -q app_b_default -q bus_incoming

Local Mode

For development, a local mode is provided and is specified in the configuration.

# config
QueueBus.local_mode = :standalone
or
QueueBus.local_mode = :inline

Standalone mode does not require a separate queuebus:driver task to be running to process the incoming queue. Simply publishing to the bus will distribute the incoming events to the appropriate application specific queue. A separate queuebus:work task does still need to be run to process these events

Inline mode skips queue processing entirely and directly dispatches the event to the appropriate code block.

You can also say QueueBus.local_mode = :suppress to turn off publishing altogether. This can be helpful inside some sort of migration, for example.

TODO

• Replace local modes with adapters
• We might not actually need to publish in tests
• Add some rspec helpers for the apps to use: should_ post an event_publish or something along those lines