que 0.4.0 → 0.5.0

data/spec/unit/queue_spec.rb

@@ -7,11 +7,11 @@ describe Que::Job, '.queue' do
     DB[:que_jobs].count.should be 1
 
     result.should be_an_instance_of Que::Job
-    result.attrs[:priority].should == '1'
+    result.attrs[:priority].should == '100'
     result.attrs[:args].should == []
 
     job = DB[:que_jobs].first
-    job[:priority].should be 1
+    job[:priority].should be 100
     job[:run_at].should be_within(3).of Time.now
     job[:job_class].should == "Que::Job"
     JSON.load(job[:args]).should == []
@@ -23,7 +23,7 @@ describe Que::Job, '.queue' do
     DB[:que_jobs].count.should be 1
 
     job = DB[:que_jobs].first
-    job[:priority].should be 1
+    job[:priority].should be 100
     job[:run_at].should be_within(3).of Time.now
     job[:job_class].should == "Que::Job"
     JSON.load(job[:args]).should == [1, 'two']
@@ -39,7 +39,7 @@ describe Que::Job, '.queue' do
     DB[:que_jobs].count.should be 1
 
     job = DB[:que_jobs].first
-    job[:priority].should be 1
+    job[:priority].should be 100
     job[:run_at].should be_within(3).of Time.now
     job[:job_class].should == "Que::Job"
     JSON.load(job[:args]).should == [
@@ -60,7 +60,7 @@ describe Que::Job, '.queue' do
     DB[:que_jobs].count.should be 1
 
     job = DB[:que_jobs].first
-    job[:priority].should be 1
+    job[:priority].should be 100
     job[:run_at].should be_within(3).of Time.now + 60
     job[:job_class].should == "Que::Job"
     JSON.load(job[:args]).should == [1]
@@ -125,12 +125,12 @@ describe Que::Job, '.queue' do
 
     first, second = DB[:que_jobs].order(:job_id).all
 
-    first[:priority].should be 1
+    first[:priority].should be 100
     first[:run_at].should be_within(3).of Time.now + 60
     first[:job_class].should == "DefaultRunAtJob"
     JSON.load(first[:args]).should == [1]
 
-    second[:priority].should be 1
+    second[:priority].should be 100
     second[:run_at].should be_within(3).of Time.now + 30
     second[:job_class].should == "DefaultRunAtJob"
     JSON.load(second[:args]).should == [1]

data/spec/unit/states_spec.rb

@@ -24,6 +24,9 @@ describe Que, '.worker_states' do
       states = Que.worker_states
       states.length.should be 1
 
+      $q2.push nil
+      t.join
+
       state = states.first
       state.keys.should == %w(priority run_at job_id job_class args error_count last_error pg_backend_pid pg_state pg_state_changed_at pg_last_query pg_last_query_started_at pg_transaction_started_at pg_waiting_on_lock)
 
@@ -42,11 +45,6 @@ describe Que, '.worker_states' do
       Time.parse(state[:pg_last_query_started_at]).should be_within(3).of Time.now
       state[:pg_transaction_started_at].should == nil
       state[:pg_waiting_on_lock].should == 'f'
-    ensure
-      if t
-        t.kill
-        t.join
-      end
     end
   end if QUE_ADAPTERS[:connection_pool]
 end

data/spec/unit/work_spec.rb

@@ -4,7 +4,11 @@ describe Que::Job, '.work' do
   it "should pass a job's arguments to the run method and delete it from the database" do
     ArgsJob.queue 1, 'two', {'three' => 3}
     DB[:que_jobs].count.should be 1
-    Que::Job.work.should be_an_instance_of ArgsJob
+
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'ArgsJob'
+
     DB[:que_jobs].count.should be 0
     $passed_args.should == [1, 'two', {'three' => 3}]
   end
@@ -13,33 +17,18 @@ describe Que::Job, '.work' do
     DB[:que_jobs].count.should be 0
     ArgsJob.queue 1, 'two', {'array' => [{'number' => 3}]}
     DB[:que_jobs].count.should be 1
-    Que::Job.work.should be_an_instance_of ArgsJob
+
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'ArgsJob'
+
     DB[:que_jobs].count.should be 0
 
     $passed_args.last[:array].first[:number].should == 3
   end
 
   it "should not fail if there are no jobs to work" do
-    Que::Job.work.should be nil
-  end
-
-  it "should write messages to the logger" do
-    Que::Job.queue
-    Que::Job.work
-
-    $logger.messages.length.should == 1
-    $logger.messages[0].should =~ /\A\[Que\] Worked job in/
-  end
-
-  it "should not fail if there's no logger assigned" do
-    begin
-      Que.logger = nil
-
-      Que::Job.queue
-      Que::Job.work
-    ensure
-      Que.logger = $logger
-    end
+    Que::Job.work[:event].should be :job_unavailable
   end
 
   it "should prefer a job with a higher priority" do
@@ -47,7 +36,9 @@ describe Que::Job, '.work' do
     [5, 4, 3, 2, 1, 2, 3, 4, 5].map{|p| Que::Job.queue :priority => p}
     DB[:que_jobs].order(:job_id).select_map(:priority).should == [5, 4, 3, 2, 1, 2, 3, 4, 5]
 
-    Que::Job.work.should be_an_instance_of Que::Job
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'Que::Job'
     DB[:que_jobs].select_map(:priority).should == [5, 4, 3, 2, 2, 3, 4, 5]
   end
 
@@ -58,7 +49,9 @@ describe Que::Job, '.work' do
 
     recent1, old, recent2 = DB[:que_jobs].order(:job_id).select_map(:run_at)
 
-    Que::Job.work.should be_an_instance_of Que::Job
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'Que::Job'
     DB[:que_jobs].order_by(:job_id).select_map(:run_at).should == [recent1, recent2]
   end
 
@@ -70,7 +63,9 @@ describe Que::Job, '.work' do
 
     first, second, third = DB[:que_jobs].select_order_map(:job_id)
 
-    Que::Job.work.should be_an_instance_of Que::Job
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'Que::Job'
     DB[:que_jobs].select_order_map(:job_id).should == [second, third]
   end
 
@@ -81,8 +76,10 @@ describe Que::Job, '.work' do
 
     future1, past, future2 = DB[:que_jobs].order(:job_id).select_map(:run_at)
 
-    Que::Job.work.should be_an_instance_of Que::Job
-    Que::Job.work.should be nil
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'Que::Job'
+    Que::Job.work[:event].should be :job_unavailable
     DB[:que_jobs].order_by(:job_id).select_map(:run_at).should == [future1, future2]
   end
 
@@ -106,7 +103,11 @@ describe Que::Job, '.work' do
 
     begin
       DB.select{pg_advisory_lock(id)}.single_value
-      Que::Job.work.should be_an_instance_of Que::Job
+
+      result = Que::Job.work
+      result[:event].should == :job_worked
+      result[:job][:job_class].should == 'Que::Job'
+
       DB[:que_jobs].order_by(:job_id).select_map(:priority).should == [1, 3]
     ensure
       DB.select{pg_advisory_unlock(id)}.single_value
@@ -134,13 +135,17 @@ describe Que::Job, '.work' do
     $job_spec_result = []
     SubClassJob.queue
     DB[:que_jobs].select_map(:priority).should == [2]
-    Que::Job.work.should be_an_instance_of SubClassJob
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'SubClassJob'
     $job_spec_result.should == [:sub]
 
     $job_spec_result = []
     SubSubClassJob.queue
     DB[:que_jobs].select_map(:priority).should == [4]
-    Que::Job.work.should be_an_instance_of SubSubClassJob
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'SubSubClassJob'
     $job_spec_result.should == [:sub, :subsub]
   end
 
@@ -152,7 +157,10 @@ describe Que::Job, '.work' do
 
     ModuleJobModule::ModuleJob.queue
     DB[:que_jobs].get(:job_class).should == "ModuleJobModule::ModuleJob"
-    Que::Job.work.should be_an_instance_of ModuleJobModule::ModuleJob
+
+    result = Que::Job.work
+    result[:event].should == :job_worked
+    result[:job][:job_class].should == 'ModuleJobModule::ModuleJob'
   end
 
   it "should make it easy to destroy the job within the same transaction as other changes" do
@@ -171,7 +179,11 @@ describe Que::Job, '.work' do
   describe "when encountering an error" do
     it "should exponentially back off the job" do
       ErrorJob.queue
-      Que::Job.work.should be true
+
+      result = Que::Job.work
+      result[:event].should == :job_errored
+      result[:error].should be_an_instance_of RuntimeError
+      result[:job][:job_class].should == 'ErrorJob'
 
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
@@ -182,7 +194,10 @@ describe Que::Job, '.work' do
       DB[:que_jobs].update :error_count => 5,
                            :run_at => Time.now - 60
 
-      Que::Job.work.should be true
+      result = Que::Job.work
+      result[:event].should == :job_errored
+      result[:error].should be_an_instance_of RuntimeError
+      result[:job][:job_class].should == 'ErrorJob'
 
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
@@ -197,7 +212,11 @@ describe Que::Job, '.work' do
         Que.error_handler = proc { |error| errors << error }
 
         ErrorJob.queue
-        Que::Job.work.should be true
+
+        result = Que::Job.work
+        result[:event].should == :job_errored
+        result[:error].should be_an_instance_of RuntimeError
+        result[:job][:job_class].should == 'ErrorJob'
 
         errors.count.should be 1
         error = errors[0]
@@ -212,26 +231,23 @@ describe Que::Job, '.work' do
       begin
         Que.error_handler = proc { |error| raise "Another error!" }
         ErrorJob.queue
-        Que::Job.work.should be true
+
+        result = Que::Job.work
+        result[:event].should == :job_errored
+        result[:error].should be_an_instance_of RuntimeError
       ensure
         Que.error_handler = nil
       end
     end
 
-    it "should return false if the job throws a postgres error" do
-      class PGErrorJob < Que::Job
-        def run
-          Que.execute "bad SQL syntax"
-        end
-      end
-
-      PGErrorJob.queue
-      Que::Job.work.should be false
-    end
-
     it "should throw an error properly if there's no corresponding job class" do
       DB[:que_jobs].insert :job_class => "NonexistentClass"
-      Que::Job.work.should be true
+
+      result = Que::Job.work
+      result[:event].should == :job_errored
+      result[:error].should be_an_instance_of NameError
+      result[:job][:job_class].should == 'NonexistentClass'
+
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 1

data/spec/unit/worker_spec.rb

@@ -10,10 +10,15 @@ describe Que::Worker do
       @worker = Que::Worker.new
       sleep_until { @worker.sleeping? }
       DB[:que_jobs].count.should be 0
+
+      $logger.messages.map{|m| JSON.load(m)['event']}.should == %w(job_worked job_worked job_unavailable)
+
+      json = JSON.load($logger.messages[0])
+      json['job']['job_class'].should == 'Que::Job'
     ensure
       if @worker
-        @worker.thread.kill
-        @worker.thread.join
+        @worker.stop
+        @worker.wait_until_stopped
       end
     end
   end
@@ -32,8 +37,8 @@ describe Que::Worker do
       DB[:que_jobs].count.should be 0
     ensure
       if @worker
-        @worker.thread.kill
-        @worker.thread.join
+        @worker.stop
+        @worker.wait_until_stopped
       end
     end
   end
@@ -46,10 +51,11 @@ describe Que::Worker do
       $q1.pop
       DB[:que_jobs].count.should be 1
       @worker.wake!.should be nil
+      $q2.push nil
     ensure
       if @worker
-        @worker.thread.kill
-        @worker.thread.join
+        @worker.stop
+        @worker.wait_until_stopped
       end
     end
   end
@@ -67,10 +73,16 @@ describe Que::Worker do
       job = DB[:que_jobs].first
       job[:job_class].should == 'ErrorJob'
       job[:run_at].should be_within(3).of Time.now + 4
+
+      log = JSON.load($logger.messages[0])
+      log['event'].should == 'job_errored'
+      log['error']['class'].should == 'RuntimeError'
+      log['error']['message'].should == "ErrorJob!"
+      log['job']['job_class'].should == 'ErrorJob'
     ensure
       if @worker
-        @worker.thread.kill
-        @worker.thread.join
+        @worker.stop
+        @worker.wait_until_stopped
       end
     end
   end
@@ -92,11 +104,6 @@ describe Que::Worker do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:job_class].should == 'Que::Job'
-    ensure
-      if @worker
-        @worker.thread.kill
-        @worker.thread.join
-      end
     end
   end
 
