如何为ActiveRecord模型对象查找关联的Resque作业?

时间:2016-02-25 19:46:02

标签: ruby-on-rails ruby redis resque

我需要能够为模型对象找到排队和/或工作的作业和/或失败的作业,例如,当模型对象被销毁时我们想要找到所有并且决定不删除或销毁作业(有条件的)。

在我重新发明轮子之前,有没有推荐的方法呢?

示例:

如果你想创建一个before_destroy回调,当对象被销毁时排队所有的工作(排队和失败的工作),只有在没有工作的情况下才会销毁

我想为此示例用例做的一些伪代码:

报告模型

class Report < ActiveRecord::Base
  before_destroy :check_if_working_jobs, :destroy_queued_and_failed_jobs

  def check_if_working_jobs
    # find all working jobs related to this report object
    working_jobs = ProcessReportWorker.find_working_jobs_by_report_id(self.id) 
    return false unless working_jobs.empty?
  end

  def destroy_queued_and_failed_jobs
    # find all jobs related to this report object
    queued_jobs = ProcessReportWorker.find_queued_jobs_by_report_id(self.id) 
    failed_jobs = ProcessReportWorker.find_failed_jobs_by_report_id(self.id) 

    # destroy/remove all jobs found
    (queued_jobs + failed_jobs).each do |job| 
       # destroy the job here ... commands?
    end

  end
end

报告resque / redis支持作业的处理工人类

class ProcessReportWorker

  # find the jobs by report id which is one of the arguments for the job?
  # envisioned as separate methods so they can be used independently as needed

  def self.find_queued_jobs_by_report_id(id)
     # parse all jobs in all queues to find based on the report id argument?
  end 

  def self.find_working_jobs_by_report_id(id)
     # parse all jobs in working queues to find based on the report id argument? 
  end 

  def self.find_failed_jobs_by_report_id(id)
     # parse all jobs in failed queue to find based on the report id argument? 
  end 
end

这种方法是否正常运转?

通过模型对象id找到排队或工作的作业然后将其销毁,上面缺少什么?

是否已经有方法通过我在文档或搜索中遗漏的相关模型对象ID来查找和/或销毁?

更新:修改了使用示例,仅使用working_jobs作为检查是否应删除的方式vs建议我们也尝试删除working_jobs。 (因为删除工作作业比简单地删除redis键条目更复杂)

1 个答案:

答案 0 :(得分:1)

它在这里很安静,没有任何回应,所以我设法花了一天时间按照我在问题中指出的路径来解决这个问题。可能有更好的解决方案或其他可用的方法,但这似乎可以完成目前的工作。如果对于所使用的方法有更好的选择或者是否可以进一步改进,请随意发表评论。

此处的总体方法是您需要搜索所有作业(排队,工作,失败)并仅筛选出相关且与对象记录ID匹配的classqueue的作业您正在寻找args数组的正确索引位置。例如(在确认classqueue匹配之后)如果参数位置0是对象ID所在的位置,那么您可以测试args[0]是否与对象ID匹配。

基本上,如果出现以下情况,则作业与对象ID相关联:job_class == class.name && job_queue == @queue && job_args[OBJECT_ID_ARGS_INDEX].to_i == object_id

  • 排队作业:要查找所有排队作业,您需要收集所有redis 具有名为queue:#{@queue}的键的条目,其中@queue是 您的工作类正在使用的队列的名称。相应地修改 如果您使用多个队列,则循环遍历多个队列 特定的工人阶级。 Resque.redis.lrange("queue:#{@queue}",0,-1)
  • 失败的工作:要查找所有排队的工作,您需要收集所有redis 具有名为failed的键的条目(除非您使用多个 故障队列或默认设置以外的其他组件)。 Resque.redis.lrange("failed",0,-1)
  • 工作职位:要查找所有可以使用的工作Resque.workers 其中包含所有工作人员和正在运行的作业的数组。 Resque.workers.map(&:job)
  • 作业:上述每个列表中的每个作业都是一个编码哈希。您 可以使用Resque.decode(job)将作业解码为ruby哈希。
  • 类和参数:对于排队的作业classargs键为job["class"]job["args"]。对于失败的工作职位,这些是job["payload"]["class"]job["payload"]["args"]
  • 队列:对于找到的每个失败的工作作业,队列将为job["queue"]。在测试对象ID的args列表之前,您只需要与classqueue匹配的作业。您的排队作业列表将仅限于您收集的队列。

