que 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2f4b100178a6d42d65ee4de7c3f1d1b71cc2112
-  data.tar.gz: c85c868eca099620035367f303f1db4ad2d73cf4
+  metadata.gz: ea48a3d241852be82ac3310d9a9b77dd5c752c66
+  data.tar.gz: 9c959569e9b5eb520dffde4a21f08875d9efbbce
 SHA512:
-  metadata.gz: 0c88982605dabab6aa9a026859c69c0c979b6f0b85af24e444462befdc9945fb905d5ef884a7fb364c3bc00f388771c6b636d41afc09f085dd245761afbb32e9
-  data.tar.gz: fd1695313794a1ac4e9d6bc9f3ad00c77ba8a07532a19972b8b1cefddb367bdb676f5295e62a7847b5d58be84c56baed02f35507a032f7c9ed1a52e17d95b585
+  metadata.gz: 794d3b3a6e55beaa75a8142324a8eac2512505114b401aa1b306ef20e0e08f58913a8bb6685dd599a4bcadbdfec295c97637b22b6ddfdf8d2862225444e76ced
+  data.tar.gz: b186100af249195025f731e551155dcdcd9e4797a7164d0c71a9604842e5a3d604bd47f6b5331e0773bdfad1018332d21463266675251afeb5034407fc7dcae6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 0.10.0 (2015-03-18)
+
+*   When working jobs via the rake task, Rails applications are now eager-loaded if present, to avoid problems with multithreading and autoloading. (#96) (hmarr)
+
+*   The que:work rake task now uses whatever logger Que is configured to use normally, rather than forcing the use of STDOUT. (#95)
+
+*   Add Que.transaction() helper method, to aid in transaction management in migrations or when the user's ORM doesn't provide one. (#81)
+
 ### 0.9.2 (2015-02-05)
 
 *   Fix a bug wherein the at_exit hook in the railtie wasn't waiting for jobs to finish before exiting.

data/docs/error_handling.md

@@ -20,6 +20,24 @@ Unlike DelayedJob, however, there is currently no maximum number of failures aft
 
 If you're using an error notification system (highly recommended, of course), you can hook Que into it by setting a callable as the error handler:
 
-    Que.error_handler = proc do |error|
-      # Do whatever you want with the error object.
+    Que.error_handler = proc do |error, job|
+      # Do whatever you want with the error object or job row here.
+
+      # Note that the job passed is not the actual job object, but the hash
+      # representing the job row in the database, which looks like:
+
+      # {
+      #   "queue" => "my_queue",
+      #   "priority" => 100,
+      #   "run_at" => 2015-03-06 11:07:08 -0500,
+      #   "job_id" => 65,
+      #   "job_class" => "MyJob",
+      #   "args" => ['argument', 78],
+      #   "error_count" => 0
+      # }
+
+      # This is done because the job may not have been able to be deserialized
+      # properly, if the name of the job class was changed or the job is being
+      # retrieved and worked by the wrong app. The job argument may also be
+      # nil, if there was a connection failure or something similar.
     end

data/lib/que.rb

@@ -96,6 +96,32 @@ module Que
       @log_formatter ||= JSON_MODULE.method(:dump)
     end
 
+    # A helper method to manage transactions, used mainly by the migration
+    # system. It's available for general use, but if you're using an ORM that
+    # provides its own transaction helper, be sure to use that instead, or the
+    # two may interfere with one another.
+    def transaction
+      adapter.checkout do
+        if adapter.in_transaction?
+          yield
+        else
+          begin
+            execute "BEGIN"
+            yield
+          rescue => error
+            raise
+          ensure
+            # Handle a raised error or a killed thread.
+            if error || Thread.current.status == 'aborting'
+              execute "ROLLBACK"
+            else
+              execute "COMMIT"
+            end
+          end
+        end
+      end
+    end
+
     # Copy some of the Worker class' config methods here for convenience.
     [:mode, :mode=, :worker_count, :worker_count=, :wake_interval, :wake_interval=, :wake!, :wake_all!].each do |meth|
       define_method(meth) { |*args| Worker.send(meth, *args) }

data/lib/que/migrations.rb

@@ -7,7 +7,7 @@ module Que
 
     class << self
       def migrate!(options = {:version => CURRENT_VERSION})
-        transaction do
+        Que.transaction do
           version = options[:version]
 
           if (current = db_version) == version
@@ -52,28 +52,6 @@ module Que
         i = version.to_i
         Que.execute "COMMENT ON TABLE que_jobs IS '#{i}'" unless i.zero?
       end
-
-      def transaction
-        Que.adapter.checkout do
-          if Que.adapter.in_transaction?
-            yield
-          else
-            begin
-              Que.execute "BEGIN"
-              yield
-            rescue => error
-              raise
-            ensure
-              # Handle a raised error or a killed thread.
-              if error || Thread.current.status == 'aborting'
-                Que.execute "ROLLBACK"
-              else
-                Que.execute "COMMIT"
-              end
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/que/rake_tasks.rb

@@ -1,9 +1,14 @@
 namespace :que do
   desc "Process Que's jobs using a worker pool"
   task :work => :environment do
-    require 'logger'
+    if defined?(::Rails) && Rails.respond_to?(:application)
+      # ActiveSupport's dependency autoloading isn't threadsafe, and Que uses
+      # multiple threads, which means that eager loading is necessary. Rails
+      # explicitly prevents eager loading when the environment task is invoked,
+      # so we need to manually eager load the app here.
+      Rails.application.eager_load!
+    end
 
-    Que.logger        = Logger.new(STDOUT)
     Que.logger.level  = Logger.const_get((ENV['QUE_LOG_LEVEL'] || 'INFO').upcase)
     Que.worker_count  = (ENV['QUE_WORKER_COUNT'] || 4).to_i
     Que.wake_interval = (ENV['QUE_WAKE_INTERVAL'] || 0.1).to_f

data/lib/que/version.rb

@@ -1,3 +1,3 @@
 module Que
-  Version = '0.9.2'
+  Version = '0.10.0'
 end

data/spec/unit/migrations_spec.rb

@@ -79,37 +79,4 @@ describe Que::Migrations do
     Que::Migrations.migrate!
     DB.table_exists?(:que_jobs).should be true
   end
-
-  it "should use transactions to protect its migrations from errors" do
-    proc do
-      Que::Migrations.transaction do
-        Que.execute "DROP TABLE que_jobs"
-        Que.execute "invalid SQL syntax"
-      end
-    end.should raise_error(PG::Error)
-
-    DB.table_exists?(:que_jobs).should be true
-  end
-
-  # In Ruby 1.9, it's impossible to tell inside an ensure block whether the
-  # currently executing thread has been killed.
-  unless RUBY_VERSION.start_with?('1.9')
-    it "should use transactions to protect its migrations from killed threads" do
-      q = Queue.new
-
-      t = Thread.new do
-        Que::Migrations.transaction do
-          Que.execute "DROP TABLE que_jobs"
-          q.push :go!
-          sleep
-        end
-      end
-
-      q.pop
-      t.kill
-      t.join
-
-      DB.table_exists?(:que_jobs).should be true
-    end
-  end
 end

data/spec/unit/transaction_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Que, '.transaction' do
+  it "should use a transaction to rollback changes in the event of an error" do
+    proc do
+      Que.transaction do
+        Que.execute "DROP TABLE que_jobs"
+        Que.execute "invalid SQL syntax"
+      end
+    end.should raise_error(PG::Error)
+
+    DB.table_exists?(:que_jobs).should be true
+  end
+
+  unless RUBY_VERSION.start_with?('1.9')
+    it "should rollback correctly in the event of a killed thread" do
+      q = Queue.new
+
+      t = Thread.new do
+        Que.transaction do
+          Que.execute "DROP TABLE que_jobs"
+          q.push :go!
+          sleep
+        end
+      end
+
+      q.pop
+      t.kill
+      t.join
+
+      DB.table_exists?(:que_jobs).should be true
+    end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !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'
 description: A job queue that uses PostgreSQL's advisory locks for speed and reliability.
@@ -31,9 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -97,6 +97,7 @@ files:
 - spec/unit/run_spec.rb
 - spec/unit/states_spec.rb
 - spec/unit/stats_spec.rb
+- spec/unit/transaction_spec.rb
 - spec/unit/work_spec.rb
 - spec/unit/worker_spec.rb
 - tasks/benchmark.rb
@@ -112,17 +113,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A PostgreSQL-based Job Queue
@@ -150,5 +151,6 @@ test_files:
 - spec/unit/run_spec.rb
 - spec/unit/states_spec.rb
 - spec/unit/stats_spec.rb
+- spec/unit/transaction_spec.rb
 - spec/unit/work_spec.rb
 - spec/unit/worker_spec.rb