@@ -107,45 +114,6 @@ describe Que::Worker do
 
       @worker.stop
       @worker.wait_until_stopped
-    ensure
-      if @worker
-        @worker.thread.kill
-        @worker.thread.join
-      end
-    end
-  end
-
-  it "should receive and respect a notification to stop immediately when it is working, and kill the job" do
-    begin
-      # Worker#stop! can leave the database connection in an unpredictable
-      # state, which would impact the rest of the tests, so we need a special
-      # connection for it.
-      pg = NEW_PG_CONNECTION.call
-      Que.connection = pg
-
-      BlockJob.queue
-
-      @worker = Que::Worker.new
-      $q1.pop
-      @worker.stop!
-      @worker.wait_until_stopped
-    ensure
-      pg.close if pg
-    end
-  end
-
-  it "should receive and respect a notification to stop immediately when it is currently asleep" do
-    begin
-      @worker = Que::Worker.new
-      sleep_until { @worker.sleeping? }
-
-      @worker.stop!
-      @worker.wait_until_stopped
-    ensure
-      if @worker
-        @worker.thread.kill
-        @worker.thread.join
-      end
     end
   end
 end

data/tasks/safe_shutdown.rb

@@ -49,15 +49,15 @@ task :safe_shutdown do
     puts "kill -#{signal} #{Process.pid}"
   end
 