下面是用于查找(和删除)与示例模型对象(报表)关联的作业的示例工作者类和模型方法。

报告resque / redis支持作业的处理工人类

class ProcessReportWorker
  # queue name
  @queue = :report_processing
  # tell the worker class where the report id is in the arguments list
  REPORT_ID_ARGS_INDEX = 0 

  # <snip> rest of class, not needed here for this answer

  # find jobs methods - find by report id (report is the 'associated' object)

  def self.find_queued_jobs_by_report_id report_id
    queued_jobs(@queue).select do |job|
      is_job_for_report? :queued, job, report_id
    end
  end

  def self.find_failed_jobs_by_report_id report_id
    failed_jobs.select do |job|
      is_job_for_report? :failed, job, report_id
    end
  end

  def self.find_working_jobs_by_report_id report_id
    working_jobs.select do |worker,job|
      is_job_for_report? :working, job, report_id
    end
  end

  # association test method - determine if this job is associated      

  def self.is_job_for_report? state, job, report_id
    attributes = job_attributes(state, job)
    attributes[:klass] == self.name && 
      attributes[:queue] == @queue && 
        attributes[:args][REPORT_ID_ARGS_INDEX].to_i == report_id
  end

  # remove jobs methods

  def self.remove_failed_jobs_by_report_id report_id
    find_failed_jobs_by_report_id(report_id).each do |job|
      Resque::Failure.remove(job["index"]) 
    end
  end

  def self.remove_queued_jobs_by_report_id report_id
    find_queued_jobs_by_report_id(report_id).each do |job|
      Resque::Job.destroy(@queue,job["class"],*job["args"])
    end
  end

  # reusable methods - these methods could go elsewhere and be reusable across worker classes

  # job attributes method

  def self.job_attributes(state, job)
    if state == :queued && job["args"].present?
      args = job["args"]
      klass = job["class"]
    elsif job["payload"] && job["payload"]["args"].present?
      args = job["payload"]["args"]
      klass = job["payload"]["class"] 
    else
      return {args: nil, klass: nil, queue: nil}
    end
    {args: args, klass: klass, queue: job["queue"]}
  end

  # jobs list methods

  def self.queued_jobs queue
    Resque.redis.lrange("queue:#{queue}", 0, -1)
      .collect do |job| 
        job = Resque.decode(job)
        job["queue"] = queue # for consistency only
        job
      end
  end

  def self.failed_jobs
    Resque.redis.lrange("failed", 0, -1)
      .each_with_index.collect do |job,index|
        job = Resque.decode(job)
        job["index"] = index # required if removing
        job
      end
  end

  def self.working_jobs
    Resque.workers.zip(Resque.workers.map(&:job))
      .reject { |w, j| w.idle? || j['queue'].nil? }
  end

end

然后,报告模型的使用示例变为

class Report < ActiveRecord::Base
  before_destroy :check_if_working_jobs, :remove_queued_and_failed_jobs

  def check_if_working_jobs
    # find all working jobs related to this report object
    working_jobs = ProcessReportWorker.find_working_jobs_by_report_id(self.id) 
    return false unless working_jobs.empty?
  end

  def remove_queued_and_failed_jobs
    # find all jobs related to this report object
    queued_jobs = ProcessReportWorker.find_queued_jobs_by_report_id(self.id) 
    failed_jobs = ProcessReportWorker.find_failed_jobs_by_report_id(self.id) 

    # extra code and conditionals here for example only as all that is really 
    # needed is to call the remove methods without first finding or checking

    unless queued_jobs.empty?
      ProcessReportWorker.remove_queued_jobs_by_report_id(self.id)
    end

    unless failed_jobs.empty?
      ProcessReportWorker.remove_failed_jobs_by_report_id(self.id)
    end

  end
end

如果为工作类使用多个队列或者有多个故障队列,则需要修改解决方案。此外,还使用了redis故障后端。如果使用不同的故障后端,则可能需要进行更改。