que 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91851179dace9028e7617410ea3214b2f465aa20399db4714c91aa533682a326
-  data.tar.gz: 42935a8c9b1d8c709b7e39c590d2d1b062474dc509c66c0e5e87650bf40b39ac
+  metadata.gz: 73f8f07b0a406399663e08cbfd7faddaf5239b5ac08d29320eb8651e76dd1671
+  data.tar.gz: 6fc8445aed22c679a323ac22941e9f9037f668840a97fc16b7915850d494f668
 SHA512:
-  metadata.gz: 2635539c039b7e30736d8032bf8c27210624b98695f98c30053dff29345cc6368eb864315b32a41ea79a8af7a91f0c76c89924e73b652fe4edc08f15b1b65e41
-  data.tar.gz: 28d797216ae91e9cc15aee815c51308432f45d87dbc9cfc966d500496eec4efecb018c99dcf19fc0edb46bdd925ca35967eb10da325dfde642dafceb5f38297b
+  metadata.gz: 6020097fb14b30ce4775a34124ef7e40d52d8f56381286bab98e2e670626fac61c137f685f6ba87443143d52eee4e366bed96177bcb4e196b72c84546c022e07
+  data.tar.gz: 916cbe011fc1d742b1559997ad71dbc9822bf68c56ce629d2cf7e01a2bd218dd6b626eb09ac873da0be1e3c770fcfe75a245361e418c01787fc10d7c85b4e1f2

data/.travis.yml

@@ -4,7 +4,8 @@ cache: bundler
 rvm:
   - 2.2
   - 2.3
-  - 2.4.0
+  - 2.4
+  - 2.5
   - ruby-head
   # The Rubinii aren't installing properly on Travis :/
   # - rbx-2

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.14.3 (2018-03-02)
+
+*   Recorded errors now always include the error class, so that empty error messages can still be helpful. (  joehorsnell)
+
+*   Recorded error messages are now truncated to the first 500 characters.
+
 ### 0.14.2 (2018-01-05)
 
 *   Deprecate the Que.disable_prepared_statements= accessors.

data/lib/que/job.rb

@@ -33,6 +33,10 @@ module Que
       @attrs[:error_count]
     end
 
+    def error_message
+      self.class.send(:error_message, @_error)
+    end
+
     def handle_error(error)
       error_count = @attrs[:error_count] += 1
       retry_interval = self.class.retry_interval || Job.retry_interval
@@ -41,7 +45,6 @@ module Que
     end
 
     def retry_in(period)
-      error_message = "#{@_error.message}\n#{@_error.backtrace.join("\n")}"
       Que.execute :set_error, [period, error_message] + @attrs.values_at(:queue, :priority, :run_at, :job_id)
       @retried = true
     end
@@ -142,7 +145,7 @@ module Que
                   count    = job[:error_count].to_i + 1
                   interval = klass && klass.respond_to?(:retry_interval) && klass.retry_interval || retry_interval
                   delay    = interval.respond_to?(:call) ? interval.call(count) : interval
-                  message  = "#{error.message}\n#{error.backtrace.join("\n")}"
+                  message  = error_message(error)
                   Que.execute :set_error, [delay, message] + job.values_at(:queue, :priority, :run_at, :job_id)
                 end
               rescue
@@ -174,6 +177,18 @@ module Que
 
       private
 
+      def error_message(error)
+        message = error.class.to_s
+
+        unless error.message.nil? || error.message.strip.empty?
+          message << ": #{error.message}"
+        end
+
+        message = message.slice(0, 500)
+
+        ([message] + error.backtrace).join("\n")
+      end
+
       def class_for(string)
         Que.constantize(string)
       end

data/lib/que/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Que
-  Version = '0.14.2'
+  Version = '0.14.3'
 end

data/spec/unit/work_spec.rb

@@ -237,7 +237,7 @@ describe Que::Job, '.work' do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 1
-      job[:last_error].should =~ /\AErrorJob!/
+      job[:last_error].should =~ /\ARuntimeError: ErrorJob!/
       job[:run_at].should be_within(3).of Time.now + 4
 
       DB[:que_jobs].update :error_count => 5,