-  # Put exit behavior to test the behavior of here:
-  at_exit do
-    puts "Stopping Que..."
-    Que.stop!
-  end
-
   stop = false
   trap('INT'){stop = true}
 
+  at_exit do
+    $stdout.puts "Finishing Que's current jobs before exiting..."
+    Que.mode = :off
+    $stdout.puts "Que's jobs finished, exiting..."
+  end
+
   loop do
     sleep 0.01
     break if stop

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -18,26 +18,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
-  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: A job queue that uses PostgreSQL's advisory locks for speed and reliability.
 email:
 - christopher.m.hanks@gmail.com
@@ -47,14 +33,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - docs/advanced_setup.md
+- docs/customizing_que.md
 - docs/error_handling.md
 - docs/inspecting_the_queue.md
+- docs/logging.md
 - docs/managing_workers.md
 - docs/using_plain_connections.md
 - docs/using_sequel.md
@@ -68,6 +57,11 @@ files:
 - lib/que/adapters/pg.rb
 - lib/que/adapters/sequel.rb
 - lib/que/job.rb
+- lib/que/migrations.rb
+- lib/que/migrations/1-down.sql
+- lib/que/migrations/1-up.sql
+- lib/que/migrations/2-down.sql
+- lib/que/migrations/2-up.sql
 - lib/que/railtie.rb
 - lib/que/rake_tasks.rb
 - lib/que/sql.rb
@@ -83,8 +77,11 @@ files:
 - spec/support/jobs.rb
 - spec/support/shared_examples/adapter.rb
 - spec/support/shared_examples/multi_threaded_adapter.rb
+- spec/travis.rb
 - spec/unit/connection_spec.rb
 - spec/unit/helper_spec.rb
+- spec/unit/logging_spec.rb
+- spec/unit/migrations_spec.rb
 - spec/unit/pool_spec.rb
 - spec/unit/queue_spec.rb
 - spec/unit/states_spec.rb
@@ -114,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: A PostgreSQL-based Job Queue
@@ -128,8 +125,11 @@ test_files:
 - spec/support/jobs.rb
 - spec/support/shared_examples/adapter.rb
 - spec/support/shared_examples/multi_threaded_adapter.rb
+- spec/travis.rb
 - spec/unit/connection_spec.rb
 - spec/unit/helper_spec.rb
+- spec/unit/logging_spec.rb
+- spec/unit/migrations_spec.rb
 - spec/unit/pool_spec.rb
 - spec/unit/queue_spec.rb
 - spec/unit/states_spec.rb