resque-job-tracking 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+cubbyhole.*

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in resque-job-tracking.gemspec
+gemspec
+
+gem 'json'
+
+group :test do
+  gem 'cubbyhole'
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Engine Yard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README

@@ -0,0 +1,15 @@
+A resque plugin for tracking jobs and their state (pending, running, failed) based on some originating entity.
+This plugin relies heavily on resque-meta to store meta data on resque jobs.
+
+Our use case is:
+
+Account is a model in our database. Accounts do lots of things which trigger background jobs.  We want to be able to see for a given account:
+1. What jobs are waiting to be run.
+2. What jobs are currently running.
+3. What jobs ran and had some exception in the past 24 hours.
+
+You define how jobs are tracked by defining the "track" method on your job class (see the tests for an example)
+
+You define how long meta data is kept around by defining expire_meta_in, expire_normal_meta_in, and/or expire_failures_meta_in on your job class (see tests for an example)
+
+You can access the list of pending, running, and failed jobs using the Resque::Plugins::JobTracking methods: pending_jobs, running_jobs, failed_jobs (again, see tests)

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/resque/plugins/job_tracking/meta_ext.rb

@@ -0,0 +1,23 @@
+#TODO: send a PULL request with this change!!!
+Resque::Plugins::Meta::Metadata.class_eval do
+
+  def initialize(data_hash)
+    data_hash['enqueued_at'] ||= to_time_format_str(Time.now)
+    @data = data_hash
+    @meta_id = data_hash['meta_id'].dup
+    @enqueued_at = from_time_format_str('enqueued_at')
+    @job_class = data_hash['job_class']
+    if @job_class.is_a?(String)
+      @job_class = Resque.constantize(data_hash['job_class'])
+    else
+      data_hash['job_class'] = @job_class.to_s
+    end
+    @expire_in = data_hash["expire_in"] || @job_class.expire_meta_in || 0
+  end
+
+  def expire_in=(val)
+    @expire_in = val
+    data["expire_in"] = val
+  end
+
+end

data/lib/resque/plugins/job_tracking/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module JobTracking
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/resque/plugins/job_tracking.rb

@@ -0,0 +1,78 @@
+require 'resque/plugins/meta'
+require 'resque/plugins/job_tracking/meta_ext'
+
+module Resque
+  module Plugins
+    module JobTracking
+      def self.extended(mod)
+        mod.extend(Resque::Plugins::Meta)
+      end
+
+      def self.pending_jobs(identifier)
+        Resque.redis.smembers("#{identifier}:pending") || []
+      end
+
+      def self.running_jobs(identifier)
+        Resque.redis.smembers("#{identifier}:running") || []
+      end
+
+      def self.failed_jobs(identifier)
+        Resque.redis.smembers("#{identifier}:failed") || []
+      end
+
+      def expire_normal_meta_in
+        expire_meta_in
+      end
+
+      def expire_failures_meta_in
+        expire_meta_in + (24 * 60 * 60)
+      end
+
+      def before_enqueue_job_tracking(meta_id, *jobargs)
+        if self.respond_to?(:track)
+          identifiers = track(*jobargs)
+          identifiers.each do |ident|
+            Resque.redis.sadd("#{ident}:pending", meta_id)
+          end
+          meta = get_meta(meta_id)
+          meta["job_args"] = jobargs
+          meta.save
+        end
+      end
+
+      def around_perform_job_tracking(meta_id, *jobargs)
+        if self.respond_to?(:track)
+          identifiers = track(*jobargs)
+          identifiers.each do |ident|
+            Resque.redis.srem("#{ident}:pending", meta_id)
+            Resque.redis.sadd("#{ident}:running", meta_id)
+          end
+          begin
+            to_return = yield
+            meta = get_meta(meta_id)
+            meta.expire_in = expire_normal_meta_in
+            meta.save
+            to_return
+          rescue => e
+            identifiers.each do |ident|
+              Resque.redis.sadd("#{ident}:failed", meta_id)
+            end
+            meta = get_meta(meta_id)
+            meta.expire_in = expire_failures_meta_in
+            meta['exception_message'] = e.message
+            meta['exception_backtrace'] = e.backtrace
+            meta.save
+            raise e
+          ensure
+            identifiers.each do |ident|
+              Resque.redis.srem("#{ident}:running", meta_id)
+            end
+          end
+        else
+          yield
+        end
+      end
+
+    end
+  end
+end

