Skip to content

Latest commit

 

History

History
81 lines (49 loc) · 2.2 KB

README.md

File metadata and controls

81 lines (49 loc) · 2.2 KB

delayed-method

Requires the resque gem.

Allows you to move a long running method to background to be processed later by resque

I have to come up with this because all other resque based delayed execution gems out there that I have tried are complex, buggy and don't work.

delayed-method is designed to be dead simple, and doesn't hack deep into resque itself (so it is more likely to continue to work, even with further internal change of resque)

In fact, it just relies on Resque.enqueue at the deepest level. It doesn't deal with serialization, so it won't have any problem with serialization

Installation

$ gem install delayed-method

Usage

Given you have this long call inside your web request:

Executor.long_call(arg1, arg2)

then you can easily move it to the delayed queue in background with this:

DelayedMethod.enqueue(Executor, :long_call, arg1, arg2)

Or if you use active record model:

model.long_call(arg1, arg2)

then you can easily move it to the delayed queue in background with this:

DelayedMethod.enqueue(model, :long_call, arg1, arg2)

That's it. This is the only two cases where DelayedMethod will work: Caller needs to be either a class or a persisted ActiveRecord model

If you use resque-scheduler, you can also do this:

DelayedMethod.enqueue_at(1.day.from_now, Executor, :long_call, arg1, arg2)

or

DelayedMethod.enqueue_at(1.day.from_now, model, :long_call, arg1, arg2)

Customize your worker

If you want to customize DelayedMethod to enforce things like having ActiveRecord reading from master instead of slave, you can do this:

   class MyCustomDelayedMethod < DelayedMethod
     @queue = :delayed

     def perform(*args)
       wrap_method do
         super
       end
     end
   end

   MyCustomDelayedMethod.enqueue(object, :method)

Warning

Please notice that Class method call and ActiveRecord instance call are the only two cases supported. Even in those cases, only simple arguments (string, number) are supported. Using object, structure, or symbol as argument will yield unexpected results. (Symbol will be converted to String).

Author

Phuong Nguyen:: [email protected]