Reliable is no longer maintained. The code is still public for reference.

Reliable is.

Redis is a great storage service for building a reliable queue. That's what this is for.

Is this like Ost?

Ost was the inspiration for this project. We love ost, but it lacks a few of the nice things we want (retry, failures count, etc) and will will implement those extra features here. We also wanted parallelism baked in.

Configuring redis

One must set the REDIS_URL environment variable.

Enqueueing messages

The developer is responsible for enqueuing Strings or string-like objects.

Reliable[:messages].push(JSON.generate({
  id: 123,
  title: "Hello"
}))

In this example :messages is the queue name. The developer can make as many queues as they like.

Processing messages

Processing all messages as they arrive

Reliable[:messages].each do |message|
  hash = JSON.generate(message)
  DatabaseTable.find(hash["id"]).do_something_awesome(message)
end

Reliable[:emails].each do |message|
  hash = JSON.generate(message)
  Emailer.new(hash).deliver
end

Calling #each will block the main thread and sleep forever.

Processing messages in parallel

If the processing code is thread-safe, the developer can spawn any number of threads with #peach:

Reliable[:touches].peach(concurrency: 12) { |id| Model.find(id).touch }

In this example 12 threads will be created and all are joined with the main thread.

Processing some messages

It's also possible to process only some message by #take-ing as many as necessary:

Reliable[:urls].take(2) do |url|
  content = open(url)
  PersistentStore.store(content)
end

Or if you just want the urls themselves as an array:

urls = Reliable[:urls].take(2)

urls.each do |url|
  content = open(url)
  PersistentStore.store(content)
end

And if the developer wants, they can get an enumerator object and interact with it as necessary:

enumerator = Reliable[:ids].to_enum { |id| notify(id) }
assert_equal 0, notifications.length
4.times { enumerator.next }
assert_equal 4, notifications.length

Time

Make sure the distributed clock starts moving before you lock the main thread. The clock makes it possible to re-enqueue stale items.

Here is a full example:

Reliable[:emails].periodically_move_time_forward
Reliable[:emails].peach(concurrency: 6) do |message|
  hash = JSON.generate(message)
  Emailer.new(hash).deliver
end

Rails

Probably best to create an initializer:

# config/initializers/reliable.rb
Reliable[:emails].periodically_move_time_forward

Then in a controller one might:

# app/controllers/users_controller.rb
class UsersController < ApplicationController
  def create
    @user = User.create!(params.require(:email))
    Reliable[:emails].push JSON.generate({
      user_id: @user.id
    })
    redirect_to root_url
  end
end

Then, in a worker file:

# app/workers/emails_worker.rb
Reliable[:emails].peach(concurrency: 6) do |message|
  hash = JSON.parse(message)
  user = User.find(hash[:user_id])
  Emailer.welcome_email(user).deliver
end

And maybe one would have a Procfile like this:

web: bin/rails s -p$PORT
worker: bin/rails r app/workers/emails_worker.rb

microsoftarchive / reliable Goto Github PK

reliable's Introduction

Reliable is no longer maintained. The code is still public for reference.

Reliable is.

Is this like Ost?

Configuring redis

Enqueueing messages

Processing messages

Processing all messages as they arrive

Processing messages in parallel

Processing some messages

Time

Rails

reliable's People

Contributors

Stargazers

Watchers

Forkers

reliable's Issues

Recommend Projects

Recommend Topics

Recommend Org