data/resque-job-tracking.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/resque/plugins/job_tracking/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jacob Burkhart"]
+  gem.email         = ["jacob@engineyard.com"]
+  gem.description   = %q{A resque plugin for tracking jobs and their state (pending, running, failed) based on some originating entity}
+  gem.summary       = %q{A resque plugin for tracking jobs and their state (pending, running, failed) based on some originating entity}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "resque-job-tracking"
+  gem.require_paths = ["lib"]
+  gem.version       = Resque::Plugins::JobTracking::VERSION
+
+  gem.add_dependency 'resque', '>= 1.8.0'
+  gem.add_dependency 'resque-meta', '>= 1.0.0'
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/basic_spec.rb

@@ -0,0 +1,48 @@
+require 'resque'
+require 'resque/plugins/job_tracking'
+
+require 'spec_helper'
+
+class WhatHappened
+  require 'tempfile'  
+  def self.reset!
+    @what_happened = Tempfile.new("what_happened")
+  end
+  def self.what_happened
+    File.read(@what_happened.path)
+  end
+  def self.record(*event)
+    @what_happened.write(event.to_s)
+    @what_happened.flush
+  end
+end
+
+class BasicJob
+  extend Resque::Plugins::JobTracking
+  @queue = :test
+    
+  def self.perform(*args)
+    begin
+      WhatHappened.record(self, args)
+    rescue => e
+      puts e.inspect
+      puts e.backtrace.join("\n")
+    end
+  end
+end
+
+
+describe "the basics" do
+  before do
+    WhatHappened.reset!
+    Resque.redis.flushall
+  end
+
+  it "works" do
+    meta = BasicJob.enqueue('foo', 'bar')
+    worker = Resque::Worker.new(:test)
+    worker.work(0)
+    meta = BasicJob.get_meta(meta.meta_id)
+    WhatHappened.what_happened.should == "BasicJob#{meta.meta_id}foobar"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+Dir[File.expand_path('../support/*.rb', __FILE__)].each{|f| require f}

data/spec/support/worker_support.rb

@@ -0,0 +1,50 @@
+module WorkerSupport
+
+  def work(worker_count = 5)
+    @workers = []
+    worker_count.times do
+      @workers << Process.fork do
+        begin
+          Resque.redis.client.reconnect
+          Resque::Worker.new(:test).work(1)
+        rescue => e
+          puts e.inspect
+          puts e.backtrace.join("\n")
+        end
+      end
+    end
+  end
+
+  def finished?
+    Resque.redis.keys("meta*").each do |key|
+      meta = Resque::Plugins::Meta.get_meta(key.split(":").last)
+      if meta.finished?
+        # puts "finished #{meta['job_class']}"
+      else
+        return false
+        # puts "still running #{meta['job_class']}"
+      end
+    end
+    return true
+  end
+
+  def wait_until_finished
+    while(!finished?)
+      sleep(0.5)
+    end
+  end
+
+  def work_until_finished
+    work
+    wait_until_finished
+  end
+
+  def cleanup
+    if @workers
+      @workers.each do |p|
+        Process.kill(9, p)
+      end
+    end
+  end
+
+end

data/spec/tracking_spec.rb