@@ -251,7 +251,7 @@ describe Que::Job, '.work' do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 6
-      job[:last_error].should =~ /\AErrorJob!/
+      job[:last_error].should =~ /\ARuntimeError: ErrorJob!/
       job[:run_at].should be_within(3).of Time.now + 1299
     end
 
@@ -270,7 +270,7 @@ describe Que::Job, '.work' do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 1
-      job[:last_error].should =~ /\AErrorJob!/
+      job[:last_error].should =~ /\ARuntimeError: ErrorJob!/
       job[:run_at].to_f.should be_within(3).of Time.now.to_f + RetryIntervalJob.retry_interval
 
       DB[:que_jobs].update :error_count => 5,
@@ -284,7 +284,7 @@ describe Que::Job, '.work' do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 6
-      job[:last_error].should =~ /\AErrorJob!/
+      job[:last_error].should =~ /\ARuntimeError: ErrorJob!/
       job[:run_at].to_f.should be_within(3).of Time.now.to_f + RetryIntervalJob.retry_interval
     end
 
@@ -303,7 +303,7 @@ describe Que::Job, '.work' do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 1
-      job[:last_error].should =~ /\AErrorJob!/
+      job[:last_error].should =~ /\ARuntimeError: ErrorJob!/
       job[:run_at].should be_within(3).of Time.now + 10
 
       DB[:que_jobs].update :error_count => 5,
@@ -317,7 +317,7 @@ describe Que::Job, '.work' do
       DB[:que_jobs].count.should be 1
       job = DB[:que_jobs].first
       job[:error_count].should be 6
-      job[:last_error].should =~ /\AErrorJob!/
+      job[:last_error].should =~ /\ARuntimeError: ErrorJob!/
       job[:run_at].should be_within(3).of Time.now + 60
     end
 
@@ -404,6 +404,46 @@ describe Que::Job, '.work' do
       job[:run_at].should be_within(3).of Time.now + 4
     end
 
+    it "should use the class name of the exception if its message is blank when setting last_error" do
+      class BlankExceptionMessageJob < Que::Job
+        def self.error
+          @error ||= RuntimeError.new("")
+        end
+
+        def run
+          raise self.class.error
+        end
+      end
+
+      BlankExceptionMessageJob.enqueue
+      result = Que::Job.work
+      result[:event].should == :job_errored
+      job = DB[:que_jobs].first
+      job[:error_count].should be 1
+      last_error_lines = job[:last_error].split("\n")
+      last_error_lines.should == %w[RuntimeError] + BlankExceptionMessageJob.error.backtrace
+    end
+
+    it "should use the class name of the exception if its message is blank when setting last_error" do
+      class LongExceptionMessageJob < Que::Job
+        def self.error
+          @error ||= RuntimeError.new("a" * 500)
+        end
+
+        def run
+          raise self.class.error
+        end
+      end
+
+      LongExceptionMessageJob.enqueue
+      result = Que::Job.work
+      result[:event].should == :job_errored
+      job = DB[:que_jobs].first
+      job[:error_count].should be 1
+      last_error_lines = job[:last_error].split("\n")
+      last_error_lines.should == ["RuntimeError: #{'a' * 486}"] + LongExceptionMessageJob.error.backtrace
+    end
+
     context "in a job class that has a custom error handler" do
       it "should allow it to schedule a retry after a specific interval" do
         begin
@@ -434,7 +474,7 @@ describe Que::Job, '.work' do
           job[:error_count].should be 1
 
           lines = job[:last_error].split("\n")
-          lines[0].should == "Blah!"
+          lines[0].should == "RuntimeError: Blah!"
           lines[1].should =~ /work_spec/
           job[:run_at].should be_within(3).of Time.now + 42
 
@@ -543,7 +583,7 @@ describe Que::Job, '.work' do
           DB[:que_jobs].count.should be 1
           job = DB[:que_jobs].first
           job[:error_count].should be 1
-          job[:last_error].should =~ /\ABlah!/
+          job[:last_error].should =~ /\ARuntimeError: Blah!/
           job[:run_at].should be_within(3).of Time.now + 4
 
           error.should == result[:error]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: que
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Chris Hanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler