module Backburner # A single backburner job which can be processed and removed by the worker class Job < SimpleDelegator include Backburner::Helpers # Raises when a job times out class JobTimeout < RuntimeError; end class JobNotFound < RuntimeError; end class JobFormatInvalid < RuntimeError; end class RetryJob < RuntimeError; end attr_accessor :task, :body, :name, :args # Construct a job to be parsed and processed # # task is a reserved object containing the json body in the form of # { :class => "NewsletterSender", :args => ["foo@bar.com"] } # # @example # Backburner::Job.new(payload) # def initialize(task) @hooks = Backburner::Hooks @task = task @body = task.body.is_a?(Hash) ? task.body : Backburner.configuration.job_parser_proc.call(task.body) @name = body["class"] || body[:class] @args = body["args"] || body[:args] @ttr = body["ttr"] || body[:ttr] rescue => ex # Job was not valid format # self.bury # raise JobFormatInvalid, "Job body could not be parsed: #{ex.inspect}" end # Sets the delegator object to the underlying beaneater job # self.bury def __getobj__ __setobj__(@task) super end # Processes a job and handles any failure, deleting the job once complete # # @example # @task.process # def process # Invoke before hook and stop if false res = @hooks.invoke_hook_events(job_name, :before_perform, *args) return false unless res # Execute the job @hooks.around_hook_events(job_name, :around_perform, *args) do timeout_job_after(@ttr > 1 ? @ttr - 1 : @ttr) { job_class.perform(*args) } end task.delete # Invoke after perform hook @hooks.invoke_hook_events(job_name, :after_perform, *args) rescue => e @hooks.invoke_hook_events(job_name, :on_failure, e, *args) raise e end def bury @hooks.invoke_hook_events(job_name, :on_bury, *args) @task.bury end def retry(count, delay) @hooks.invoke_hook_events(job_name, :on_retry, count, delay, *args) @task.release(delay: delay) end # Returns the class for the job handler # # @example # job_class # => NewsletterSender # def job_class handler = try_job_class raise(JobNotFound, self.name) unless handler handler end protected # Attempts to return a constantized job name, otherwise reverts to the name string # # @example # job_name # => "SomeUnknownJob" def job_name handler = try_job_class handler ? handler : self.name end def try_job_class constantize(self.name) rescue NameError nil end # Timeout job within specified block after given time. # # @example # timeout_job_after(3) { do_something! } # def timeout_job_after(secs, &block) begin Timeout::timeout(secs) { yield } rescue Timeout::Error => e raise JobTimeout, "#{name}(#{(@args||[]).join(', ')}) hit #{secs}s timeout.\nbacktrace: #{e.backtrace}" end end end # Job end # Backburner