@@ -0,0 +1,156 @@
+require 'resque'
+require 'resque/plugins/job_tracking'
+
+require 'spec_helper'
+
+class WhatHappened
+  require 'tempfile'  
+  def self.reset!
+    @what_happened = Tempfile.new("what_happened")
+  end
+  def self.what_happened
+    File.read(@what_happened.path)
+  end
+  def self.record(*event)
+    @what_happened.write(event.to_s)
+    @what_happened.flush
+  end
+end
+
+class BaseJobWithPerform
+  extend Resque::Plugins::JobTracking
+  def self.queue
+    :test
+  end
+
+  def self.expire_meta_in
+    1
+  end
+
+  def self.perform(meta_id, *args)
+    self.new.perform(*args)
+  end
+
+end
+
+require 'cubbyhole/base'
+class Account < Cubbyhole::Base
+
+  def pending_jobs
+    Resque::Plugins::JobTracking.pending_jobs(job_tracking_identifier)
+  end
+
+  def running_jobs
+    Resque::Plugins::JobTracking.running_jobs(job_tracking_identifier)
+  end
+
+  def failed_jobs
+    Resque::Plugins::JobTracking.failed_jobs(job_tracking_identifier)
+  end
+
+  def job_tracking_identifier
+    "account#{self.id}"
+  end
+
+end
+
+
+class TypicalProblemJob < BaseJobWithPerform
+
+  def self.track(account_id, something)
+    [Account.get(account_id).job_tracking_identifier]
+  end
+
+  def perform(account_id, something)
+    if something == 'fail_immediate'
+      raise "failing immediate"
+    end
+    sleep(2)
+    if something == 'fail_please'
+      raise "i fail now"
+    end
+  end
+
+end
+
+
+describe TypicalProblemJob do
+  include WorkerSupport
+
+  before do
+    WhatHappened.reset!
+    Resque.redis.flushall
+  end
+  after do
+    cleanup
+  end
+
+  it "should keep meta data for failed jobs" do
+    account = Account.create
+    TypicalProblemJob.enqueue(account.id, 'fail_please')
+    account.pending_jobs.size.should eq 1
+    account.running_jobs.size.should eq 0
+    account.failed_jobs.size.should eq 0
+    meta_id = account.pending_jobs.first
+    TypicalProblemJob.get_meta(meta_id).should_not be_nil
+    work(1)
+    sleep(1)
+    account.pending_jobs.size.should eq 0
+    account.running_jobs.size.should eq 1
+    account.failed_jobs.size.should eq 0
+    account.running_jobs.first.should eq meta_id
+    TypicalProblemJob.get_meta(meta_id).should_not be_nil
+    wait_until_finished
+    account.pending_jobs.size.should eq 0
+    account.running_jobs.size.should eq 0
+    account.failed_jobs.size.should eq 1
+    account.failed_jobs.first.should eq meta_id
+    meta = TypicalProblemJob.get_meta(meta_id)
+    meta.should_not be_nil
+  end
+
+  it "should lose meta data for non-failing jobs" do
+    account = Account.create
+    TypicalProblemJob.enqueue(account.id, 'pass_please')
+    account.pending_jobs.size.should eq 1
+    account.running_jobs.size.should eq 0
+    account.failed_jobs.size.should eq 0
+    meta_id = account.pending_jobs.first
+    TypicalProblemJob.get_meta(meta_id).should_not be_nil
+    work(1)
+    sleep(1)
+    account.pending_jobs.size.should eq 0
+    account.running_jobs.size.should eq 1
+    account.failed_jobs.size.should eq 0
+    account.running_jobs.first.should eq meta_id
+    TypicalProblemJob.get_meta(meta_id).should_not be_nil
+    wait_until_finished
+    account.pending_jobs.size.should eq 0
+    account.running_jobs.size.should eq 0
+    account.failed_jobs.size.should eq 0
+    sleep(2)
+    TypicalProblemJob.get_meta(meta_id).should be_nil
+  end
+
+  it "should store the exception in meta data" do
+    account = Account.create
+    TypicalProblemJob.enqueue(account.id, 'fail_immediate')
+    work_until_finished
+    account.failed_jobs.size.should eq 1
+    meta_id = account.failed_jobs.first
+    meta_data = TypicalProblemJob.get_meta(meta_id)
+    meta_data['exception_message'].should eq "failing immediate"
+    meta_data['exception_backtrace'].should_not be_nil
+  end
+
+  it "should store the job class and args in meta data" do
+    account = Account.create
+    TypicalProblemJob.enqueue(account.id, 'dontcare')
+    account.pending_jobs.size.should eq 1
+    meta_id = account.pending_jobs.first
+    meta_data = TypicalProblemJob.get_meta(meta_id)
+    meta_data['job_class'].should eq "TypicalProblemJob"
+    meta_data['job_args'].should eq [account.id, 'dontcare']
+  end
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: resque-job-tracking
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jacob Burkhart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-meta
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A resque plugin for tracking jobs and their state (pending, running, failed) based on some originating entity
+email: 
+- jacob@engineyard.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- lib/resque/plugins/job_tracking.rb
+- lib/resque/plugins/job_tracking/meta_ext.rb
+- lib/resque/plugins/job_tracking/version.rb
+- resque-job-tracking.gemspec
+- spec/basic_spec.rb
+- spec/spec_helper.rb
+- spec/support/worker_support.rb
+- spec/tracking_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A resque plugin for tracking jobs and their state (pending, running, failed) based on some originating entity
+test_files: 
+- spec/basic_spec.rb
+- spec/spec_helper.rb
+- spec/support/worker_support.rb
+- spec/tracking_spec.rb